diff --git a/docs/make.jl b/docs/make.jl index 431f917a..7592c357 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -10,7 +10,7 @@ makedocs(; sitename="MathematicalSystems.jl", assets=["assets/aligned.css"], size_threshold_warn=150 * 2^10), pagesonly=true, pages=["Home" => "index.md", - "Manual" => Any["System types overview" => "man/systems.md"], + "Manual" => Any["Overview of System Types" => "man/systems.md"], "Library" => Any["Types" => "lib/types.md", "Methods" => "lib/methods.md", "Internals" => "lib/internals.md"], diff --git a/docs/src/lib/internals.md b/docs/src/lib/internals.md index d33d1cad..575061b8 100644 --- a/docs/src/lib/internals.md +++ b/docs/src/lib/internals.md @@ -14,7 +14,7 @@ DocTestSetup = quote end ``` -## Expression handling +## Expression Handling ```@docs _corresponding_type @@ -24,20 +24,20 @@ add_asterisk sort ``` -## Querying expressions +## Querying Expressions ```@docs is_equation extract_sum ``` -## Evaluation of AbstractSystem at given state +## Evaluation of AbstractSystem at Given State ```@docs _instantiate ``` -## Naming convention for systems' fields +## Naming Convention for Systems' Fields Systems' fields should be accessed externally by their respective getter functions. Internally to the library, the following naming conventions are used. diff --git a/docs/src/lib/types.md b/docs/src/lib/types.md index 2eac60ce..e7784b16 100644 --- a/docs/src/lib/types.md +++ b/docs/src/lib/types.md @@ -104,34 +104,22 @@ ExactDiscretization EulerDiscretization ``` -## System macro - -```@docs -@system -``` - -## Initial-value problem macro +## Initial Value Problems ```@docs -@ivp +InitialValueProblem +IVP +initial_state +system ``` -## Identity operator +## Identity Operator ```@docs IdentityMultiple Id ``` -## Initial Value Problems - -```@docs -InitialValueProblem -IVP -initial_state -system -``` - ## Input Types ```@docs @@ -162,13 +150,7 @@ BlackBoxControlMap ConstrainedBlackBoxControlMap ``` -### Macros - -```@docs -@map -``` - -## Systems with output +## Systems with Output ```@docs SystemWithOutput @@ -176,8 +158,15 @@ LinearTimeInvariantSystem LTISystem ``` - -## Vector Field +## Vector Fields ```@docs VectorField ``` + +## Macros + +```@docs +@system +@ivp +@map +``` diff --git a/docs/src/man/systems.md b/docs/src/man/systems.md index 51c9b552..b7475263 100644 --- a/docs/src/man/systems.md +++ b/docs/src/man/systems.md @@ -1,6 +1,6 @@ -# System types overview +# Overview of System Types -## Using the macro +## Using the `@system` Macro A convenient way to create a new system is with the `@system` macro. For example, the ODE $x'(t) = -2x(t)$ is simply `x' = -2x`, where $x'(t) := dx/dt$ is the derivative @@ -56,7 +56,7 @@ for (controlled) inputs and noise respectively. Please note that some systems ar equivalent, for example `CLCCS` and `NCLCS` being $x' = Ax + Bu$ and $x' = Ax + Dw$ respectively; the difference lies in the resulting value of getter functions such as `inputset` and `noiseset`. -## Summary tables +## Summary Tables The following table summarizes the different system types in abbreviated form. The abbreviated names are included here only for reference and are not exported.