CommonSolve.jl

https://docs.sciml.ai/CommonSolve/stable/
Admin
CommonSolve.jl provides a lightweight, common interface defining solve, init, solve!, and step!...
Tokens:5,055
Snippets:27
Trust Score:9.1
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install CommonSolve.jl

Source: https://docs.sciml.ai/CommonSolve/stable

Use the Julia package manager to install the CommonSolve package.

```julia
using Pkg
Pkg.add("CommonSolve")
```

--------------------------------

### Avoid ambiguous method definition

Source: https://docs.sciml.ai/CommonSolve/stable

Example of an invalid method definition that causes type piracy and ambiguity.

```julia
init(::AbstractVector, ::AlgorithmType)
```

--------------------------------

### Recommended interface definitions

Source: https://docs.sciml.ai/CommonSolve/stable

Recommended method signatures for init and solve! using package-specific types.

```julia
init(::ProblemType, args...; kwargs...)::SolverType
solve!(::SolverType)::SolutionType
```

--------------------------------

### Full dependency manifest

Source: https://docs.sciml.ai/CommonSolve/stable

A complete list of all dependencies and their versions from the Manifest.toml file.

```toml
Status `~/_work/CommonSolve.jl/CommonSolve.jl/docs/Manifest.toml`
  [a4c015fc] ANSIColoredPrinters v0.0.1
  [1520ce14] AbstractTrees v0.4.5
  [944b1d66] CodecZlib v0.7.8
  [38540f10] CommonSolve v0.2.8 `~/_work/CommonSolve.jl/CommonSolve.jl`
  [ffbed154] DocStringExtensions v0.9.5
  [e30172f5] Documenter v1.17.0
  [d7ba0133] Git v1.5.0
  [b5f81e59] IOCapture v1.0.0
  [692b3bcd] JLLWrappers v1.8.0
  [682c06a0] JSON v1.6.1
  [0e77f7df] LazilyInitializedFields v1.3.0
  [d0879d2d] MarkdownAST v0.1.3
  [69de0a69] Parsers v2.8.6
  [aea7be01] PrecompileTools v1.3.4
  [21216c6a] Preferences v1.5.2
  [2792f1a3] RegistryInstances v0.1.0
  [ec057cc2] StructUtils v2.8.2
  [3bb67fe8] TranscodingStreams v0.11.3
  [2e619515] Expat_jll v2.8.1+0
  [020c3dae] Git_LFS_jll v3.7.1+0
  [f8c6e375] Git_jll v2.54.0+0
  [94ce4f54] Libiconv_jll v1.18.0+0
  [9bd350c2] OpenSSH_jll v10.3.1+0
  [0dad84c5] ArgTools v1.1.2
  [56f22d72] Artifacts v1.11.0
  [2a0f44e3] Base64 v1.11.0
  [ade2ca70] Dates v1.11.0
  [f43a241f] Downloads v1.7.0
  [7b1f6079] FileWatching v1.11.0
  [b77e0a4c] InteractiveUtils v1.11.0
  [ac6e5ff7] JuliaSyntaxHighlighting v1.12.0
  [b27032c2] LibCURL v0.6.4
  [76f85450] LibGit2 v1.11.0
  [8f399da3] Libdl v1.11.0
  [56ddb016] Logging v1.11.0
  [d6f4376e] Markdown v1.11.0
  [ca575930] NetworkOptions v1.3.0
  [44cfe95a] Pkg v1.12.1
  [de0858da] Printf v1.11.0
  [3fa0cd96] REPL v1.11.0
  [9a3f8284] Random v1.11.0
  [ea8e919c] SHA v0.7.0
  [9e88b42a] Serialization v1.11.0
  [6462fe0b] Sockets v1.11.0
  [f489334b] StyledStrings v1.11.0
  [fa267f1f] TOML v1.0.3
  [a4e569a6] Tar v1.10.0
  [8dfed614] Test v1.11.0
  [cf7118a7] UUIDs v1.11.0
  [4ec0a83e] Unicode v1.11.0
  [e66e0078] CompilerSupportLibraries_jll v1.3.0+1
  [deac9b47] LibCURL_jll v8.15.0+0
  [e37daf67] LibGit2_jll v1.9.0+0
  [29816b5a] LibSSH2_jll v1.11.3+1
  [14a3606d] MozillaCACerts_jll v2025.11.4
  [458c3c95] OpenSSL_jll v3.5.4+0
  [efcefdf7] PCRE2_jll v10.44.0+1
  [83775a58] Zlib_jll v1.3.1+2
  [8e850ede] nghttp2_jll v1.64.0+1
  [3f19e933] p7zip_jll v17.7.0+0
```

