File tree Expand file tree Collapse file tree 1 file changed +5
-9
lines changed Expand file tree Collapse file tree 1 file changed +5
-9
lines changed Original file line number Diff line number Diff line change @@ -6,15 +6,11 @@ in order to give composability. These are also the options taken at `init` time.
66The following are the options these algorithms take, along with their defaults.
77
88## General Controls
9-
10- - ` alias_A::Bool ` : Whether to alias the matrix ` A ` or use a copy by default. When ` true ` ,
11- algorithms like LU-factorization can be faster by reusing the memory via ` lu! ` ,
12- but care must be taken as the original input will be modified. Default is ` true ` if the
13- algorithm is known not to modify ` A ` , otherwise is ` false ` .
14- - ` alias_b::Bool ` : Whether to alias the matrix ` b ` or use a copy by default. When ` true ` ,
15- algorithms can write and change ` b ` upon usage. Care must be taken as the
16- original input will be modified. Default is ` true ` if the algorithm is known not to
17- modify ` b ` , otherwise ` false ` .
9+ - ` alias::LinearAliasSpecifier ` : Holds the fields ` alias_A ` and ` alias_b ` which specify
10+ whether to alias the matrices ` A ` and ` b ` respectively. When these fields are ` true ` ,
11+ ` A ` and ` b ` can be written to and changed by the solver algorithm. When fields are ` nothing `
12+ the default behavior is used, which is to default to ` true ` when the algorithm is known
13+ not to modify the matrices, and false otherwise.
1814 - ` verbose ` : Whether to print extra information. Defaults to ` false ` .
1915 - ` assumptions ` : Sets the assumptions of the operator in order to effect the default
2016 choice algorithm. See the [ Operator Assumptions page for more details] (@ref assumptions).
You can’t perform that action at this time.
0 commit comments