Skip to content

Print algebraic form of AbstractFunction by default #2112

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 7, 2023
Merged

Print algebraic form of AbstractFunction by default #2112

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
08d5fb6
Print algebraic form of AbstractFunction by default
odow Mar 2, 2023
7c311d5
Fix formatting
odow Mar 2, 2023
79af48d
Add tests
odow Mar 3, 2023
1fa486d
Update
odow Mar 6, 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
6 changes: 3 additions & 3 deletions docs/src/manual/variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Use [`add_variable`](@ref) to add a single variable.

```jldoctest variables; setup=:(model = MOI.Utilities.Model{Float64}(); )
julia> x = MOI.add_variable(model)
MathOptInterface.VariableIndex(1)
MOI.VariableIndex(1)
```
[`add_variable`](@ref) returns a [`VariableIndex`](@ref) type, which is used to
refer to the added variable in other calls.
Expand All @@ -29,8 +29,8 @@ Use [`add_variables`](@ref) to add a number of variables.
```jldoctest variables
julia> y = MOI.add_variables(model, 2)
2-element Vector{MathOptInterface.VariableIndex}:
MathOptInterface.VariableIndex(2)
MathOptInterface.VariableIndex(3)
MOI.VariableIndex(2)
MOI.VariableIndex(3)
```

!!! warning
Expand Down
4 changes: 2 additions & 2 deletions docs/src/submodules/FileFormats/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ julia> src = MOI.Utilities.Model{Float64}()
MOIU.Model{Float64}

julia> MOI.add_variable(src)
MathOptInterface.VariableIndex(1)
MOI.VariableIndex(1)

julia> dest = MOI.FileFormats.Model(format = MOI.FileFormats.FORMAT_MOF)
A MathOptFormat Model
Expand Down Expand Up @@ -119,7 +119,7 @@ julia> MOI.read_from_file(dest, "file.mof.json")

julia> MOI.get(dest, MOI.ListOfVariableIndices())
1-element Vector{MathOptInterface.VariableIndex}:
MathOptInterface.VariableIndex(1)
MOI.VariableIndex(1)

julia> rm("file.mof.json") # Clean up after ourselves.
```
Expand Down
6 changes: 3 additions & 3 deletions docs/src/submodules/Nonlinear/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ incorporate [`VariableIndex`](@ref)es, but these must be interpolated into
the expression with `$`:
```jldoctest nonlinear_developer
julia> x = MOI.VariableIndex(1)
MathOptInterface.VariableIndex(1)
MOI.VariableIndex(1)

julia> input = :(1 + sin($x)^2)
:(1 + sin(MathOptInterface.VariableIndex(1)) ^ 2)
Expand Down Expand Up @@ -429,9 +429,9 @@ julia> expr = Any[:+, 2, :^, 2, :sin, 1, x, 2.0, x]
2
:sin
1
MathOptInterface.VariableIndex(1)
MOI.VariableIndex(1)
2.0
MathOptInterface.VariableIndex(1)
MOI.VariableIndex(1)
```
The `Int` after each operator `Symbol` specifies the number of arguments.

Expand Down
6 changes: 3 additions & 3 deletions docs/src/submodules/Utilities/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,7 @@ Use `print` to print the formulation of the model.
julia> model = MOI.Utilities.Model{Float64}();

julia> x = MOI.add_variable(model)
MathOptInterface.VariableIndex(1)
MOI.VariableIndex(1)

julia> MOI.set(model, MOI.VariableName(), x, "x_var")

Expand Down Expand Up @@ -345,7 +345,7 @@ VariableIndex-in-GreaterThan{Float64}
v[2] >= 0.0

julia> map[c]
MathOptInterface.ScalarAffineFunction{Float64}(MathOptInterface.ScalarAffineTerm{Float64}[MathOptInterface.ScalarAffineTerm{Float64}(1.0, MathOptInterface.VariableIndex(2))], 0.0)
0.0 + 1.0 MOI.VariableIndex(2)
```

You can also modify a single constraint using [`Utilities.ScalarPenaltyRelaxation`](@ref):
Expand Down Expand Up @@ -373,7 +373,7 @@ VariableIndex-in-GreaterThan{Float64}
v[2] >= 0.0

