Skip to content

Commit f08c78c

Browse files
authored
[Utilities] Rename variable and objective containers (#1526)
* [Utilities] Rename variable and objective containers * Fix tests
1 parent 9e79136 commit f08c78c

File tree

12 files changed

+151
-167
lines changed

12 files changed

+151
-167
lines changed

docs/src/submodules/Bridges/overview.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ any optimizer. Some bridges also implement constraint modifications and
3838
constraint primal and dual translations.
3939

4040
Several bridges can be used in combination to transform a single constraint
41-
into a form that the solver may understand. Choosing the bridges to use
41+
into a form that the solver may understand. Choosing the bridges to use
4242
takes the form of finding a shortest path in the hypergraph of bridges. The
4343
methodology is detailed in [the MOI paper](https://arxiv.org/abs/2002.03447).
4444

@@ -52,14 +52,14 @@ There are three types of bridges in MathOptInterface:
5252
### Constraint bridges
5353

5454
Constraint bridges convert constraints formulated by the user into an equivalent
55-
form supported by the solver. Constraint bridges are subtypes of
55+
form supported by the solver. Constraint bridges are subtypes of
5656
[`Bridges.Constraint.AbstractBridge`](@ref).
5757

5858
The equivalent formulation may add constraints (and possibly also variables) in
5959
the underlying model.
6060

6161
In particular, constraint bridges can focus on rewriting the function of a
62-
constraint, and do not change the set. Function bridges are subtypes of
62+
constraint, and do not change the set. Function bridges are subtypes of
6363
[`Bridges.Constraint.AbstractFunctionConversionBridge`](@ref).
6464

6565
Read the [list of implemented constraint bridges](@ref constraint_bridges_ref)
@@ -72,7 +72,7 @@ Function bridges are [`Bridges.Constraint.ScalarFunctionizeBridge`](@ref) and
7272
Variable bridges convert variables added by the user, either free with
7373
[`add_variable`](@ref)/[`add_variables`](@ref), or constrained with
7474
[`add_constrained_variable`](@ref)/[`add_constrained_variables`](@ref),
75-
into an equivalent form supported by the solver. Variable bridges are
75+
into an equivalent form supported by the solver. Variable bridges are
7676
subtypes of [`Bridges.Variable.AbstractBridge`](@ref).
7777

7878
The equivalent formulation may add constraints (and possibly also variables) in
@@ -84,7 +84,7 @@ more details on the types of transformations that are available.
8484
### Objective bridges
8585

8686
Objective bridges convert the [`ObjectiveFunction`](@ref) set by the user into
87-
an equivalent form supported by the solver. Objective bridges are
87+
an equivalent form supported by the solver. Objective bridges are
8888
subtypes of [`Bridges.Objective.AbstractBridge`](@ref).
8989

9090
The equivalent formulation may add constraints (and possibly also variables) in
@@ -104,14 +104,14 @@ in a [`Bridges.full_bridge_optimizer`](@ref).
104104

105105
```jldoctest
106106
julia> inner_optimizer = MOI.Utilities.Model{Float64}()
107-
MOIU.GenericModel{Float64,MOIU.ObjectiveFunctionContainer{Float64},MOIU.SingleVariableConstraints{Float64},MOIU.ModelFunctionConstraints{Float64}}
107+
MOIU.GenericModel{Float64,MOIU.ObjectiveContainer{Float64},MOIU.VariablesContainer{Float64},MOIU.ModelFunctionConstraints{Float64}}
108108
109109
julia> optimizer = MOI.Bridges.full_bridge_optimizer(inner_optimizer, Float64)
110-
MOIB.LazyBridgeOptimizer{MOIU.GenericModel{Float64,MOIU.ObjectiveFunctionContainer{Float64},MOIU.SingleVariableConstraints{Float64},MOIU.ModelFunctionConstraints{Float64}}}
110+
MOIB.LazyBridgeOptimizer{MOIU.GenericModel{Float64,MOIU.ObjectiveContainer{Float64},MOIU.VariablesContainer{Float64},MOIU.ModelFunctionConstraints{Float64}}}
111111
with 0 variable bridges
112112
with 0 constraint bridges
113113
with 0 objective bridges
114-
with inner model MOIU.GenericModel{Float64,MOIU.ObjectiveFunctionContainer{Float64},MOIU.SingleVariableConstraints{Float64},MOIU.ModelFunctionConstraints{Float64}}
114+
with inner model MOIU.GenericModel{Float64,MOIU.ObjectiveContainer{Float64},MOIU.VariablesContainer{Float64},MOIU.ModelFunctionConstraints{Float64}}
115115
```
116116

117117
That's all you have to do! Use `optimizer` as normal, and bridging will happen
@@ -136,12 +136,12 @@ However, this will force the constraint to be bridged, even if the
136136

137137
```jldoctest
138138
julia> inner_optimizer = MOI.Utilities.Model{Float64}()
139-
MOIU.GenericModel{Float64,MOIU.ObjectiveFunctionContainer{Float64},MOIU.SingleVariableConstraints{Float64},MOIU.ModelFunctionConstraints{Float64}}
139+
MOIU.GenericModel{Float64,MOIU.ObjectiveContainer{Float64},MOIU.VariablesContainer{Float64},MOIU.ModelFunctionConstraints{Float64}}
140140
141141
julia> optimizer = MOI.Bridges.Constraint.SplitInterval{Float64}(inner_optimizer)
142-
MOIB.Constraint.SingleBridgeOptimizer{MOIB.Constraint.SplitIntervalBridge{Float64,F,S,LS,US} where US<:MOI.AbstractSet where LS<:MOI.AbstractSet where S<:MOI.AbstractSet where F<:MOI.AbstractFunction,MOIU.GenericModel{Float64,MOIU.ObjectiveFunctionContainer{Float64},MOIU.SingleVariableConstraints{Float64},MOIU.ModelFunctionConstraints{Float64}}}
142+
MOIB.Constraint.SingleBridgeOptimizer{MOIB.Constraint.SplitIntervalBridge{Float64,F,S,LS,US} where US<:MOI.AbstractSet where LS<:MOI.AbstractSet where S<:MOI.AbstractSet where F<:MOI.AbstractFunction,MOIU.GenericModel{Float64,MOIU.ObjectiveContainer{Float64},MOIU.VariablesContainer{Float64},MOIU.ModelFunctionConstraints{Float64}}}
143143
with 0 constraint bridges
144-
with inner model MOIU.GenericModel{Float64,MOIU.ObjectiveFunctionContainer{Float64},MOIU.SingleVariableConstraints{Float64},MOIU.ModelFunctionConstraints{Float64}}
144+
with inner model MOIU.GenericModel{Float64,MOIU.ObjectiveContainer{Float64},MOIU.VariablesContainer{Float64},MOIU.ModelFunctionConstraints{Float64}}
145145
146146
julia> x = MOI.add_variable(optimizer)
147147
MOI.VariableIndex(1)
@@ -168,14 +168,14 @@ manually construct a [`Bridges.LazyBridgeOptimizer`](@ref).
168168
First, wrap an inner optimizer:
169169
```jldoctest lazy_bridge_optimizer
170170
julia> inner_optimizer = MOI.Utilities.Model{Float64}()
171-
MOIU.GenericModel{Float64,MOIU.ObjectiveFunctionContainer{Float64},MOIU.SingleVariableConstraints{Float64},MOIU.ModelFunctionConstraints{Float64}}
171+
MOIU.GenericModel{Float64,MOIU.ObjectiveContainer{Float64},MOIU.VariablesContainer{Float64},MOIU.ModelFunctionConstraints{Float64}}
172172
173173
julia> optimizer = MOI.Bridges.LazyBridgeOptimizer(inner_optimizer)
174-
MOIB.LazyBridgeOptimizer{MOIU.GenericModel{Float64,MOIU.ObjectiveFunctionContainer{Float64},MOIU.SingleVariableConstraints{Float64},MOIU.ModelFunctionConstraints{Float64}}}
174+
MOIB.LazyBridgeOptimizer{MOIU.GenericModel{Float64,MOIU.ObjectiveContainer{Float64},MOIU.VariablesContainer{Float64},MOIU.ModelFunctionConstraints{Float64}}}
175175
with 0 variable bridges
176176
with 0 constraint bridges
177177
with 0 objective bridges
178-
with inner model MOIU.GenericModel{Float64,MOIU.ObjectiveFunctionContainer{Float64},MOIU.SingleVariableConstraints{Float64},MOIU.ModelFunctionConstraints{Float64}}
178+
with inner model MOIU.GenericModel{Float64,MOIU.ObjectiveContainer{Float64},MOIU.VariablesContainer{Float64},MOIU.ModelFunctionConstraints{Float64}}
179179
```
180180

181181
Then use [`Bridges.add_bridge`](@ref) to add individual bridges:

docs/src/submodules/FileFormats/overview.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ To write a model `src` to a [MathOptFormat file](https://jump.dev/MathOptFormat/
6565
use:
6666
```jldoctest fileformats
6767
julia> src = MOI.Utilities.Model{Float64}()
68-
MOIU.GenericModel{Float64,MOIU.ObjectiveFunctionContainer{Float64},MOIU.SingleVariableConstraints{Float64},MOIU.ModelFunctionConstraints{Float64}}
68+
MOIU.GenericModel{Float64,MOIU.ObjectiveContainer{Float64},MOIU.VariablesContainer{Float64},MOIU.ModelFunctionConstraints{Float64}}
6969
7070
julia> MOI.add_variable(src)
7171
MathOptInterface.VariableIndex(1)
@@ -122,7 +122,7 @@ guess the format from the file extension. For example:
122122

123123
```jldoctest fileformats
124124
julia> src = MOI.Utilities.Model{Float64}()
125-
MOIU.GenericModel{Float64,MOIU.ObjectiveFunctionContainer{Float64},MOIU.SingleVariableConstraints{Float64},MOIU.ModelFunctionConstraints{Float64}}
125+
MOIU.GenericModel{Float64,MOIU.ObjectiveContainer{Float64},MOIU.VariablesContainer{Float64},MOIU.ModelFunctionConstraints{Float64}}
126126
127127
julia> dest = MOI.FileFormats.Model(filename = "file.cbf.gz")
128128
A Conic Benchmark Format (CBF) model
@@ -136,7 +136,7 @@ julia> src_2 = MOI.FileFormats.Model(filename = "file.cbf.gz")
136136
A Conic Benchmark Format (CBF) model
137137
138138
julia> src = MOI.Utilities.Model{Float64}()
139-
MOIU.GenericModel{Float64,MOIU.ObjectiveFunctionContainer{Float64},MOIU.SingleVariableConstraints{Float64},MOIU.ModelFunctionConstraints{Float64}}
139+
MOIU.GenericModel{Float64,MOIU.ObjectiveContainer{Float64},MOIU.VariablesContainer{Float64},MOIU.ModelFunctionConstraints{Float64}}
140140
141141
julia> dest = MOI.FileFormats.Model(filename = "file.cbf.gz")
142142
A Conic Benchmark Format (CBF) model
@@ -180,7 +180,7 @@ In addition to [`write_to_file`](@ref) and [`read_from_file`](@ref), you can
180180
read and write directly from `IO` streams using `Base.write` and `Base.read!`:
181181
```jldoctest
182182
julia> src = MOI.Utilities.Model{Float64}()
183-
MOIU.GenericModel{Float64,MOIU.ObjectiveFunctionContainer{Float64},MOIU.SingleVariableConstraints{Float64},MOIU.ModelFunctionConstraints{Float64}}
183+
MOIU.GenericModel{Float64,MOIU.ObjectiveContainer{Float64},MOIU.VariablesContainer{Float64},MOIU.ModelFunctionConstraints{Float64}}
184184
185185
julia> dest = MOI.FileFormats.Model(format = MOI.FileFormats.FORMAT_MPS)
186186
A Mathematical Programming System (MPS) model

0 commit comments

Comments
 (0)