--------------------------------

### Project dependencies for documentation

Source: https://docs.sciml.ai/CommonSolve/stable

The direct dependencies used to build the documentation as listed in the Project.toml file.

```toml
Status `~/_work/CommonSolve.jl/CommonSolve.jl/docs/Project.toml`
  [38540f10] CommonSolve v0.2.8 `~/_work/CommonSolve.jl/CommonSolve.jl`
  [e30172f5] Documenter v1.17.0
```

--------------------------------

### CommonSolve.init

Source: https://docs.sciml.ai/CommonSolve/stable

Creates an iterator or cache object to hold a problem and solver algorithm, to be passed to solve! or step!. This allows more direct control over the internal solving process.

```APIDOC
## CommonSolve.init

### Description
Creates an iterator or cache object to hold a problem `prob` and a solver algorithm `alg` to be passed to `solve!` or `step!`. The object returned by `init` allows more direct control over the internal solving process, and users shouldn't generally need to handle it.

### Method
Function

### Endpoint
`CommonSolve.init(args...; kwargs...)`

### Parameters
#### Arguments
- `args...` - Required - Problem and algorithm arguments, typically `prob::ProblemType` and `alg::SolverType`.

#### Keyword Arguments
- `kwargs...` - Optional - Uniform keyword arguments across all choices of algorithms.

### Request Example
```julia
iter = CommonSolve.init(prob, alg; kwargs...)
```

### Response
#### Success Response
Returns an iterator object of type `IterType`.

#### Response Example
```julia
iter::IterType
```
```

--------------------------------

### CommonSolve.step!

Source: https://docs.sciml.ai/CommonSolve/stable

Progresses the iterator object returned by `CommonSolve.init`. The additional arguments typically describe how much to progress the iterator for, and are implementation-specific.

```APIDOC
## CommonSolve.step!

### Description
Progresses the iterator object (the one returned by `CommonSolve.init`). The additional arguments typically describe how much to progress the iterator for, and are implementation-specific.

### Method
Function

### Endpoint
`CommonSolve.step!(iter, args...; kwargs...)`

### Parameters
#### Arguments
- `iter` - Required - The iterator object returned by `CommonSolve.init`.
- `args...` - Optional - Additional arguments describing how much to progress the iterator.

#### Keyword Arguments
- `kwargs...` - Optional - Additional keyword arguments.

### Request Example
```julia
CommonSolve.step!(iter, args...; kwargs...)
```

### Response
#### Success Response
No explicit return value documented.
```

--------------------------------

### CommonSolve.init function signature

Source: https://docs.sciml.ai/CommonSolve/stable

Initializes an iterator or cache object for a problem and solver algorithm.

```julia
iter = CommonSolve.init(args...; kwargs...)
```

```julia
iter = CommonSolve.init(prob::ProblemType, alg::SolverType; kwargs...)::IterType
CommonSolve.solve!(iter)::SolutionType
```

--------------------------------

### Julia version and system information

Source: https://docs.sciml.ai/CommonSolve/stable

The specific Julia version and machine platform details used for the build.

