Skip to content

Commit 26f6f4c

Browse files
Update description of inplace argument
1 parent 5bcd2e1 commit 26f6f4c

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/time_evolution/sesolve.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Generate the ODEProblem for the Schrödinger time evolution of a quantum system:
4545
- `e_ops`: List of operators for which to calculate expectation values. It can be either a `Vector` or a `Tuple`.
4646
- `params`: Parameters to pass to the solver. This argument is usually expressed as a `NamedTuple` or `AbstractVector` of parameters. For more advanced usage, any custom struct can be used.
4747
- `progress_bar`: Whether to show the progress bar. Using non-`Val` types might lead to type instabilities.
48-
- `inplace`: Whether to use the inplace version of the ODEProblem. The default is `Val(true)`.
48+
- `inplace`: Whether to use the inplace version of the ODEProblem. The default is `Val(true)`. It is recommended to use `Val(true)` for better performance, but it is sometimes necessary to use `Val(false)`, for example when performing automatic differentiation using [Zygote.jl](https://github.com/FluxML/Zygote.jl).
4949
- `kwargs`: The keyword arguments for the ODEProblem.
5050
5151
# Notes
@@ -123,7 +123,7 @@ Time evolution of a closed quantum system using the Schrödinger equation:
123123
- `e_ops`: List of operators for which to calculate expectation values. It can be either a `Vector` or a `Tuple`.
124124
- `params`: Parameters to pass to the solver. This argument is usually expressed as a `NamedTuple` or `AbstractVector` of parameters. For more advanced usage, any custom struct can be used.
125125
- `progress_bar`: Whether to show the progress bar. Using non-`Val` types might lead to type instabilities.
126-
- `inplace`: Whether to use the inplace version of the ODEProblem. The default is `Val(true)`.
126+
- `inplace`: Whether to use the inplace version of the ODEProblem. The default is `Val(true)`. It is recommended to use `Val(true)` for better performance, but it is sometimes necessary to use `Val(false)`, for example when performing automatic differentiation using [Zygote.jl](https://github.com/FluxML/Zygote.jl).
127127
- `kwargs`: The keyword arguments for the ODEProblem.
128128
129129
# Notes

0 commit comments

Comments
 (0)