Skip to content

Commit 7387a91

Browse files
Update README.md
1 parent ad1a7f5 commit 7387a91

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ which allows for solvers to be able to handle custom user types in an efficient
1919

2020
```julia
2121
isscimlstructure(p)::Bool
22+
ismutablescimlstructure(p)::Bool
2223
```
2324

2425
Returns 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
3031
canonicalize(::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
3740
to the solver how to represent the given "portion" in a standard `AbstractVector` type which allows for
3841
interfacing with standard tools like linear algebra in an efficient manner. The type of portions which
3942
are defined are:

0 commit comments

Comments
 (0)