[Utilities] add default MIME for printing (#2126)

Author: odow

docs/src/submodules/FileFormats/overview.md

@@ -85,7 +85,7 @@ A MathOptFormat Model
 
 julia> MOI.copy_to(dest, src)
 MathOptInterface.Utilities.IndexMap with 1 entry:
-  VariableIndex(1) => VariableIndex(1)
+  MOI.VariableIndex(1) => MOI.VariableIndex(1)
 
 julia> MOI.write_to_file(dest, "file.mof.json")
 

src/Utilities/print.jl

@@ -655,6 +655,10 @@ function MOI.get(
     return ""  # Leave as default
 end
 
+function Base.show(io::IO, f::MOI.AbstractFunction)
+    return show(io, MIME("text/plain"), f)
+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))

src/functions.jl

@@ -84,7 +84,7 @@ julia> x = MOI.VariableIndex(1)
 MOI.VariableIndex(1)
 
 julia> MOI.ScalarAffineTerm(2.0, x)
-MathOptInterface.ScalarAffineTerm{Float64}(2.0, MathOptInterface.VariableIndex(1))
+MathOptInterface.ScalarAffineTerm{Float64}(2.0, MOI.VariableIndex(1))
 ```
 """
 struct ScalarAffineTerm{T}
@@ -130,8 +130,8 @@ 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))
+ MathOptInterface.ScalarAffineTerm{Float64}(2.0, MOI.VariableIndex(1))
+ MathOptInterface.ScalarAffineTerm{Float64}(3.0, MOI.VariableIndex(1))
 
 julia> f = MOI.ScalarAffineFunction(terms, 4.0)
 4.0 + 2.0 MOI.VariableIndex(1) + 3.0 MOI.VariableIndex(1)
@@ -171,7 +171,7 @@ julia> x = MOI.VariableIndex(1)
 MOI.VariableIndex(1)
 
 julia> MOI.ScalarQuadraticTerm(2.0, x, x)
-MathOptInterface.ScalarQuadraticTerm{Float64}(2.0, MathOptInterface.VariableIndex(1), MathOptInterface.VariableIndex(1))
+MathOptInterface.ScalarQuadraticTerm{Float64}(2.0, MOI.VariableIndex(1), MOI.VariableIndex(1))
 ```
 """
 struct ScalarQuadraticTerm{T}
@@ -254,8 +254,8 @@ julia> quadratic_terms = [
            MOI.ScalarQuadraticTerm(3.0, x, y),
        ]
 2-element Vector{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.ScalarQuadraticTerm{Float64}(4.0, MOI.VariableIndex(1), MOI.VariableIndex(1))
+ MathOptInterface.ScalarQuadraticTerm{Float64}(3.0, MOI.VariableIndex(1), MOI.VariableIndex(2))
 
 julia> f = MOI.ScalarQuadraticFunction(quadratic_terms, affine_terms, constant)
 5.0 + 4.0 MOI.VariableIndex(1) + 2.0 MOI.VariableIndex(1)² + 3.0 MOI.VariableIndex(1)*MOI.VariableIndex(2)
@@ -356,7 +356,7 @@ julia> import MathOptInterface as MOI
 julia> x = MOI.VariableIndex(1);
 
 julia> MOI.VectorAffineTerm(Int64(2), MOI.ScalarAffineTerm(3.0, x))
-MathOptInterface.VectorAffineTerm{Float64}(2, MathOptInterface.ScalarAffineTerm{Float64}(3.0, MathOptInterface.VariableIndex(1)))
+MathOptInterface.VectorAffineTerm{Float64}(2, MathOptInterface.ScalarAffineTerm{Float64}(3.0, MOI.VariableIndex(1)))
 ```
 """
 struct VectorAffineTerm{T}
@@ -455,7 +455,7 @@ julia> import MathOptInterface as MOI
 julia> x = MOI.VariableIndex(1);
 
 julia> MOI.VectorQuadraticTerm(Int64(2), MOI.ScalarQuadraticTerm(3.0, x, x))
