Change show(::IO, ::GenericModel) to a more informative tree structure (

#3803)
jump-dev · Aug 10, 2024 · 52bb94f · 52bb94f
1 parent 23ccb2c
commit 52bb94f
Show file tree

Hide file tree

Showing 8 changed files with 263 additions and 188 deletions.
diff --git a/docs/src/developers/extensions.md b/docs/src/developers/extensions.md
@@ -364,11 +364,11 @@ MyModel (generic function with 1 method)
 
 julia> model = MyModel()
 A JuMP Model
-Feasibility problem with:
-Variables: 0
-Model mode: AUTOMATIC
-CachingOptimizer state: NO_OPTIMIZER
-Solver name: No optimizer attached.
+├ solver: none
+├ objective_sense: FEASIBILITY_SENSE
+├ num_variables: 0
+├ num_constraints: 0
+└ Names registered in the model: none
 
 julia> model.ext
 Dict{Symbol, Any} with 1 entry:

diff --git a/docs/src/manual/constraints.md b/docs/src/manual/constraints.md
@@ -351,11 +351,11 @@ corresponding symbol. Get a registered name using `model[:key]`:
 ```jldoctest
 julia> model = Model()
 A JuMP Model
-Feasibility problem with:
-Variables: 0
-Model mode: AUTOMATIC
-CachingOptimizer state: NO_OPTIMIZER
-Solver name: No optimizer attached.
+├ solver: none
+├ objective_sense: FEASIBILITY_SENSE
+├ num_variables: 0
+├ num_constraints: 0
+└ Names registered in the model: none
 
 julia> @variable(model, x)
 x
@@ -365,13 +365,13 @@ my_c : 2 x ≤ 1
 
 julia> model
 A JuMP Model
-Feasibility problem with:
-Variable: 1
-`AffExpr`-in-`MathOptInterface.LessThan{Float64}`: 1 constraint
-Model mode: AUTOMATIC
-CachingOptimizer state: NO_OPTIMIZER
-Solver name: No optimizer attached.
-Names registered in the model: my_c, x
+├ solver: none
+├ objective_sense: FEASIBILITY_SENSE
+├ num_variables: 1
+├ num_constraints: 1
+│ └ AffExpr in MOI.LessThan{Float64}: 1
+└ Names registered in the model
+  └ :my_c, :x
 
 julia> model[:my_c] === my_c
 true
@@ -567,13 +567,13 @@ c : 2 x ≤ 1
 
 julia> model
 A JuMP Model
-Feasibility problem with:
-Variable: 1
-`AffExpr`-in-`MathOptInterface.LessThan{Float64}`: 1 constraint
-Model mode: AUTOMATIC
-CachingOptimizer state: NO_OPTIMIZER
-Solver name: No optimizer attached.
-Names registered in the model: x
+├ solver: none
+├ objective_sense: FEASIBILITY_SENSE
+├ num_variables: 1
+├ num_constraints: 1
+│ └ AffExpr in MOI.LessThan{Float64}: 1
+└ Names registered in the model
+  └ :x
 
 julia> c
 ERROR: UndefVarError: `c` not defined
@@ -589,13 +589,13 @@ c : 2 x ≤ 1
 
 julia> model
 A JuMP Model
-Feasibility problem with:
-Variable: 1
-`AffExpr`-in-`MathOptInterface.LessThan{Float64}`: 1 constraint
-Model mode: AUTOMATIC
-CachingOptimizer state: NO_OPTIMIZER
-Solver name: No optimizer attached.
-Names registered in the model: c_register, x
+├ solver: none
+├ objective_sense: FEASIBILITY_SENSE
+├ num_variables: 1
+├ num_constraints: 1
+│ └ AffExpr in MOI.LessThan{Float64}: 1
+└ Names registered in the model
+  └ :c_register, :x
 
 julia> model[:c_register]
 c : 2 x ≤ 1
@@ -1597,13 +1597,14 @@ x[1] && x[2] = false
 
 julia> model
 A JuMP Model
-Feasibility problem with:
-Variables: 2
-`GenericNonlinearExpr{GenericVariableRef{Bool}}`-in-`MathOptInterface.EqualTo{Bool}`: 2 constraints
-Model mode: AUTOMATIC
-CachingOptimizer state: NO_OPTIMIZER
-Solver name: No optimizer attached.
-Names registered in the model: x
+├ value_type: Bool
+├ solver: none
+├ objective_sense: FEASIBILITY_SENSE
+├ num_variables: 2
+├ num_constraints: 2
+│ └ GenericNonlinearExpr{GenericVariableRef{Bool}} in MOI.EqualTo{Bool}: 2
+└ Names registered in the model
+  └ :x
 ```
 
 Boolean constraints should not be added using the `==` operator because JuMP

diff --git a/docs/src/manual/models.md b/docs/src/manual/models.md
@@ -27,11 +27,11 @@ Create a model by passing an optimizer to [`Model`](@ref):
 ```jldoctest
 julia> model = Model(HiGHS.Optimizer)
 A JuMP Model
-Feasibility problem with:
-Variables: 0
-Model mode: AUTOMATIC
-CachingOptimizer state: EMPTY_OPTIMIZER
-Solver name: HiGHS
+├ solver: HiGHS
+├ objective_sense: FEASIBILITY_SENSE
+├ num_variables: 0
+├ num_constraints: 0
+└ Names registered in the model: none
 ```
 
 If you don't know which optimizer you will be using at creation time, create a
@@ -40,11 +40,11 @@ prior to [`optimize!`](@ref):
 ```jldoctest
 julia> model = Model()
 A JuMP Model
-Feasibility problem with:
-Variables: 0
-Model mode: AUTOMATIC
-CachingOptimizer state: NO_OPTIMIZER
-Solver name: No optimizer attached.
+├ solver: none
+├ objective_sense: FEASIBILITY_SENSE
+├ num_variables: 0
+├ num_constraints: 0
+└ Names registered in the model: none
 
 julia> set_optimizer(model, HiGHS.Optimizer)
 ```
@@ -127,11 +127,11 @@ julia> import MultiObjectiveAlgorithms as MOA
 
 julia> model = Model(() -> MOA.Optimizer(HiGHS.Optimizer))
 A JuMP Model
-Feasibility problem with:
-Variables: 0
-Model mode: AUTOMATIC
-CachingOptimizer state: EMPTY_OPTIMIZER
-Solver name: MOA[algorithm=MultiObjectiveAlgorithms.Lexicographic, optimizer=HiGHS]
+├ solver: MOA[algorithm=MultiObjectiveAlgorithms.Lexicographic, optimizer=HiGHS]
+├ objective_sense: FEASIBILITY_SENSE
+├ num_variables: 0
+├ num_constraints: 0
+└ Names registered in the model: none
 ```
 
 ## [Solver options](@id solver_options)
@@ -144,11 +144,11 @@ julia> model = Model(
            optimizer_with_attributes(HiGHS.Optimizer, "output_flag" => false),
        )
 A JuMP Model
-Feasibility problem with:
-Variables: 0
-Model mode: AUTOMATIC
-CachingOptimizer state: EMPTY_OPTIMIZER
-Solver name: HiGHS
+├ solver: HiGHS
+├ objective_sense: FEASIBILITY_SENSE
+├ num_variables: 0
+├ num_constraints: 0
+└ Names registered in the model: none
 ```
 
 Alternatively, use [`set_attribute`](@ref) to set an attribute after
@@ -214,14 +214,14 @@ julia> model = Model(); @variable(model, x >= 0); @objective(model, Max, x);
 
 julia> model
 A JuMP Model
-Maximization problem with:
-Variable: 1
-Objective function type: VariableRef
-`VariableRef`-in-`MathOptInterface.GreaterThan{Float64}`: 1 constraint
-Model mode: AUTOMATIC
-CachingOptimizer state: NO_OPTIMIZER
-Solver name: No optimizer attached.
-Names registered in the model: x
+├ solver: none
+├ objective_sense: MAX_SENSE
+│ └ objective_function_type: VariableRef
+├ num_variables: 1
+├ num_constraints: 1
+│ └ VariableRef in MOI.GreaterThan{Float64}: 1
+└ Names registered in the model
+  └ :x
 ```
 
 Use `print` to print the formulation of the model (in IJulia, this will render
@@ -356,23 +356,23 @@ JuMP models can be created from file formats using [`read_from_file`](@ref) and
 ```jldoctest file_formats
 julia> model = read_from_file("model.mps")
 A JuMP Model
-Minimization problem with:
-Variables: 0
-Objective function type: AffExpr
-Model mode: AUTOMATIC
-CachingOptimizer state: NO_OPTIMIZER
-Solver name: No optimizer attached.
+├ solver: none
+├ objective_sense: MIN_SENSE
+│ └ objective_function_type: AffExpr
+├ num_variables: 0
+├ num_constraints: 0
+└ Names registered in the model: none
 
 julia> seekstart(io);
 
 julia> model2 = read(io, Model; format = MOI.FileFormats.FORMAT_MPS)
 A JuMP Model
-Minimization problem with:
-Variables: 0
-Objective function type: AffExpr
-Model mode: AUTOMATIC
-CachingOptimizer state: NO_OPTIMIZER
-Solver name: No optimizer attached.
+├ solver: none
+├ objective_sense: MIN_SENSE
+│ └ objective_function_type: AffExpr
+├ num_variables: 0
+├ num_constraints: 0
+└ Names registered in the model: none
 ```
 
 !!! note
@@ -634,11 +634,11 @@ Use the `add_bridges = false` keyword to remove the bridging layer:
 ```jldoctest
 julia> model = Model(HiGHS.Optimizer; add_bridges = false)
 A JuMP Model
-Feasibility problem with:
-Variables: 0
-Model mode: AUTOMATIC
-CachingOptimizer state: EMPTY_OPTIMIZER
-Solver name: HiGHS
+├ solver: HiGHS
+├ objective_sense: FEASIBILITY_SENSE
+├ num_variables: 0
+├ num_constraints: 0
+└ Names registered in the model: none
 
 julia> backend(model)
 MOIU.CachingOptimizer
@@ -694,10 +694,12 @@ JuMP model using [`direct_model`](@ref):
 ```jldoctest direct_mode
 julia> model = direct_model(HiGHS.Optimizer())
 A JuMP Model
-Feasibility problem with:
-Variables: 0
-Model mode: DIRECT
-Solver name: HiGHS
+├ mode: DIRECT
+├ solver: HiGHS
+├ objective_sense: FEASIBILITY_SENSE
+├ num_variables: 0
+├ num_constraints: 0
+└ Names registered in the model: none
 ```
 
 !!! warning

diff --git a/docs/src/manual/solutions.md b/docs/src/manual/solutions.md
@@ -608,13 +608,7 @@ julia> using JuMP
 
 julia> import Gurobi
 
-julia> model = Model(Gurobi.Optimizer)
-A JuMP Model
-Feasibility problem with:
-Variables: 0
-Model mode: AUTOMATIC
-CachingOptimizer state: EMPTY_OPTIMIZER
-Solver name: Gurobi
+julia> model = Model(Gurobi.Optimizer);
 
 julia> set_silent(model)
 

diff --git a/docs/src/manual/variables.md b/docs/src/manual/variables.md
@@ -190,23 +190,23 @@ corresponding symbol. Get a registered name using `model[:key]`:
 ```jldoctest
 julia> model = Model()
 A JuMP Model
-Feasibility problem with:
-Variables: 0
-Model mode: AUTOMATIC
-CachingOptimizer state: NO_OPTIMIZER
-Solver name: No optimizer attached.
+├ solver: none
+├ objective_sense: FEASIBILITY_SENSE
+├ num_variables: 0
+├ num_constraints: 0
+└ Names registered in the model: none
 
 julia> @variable(model, x)
 x
 
 julia> model
 A JuMP Model
-Feasibility problem with:
-Variable: 1
-Model mode: AUTOMATIC
-CachingOptimizer state: NO_OPTIMIZER
-Solver name: No optimizer attached.
-Names registered in the model: x
+├ solver: none
+├ objective_sense: FEASIBILITY_SENSE
+├ num_variables: 1
+├ num_constraints: 0
+└ Names registered in the model
+  └ :x
 
 julia> model[:x] === x
 true
@@ -430,11 +430,11 @@ x
 
 julia> model
 A JuMP Model
-Feasibility problem with:
-Variable: 1
-Model mode: AUTOMATIC
-CachingOptimizer state: NO_OPTIMIZER
-Solver name: No optimizer attached.
+├ solver: none
+├ objective_sense: FEASIBILITY_SENSE
+├ num_variables: 1
+├ num_constraints: 0
+└ Names registered in the model: none
 
 julia> x
 ERROR: UndefVarError: `x` not defined
@@ -450,12 +450,12 @@ x
 
 julia> model
 A JuMP Model
-Feasibility problem with:
-Variable: 1
-Model mode: AUTOMATIC
-CachingOptimizer state: NO_OPTIMIZER
-Solver name: No optimizer attached.
-Names registered in the model: x_register
+├ solver: none
+├ objective_sense: FEASIBILITY_SENSE
+├ num_variables: 1
+├ num_constraints: 0
+└ Names registered in the model
+  └ :x_register
 
 julia> model[:x_register]
 x