Skip to content

Tidy functions.jl and improve docstrings #2108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 2, 2023
Merged

Tidy functions.jl and improve docstrings #2108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ea48bd3
Tidy functions.jl and improve docstrings
odow Mar 1, 2023
0dc18d0
Fix docs
odow Mar 1, 2023
37cc7b8
Update
odow Mar 1, 2023
7315498
Update src/functions.jl
odow Mar 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 14 additions & 12 deletions docs/src/reference/standard_form.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,28 +12,30 @@ DocTestFilters = [r"MathOptInterface|MOI"]

```@docs
AbstractFunction
output_dimension
constant
```

## Scalar functions

```@docs
AbstractScalarFunction
AbstractVectorFunction
VariableIndex
VectorOfVariables
ScalarAffineTerm
ScalarAffineFunction
VectorAffineTerm
VectorAffineFunction
ScalarQuadraticTerm
ScalarQuadraticFunction
VectorQuadraticTerm
VectorQuadraticFunction
```

### Utilities
## Vector functions

```@docs
output_dimension
constant(f::Union{ScalarAffineFunction, ScalarQuadraticFunction})
constant(f::Union{VectorAffineFunction, VectorQuadraticFunction})
constant(f::VariableIndex, ::Type)
constant(f::VectorOfVariables, T::Type)
AbstractVectorFunction
VectorOfVariables
VectorAffineTerm
VectorAffineFunction
VectorQuadraticTerm
VectorQuadraticFunction
```

## Sets
Expand Down
Loading