Skip to content

Commit 2ccb876

Browse files
mention the ref
1 parent 935de6e commit 2ccb876

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/solutions/basic_solutions.jl

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ Representation of the solution to an linear system Ax=b defined by a LinearProbl
55
66
## Fields
77
8-
- `u`: the representation of the optimization's solution.
9-
- `resid`: the residual of the solver, if the method is an iterative method.
8+
- `u`: the representation of the linear solve's solution.
9+
- `resid`: the residual of the solver, if the method is an iterative method. Returns a mutable
10+
type, thus if scalar it is wrapped in a `Ref`.
1011
- `alg`: the algorithm type used by the solver.
1112
- `iters`: the number of iterations used to solve the equation, if the method is an iterative
1213
method.

0 commit comments

Comments
 (0)