Merge branch 'master' into fix_documenter

.github/workflows/CI.yml

@@ -0,0 +1,31 @@
+name: CI
+on:
+  push:
+    branches:
+      - master
+    tags: '*'
+  pull_request:
+jobs:
+  test:
+    name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        version:
+          - '1.6'
+        os:
+          - ubuntu-latest
+          - macOS-latest
+          - windows-latest
+        arch:
+          - x64
+    steps:
+      - uses: actions/checkout@v1
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: ${{ matrix.version }}
+          arch: ${{ matrix.arch }}
+      - uses: julia-actions/julia-runtest@latest
+      - uses: julia-actions/julia-uploadcodecov@latest
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

README.md

@@ -45,10 +45,10 @@ data = gdp_data(model)
 
 ## Logical Variables
 
-Logical variables are JuMP `AbstractVariable`s with two fields: `fix_value` and `start_value`. These can be optionally specified at variable creation. Logical variables are created with the `@variable` JuMP macro by adding the tag `LogicalVariable` as the last keyword argument. As with the regular `@variable` macro, variables can be named and indexed: 
+Logical variables are JuMP `AbstractVariable`s with two fields: `fix_value` and `start_value`. These can be optionally specified at variable creation. Logical variables are created with the `@variable` JuMP macro by adding the tag `Logical` as the last keyword argument. As with the regular `@variable` macro, variables can be named and indexed: 
 
 ```julia
-@variable(model, Y[1:3], LogicalVariable)
+@variable(model, Y[1:3], Logical)
 ```
 
 ## Logical Constraints
@@ -133,7 +133,7 @@ using DisjunctiveProgramming
 
 m = GDPModel()
 @variable(m, 0 ≤ x[1:2] ≤ 20)
-@variable(m, Y[1:2], LogicalVariable)
+@variable(m, Y[1:2], Logical)
 @constraint(m, [i = 1:2], [2,5][i] ≤ x[i] ≤ [6,9][i], DisjunctConstraint(Y[1]))
 @constraint(m, [i = 1:2], [8,10][i] ≤ x[i] ≤ [11,15][i], DisjunctConstraint(Y[2]))
 @disjunction(m, Y)

examples/ex1.jl

@@ -6,7 +6,7 @@ using HiGHS
 # Disjunction Method 1: Assign Logical Variables Explicitly
 m = GDPModel()
 @variable(m, -5 ≤ x ≤ 10)
-@variable(m, Y[1:2], LogicalVariable)
+@variable(m, Y[1:2], Logical)
 @constraint(m, 0 ≤ x ≤ 3, DisjunctConstraint(Y[1]))
 @constraint(m, 5 ≤ x, DisjunctConstraint(Y[2]))
 @constraint(m, x ≤ 9, DisjunctConstraint(Y[2]))

examples/ex2.jl

@@ -4,7 +4,7 @@ using HiGHS
 
 m = GDPModel(HiGHS.Optimizer)
 @variable(m, 0 ≤ x[1:2] ≤ 20)
-@variable(m, Y[1:2], LogicalVariable)
+@variable(m, Y[1:2], Logical)
 @constraint(m, [i = 1:2], [2,5][i] ≤ x[i] ≤ [6,9][i], DisjunctConstraint(Y[1]))
 @constraint(m, [i = 1:2], [8,10][i] ≤ x[i] ≤ [11,15][i], DisjunctConstraint(Y[2]))
 @disjunction(m, Y)

examples/ex3.jl

@@ -2,7 +2,7 @@ using DisjunctiveProgramming
 
 m = GDPModel()
 @variable(m, -5 ≤ x ≤ 10)
-@variable(m, Y[1:2], LogicalVariable)
+@variable(m, Y[1:2], Logical)
 @constraint(m, exp(x) <= 2, DisjunctConstraint(Y[1]))
 @constraint(m, x >= -3, DisjunctConstraint(Y[1]))
 @constraint(m, exp(x) >= 3, DisjunctConstraint(Y[2]))

examples/ex4.jl

@@ -5,7 +5,7 @@ using DisjunctiveProgramming
 # ¬((Y[1] ∧ ¬Y[2]) ⇔ (Y[3] ∨ Y[4]))
 
 m = GDPModel()
-@variable(m, Y[1:4], LogicalVariable)
+@variable(m, Y[1:4], Logical)
 @constraint(m, ¬((Y[1] ∧ ¬Y[2]) ⇔ (Y[3] ∨ Y[4])) ∈ IsTrue())
 reformulate_model(m, BigM())
 print(m)

examples/ex5.jl

@@ -4,8 +4,8 @@ using DisjunctiveProgramming
 ##
 m = GDPModel()
 @variable(m, 1 ≤ x[1:2] ≤ 9)