-MathOptInterface.VectorQuadraticTerm{Float64}(2, MathOptInterface.ScalarQuadraticTerm{Float64}(3.0, MathOptInterface.VariableIndex(1), MathOptInterface.VariableIndex(1)))
+MathOptInterface.VectorQuadraticTerm{Float64}(2, MathOptInterface.ScalarQuadraticTerm{Float64}(3.0, MOI.VariableIndex(1), MOI.VariableIndex(1)))
 ```
 """
 struct VectorQuadraticTerm{T}

src/sets.jl

@@ -249,7 +249,7 @@ julia> model = MOI.Utilities.Model{Float64}()
 MOIU.Model{Float64}
 
 julia> p, ci = MOI.add_constrained_variable(model, MOI.Parameter(2.5))
-(MathOptInterface.VariableIndex(1), MathOptInterface.ConstraintIndex{MathOptInterface.VariableIndex, MathOptInterface.Parameter{Float64}}(1))
+(MOI.VariableIndex(1), MathOptInterface.ConstraintIndex{MathOptInterface.VariableIndex, MathOptInterface.Parameter{Float64}}(1))
 
 julia> MOI.set(model, MOI.ConstraintSet(), ci, MOI.Parameter(3.0))
 
@@ -1753,7 +1753,7 @@ julia> x = MOI.add_variables(model, 2)
  MOI.VariableIndex(2)
 
 julia> y, _ = MOI.add_constrained_variable(model, MOI.ZeroOne())
-(MathOptInterface.VariableIndex(3), MathOptInterface.ConstraintIndex{MathOptInterface.VariableIndex, MathOptInterface.ZeroOne}(3))
+(MOI.VariableIndex(3), MathOptInterface.ConstraintIndex{MathOptInterface.VariableIndex, MathOptInterface.ZeroOne}(3))
 
 julia> f = MOI.VectorAffineFunction(
            [
@@ -2080,16 +2080,16 @@ julia> model = MOI.Utilities.Model{Float64}()
 MOIU.Model{Float64}
 
 julia> a, _ = MOI.add_constrained_variable(model, MOI.Integer())
-(MathOptInterface.VariableIndex(1), MathOptInterface.ConstraintIndex{MathOptInterface.VariableIndex, MathOptInterface.Integer}(1))
+(MOI.VariableIndex(1), MathOptInterface.ConstraintIndex{MathOptInterface.VariableIndex, MathOptInterface.Integer}(1))
 
 julia> b, _ = MOI.add_constrained_variable(model, MOI.Integer())
-(MathOptInterface.VariableIndex(2), MathOptInterface.ConstraintIndex{MathOptInterface.VariableIndex, MathOptInterface.Integer}(2))
+(MOI.VariableIndex(2), MathOptInterface.ConstraintIndex{MathOptInterface.VariableIndex, MathOptInterface.Integer}(2))
 
 julia> c, _ = MOI.add_constrained_variable(model, MOI.Integer())
-(MathOptInterface.VariableIndex(3), MathOptInterface.ConstraintIndex{MathOptInterface.VariableIndex, MathOptInterface.Integer}(3))
+(MOI.VariableIndex(3), MathOptInterface.ConstraintIndex{MathOptInterface.VariableIndex, MathOptInterface.Integer}(3))
 
 julia> x, d, set = [a, b, b, c], [2, 2], [3]
-(MathOptInterface.VariableIndex[MathOptInterface.VariableIndex(1), MathOptInterface.VariableIndex(2), MathOptInterface.VariableIndex(2), MathOptInterface.VariableIndex(3)], [2, 2], [3])
+(MathOptInterface.VariableIndex[MOI.VariableIndex(1), MOI.VariableIndex(2), MOI.VariableIndex(2), MOI.VariableIndex(3)], [2, 2], [3])
 
 julia> MOI.add_constraint(model, MOI.VectorOfVariables(x), MOI.CountAtLeast(1, d, Set(set)))
 MathOptInterface.ConstraintIndex{MathOptInterface.VectorOfVariables, MathOptInterface.CountAtLeast}(1)
@@ -2140,7 +2140,7 @@ julia> model = MOI.Utilities.Model{Float64}()
 MOIU.Model{Float64}
 
 julia> n, _ = MOI.add_constrained_variable(model, MOI.Integer())
-(MathOptInterface.VariableIndex(1), MathOptInterface.ConstraintIndex{MathOptInterface.VariableIndex, MathOptInterface.Integer}(1))
+(MOI.VariableIndex(1), MathOptInterface.ConstraintIndex{MathOptInterface.VariableIndex, MathOptInterface.Integer}(1))
 
 julia> x = [MOI.add_constrained_variable(model, MOI.Integer())[1] for _ in 1:3]
 3-element Vector{MathOptInterface.VariableIndex}:
@@ -2203,7 +2203,7 @@ julia> model = MOI.Utilities.Model{Float64}()
 MOIU.Model{Float64}
 
 julia> n, _ = MOI.add_constrained_variable(model, MOI.Integer())
-(MathOptInterface.VariableIndex(1), MathOptInterface.ConstraintIndex{MathOptInterface.VariableIndex, MathOptInterface.Integer}(1))
+(MOI.VariableIndex(1), MathOptInterface.ConstraintIndex{MathOptInterface.VariableIndex, MathOptInterface.Integer}(1))
 
 julia> x = [MOI.add_constrained_variable(model, MOI.Integer())[1] for _ in 1:3]
 3-element Vector{MathOptInterface.VariableIndex}:
@@ -2249,10 +2249,10 @@ julia> model = MOI.Utilities.Model{Float64}()
 MOIU.Model{Float64}
 
 julia> c, _ = MOI.add_constrained_variable(model, MOI.Integer())
-(MathOptInterface.VariableIndex(1), MathOptInterface.ConstraintIndex{MathOptInterface.VariableIndex, MathOptInterface.Integer}(1))
+(MOI.VariableIndex(1), MathOptInterface.ConstraintIndex{MathOptInterface.VariableIndex, MathOptInterface.Integer}(1))
 
 julia> y, _ = MOI.add_constrained_variable(model, MOI.Integer())
-(MathOptInterface.VariableIndex(2), MathOptInterface.ConstraintIndex{MathOptInterface.VariableIndex, MathOptInterface.Integer}(2))
+(MOI.VariableIndex(2), MathOptInterface.ConstraintIndex{MathOptInterface.VariableIndex, MathOptInterface.Integer}(2))
 
 julia> x = [MOI.add_constrained_variable(model, MOI.Integer())[1] for _ in 1:3]
 3-element Vector{MathOptInterface.VariableIndex}:
@@ -2320,7 +2320,7 @@ julia> r = [MOI.add_constrained_variable(model, MOI.Integer())[1] for _ in 1:3]
  MOI.VariableIndex(9)
 
 julia> b, _ = MOI.add_constrained_variable(model, MOI.Integer())
-(MathOptInterface.VariableIndex(10), MathOptInterface.ConstraintIndex{MathOptInterface.VariableIndex, MathOptInterface.Integer}(10))
+(MOI.VariableIndex(10), MathOptInterface.ConstraintIndex{MathOptInterface.VariableIndex, MathOptInterface.Integer}(10))
 
 julia> MOI.add_constraint(model, MOI.VectorOfVariables([s; d; r; b]), MOI.Cumulative(10))
 MathOptInterface.ConstraintIndex{MathOptInterface.VectorOfVariables, MathOptInterface.Cumulative}(1)
@@ -2381,10 +2381,10 @@ julia> to = [2, 3, 3, 4, 4]
  4
 
 julia> s, _ = MOI.add_constrained_variable(model, MOI.Integer())
-(MathOptInterface.VariableIndex(1), MathOptInterface.ConstraintIndex{MathOptInterface.VariableIndex, MathOptInterface.Integer}(1))
+(MOI.VariableIndex(1), MathOptInterface.ConstraintIndex{MathOptInterface.VariableIndex, MathOptInterface.Integer}(1))
 
 julia> t, _ = MOI.add_constrained_variable(model, MOI.Integer())
-(MathOptInterface.VariableIndex(2), MathOptInterface.ConstraintIndex{MathOptInterface.VariableIndex, MathOptInterface.Integer}(2))
+(MOI.VariableIndex(2), MathOptInterface.ConstraintIndex{MathOptInterface.VariableIndex, MathOptInterface.Integer}(2))
 
 julia> ns = MOI.add_variables(model, N)
 4-element Vector{MathOptInterface.VariableIndex}:
@@ -2554,7 +2554,7 @@ MOIU.UniversalFallback{MOIU.Model{Float64}}
 fallback for MOIU.Model{Float64}
 
 julia> z, _ = MOI.add_constrained_variable(model, MOI.ZeroOne())
-(MathOptInterface.VariableIndex(1), MathOptInterface.ConstraintIndex{MathOptInterface.VariableIndex, MathOptInterface.ZeroOne}(1))
+(MOI.VariableIndex(1), MathOptInterface.ConstraintIndex{MathOptInterface.VariableIndex, MathOptInterface.ZeroOne}(1))
 
 julia> x = MOI.add_variable(model)
 MOI.VariableIndex(2)

test/Bridges/Variable/vectorize.jl

@@ -130,7 +130,7 @@ function test_exp3_with_add_constrained_variable_y()
 
     err = ErrorException(
         "Cannot add two `VariableIndex`-in-`MathOptInterface.LessThan{Float64}`" *
-        " on the same variable MathOptInterface.VariableIndex(-1).",
+        " on the same variable MOI.VariableIndex(-1).",
     )
     @test_throws err MOI.add_constraint(bridged_mock, y, MOI.LessThan(4.0))
 
@@ -156,7 +156,7 @@ function test_exp3_with_add_constrained_variable_y()
     attr = MOI.ConstraintSet()
     err = MOI.SetAttributeNotAllowed(
         attr,
-        "The variable `MathOptInterface.VariableIndex(12345676)` is bridged by the `VectorizeBridge`.",
+        "The variable `MOI.VariableIndex(12345676)` is bridged by the `VectorizeBridge`.",
     )
     @test_throws err MOI.set(bridged_mock, attr, ci, MOI.LessThan(4.0))
 
@@ -170,7 +170,7 @@ function test_exp3_with_add_constrained_variable_y()
     change = MOI.ScalarCoefficientChange(y, 0.0)
     attr = MOI.ObjectiveFunction{MOI.ScalarAffineFunction{Float64}}()
     message =
-        "The change MathOptInterface.ScalarCoefficientChange{Float64}(MathOptInterface.VariableIndex(-1), 0.0)" *
+        "The change MathOptInterface.ScalarCoefficientChange{Float64}(MOI.VariableIndex(-1), 0.0)" *
         " contains variables bridged into a function with nonzero constant."
     err = MOI.ModifyObjectiveNotAllowed(change, message)
     @test_throws err MOI.modify(bridged_mock, attr, change)

test/Utilities/print.jl

@@ -695,6 +695,9 @@ function test_default_printing()
     end
     @test sprint(show, MIME("text/plain"), x) == "MOI.VariableIndex(1)"
     @test sprint(show, MIME("text/latex"), x) == "v_{1}"
+    for f in (x, aff)
+        @test sprint(show, f) == sprint(show, MIME("text/plain"), f)
+    end
     return
 end
 

test/errors.jl

@@ -126,24 +126,22 @@ function test_errors_DeleteNotAllowed()
         MOI.delete(model, vi)
     catch err
         @test sprint(showerror, err) ==
-              "MathOptInterface.DeleteNotAllowed{MathOptInterface.VariableIndex}:" *
-              " Deleting the index MathOptInterface.VariableIndex(1) cannot be" *
-              " performed. You may want to use a `CachingOptimizer` in" *
-              " `AUTOMATIC` mode or you may need to call `reset_optimizer`" *
-              " before doing this operation if the `CachingOptimizer` is in" *
-              " `MANUAL` mode."
+              "$(MOI.DeleteNotAllowed{typeof(vi)}): Deleting the index $vi " *
+              "cannot be performed. You may want to use a `CachingOptimizer` " *
+              "in `AUTOMATIC` mode or you may need to call `reset_optimizer` " *
+              "before doing this operation if the `CachingOptimizer` is in " *
+              "`MANUAL` mode."
     end
     @test_throws MOI.DeleteNotAllowed{typeof(ci)} MOI.delete(model, ci)
     try
         MOI.delete(model, ci)
     catch err
         @test sprint(showerror, err) ==
-              "$(MOI.DeleteNotAllowed{MOI.ConstraintIndex{MOI.VariableIndex,MOI.EqualTo{Float64}}}):" *
-              " Deleting the index $(MOI.ConstraintIndex{MOI.VariableIndex,MOI.EqualTo{Float64}}(1))" *
-              " cannot be performed. You may want to use a `CachingOptimizer`" *
-              " in `AUTOMATIC` mode or you may need to call `reset_optimizer`" *
-              " before doing this operation if the `CachingOptimizer` is in" *
-              " `MANUAL` mode."
+              "$(MOI.DeleteNotAllowed{typeof(ci)}): Deleting the index $ci " *
+              "cannot be performed. You may want to use a `CachingOptimizer` " *
+              "in `AUTOMATIC` mode or you may need to call `reset_optimizer` " *
+              "before doing this operation if the `CachingOptimizer` is in " *
+              "`MANUAL` mode."
     end
     return
 end