Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Reexport = "1.2"
SafeTestsets = "0.1, 1"
SciMLBase = "2.104, 3.0"
SciMLLogging = "1.10.1, 2"
SciMLTesting = "2.1"
SciMLTesting = "2.4"
StaticArrays = "1.9.8"
Test = "1.10"
Unitful = "1"
Expand Down
3 changes: 0 additions & 3 deletions docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@ ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210"
Integrals = "de52edbc-65ea-441a-8357-d3a637375a31"
Zygote = "e88e6eb3-aa80-5325-afca-941959d7151f"

[sources]
Integrals = {path = ".."}

[compat]
Cuba = "2"
Cubature = "1"
Expand Down
5 changes: 2 additions & 3 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,8 @@ include("pages.jl")
makedocs(
sitename = "Integrals.jl",
authors = "Chris Rackauckas",
modules = [Integrals, Integrals.SciMLBase],
clean = true, doctest = false, linkcheck = true,
warnonly = [:missing_docs],
modules = [Integrals],
clean = true, doctest = true, linkcheck = true, checkdocs = :exports,
format = Documenter.HTML(
assets = ["assets/favicon.ico"],
canonical = "https://docs.sciml.ai/Integrals/stable/"
Expand Down
2 changes: 1 addition & 1 deletion docs/src/basics/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ precision arithmetic may help.

## How can I integrate arbitrarily-spaced data?

See [`SampledIntegralProblem`](@ref).
See the Integrating pre-sampled data page.

## How can I integrate on arbitrary geometries?

Expand Down
7 changes: 3 additions & 4 deletions docs/src/basics/IntegralFunction.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# [Integral Functions](@id func)

```@docs
SciMLBase.IntegralFunction
SciMLBase.BatchIntegralFunction
```
`IntegralFunction` and `BatchIntegralFunction` are SciMLBase problem-interface
wrappers reexported by Integrals.jl for convenience. Their API is documented by
SciMLBase; Integrals.jl supplies algorithms that solve problems built with them.
6 changes: 3 additions & 3 deletions docs/src/basics/IntegralProblem.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# [Integral Problems](@id prob)

```@docs
SciMLBase.IntegralProblem
```
`IntegralProblem` is a SciMLBase problem type reexported by Integrals.jl for
convenience. Its construction API is documented by SciMLBase; this page describes the
integrand shapes accepted by Integrals.jl algorithms.

The correct shape of the variables (inputs) `u` and the values (outputs) `y` of the integrand `f`
depends on whether batching is used. Batching is enabled by using
Expand Down
7 changes: 3 additions & 4 deletions docs/src/basics/SampledIntegralProblem.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,9 @@ The exact answer is of course ``1/3``.

## Details

```@docs
SciMLBase.SampledIntegralProblem
solve(::SampledIntegralProblem, ::SciMLBase.AbstractIntegralAlgorithm)
```
`SampledIntegralProblem` and the generic `solve` interface are provided by SciMLBase
and reexported by Integrals.jl for convenience. The following sections describe how
Integrals.jl algorithms use sampled data.

### Non-equidistant grids

Expand Down
8 changes: 7 additions & 1 deletion docs/src/basics/solve.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,22 @@
# Common Solver Options (Solve Keyword Arguments)

`solve` is the generic SciMLBase interface reexported by Integrals.jl. Integrals.jl
implements it for integral problems and the algorithms documented on this site.

```@docs
solve(prob::IntegralProblem, alg::SciMLBase.AbstractIntegralAlgorithm)
solve(prob::SampledIntegralProblem, alg::SciMLBase.AbstractIntegralAlgorithm)
```

## Related SciML interface utilities

`init`, `solve!`, `isinplace`, `remake`, and `ReturnCode` are SciMLBase interface
utilities reexported by Integrals.jl. Their API is documented by SciMLBase.

```@docs
init(prob::IntegralProblem, alg::SciMLBase.AbstractIntegralAlgorithm)
init(prob::SampledIntegralProblem, alg::SciMLBase.AbstractIntegralAlgorithm)
solve!(cache::Integrals.IntegralCache)
solve!(cache::Integrals.SampledIntegralCache)
isinplace(cache::Integrals.IntegralCache)
ReturnCode
```
2 changes: 1 addition & 1 deletion test/AD/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ ForwardDiff = "0.10.36, 1"
Integrals = "5"
Mooncake = "0.5.6"
SafeTestsets = "0.1, 1"
SciMLTesting = "2.1"
SciMLTesting = "2.4"
Test = "1.10"
Zygote = "0.7.10"
julia = "1.10"
2 changes: 1 addition & 1 deletion test/qa/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ Aqua = "0.8"
Integrals = "5"
JET = "0.9, 0.10, 0.11.3"
SafeTestsets = "0.1, 1"
SciMLTesting = "2.1"
SciMLTesting = "2.4"
Test = "1.10"
julia = "1.10"
4 changes: 4 additions & 0 deletions test/qa/qa.jl
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ using JET

run_qa(
Integrals;
reexports_allow = (
:BatchIntegralFunction, :IntegralFunction, :IntegralProblem, :ReturnCode,
:SampledIntegralProblem, :SciMLBase, :init, :isinplace, :remake, :solve, :solve!,
),
aqua_kwargs = (;
# IntegralProblem / SampledIntegralProblem are SciMLBase types this package
# owns the integral-solver methods for, so dispatching on them is not piracy.
Expand Down
Loading