julia> f
MathOptInterface.ScalarAffineFunction{Float64}(MathOptInterface.ScalarAffineTerm{Float64}[MathOptInterface.ScalarAffineTerm{Float64}(1.0, MathOptInterface.VariableIndex(2))], 0.0)
0.0 + 1.0 MOI.VariableIndex(2)
```

## Utilities.MatrixOfConstraints
Expand Down
23 changes: 13 additions & 10 deletions docs/src/tutorials/manipulating_expressions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The simplest scalar function is simply a variable:

```jldoctest expr; setup=:(model = MOI.Utilities.CachingOptimizer(MOI.Utilities.Model{Float64}(), MOI.Utilities.AUTOMATIC); )
julia> x = MOI.add_variable(model) # Create the variable x
MathOptInterface.VariableIndex(1)
MOI.VariableIndex(1)
```

This type of function is extremely simple; to express more complex functions,
Expand All @@ -32,14 +32,14 @@ can be built using the standard constructor:

```jldoctest expr
julia> f = MOI.ScalarAffineFunction([MOI.ScalarAffineTerm(1, x)], 2) # x + 2
MathOptInterface.ScalarAffineFunction{Int64}(MathOptInterface.ScalarAffineTerm{Int64}[MathOptInterface.ScalarAffineTerm{Int64}(1, MathOptInterface.VariableIndex(1))], 2)
(2) + (1) MOI.VariableIndex(1)
```

However, you can also use operators to build the same scalar function:

```jldoctest expr
julia> f = x + 2
MathOptInterface.ScalarAffineFunction{Int64}(MathOptInterface.ScalarAffineTerm{Int64}[MathOptInterface.ScalarAffineTerm{Int64}(1, MathOptInterface.VariableIndex(1))], 2)
(2) + (1) MOI.VariableIndex(1)
```

### Creating scalar quadratic functions
Expand All @@ -50,13 +50,13 @@ obtain a quadratic function as a product of affine functions:

```jldoctest expr
julia> 1 * x * x
MathOptInterface.ScalarQuadraticFunction{Int64}(MathOptInterface.ScalarQuadraticTerm{Int64}[MathOptInterface.ScalarQuadraticTerm{Int64}(2, MathOptInterface.VariableIndex(1), MathOptInterface.VariableIndex(1))], MathOptInterface.ScalarAffineTerm{Int64}[], 0)
(0) + 1.0 MOI.VariableIndex(1)²

julia> f * f # (x + 2)²
MathOptInterface.ScalarQuadraticFunction{Int64}(MathOptInterface.ScalarQuadraticTerm{Int64}[MathOptInterface.ScalarQuadraticTerm{Int64}(2, MathOptInterface.VariableIndex(1), MathOptInterface.VariableIndex(1))], MathOptInterface.ScalarAffineTerm{Int64}[MathOptInterface.ScalarAffineTerm{Int64}(2, MathOptInterface.VariableIndex(1)), MathOptInterface.ScalarAffineTerm{Int64}(2, MathOptInterface.VariableIndex(1))], 4)
(4) + (2) MOI.VariableIndex(1) + (2) MOI.VariableIndex(1) + 1.0 MOI.VariableIndex(1)²

