Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

start fixing LinearProblem docstring #351

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

start fixing LinearProblem docstring #351

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cb05e7a
start fixing LinearProblem docstring
ArnoStrouwen Jan 3, 2023
7556215
Update src/problems/basic_problems.jl
ChrisRackauckas Jan 3, 2023
f423047
Update src/problems/basic_problems.jl
ChrisRackauckas Jan 3, 2023
6de9890
LinearProblem docstring
ArnoStrouwen Jan 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/problems/basic_problems.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Au = b

For matrix-free versions, the specification of the problem is given by an
operator `A(u,p,t)` which computes `A*u`, or in-place as `A(du,u,p,t)`. These
are specified via the `AbstractSciMLOperator` interface. For more details, see
are specified via the `AbstractDiffEqOperator` interface. For more details, see
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should just keep it to SciMLOperators as we plan to finish it ASAP

the [SciMLBase Documentation](https://docs.sciml.ai/SciMLBase/stable/).

Note that matrix-free versions of LinearProblem definitions are not compatible
Expand All @@ -32,13 +32,13 @@ Optionally, an initial guess ``u₀`` can be supplied which is used for iterativ
methods.

```julia
LinearProblem{isinplace}(A,x,p=NullParameters();u0=nothing,kwargs...)
LinearProblem(f::AbstractDiffEqOperator,u0,p=NullParameters();u0=nothing,kwargs...)
LinearProblem(A,b,p=NullParameters();u0=nothing,kwargs...)
LinearProblem{isinplace}(f::AbstractDiffEqOperator,b,p=NullParameters();u0=nothing,kwargs...)
```

`isinplace` optionally sets whether the function is in-place or not, i.e. whether
the solvers are allowed to mutate. By default this is true for `AbstractMatrix`,
and for `AbstractSciMLOperator`s it matches the choice of the operator definition.
and for `AbstractDiffEqOperator`s it matches the choice of the operator definition.

Parameters are optional, and if not given, then a `NullParameters()` singleton
will be used, which will throw nice errors if you try to index non-existent
Expand All @@ -48,7 +48,7 @@ parameters. Any extra keyword arguments are passed on to the solvers.

* `A`: The representation of the linear operator.
* `b`: The right-hand side of the linear system.
* `p`: The parameters for the problem. Defaults to `NullParameters`. Currently unused.
* `p`: The parameters for the problem. Defaults to `NullParameters`.
* `u0`: The initial condition used by iterative solvers.
* `kwargs`: The keyword arguments passed on to the solvers.
"""
Expand Down