From 40b969092a36c8a1895f705c794188435ad997ab Mon Sep 17 00:00:00 2001 From: lxvm Date: Thu, 15 Feb 2024 20:49:49 -0500 Subject: [PATCH] update solver documentation --- docs/src/solvers/IntegralSolvers.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/src/solvers/IntegralSolvers.md b/docs/src/solvers/IntegralSolvers.md index 17df07f..8178f52 100644 --- a/docs/src/solvers/IntegralSolvers.md +++ b/docs/src/solvers/IntegralSolvers.md @@ -2,18 +2,17 @@ The following algorithms are available: - - `QuadGKJL`: Uses QuadGK.jl. Requires `nout=1` and `batch=0`, in-place is not allowed. - - `HCubatureJL`: Uses HCubature.jl. Requires `batch=0`. - - `VEGAS`: Uses MonteCarloIntegration.jl. Requires `nout=1`. Works only for - `>1`-dimensional integrations. + - `QuadGKJL`: Uses QuadGK.jl, which supports one-dimensional integration of scalar and array-valued integrands with in-place or batched forms. Integrands that are both in-place and batched are implemented in the wrapper but are not supported under the hood. + - `HCubatureJL`: Uses HCubature.jl, which supports scalar and array-valued integrands and works best in low dimensions, e.g. ≤ 8. In-place integrands are implemented in the wrapper but are not supported under the hood. Batching is not supported. + - `VEGAS`: Uses MonteCarloIntegration.jl, which requires scalar, `Float64`-valued integrands and works in any number of dimensions. - `VEGASMC`: Uses MCIntegration.jl. Requires `using MCIntegration`. Doesn't support batching. - `CubatureJLh`: h-Cubature from Cubature.jl. Requires `using Cubature`. - `CubatureJLp`: p-Cubature from Cubature.jl. Requires `using Cubature`. - - `CubaVegas`: Vegas from Cuba.jl. Requires `using Cuba`, `nout=1`. + - `CubaVegas`: Vegas from Cuba.jl. Requires `using Cuba`. - `CubaSUAVE`: SUAVE from Cuba.jl. Requires `using Cuba`. - `CubaDivonne`: Divonne from Cuba.jl. Requires `using Cuba`. Works only for `>1`-dimensional integrations. - `CubaCuhre`: Cuhre from Cuba.jl. Requires `using Cuba`. Works only for `>1`-dimensional integrations. - - `GaussLegendre`: Uses Gauss-Legendre quadrature with nodes and weights from FastGaussQuadrature.jl. + - `GaussLegendre`: Performs fixed-order Gauss-Legendre quadrature. Requires `using FastGaussQuadrature`. - `QuadratureRule`: Accepts a user-defined function that returns nodes and weights. - `ArblibJL`: real- and complex-valued univariate integration of holomorphic and meromorphic functions from Arblib.jl. Requires `using Arblib`.