Skip to content

Commit a5040d2

Browse files
Merge pull request #33 from bowenszhu/docstring-signature
Update `deim` docstring to include types and default values of kwargs
2 parents c3ed12e + 8d3d63a commit a5040d2

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

src/deim.jl

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,14 @@ function deim(full_vars::AbstractVector, linear_coeffs::AbstractMatrix,
9494
reduced_rhss, linear_projection_eqs
9595
end
9696
"""
97-
$(TYPEDSIGNATURES)
97+
$(FUNCTIONNAME)(
98+
sys::ModelingToolkit.ODESystem,
99+
snapshot::AbstractMatrix,
100+
pod_dim::Integer;
101+
deim_dim::Integer = pod_dim,
102+
name::Symbol = Symbol(nameof(sys), :_deim),
103+
kwargs...
104+
) -> ModelingToolkit.ODESystem
98105
99106
Reduce a `ModelingToolkit.ODESystem` using the Proper Orthogonal Decomposition (POD) with
100107
the Discrete Empirical Interpolation Method (DEIM).

0 commit comments

Comments
 (0)