Skip to content

Commit 6f068ac

Browse files
committed
minor doc corrections
1 parent ae0618f commit 6f068ac

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

src/model/linmodel.jl

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -188,9 +188,10 @@ end
188188
189189
Construct the model from the discrete state-space matrices `A, Bu, C, Bd, Dd` directly.
190190
191-
This syntax do not modify the state-space representation provided in argument (`minreal`
192-
is not called). Care must be taken to ensure that the model is controllable and observable.
193-
The optional parameter `NT` explicitly specifies the number type of the matrices.
191+
See [`LinModel(::StateSpace)`](@ref) Extended Help for the meaning of the matrices. This
192+
syntax do not modify the state-space representation provided in argument (`minreal` is not
193+
called). Care must be taken to ensure that the model is controllable and observable. The
194+
optional parameter `NT` explicitly specifies the number type of the matrices.
194195
"""
195196
LinModel{NT}(A, Bu, C, Bd, Dd, Ts) where NT<:Real
196197

src/model/nonlinmodel.jl

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@ functions are defined as:
4040
```
4141
They can be implemented in two possible ways:
4242
43-
- Non-mutating functions (out-of-place): defined them as `f(x, u, d) -> ẋ` and
44-
`h(x, d) -> y`. This syntax is simple and intuitive but it allocates more memory.
45-
- Mutating functions (in-place): defined them as `f!(ẋ, x, u, d) -> nothing` and
46-
`h!(y, x, d) -> nothing`. This syntax reduces the allocations and potentially the
47-
computational burden as well.
43+
1. **Non-mutating functions** (out-of-place): define them as `f(x, u, d) -> ẋ` and
44+
`h(x, d) -> y`. This syntax is simple and intuitive but it allocates more memory.
45+
2. **Mutating functions** (in-place): define them as `f!(ẋ, x, u, d) -> nothing` and
46+
`h!(y, x, d) -> nothing`. This syntax reduces the allocations and potentially the
47+
computational burden as well.
4848
4949
`Ts` is the sampling time in second. `nu`, `nx`, `ny` and `nd` are the respective number of
5050
manipulated inputs, states, outputs and measured disturbances.
@@ -99,9 +99,9 @@ NonLinModel with a sample time Ts = 2.0 s, empty solver and:
9999
```
100100
with two possible implementations as well:
101101
102-
- Non-mutating functions: defined them as `f(x, u, d) -> xnext` and `h(x, d) -> y`.
103-
- Mutating functions: defined them as `f!(xnext, x, u, d) -> nothing` and
104-
`h!(y, x, d) -> nothing`.
102+
1. **Non-mutating functions**: define them as `f(x, u, d) -> xnext` and `h(x, d) -> y`.
103+
2. **Mutating functions**: define them as `f!(xnext, x, u, d) -> nothing` and
104+
`h!(y, x, d) -> nothing`.
105105
"""
106106
function NonLinModel{NT}(
107107
f::Function, h::Function, Ts::Real, nu::Int, nx::Int, ny::Int, nd::Int=0;

0 commit comments

Comments
 (0)