-@variable(m, Y[1:2], LogicalVariable)
-@variable(m, W[1:2], LogicalVariable)
+@variable(m, Y[1:2], Logical)
+@variable(m, W[1:2], Logical)
 @objective(m, Max, sum(x))
 @constraint(m, y1[i=1:2], [1,4][i] ≤ x[i] ≤ [3,6][i], DisjunctConstraint(Y[1]))
 @constraint(m, w1[i=1:2], [1,5][i] ≤ x[i] ≤ [2,6][i], DisjunctConstraint(W[1]))

examples/ex6.jl

@@ -4,22 +4,22 @@ using DisjunctiveProgramming
 m = GDPModel()
 @variable(m, -5 <= x[1:3] <= 5)
 
-@variable(m, y[1:2], LogicalVariable)
+@variable(m, y[1:2], Logical)
 @constraint(m, x[1] <= -2, DisjunctConstraint(y[1]))
 @constraint(m, x[1] >= 2, DisjunctConstraint(y[2]))
 @constraint(m, x[2] == -1, DisjunctConstraint(y[2]))
 @constraint(m, x[3] == 1, DisjunctConstraint(y[2]))
 @disjunction(m, y)
 @constraint(m, y in Exactly(1))
 
-@variable(m, w[1:2], LogicalVariable)
+@variable(m, w[1:2], Logical)
 @constraint(m, x[2] <= -3, DisjunctConstraint(w[1]))
 @constraint(m, x[2] >= 3, DisjunctConstraint(w[2]))
 @constraint(m, x[3] == 0, DisjunctConstraint(w[2]))
 @disjunction(m, w, DisjunctConstraint(y[1]))
 @constraint(m, w in Exactly(y[1]))
 
-@variable(m, z[1:2], LogicalVariable)
+@variable(m, z[1:2], Logical)
 @constraint(m, x[3] <= -4, DisjunctConstraint(z[1]))
 @constraint(m, x[3] >= 4, DisjunctConstraint(z[2]))
 @disjunction(m, z, DisjunctConstraint(w[1]))

src/datatypes.jl

@@ -16,6 +16,8 @@ struct LogicalVariable <: JuMP.AbstractVariable
     start_value::Union{Nothing, Bool}
 end
 
