File tree Expand file tree Collapse file tree 1 file changed +5
-2
lines changed Expand file tree Collapse file tree 1 file changed +5
-2
lines changed Original file line number Diff line number Diff line change @@ -19,6 +19,7 @@ which allows for solvers to be able to handle custom user types in an efficient
1919
2020``` julia
2121isscimlstructure (p):: Bool
22+ ismutablescimlstructure (p):: Bool
2223```
2324
2425Returns whether the object satisfies the SciMLStructure interface. Defaults to ` false ` and types
@@ -28,12 +29,14 @@ are required to opt-into the interface.
2829
2930``` julia
3031canonicalize (:: AbstractPortion , p:: T1 ) -> values:: T2 , repack, aliases:: Bool
31- repack (new_values:: T2 ) -> p:: T2 # with values replaced with new_values
32+ repack (new_values:: T2 ) -> p:: T1 # with values replaced with new_values
33+ replace (:: AbstractPortion , p:: T1 , new_values) -> p:: T1
34+ replace! (p:: T1 ):: Nothing # Requires mutable
3235```
3336
3437### Portion Defintions
3538
36- The core function of the interface is the ` canonicalize ` function. ` caonicalize ` allows the user to define
39+ The core function of the interface is the ` canonicalize ` function. ` canonicalize ` allows the user to define
3740to the solver how to represent the given "portion" in a standard ` AbstractVector ` type which allows for
3841interfacing with standard tools like linear algebra in an efficient manner. The type of portions which
3942are defined are:
You can’t perform that action at this time.
0 commit comments