julia> f^2 # (x + 2)² too
MathOptInterface.ScalarQuadraticFunction{Int64}(MathOptInterface.ScalarQuadraticTerm{Int64}[MathOptInterface.ScalarQuadraticTerm{Int64}(2, MathOptInterface.VariableIndex(1), MathOptInterface.VariableIndex(1))], MathOptInterface.ScalarAffineTerm{Int64}[MathOptInterface.ScalarAffineTerm{Int64}(2, MathOptInterface.VariableIndex(1)), MathOptInterface.ScalarAffineTerm{Int64}(2, MathOptInterface.VariableIndex(1))], 4)
(4) + (2) MOI.VariableIndex(1) + (2) MOI.VariableIndex(1) + 1.0 MOI.VariableIndex(1)²
```

### Creating vector functions
Expand All @@ -73,7 +73,10 @@ dimension corresponding to a dimension of the vector.

```jldoctest expr
julia> g = MOI.Utilities.vectorize([f, 2 * f])
MathOptInterface.VectorAffineFunction{Int64}(MathOptInterface.VectorAffineTerm{Int64}[MathOptInterface.VectorAffineTerm{Int64}(1, MathOptInterface.ScalarAffineTerm{Int64}(1, MathOptInterface.VariableIndex(1))), MathOptInterface.VectorAffineTerm{Int64}(2, MathOptInterface.ScalarAffineTerm{Int64}(2, MathOptInterface.VariableIndex(1)))], [2, 4])
┌ ┐
│(2) + (1) MOI.VariableIndex(1)│
│(4) + (2) MOI.VariableIndex(1)│
└ ┘
```

!!! warning
Expand Down Expand Up @@ -108,7 +111,7 @@ function:

```jldoctest expr
julia> MOI.Utilities.canonical(f + f) # Returns 2x + 4
MathOptInterface.ScalarAffineFunction{Int64}(MathOptInterface.ScalarAffineTerm{Int64}[MathOptInterface.ScalarAffineTerm{Int64}(2, MathOptInterface.VariableIndex(1))], 4)
(4) + (2) MOI.VariableIndex(1)
```

## Exploring functions
Expand All @@ -124,8 +127,8 @@ vector function:
```jldoctest expr
julia> MOI.Utilities.scalarize(g) # Returns a vector [f, 2 * f].
2-element Vector{MathOptInterface.ScalarAffineFunction{Int64}}:
MathOptInterface.ScalarAffineFunction{Int64}(MathOptInterface.ScalarAffineTerm{Int64}[MathOptInterface.ScalarAffineTerm{Int64}(1, MathOptInterface.VariableIndex(1))], 2)
MathOptInterface.ScalarAffineFunction{Int64}(MathOptInterface.ScalarAffineTerm{Int64}[MathOptInterface.ScalarAffineTerm{Int64}(2, MathOptInterface.VariableIndex(1))], 4)
(2) + (1) MOI.VariableIndex(1)
(4) + (2) MOI.VariableIndex(1)
```

!!! note
Expand Down
30 changes: 30 additions & 0 deletions src/Utilities/print.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -636,3 +636,33 @@ end
function Base.print(io::IO, model::MOI.ModelLike; kwargs...)
return _print_model(io, _PrintOptions(MIME("text/plain"); kwargs...), model)
end

struct _NoVariableNameModel{M} <: MOI.ModelLike end

function MOI.get(
::_NoVariableNameModel{MIME"text/plain"},
::MOI.VariableName,
x::MOI.VariableIndex,
)
return "MOI.VariableIndex($(x.value))"
end

function MOI.get(
::_NoVariableNameModel{MIME"text/latex"},
::MOI.VariableName,
::MOI.VariableIndex,
)
return "" # Leave as default
end

function Base.show(io::IO, mime::MIME"text/plain", f::MOI.AbstractFunction)
model = _NoVariableNameModel{MIME"text/plain"}()
print(io, _to_string(_PrintOptions(mime), model, f))
return
end

function Base.show(io::IO, mime::MIME"text/latex", f::MOI.AbstractFunction)
model = _NoVariableNameModel{MIME"text/latex"}()
print(io, _to_string(_PrintOptions(mime), model, f))
return
end
30 changes: 20 additions & 10 deletions src/functions.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Represents the scalar-valued term `coefficient * variable`.
julia> import MathOptInterface as MOI

julia> x = MOI.VariableIndex(1)
MathOptInterface.VariableIndex(1)
MOI.VariableIndex(1)

julia> MOI.ScalarAffineTerm(2.0, x)
MathOptInterface.ScalarAffineTerm{Float64}(2.0, MathOptInterface.VariableIndex(1))
Expand Down Expand Up @@ -126,15 +126,15 @@ coefficients are summed together.
julia> import MathOptInterface as MOI

julia> x = MOI.VariableIndex(1)
MathOptInterface.VariableIndex(1)
MOI.VariableIndex(1)

julia> terms = [MOI.ScalarAffineTerm(2.0, x), MOI.ScalarAffineTerm(3.0, x)]
2-element Vector{MathOptInterface.ScalarAffineTerm{Float64}}:
MathOptInterface.ScalarAffineTerm{Float64}(2.0, MathOptInterface.VariableIndex(1))
MathOptInterface.ScalarAffineTerm{Float64}(3.0, MathOptInterface.VariableIndex(1))

julia> f = MOI.ScalarAffineFunction(terms, 4.0)
MathOptInterface.ScalarAffineFunction{Float64}(MathOptInterface.ScalarAffineTerm{Float64}[MathOptInterface.ScalarAffineTerm{Float64}(2.0, MathOptInterface.VariableIndex(1)), MathOptInterface.ScalarAffineTerm{Float64}(3.0, MathOptInterface.VariableIndex(1))], 4.0)
4.0 + 2.0 MOI.VariableIndex(1) + 3.0 MOI.VariableIndex(1)
```
"""
mutable struct ScalarAffineFunction{T} <: AbstractScalarFunction
Expand Down Expand Up @@ -168,7 +168,7 @@ Represents the scalar-valued term ``c x_i x_j`` where ``c`` is `coefficient`,
julia> import MathOptInterface as MOI

julia> x = MOI.VariableIndex(1)
MathOptInterface.VariableIndex(1)
MOI.VariableIndex(1)

julia> MOI.ScalarQuadraticTerm(2.0, x, x)
MathOptInterface.ScalarQuadraticTerm{Float64}(2.0, MathOptInterface.VariableIndex(1), MathOptInterface.VariableIndex(1))
Expand Down Expand Up @@ -258,7 +258,7 @@ julia> quadratic_terms = [
MathOptInterface.ScalarQuadraticTerm{Float64}(3.0, MathOptInterface.VariableIndex(1), MathOptInterface.VariableIndex(2))

julia> f = MOI.ScalarQuadraticFunction(quadratic_terms, affine_terms, constant)
MathOptInterface.ScalarQuadraticFunction{Float64}(MathOptInterface.ScalarQuadraticTerm{Float64}[MathOptInterface.ScalarQuadraticTerm{Float64}(4.0, MathOptInterface.VariableIndex(1), MathOptInterface.VariableIndex(1)), MathOptInterface.ScalarQuadraticTerm{Float64}(3.0, MathOptInterface.VariableIndex(1), MathOptInterface.VariableIndex(2))], MathOptInterface.ScalarAffineTerm{Float64}[MathOptInterface.ScalarAffineTerm{Float64}(4.0, MathOptInterface.VariableIndex(1))], 5.0)
5.0 + 4.0 MOI.VariableIndex(1) + 2.0 MOI.VariableIndex(1)² + 3.0 MOI.VariableIndex(1)*MOI.VariableIndex(2)
```

"""
Expand Down Expand Up @@ -306,11 +306,15 @@ julia> import MathOptInterface as MOI

