Skip to content

Commit 363b277

Browse files
odowblegat
andauthored
Tidy functions.jl and improve docstrings (#2108)
Co-authored-by: Benoît Legat <benoit.legat@gmail.com>
1 parent df0b457 commit 363b277

File tree

3 files changed

+561
-334
lines changed

3 files changed

+561
-334
lines changed

docs/src/reference/standard_form.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,28 +12,30 @@ DocTestFilters = [r"MathOptInterface|MOI"]
1212

1313
```@docs
1414
AbstractFunction
15+
output_dimension
16+
constant
17+
```
18+
19+
## Scalar functions
20+
21+
```@docs
1522
AbstractScalarFunction
16-
AbstractVectorFunction
1723
VariableIndex
18-
VectorOfVariables
1924
ScalarAffineTerm
2025
ScalarAffineFunction
21-
VectorAffineTerm
22-
VectorAffineFunction
2326
ScalarQuadraticTerm
2427
ScalarQuadraticFunction
25-
VectorQuadraticTerm
26-
VectorQuadraticFunction
2728
```
2829

29-
### Utilities
30+
## Vector functions
3031

3132
```@docs
32-
output_dimension
33-
constant(f::Union{ScalarAffineFunction, ScalarQuadraticFunction})
34-
constant(f::Union{VectorAffineFunction, VectorQuadraticFunction})
35-
constant(f::VariableIndex, ::Type)
36-
constant(f::VectorOfVariables, T::Type)
33+
AbstractVectorFunction
34+
VectorOfVariables
35+
VectorAffineTerm
36+
VectorAffineFunction
37+
VectorQuadraticTerm
38+
VectorQuadraticFunction
3739
```
3840

3941
## Sets

0 commit comments

Comments
 (0)