Skip to content

Commit 0fa2b56

Browse files
fix docs
1 parent 1024404 commit 0fa2b56

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

docs/src/systems/OptimizationSystem.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,10 @@ OptimizationSystem
88

99
## Composition and Accessor Functions
1010

11-
- `get_eqs(sys)` or `equations(sys)`: The equation to be minimized.
11+
- `get_op(sys)` or `objective(sys)`: The objective to be minimized.
1212
- `get_states(sys)` or `states(sys)`: The set of states for the optimization.
1313
- `get_ps(sys)` or `parameters(sys)`: The parameters for the optimization.
14+
- `get_constraints(sys)` or `constraints(sys)`: The constraints for the optimization.
1415

1516
## Transformations
1617

src/systems/optimization/optimizationsystem.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ $(FIELDS)
1313
@parameters a b c
1414
1515
obj = a * (y - x) + x * (b - z) - y + x * y - c * z
16-
@named os = OptimizationSystem(obj, [x, y, z], [a, b, c])
16+
cons = [x^2 + y^2 ≲ 1]
17+
@named os = OptimizationSystem(obj, [x, y, z], [a, b, c]; constraints = cons)
1718
```
1819
"""
1920
struct OptimizationSystem <: AbstractOptimizationSystem

0 commit comments

Comments
 (0)