Add default printing for show(io, ::ModelLike) (#2505)

jump-dev · May 27, 2024 · 902064f · 902064f
1 parent 6d9378a
commit 902064f
Show file tree

Hide file tree

Showing 27 changed files with 332 additions and 320 deletions.
diff --git a/docs/src/submodules/Bridges/overview.md b/docs/src/submodules/Bridges/overview.md
@@ -104,13 +104,21 @@ in a [`Bridges.full_bridge_optimizer`](@ref).
 ```jldoctest
 julia> inner_optimizer = MOI.Utilities.Model{Float64}()
 MOIU.Model{Float64}
+├ ObjectiveSense: FEASIBILITY_SENSE
+├ ObjectiveFunctionType: MOI.ScalarAffineFunction{Float64}
+├ NumberOfVariables: 0
+└ NumberOfConstraints: 0
 
 julia> optimizer = MOI.Bridges.full_bridge_optimizer(inner_optimizer, Float64)
 MOIB.LazyBridgeOptimizer{MOIU.Model{Float64}}
-with 0 variable bridges
-with 0 constraint bridges
-with 0 objective bridges
-with inner model MOIU.Model{Float64}
+├ Variable bridges: none
+├ Constraint bridges: none
+├ Objective bridges: none
+└ model: MOIU.Model{Float64}
+  ├ ObjectiveSense: FEASIBILITY_SENSE
+  ├ ObjectiveFunctionType: MOI.ScalarAffineFunction{Float64}
+  ├ NumberOfVariables: 0
+  └ NumberOfConstraints: 0
 ```
 
 Now, use `optimizer` as normal, and bridging will happen lazily behind the
@@ -134,13 +142,9 @@ However, this will force the constraint to be bridged, even if the
 `inner_optimizer` supports it.
 
 ```jldoctest
-julia> inner_optimizer = MOI.Utilities.Model{Float64}()
-MOIU.Model{Float64}
+julia> inner_optimizer = MOI.Utilities.Model{Float64}();
 
-julia> optimizer = MOI.Bridges.Constraint.SplitInterval{Float64}(inner_optimizer)
-MOIB.Constraint.SingleBridgeOptimizer{MOIB.Constraint.SplitIntervalBridge{Float64}, MOIU.Model{Float64}}
-with 0 constraint bridges
-with inner model MOIU.Model{Float64}
+julia> optimizer = MOI.Bridges.Constraint.SplitInterval{Float64}(inner_optimizer);
 
 julia> x = MOI.add_variable(optimizer)
 MOI.VariableIndex(1)
@@ -168,13 +172,21 @@ First, wrap an inner optimizer:
 ```jldoctest lazy_bridge_optimizer
 julia> inner_optimizer = MOI.Utilities.Model{Float64}()
 MOIU.Model{Float64}
+├ ObjectiveSense: FEASIBILITY_SENSE
+├ ObjectiveFunctionType: MOI.ScalarAffineFunction{Float64}
+├ NumberOfVariables: 0
+└ NumberOfConstraints: 0
 
 julia> optimizer = MOI.Bridges.LazyBridgeOptimizer(inner_optimizer)
 MOIB.LazyBridgeOptimizer{MOIU.Model{Float64}}
-with 0 variable bridges
-with 0 constraint bridges
-with 0 objective bridges
-with inner model MOIU.Model{Float64}
+├ Variable bridges: none
+├ Constraint bridges: none
+├ Objective bridges: none
+└ model: MOIU.Model{Float64}
+  ├ ObjectiveSense: FEASIBILITY_SENSE
+  ├ ObjectiveFunctionType: MOI.ScalarAffineFunction{Float64}
+  ├ NumberOfVariables: 0
+  └ NumberOfConstraints: 0
 ```
 
 Then use [`Bridges.add_bridge`](@ref) to add individual bridges:

diff --git a/docs/src/submodules/FileFormats/overview.md b/docs/src/submodules/FileFormats/overview.md
@@ -73,8 +73,7 @@ A SemiDefinite Programming Algorithm Format (SDPA) model
 To write a model `src` to a [MathOptFormat file](https://jump.dev/MathOptFormat/),
 use:
 ```jldoctest fileformats
-julia> src = MOI.Utilities.Model{Float64}()
-MOIU.Model{Float64}
+julia> src = MOI.Utilities.Model{Float64}();
 
 julia> MOI.add_variable(src)
 MOI.VariableIndex(1)
@@ -130,8 +129,7 @@ argument to [`FileFormats.Model`](@ref). This will attempt to automatically
 guess the format from the file extension. For example:
 
 ```jldoctest fileformats
-julia> src = MOI.Utilities.Model{Float64}()
-MOIU.Model{Float64}
+julia> src = MOI.Utilities.Model{Float64}();
 
 julia> dest = MOI.FileFormats.Model(filename = "file.cbf.gz")
 A Conic Benchmark Format (CBF) model
@@ -144,8 +142,7 @@ julia> MOI.write_to_file(dest, "file.cbf.gz")
 julia> src_2 = MOI.FileFormats.Model(filename = "file.cbf.gz")
 A Conic Benchmark Format (CBF) model
 
-julia> src = MOI.Utilities.Model{Float64}()
-MOIU.Model{Float64}
+julia> src = MOI.Utilities.Model{Float64}();
 
 julia> dest = MOI.FileFormats.Model(filename = "file.cbf.gz")
 A Conic Benchmark Format (CBF) model
@@ -189,8 +186,7 @@ MOI.write_to_file(dest, "my_model.cbf")
 In addition to [`write_to_file`](@ref) and [`read_from_file`](@ref), you can
 read and write directly from `IO` streams using `Base.write` and `Base.read!`:
 ```jldoctest
-julia> src = MOI.Utilities.Model{Float64}()
-MOIU.Model{Float64}
+julia> src = MOI.Utilities.Model{Float64}();
 
 julia> dest = MOI.FileFormats.Model(format = MOI.FileFormats.FORMAT_MPS)
 A Mathematical Programming System (MPS) model

diff --git a/docs/src/submodules/Utilities/overview.md b/docs/src/submodules/Utilities/overview.md
@@ -21,6 +21,10 @@ Create a model as follows:
 ```jldoctest
 julia> model = MOI.Utilities.Model{Float64}()
 MOIU.Model{Float64}
+├ ObjectiveSense: FEASIBILITY_SENSE
+├ ObjectiveFunctionType: MOI.ScalarAffineFunction{Float64}
+├ NumberOfVariables: 0
+└ NumberOfConstraints: 0
 ```
 
 ## Utilities.UniversalFallback
@@ -36,7 +40,10 @@ fallback and [`Utilities.Model`](@ref) as a generic problem cache:
 ```jldoctest
 julia> model = MOI.Utilities.UniversalFallback(MOI.Utilities.Model{Float64}())
 MOIU.UniversalFallback{MOIU.Model{Float64}}
-fallback for MOIU.Model{Float64}
+├ ObjectiveSense: FEASIBILITY_SENSE
+├ ObjectiveFunctionType: MOI.ScalarAffineFunction{Float64}
+├ NumberOfVariables: 0
+└ NumberOfConstraints: 0
 ```
 
 !!! warning
@@ -87,6 +94,10 @@ MathOptInterface.Utilities.GenericOptimizer{T, MathOptInterface.Utilities.Object
 
 julia> model = MyNewModel{Float64}()
 MOIU.GenericOptimizer{Float64, MOIU.ObjectiveContainer{Float64}, MOIU.VariablesContainer{Float64}, MyNewModelFunctionConstraints{Float64}}
+├ ObjectiveSense: FEASIBILITY_SENSE
+├ ObjectiveFunctionType: MOI.ScalarAffineFunction{Float64}
+├ NumberOfVariables: 0
+└ NumberOfConstraints: 0
 ```
 
 !!! warning
@@ -152,11 +163,19 @@ julia> model = MOI.Utilities.CachingOptimizer(
            MOI.Utilities.Model{Float64}(),
            PathOptimizer{Float64}(),
        )
-MOIU.CachingOptimizer{MOIU.GenericOptimizer{Float64, MOIU.ObjectiveContainer{Float64}, MOIU.VariablesContainer{Float64}, MOIU.VectorOfConstraints{MOI.VectorAffineFunction{Float64}, MOI.Complements}}, MOIU.Model{Float64}}
-in state EMPTY_OPTIMIZER
-in mode AUTOMATIC
-with model cache MOIU.Model{Float64}
-with optimizer MOIU.GenericOptimizer{Float64, MOIU.ObjectiveContainer{Float64}, MOIU.VariablesContainer{Float64}, MOIU.VectorOfConstraints{MOI.VectorAffineFunction{Float64}, MOI.Complements}}
+MOIU.CachingOptimizer
+├ state: EMPTY_OPTIMIZER
+├ mode: AUTOMATIC
+├ model_cache: MOIU.Model{Float64}
+│ ├ ObjectiveSense: FEASIBILITY_SENSE
+│ ├ ObjectiveFunctionType: MOI.ScalarAffineFunction{Float64}
+│ ├ NumberOfVariables: 0
+│ └ NumberOfConstraints: 0
+└ optimizer: MOIU.GenericOptimizer{Float64, MOIU.ObjectiveContainer{Float64}, MOIU.VariablesContainer{Float64}, MOIU.VectorOfConstraints{MOI.VectorAffineFunction{Float64}, MOI.Complements}}
+  ├ ObjectiveSense: FEASIBILITY_SENSE
+  ├ ObjectiveFunctionType: MOI.ScalarAffineFunction{Float64}
+  ├ NumberOfVariables: 0
+  └ NumberOfConstraints: 0
 ```
 
 A [`Utilities.CachingOptimizer`](@ref) may be in one of three possible states:
@@ -175,12 +194,8 @@ Use [`Utilities.attach_optimizer`](@ref) to go from `EMPTY_OPTIMIZER` to
 ```jldoctest pathoptimizer
 julia> MOI.Utilities.attach_optimizer(model)
 
-julia> model
-MOIU.CachingOptimizer{MOIU.GenericOptimizer{Float64, MOIU.ObjectiveContainer{Float64}, MOIU.VariablesContainer{Float64}, MOIU.VectorOfConstraints{MOI.VectorAffineFunction{Float64}, MOI.Complements}}, MOIU.Model{Float64}}
-in state ATTACHED_OPTIMIZER
-in mode AUTOMATIC
-with model cache MOIU.Model{Float64}
-with optimizer MOIU.GenericOptimizer{Float64, MOIU.ObjectiveContainer{Float64}, MOIU.VariablesContainer{Float64}, MOIU.VectorOfConstraints{MOI.VectorAffineFunction{Float64}, MOI.Complements}}
+julia> MOI.Utilities.state(model)
+ATTACHED_OPTIMIZER::CachingOptimizerState = 2
 ```
 
 !!! info
@@ -191,12 +206,8 @@ Use [`Utilities.reset_optimizer`](@ref) to go from `ATTACHED_OPTIMIZER` to
 ```jldoctest pathoptimizer
 julia> MOI.Utilities.reset_optimizer(model)
 
-julia> model
-MOIU.CachingOptimizer{MOIU.GenericOptimizer{Float64, MOIU.ObjectiveContainer{Float64}, MOIU.VariablesContainer{Float64}, MOIU.VectorOfConstraints{MOI.VectorAffineFunction{Float64}, MOI.Complements}}, MOIU.Model{Float64}}
-in state EMPTY_OPTIMIZER
-in mode AUTOMATIC
-with model cache MOIU.Model{Float64}
-with optimizer MOIU.GenericOptimizer{Float64, MOIU.ObjectiveContainer{Float64}, MOIU.VariablesContainer{Float64}, MOIU.VectorOfConstraints{MOI.VectorAffineFunction{Float64}, MOI.Complements}}
+julia> MOI.Utilities.state(model)
+EMPTY_OPTIMIZER::CachingOptimizerState = 1
 ```
 
 !!! info
@@ -208,25 +219,43 @@ Use [`Utilities.drop_optimizer`](@ref) to go from any state to `NO_OPTIMIZER`:
 ```jldoctest pathoptimizer
 julia> MOI.Utilities.drop_optimizer(model)
 
+julia> MOI.Utilities.state(model)
+NO_OPTIMIZER::CachingOptimizerState = 0
+
 julia> model
-MOIU.CachingOptimizer{MOIU.GenericOptimizer{Float64, MOIU.ObjectiveContainer{Float64}, MOIU.VariablesContainer{Float64}, MOIU.VectorOfConstraints{MOI.VectorAffineFunction{Float64}, MOI.Complements}}, MOIU.Model{Float64}}
-in state NO_OPTIMIZER
-in mode AUTOMATIC
-with model cache MOIU.Model{Float64}
-with optimizer nothing
+MOIU.CachingOptimizer
+├ state: NO_OPTIMIZER
+├ mode: AUTOMATIC
+├ model_cache: MOIU.Model{Float64}
+│ ├ ObjectiveSense: FEASIBILITY_SENSE
+│ ├ ObjectiveFunctionType: MOI.ScalarAffineFunction{Float64}
+│ ├ NumberOfVariables: 0
+│ └ NumberOfConstraints: 0
+└ optimizer: nothing
 ```
 
 Pass an empty optimizer to [`Utilities.reset_optimizer`](@ref) to go from
 `NO_OPTIMIZER` to `EMPTY_OPTIMIZER`:
 ```jldoctest pathoptimizer
 julia> MOI.Utilities.reset_optimizer(model, PathOptimizer{Float64}())
 
+julia> MOI.Utilities.state(model)
+EMPTY_OPTIMIZER::CachingOptimizerState = 1
+
 julia> model
-MOIU.CachingOptimizer{MOIU.GenericOptimizer{Float64, MOIU.ObjectiveContainer{Float64}, MOIU.VariablesContainer{Float64}, MOIU.VectorOfConstraints{MOI.VectorAffineFunction{Float64}, MOI.Complements}}, MOIU.Model{Float64}}
-in state EMPTY_OPTIMIZER
-in mode AUTOMATIC
-with model cache MOIU.Model{Float64}
-with optimizer MOIU.GenericOptimizer{Float64, MOIU.ObjectiveContainer{Float64}, MOIU.VariablesContainer{Float64}, MOIU.VectorOfConstraints{MOI.VectorAffineFunction{Float64}, MOI.Complements}}
+MOIU.CachingOptimizer
+├ state: EMPTY_OPTIMIZER
+├ mode: AUTOMATIC
+├ model_cache: MOIU.Model{Float64}
+│ ├ ObjectiveSense: FEASIBILITY_SENSE
+│ ├ ObjectiveFunctionType: MOI.ScalarAffineFunction{Float64}
+│ ├ NumberOfVariables: 0
+│ └ NumberOfConstraints: 0
+└ optimizer: MOIU.GenericOptimizer{Float64, MOIU.ObjectiveContainer{Float64}, MOIU.VariablesContainer{Float64}, MOIU.VectorOfConstraints{MOI.VectorAffineFunction{Float64}, MOI.Complements}}
+  ├ ObjectiveSense: FEASIBILITY_SENSE
+  ├ ObjectiveFunctionType: MOI.ScalarAffineFunction{Float64}
+  ├ NumberOfVariables: 0
+  └ NumberOfConstraints: 0
 ```
 
 Deciding when to attach and reset the optimizer is tedious, and you will often
@@ -256,20 +285,32 @@ julia> model = MOI.Utilities.CachingOptimizer(
            MOI.Utilities.Model{Float64}(),
            MOI.Utilities.MANUAL,
        )
-MOIU.CachingOptimizer{MOI.AbstractOptimizer, MOIU.Model{Float64}}
-in state NO_OPTIMIZER
-in mode MANUAL
-with model cache MOIU.Model{Float64}
-with optimizer nothing
+MOIU.CachingOptimizer
+├ state: NO_OPTIMIZER
+├ mode: MANUAL
+├ model_cache: MOIU.Model{Float64}
+│ ├ ObjectiveSense: FEASIBILITY_SENSE
+│ ├ ObjectiveFunctionType: MOI.ScalarAffineFunction{Float64}
+│ ├ NumberOfVariables: 0
+│ └ NumberOfConstraints: 0
+└ optimizer: nothing
 
 julia> MOI.Utilities.reset_optimizer(model, PathOptimizer{Float64}())
 
 julia> model
-MOIU.CachingOptimizer{MOI.AbstractOptimizer, MOIU.Model{Float64}}
-in state EMPTY_OPTIMIZER
-in mode MANUAL
-with model cache MOIU.Model{Float64}
-with optimizer MOIU.GenericOptimizer{Float64, MOIU.ObjectiveContainer{Float64}, MOIU.VariablesContainer{Float64}, MOIU.VectorOfConstraints{MOI.VectorAffineFunction{Float64}, MOI.Complements}}
+MOIU.CachingOptimizer
+├ state: EMPTY_OPTIMIZER
+├ mode: MANUAL
+├ model_cache: MOIU.Model{Float64}
+│ ├ ObjectiveSense: FEASIBILITY_SENSE
+│ ├ ObjectiveFunctionType: MOI.ScalarAffineFunction{Float64}
+│ ├ NumberOfVariables: 0
+│ └ NumberOfConstraints: 0
+└ optimizer: MOIU.GenericOptimizer{Float64, MOIU.ObjectiveContainer{Float64}, MOIU.VariablesContainer{Float64}, MOIU.VectorOfConstraints{MOI.VectorAffineFunction{Float64}, MOI.Complements}}
+  ├ ObjectiveSense: FEASIBILITY_SENSE
+  ├ ObjectiveFunctionType: MOI.ScalarAffineFunction{Float64}
+  ├ NumberOfVariables: 0
+  └ NumberOfConstraints: 0
 ```
 
 ## Printing

diff --git a/src/Bridges/Constraint/map.jl b/src/Bridges/Constraint/map.jl
@@ -32,13 +32,6 @@ struct Map <: AbstractDict{MOI.ConstraintIndex,AbstractBridge}
     end
 end
 
-function Base.show(io::IO, B::Map)
-    indent = " "^get(io, :indent, 0)
-    n = length(B)
-    s = n == 1 ? "" : "s"
-    return print(io, "\n$(indent)with $(n) constraint bridge$s")
-end
-
 # Implementation of `AbstractDict` interface.
 
 function Base.isempty(map::Map)

diff --git a/src/Bridges/Constraint/single_bridge_optimizer.jl b/src/Bridges/Constraint/single_bridge_optimizer.jl
@@ -23,8 +23,10 @@ julia> bridge = MOI.Bridges.Constraint.SingleBridgeOptimizer{MyNewBridge{Float64
            MOI.Utilities.Model{Float64}(),
        )
 MOIB.Constraint.SingleBridgeOptimizer{MyNewBridge{Float64}, MOIU.Model{Float64}}
-with 0 constraint bridges
-with inner model MOIU.Model{Float64}
+├ ObjectiveSense: FEASIBILITY_SENSE
+├ ObjectiveFunctionType: MOI.ScalarAffineFunction{Float64}
+├ NumberOfVariables: 0
+└ NumberOfConstraints: 0
 ```
 
 ## Implementation notes
@@ -37,10 +39,7 @@ julia> const MyNewBridgeModel{T,OT<:MOI.ModelLike} =
 ```
 This enables users to create bridged models as follows:
 ```jldoctest con_singlebridgeoptimizer
-julia> MyNewBridgeModel{Float64}(MOI.Utilities.Model{Float64}())
-MOIB.Constraint.SingleBridgeOptimizer{MyNewBridge{Float64}, MOIU.Model{Float64}}
-with 0 constraint bridges
-with inner model MOIU.Model{Float64}
+julia> MyNewBridgeModel{Float64}(MOI.Utilities.Model{Float64}());
 ```
 """
 mutable struct SingleBridgeOptimizer{BT<:AbstractBridge,OT<:MOI.ModelLike} <:

diff --git a/src/Bridges/Objective/map.jl b/src/Bridges/Objective/map.jl
@@ -17,13 +17,6 @@ end
 
 Map() = Map(Dict{MOI.ObjectiveFunction,AbstractBridge}(), nothing)
 
-function Base.show(io::IO, B::Map)
-    indent = " "^get(io, :indent, 0)
-    n = length(B)
-    s = n == 1 ? "" : "s"
-    return print(io, "\n$(indent)with $(n) objective bridge$s")
-end
-
 # Implementation of `AbstractDict` interface.
 
 Base.isempty(map::Map) = isempty(map.bridges)

diff --git a/src/Bridges/Objective/single_bridge_optimizer.jl b/src/Bridges/Objective/single_bridge_optimizer.jl
@@ -21,10 +21,7 @@ julia> struct MyNewBridge{T} <: MOI.Bridges.Objective.AbstractBridge end
 
 julia> bridge = MOI.Bridges.Objective.SingleBridgeOptimizer{MyNewBridge{Float64}}(
            MOI.Utilities.Model{Float64}(),
-       )
-MOIB.Objective.SingleBridgeOptimizer{MyNewBridge{Float64}, MOIU.Model{Float64}}
-with 0 objective bridges
-with inner model MOIU.Model{Float64}
+       );
 ```
 
 ## Implementation notes
@@ -37,10 +34,7 @@ julia> const MyNewBridgeModel{T,OT<:MOI.ModelLike} =
 ```
 This enables users to create bridged models as follows:
 ```jldoctest obj_singlebridgeoptimizer
-julia> MyNewBridgeModel{Float64}(MOI.Utilities.Model{Float64}())
-MOIB.Objective.SingleBridgeOptimizer{MyNewBridge{Float64}, MOIU.Model{Float64}}
-with 0 objective bridges
-with inner model MOIU.Model{Float64}
+julia> MyNewBridgeModel{Float64}(MOI.Utilities.Model{Float64}());
 ```
 """
 mutable struct SingleBridgeOptimizer{BT<:AbstractBridge,OT<:MOI.ModelLike} <:

diff --git a/src/Bridges/Variable/map.jl b/src/Bridges/Variable/map.jl
@@ -64,13 +64,6 @@ function Map()
     )
 end
 
-function Base.show(io::IO, B::Map)
-    indent = " "^get(io, :indent, 0)
-    n = length(B)
-    s = n == 1 ? "" : "s"
-    return print(io, "\n$(indent)with $(n) variable bridge$s")
-end
-
 # Implementation of `AbstractDict` interface.
 
 Base.isempty(map::Map) = all(bridge -> bridge === nothing, map.bridges)