Skip to content

Commit 8befb01

Browse files
docs: update docstring for getp
1 parent 4f5758c commit 8befb01

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

src/parameter_indexing.jl

+6-1
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,15 @@ set_parameter!(sys, val, idx) = set_parameter!(parameter_values(sys), val, idx)
3535
"""
3636
getp(sys, p)
3737
38-
Return a function that takes an array representing the parameter vector or an integrator
38+
Return a function that takes an array representing the parameter object or an integrator
3939
or solution of `sys`, and returns the value of the parameter `p`. Note that `p` can be a
4040
direct index or a symbolic value, or an array/tuple of the aforementioned.
4141
42+
If `p` is an array/tuple of parameters, then the returned function can also be used
43+
as an in-place getter function. The first argument is the buffer to which the parameter
44+
values should be written, and the second argument is the parameter object/integrator/
45+
solution from which the values are obtained.
46+
4247
Requires that the integrator or solution implement [`parameter_values`](@ref). This function
4348
typically does not need to be implemented, and has a default implementation relying on
4449
[`parameter_values`](@ref).

0 commit comments

Comments
 (0)