Skip to content

Commit 3b22064

Browse files
authored
Merge pull request #668 from SciML/myb/doc
Update Variable doc string
2 parents 2cd86fc + f0dbff0 commit 3b22064

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

src/variables.jl

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,15 @@ and parameters `β₁` and `β₂`.
3333
3434
3535
```julia
36-
t = Variable(:t)() # independent variables are treated as known
37-
α = Variable(:α)() # parameters are known
38-
σ = Variable(:σ) # left uncalled, since it is used as a function
39-
w = Variable(:w) # unknown, left uncalled
40-
x = Variable(:x)(t) # unknown, depends on `t`
41-
y = Variable(:y)() # unknown, no dependents
42-
z = Variable(:z)(t, α, x) # unknown, multiple arguments
43-
β₁ = Variable(:β, 1)() # with index 1
44-
β₂ = Variable(:β, 2)() # with index 2
36+
t = Num(Variable{ModelingToolkit.Parameter{Real}}(:t)) # independent variables are treated as known
37+
α = Num(Variable{ModelingToolkit.Parameter{Real}}(:α)) # parameters are known
38+
σ = Num(Variable{ModelingToolkit.FnType{Tuple{Any},Real}}(:σ)) # left uncalled, since it is used as a function
39+
w = Num(Variable{ModelingToolkit.FnType{Tuple{Any},Real}}(:w)) # unknown, left uncalled
40+
x = Num(Variable{ModelingToolkit.FnType{Tuple{Any},Real}}(:x))(t) # unknown, depends on `t`
41+
y = Num(Variable(:y)) # unknown, no dependents
42+
z = Num(Variable{ModelingToolkit.FnType{NTuple{3,Any},Real}}(:z))(t, α, x) # unknown, multiple arguments
43+
β₁ = Num(Variable(:β, 1)) # with index 1
44+
β₂ = Num(Variable(:β, 2)) # with index 2
4545
4646
expr = β₁ * x + y^α + σ(3) * (z - t) - β₂ * w(t - 1)
4747
```

0 commit comments

Comments
 (0)