export and document sys_fromparticles`

JuliaControl · Sep 29, 2023 · f4c6156 · f4c6156
1 parent 8d75167
commit f4c6156
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/src/RobustAndOptimalControl.jl b/src/RobustAndOptimalControl.jl
@@ -40,7 +40,7 @@ include("ExtendedStateSpace.jl")
 export modal_form, schur_form, hess_form
 include("canonical.jl")
 
-export δ, δr, δc, δss, nominal, UncertainSS, uss, blocksort
+export δ, δr, δc, δss, nominal, UncertainSS, uss, blocksort, sys_from_particles
 include("uncertainty_interface.jl")
 
 export makeweight, neglected_delay, gain_and_delay_uncertainty, neglected_lag, fit_complex_perturbations

diff --git a/src/uncertainty_interface.jl b/src/uncertainty_interface.jl
@@ -473,8 +473,14 @@ using MonteCarloMeasurements: vecindex
 
 """
     sys_from_particles(P, i)
+    sys_from_particles(P)
 
 Return the `i`th system from a system `P` with `Particles` coefficients.
+
+If called without an index, return a vector of systems, one for each possibly `i`.
+
+This function is used to convert from an uncertain representation using `Particles` to a "multi-model" representation using multiple `StateSpace` models.
+
 See also [`ss2particles`](@ref) and `MonteCarloMeasurements.nominal`.
 """
 function sys_from_particles(P, i)