add Logical alias for Logical Variable. Closes #73

Author: hdavid16

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
@@ -134,7 +134,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

@@ -7,7 +7,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

@@ -5,7 +5,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

@@ -3,7 +3,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

@@ -6,7 +6,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

@@ -6,8 +6,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

@@ -5,22 +5,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/constraints.jl

@@ -419,7 +419,7 @@ To select exactly 1 logical variable `Y` to be `true`, do
 
 ```jldoctest
 julia> model = GDPModel();
-julia> @variable(model, Y[i = 1:2], LogicalVariable);
+julia> @variable(model, Y[i = 1:2], Logical);
 julia> @constraint(model, [Y[1], Y[2]] in Exactly(1));
 ```
 

src/datatypes.jl

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

src/macros.jl

@@ -292,7 +292,7 @@ julia> @variable(model, w);
 
 julia> @variable(model, x);
 
-julia> @variable(model, Y[1:4], LogicalVariable);
+julia> @variable(model, Y[1:4], Logical);
 
 julia> @constraint(model, [i=1:2], w == i, DisjunctConstraint(Y[i]));