```text
Julia Version 1.12.6
Commit 15346901f00 (2026-04-09 19:20 UTC)
Build Info:
  Official https://julialang.org release
Platform Info:
  OS: Linux (x86_64-linux-gnu)
  CPU: 128 × AMD EPYC 7513 32-Core Processor
  WORD_SIZE: 64
  LLVM: libLLVM-18.1.7 (ORCJIT, znver3)
  GC: Built with stock GC
Threads: 1 default, 1 interactive, 1 GC (on 4 virtual cores)
Environment:
  JULIA_CPU_THREADS = 4
  JULIA_NUM_PRECOMPILE_TASKS = 4
```

--------------------------------

### CommonSolve.step! function signature

Source: https://docs.sciml.ai/CommonSolve/stable

Progresses the iterator object returned by CommonSolve.init.

```julia
CommonSolve.step!(iter, args...; kwargs...)
```

--------------------------------

### Iterative step! function definition

Source: https://docs.sciml.ai/CommonSolve/stable

The step! function signature for iterative solver objects.

```julia
step!(::SolverType, args...; kwargs...)
```

--------------------------------

### CommonSolve.solve function signature

Source: https://docs.sciml.ai/CommonSolve/stable

Solves a mathematical problem using the specified algorithm.

```julia
CommonSolve.solve(args...; kwargs...)
```

```julia
CommonSolve.solve(prob::ProblemType, alg::SolverType; kwargs...)::SolutionType
```

```julia
solve(args...; kwargs...) = solve!(init(args...; kwargs...))
```

--------------------------------

### CommonSolve.solve!

Source: https://docs.sciml.ai/CommonSolve/stable

Solves an equation or other mathematical problem using the algorithm specified in the arguments. This function operates on the iterator object returned by `init`.

```APIDOC
## CommonSolve.solve!

### Description
Solves an equation or other mathematical problem using the algorithm specified in the arguments. This function operates on the iterator object returned by `init`.

### Method
Function

### Endpoint
`CommonSolve.solve!(iter)`

### Parameters
#### Arguments
- `iter` - Required - The iterator object returned by `CommonSolve.init`.

### Request Example
```julia
solution = CommonSolve.solve!(iter)
```

### Response
#### Success Response
Returns a solution object of type `SolutionType`.

#### Response Example
```julia
solution::SolutionType
```
```

--------------------------------

### CommonSolve.solve

Source: https://docs.sciml.ai/CommonSolve/stable

Solves an equation or other mathematical problem using the algorithm specified in the arguments. By default, it uses `solve!` on the iterator form.

```APIDOC
## CommonSolve.solve

### Description
Solves an equation or other mathematical problem using the algorithm specified in the arguments. By default, `solve` defaults to using `solve!` on the iterator form.

### Method
Function

### Endpoint
`CommonSolve.solve(args...; kwargs...)`

### Parameters
#### Arguments
- `args...` - Required - Problem and algorithm arguments, typically `prob::ProblemType` and `alg::SolverType`.

#### Keyword Arguments
- `kwargs...` - Optional - Uniform keyword arguments across all choices of algorithms.

### Request Example
```julia
solution = CommonSolve.solve(prob, alg; kwargs...)
```

### Response
#### Success Response
Returns a solution object of type `SolutionType`.

#### Response Example
```julia
solution::SolutionType
```
```

--------------------------------

### CommonSolve.solve! function signature

Source: https://docs.sciml.ai/CommonSolve/stable

Solves a problem using an existing iterator object.

```julia
CommonSolve.solve!(iter)
```

```julia
iter = CommonSolve.init(prob::ProblemType, alg::SolverType; kwargs...)::IterType
CommonSolve.solve!(iter)::SolutionType
```

--------------------------------

### Default solve function definition

Source: https://docs.sciml.ai/CommonSolve/stable

The default implementation of the solve function in CommonSolve.jl.

```julia
solve(args...; kwargs...) = solve!(init(args...; kwargs...))
```
Tokens:
Raw