+const Logical = LogicalVariable
+
 """
     LogicalVariableData
 

src/variables.jl

@@ -40,7 +40,7 @@ end
                       name::String = "")::LogicalVariableRef
                 
 Extend `JuMP.add_variable` for [`LogicalVariable`](@ref)s. This 
-helps enable `@variable(model, [var_expr], LogicalVariable)`.
+helps enable `@variable(model, [var_expr], Logical)`.
 """
 function JuMP.add_variable(
     model::JuMP.Model, 

test/constraints/bigm.jl

@@ -19,7 +19,7 @@ end
 function test_get_M_1sided()
     model = GDPModel()
     @variable(model, x)
-    @variable(model, y, LogicalVariable)
+    @variable(model, y, Logical)
     @constraint(model, con, 3*x <= 1, DisjunctConstraint(y))
     cobj = constraint_object(con)
     M = DP._get_M(cobj.func, cobj.set, BigM(100, false))
@@ -30,7 +30,7 @@ end
 function test_get_tight_M_1sided()
     model = GDPModel()
     @variable(model, x)
-    @variable(model, y, LogicalVariable)
+    @variable(model, y, Logical)
     @constraint(model, con, 3*x <= 1, DisjunctConstraint(y))
     cobj = constraint_object(con)
 
@@ -53,7 +53,7 @@ end
 function test_get_M_2sided()
     model = GDPModel()
     @variable(model, x)
-    @variable(model, y, LogicalVariable)
+    @variable(model, y, Logical)
     @constraint(model, con, 3*x == 1, DisjunctConstraint(y))
     cobj = constraint_object(con)
 
@@ -69,7 +69,7 @@ end
 function test_get_tight_M_2sided()
     model = GDPModel()
     @variable(model, x)
-    @variable(model, y, LogicalVariable)
+    @variable(model, y, Logical)
     @constraint(model, con, 3*x == 1, DisjunctConstraint(y))
     cobj = constraint_object(con)
 
@@ -176,7 +176,7 @@ end
 function test_lessthan_bigm()
     model = GDPModel()
     @variable(model, x)
-    @variable(model, y, LogicalVariable)
+    @variable(model, y, Logical)
     @constraint(model, con, x <= 5, DisjunctConstraint(y))
 
     DP._reformulate_logical_variables(model)
@@ -190,7 +190,7 @@ end
 function test_nonpositives_bigm()
     model = GDPModel()
     @variable(model, x)
-    @variable(model, y, LogicalVariable)
+    @variable(model, y, Logical)
     @constraint(model, con, [x; x] <= [5; 5], DisjunctConstraint(y))
 
     DP._reformulate_logical_variables(model)
@@ -205,7 +205,7 @@ end
 function test_greaterhan_bigm()
     model = GDPModel()
     @variable(model, x)
-    @variable(model, y, LogicalVariable)
+    @variable(model, y, Logical)
     @constraint(model, con, x >= 5, DisjunctConstraint(y))
 
     DP._reformulate_logical_variables(model)
@@ -219,7 +219,7 @@ end
 function test_nonnegatives_bigm()
     model = GDPModel()
     @variable(model, x)
-    @variable(model, y, LogicalVariable)
+    @variable(model, y, Logical)
     @constraint(model, con, [x; x] >= [5; 5], DisjunctConstraint(y))
 
     DP._reformulate_logical_variables(model)
@@ -234,7 +234,7 @@ end
 function test_greaterhan_bigm()
     model = GDPModel()
     @variable(model, x)
-    @variable(model, y, LogicalVariable)
+    @variable(model, y, Logical)
     @constraint(model, con, x == 5, DisjunctConstraint(y))
 
     DP._reformulate_logical_variables(model)
@@ -250,7 +250,7 @@ end
 function test_greaterhan_bigm()
     model = GDPModel()
     @variable(model, x)
-    @variable(model, y, LogicalVariable)
+    @variable(model, y, Logical)
     @constraint(model, con, 5 <= x <= 5, DisjunctConstraint(y))
 
     DP._reformulate_logical_variables(model)
@@ -266,7 +266,7 @@ end
 function test_zeros_bigm()
     model = GDPModel()
     @variable(model, x)
-    @variable(model, y, LogicalVariable)
+    @variable(model, y, Logical)
     @constraint(model, con, [x; x] == [5; 5], DisjunctConstraint(y))
 
     DP._reformulate_logical_variables(model)
@@ -284,8 +284,8 @@ end
 function test_nested_bigm()
     model = GDPModel()
     @variable(model, -100 <= x <= 100)
-    @variable(model, y[1:2], LogicalVariable)
-    @variable(model, z[1:2], LogicalVariable)
+    @variable(model, y[1:2], Logical)
+    @variable(model, z[1:2], Logical)
     @constraint(model, x <= 5, DisjunctConstraint(y[1]))
     @constraint(model, x >= 5, DisjunctConstraint(y[2]))
     @disjunction(model, inner, y, DisjunctConstraint(z[1]))

test/constraints/disjunct.jl

@@ -1,18 +1,18 @@
 function test_disjunct_add_fail()
     model = GDPModel()
     @variable(model, x)
-    @variable(GDPModel(), y, LogicalVariable)
+    @variable(GDPModel(), y, Logical)
     @test_macro_throws UndefVarError @constraint(model, x == 1, DisjunctConstraint(y)) # logical variable from another model
 
-    @variable(model, w, LogicalVariable)
+    @variable(model, w, Logical)
     @variable(model, z, Bin)
     @test_macro_throws UndefVarError @constraint(model, z == 1, DisjunctConstraint(w)) # binary variable
 end
 
 function test_disjunct_add_success()
     model = GDPModel()
     @variable(model, x)
-    @variable(model, y, LogicalVariable)
+    @variable(model, y, Logical)
     c1 = @constraint(model, x == 1, DisjunctConstraint(y))
     @constraint(model, c2, x == 1, DisjunctConstraint(y))
     @test owner_model(c1) == model
@@ -34,7 +34,7 @@ end
 function test_disjunct_add_array()
     model = GDPModel()
     @variable(model, x)
-    @variable(model, y[1:2, 1:3], LogicalVariable)
+    @variable(model, y[1:2, 1:3], Logical)
     @constraint(model, con[i=1:2, j=1:3], x == 1, DisjunctConstraint(y[i,j]))
     @test con isa Matrix{DisjunctConstraintRef}
     @test length(con) == 6
@@ -45,7 +45,7 @@ function test_disjunct_add_dense_axis()
     @variable(model, x)
     I = ["a", "b", "c"]
     J = [1, 2]
-    @variable(model, y[I, J], LogicalVariable)
+    @variable(model, y[I, J], Logical)
     @constraint(model, con[i=I, j=J], x == 1, DisjunctConstraint(y[i,j]))
 
     @test con isa Containers.DenseAxisArray
@@ -57,7 +57,7 @@ end
 function test_disjunct_add_sparse_axis()
     model = GDPModel()
     @variable(model, x)
-    @variable(model, y[1:3, 1:3], LogicalVariable)
+    @variable(model, y[1:3, 1:3], Logical)
     @constraint(model, con[i=1:3, j=1:3; j > i], x==i+j, DisjunctConstraint(y[i,j]))
 
     @test con isa Containers.SparseAxisArray
@@ -69,7 +69,7 @@ end
 function test_disjunct_set_name()
     model = GDPModel()
     @variable(model, x)
-    @variable(model, y, LogicalVariable)
+    @variable(model, y, Logical)
     c1 = @constraint(model, x == 1, DisjunctConstraint(y))
     set_name(c1, "new name")
     @test name(c1) == "new name"
@@ -78,7 +78,7 @@ end
 function test_disjunct_delete()
     model = GDPModel()
     @variable(model, x)
-    @variable(model, y, LogicalVariable)
+    @variable(model, y, Logical)
     @constraint(model, c1, x == 1, DisjunctConstraint(y))
 
     @test_throws AssertionError delete(GDPModel(), c1)