-
-
Notifications
You must be signed in to change notification settings - Fork 92
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.
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
start fixing LinearProblem docstring #351
base: master
Are you sure you want to change the base?
Conversation
Codecov Report
@@ Coverage Diff @@
## master #351 +/- ##
==========================================
+ Coverage 57.92% 57.98% +0.06%
==========================================
Files 43 43
Lines 3289 3289
==========================================
+ Hits 1905 1907 +2
+ Misses 1384 1382 -2
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
src/problems/basic_problems.jl
Outdated
@@ -32,8 +32,8 @@ 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;u0=nothing,kwargs...) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why was p removed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you are passing a matrix, why would this need parameters?
Parameters should only be there when you work with the Operator interface?
src/problems/basic_problems.jl
Outdated
LinearProblem{isinplace}(A,x,p=NullParameters();u0=nothing,kwargs...) | ||
LinearProblem(f::AbstractDiffEqOperator,u0,p=NullParameters();u0=nothing,kwargs...) | ||
LinearProblem(A,b;u0=nothing,kwargs...) | ||
LinearProblem{isinplace}(f::AbstractSciMLOperator,b,p=NullParameters();u0=nothing,kwargs...) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this isn't true yet
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The surrounding text all mention SciMLOperator, not DiffEqOperator.
@@ -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 |
There was a problem hiding this comment.
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
There is still something more wrong with
u0
, it is used both as positional and keyword argument.