julia> x = MOI.VariableIndex.(1:2)
2-element Vector{MathOptInterface.VariableIndex}:
MathOptInterface.VariableIndex(1)
MathOptInterface.VariableIndex(2)
MOI.VariableIndex(1)
MOI.VariableIndex(2)

julia> f = MOI.VectorOfVariables([x[1], x[2], x[1]])
MathOptInterface.VectorOfVariables(MathOptInterface.VariableIndex[MathOptInterface.VariableIndex(1), MathOptInterface.VariableIndex(2), MathOptInterface.VariableIndex(1)])
┌ ┐
│MOI.VariableIndex(1)│
│MOI.VariableIndex(2)│
│MOI.VariableIndex(1)│
└ ┘

julia> MOI.output_dimension(f)
3
Expand Down Expand Up @@ -404,7 +408,10 @@ julia> terms = [
];

julia> f = MOI.VectorAffineFunction(terms, [4.0, 5.0])
MathOptInterface.VectorAffineFunction{Float64}(MathOptInterface.VectorAffineTerm{Float64}[MathOptInterface.VectorAffineTerm{Float64}(1, MathOptInterface.ScalarAffineTerm{Float64}(2.0, MathOptInterface.VariableIndex(1))), MathOptInterface.VectorAffineTerm{Float64}(2, MathOptInterface.ScalarAffineTerm{Float64}(3.0, MathOptInterface.VariableIndex(1)))], [4.0, 5.0])
┌ ┐
│4.0 + 2.0 MOI.VariableIndex(1)│
│5.0 + 3.0 MOI.VariableIndex(1)│
└ ┘

julia> MOI.output_dimension(f)
2
Expand Down Expand Up @@ -516,7 +523,10 @@ julia> quad_terms = [
];

julia> f = MOI.VectorQuadraticFunction(quad_terms, affine_terms, constants)
MathOptInterface.VectorQuadraticFunction{Float64}(MathOptInterface.VectorQuadraticTerm{Float64}[MathOptInterface.VectorQuadraticTerm{Float64}(1, MathOptInterface.ScalarQuadraticTerm{Float64}(2.0, MathOptInterface.VariableIndex(1), MathOptInterface.VariableIndex(1))), MathOptInterface.VectorQuadraticTerm{Float64}(2, MathOptInterface.ScalarQuadraticTerm{Float64}(3.0, MathOptInterface.VariableIndex(1), MathOptInterface.VariableIndex(2)))], MathOptInterface.VectorAffineTerm{Float64}[MathOptInterface.VectorAffineTerm{Float64}(1, MathOptInterface.ScalarAffineTerm{Float64}(2.0, MathOptInterface.VariableIndex(1))), MathOptInterface.VectorAffineTerm{Float64}(2, MathOptInterface.ScalarAffineTerm{Float64}(3.0, MathOptInterface.VariableIndex(1)))], [4.0, 5.0])
┌ ┐
│4.0 + 2.0 MOI.VariableIndex(1) + 1.0 MOI.VariableIndex(1)² │
│5.0 + 3.0 MOI.VariableIndex(1) + 3.0 MOI.VariableIndex(1)*MOI.VariableIndex(2)│
└ ┘

julia> MOI.output_dimension(f)
2
Expand Down
Loading