Merge pull request #1 from Robbybp/no-submodule

Stop using submodules

Author: Robbybp

docs/src/reference/get_equality.md

@@ -1,12 +1,11 @@
-# GetEquality
+# Identifying equality constraints
 
 ```@meta
 CurrentModule = JuMPIn
 ```
 
 ```@docs
-GetEquality
-GetEquality.get_equality_constraints
-GetEquality.is_equality
-GetEquality.set_implies_equality
+get_equality_constraints
+is_equality
+set_implies_equality
 ```

docs/src/reference/identify_variables.md

@@ -1,11 +1,10 @@
-# IdentifyVariables
+# Identifying variables in constraints
 
 ```@meta
 CurrentModule = JuMPIn
 ```
 
 ```@docs
-IdentifyVariables
-IdentifyVariables.identify_unique_variables
-IdentifyVariables._get_variable_terms
+identify_unique_variables
+_get_variable_terms
 ```

docs/src/reference/incidence_graph.md

@@ -1,10 +1,9 @@
-# IncidenceGraph
+# Incidence graph
 
 ```@meta
 CurrentModule = JuMPIn
 ```
 
 ```@docs
-IncidenceGraph
-IncidenceGraph.get_bipartite_incidence_graph
+get_bipartite_incidence_graph
 ```

docs/src/reference/interface.md

@@ -1,13 +1,12 @@
-# Interface
+# Algorithm interfaces
 
 ```@meta
 CurrentModule = JuMPIn
 ```
 
 ```@docs
-Interface
-Interface.IncidenceGraphInterface
-Interface.get_adjacent
-Interface.maximum_matching
-Interface.dulmage_mendelsohn
+IncidenceGraphInterface
+get_adjacent
+maximum_matching
+dulmage_mendelsohn
 ```

src/JuMPIn.jl

@@ -18,25 +18,19 @@
 #  ___________________________________________________________________________
 
 module JuMPIn
-# TODO: Explicitly export functions?
-
-# Methods to identify variables
-include("identify_variables.jl") # IdentifyVariables
-identify_unique_variables = IdentifyVariables.identify_unique_variables
 
 # Methods to identify equality constraints
-include("get_equality.jl") # GetEquality
-get_equality_constraints = GetEquality.get_equality_constraints
+include("get_equality.jl")
+
+# Methods to identify variables
+include("identify_variables.jl")
 
 # Methods to get the incidence graph of constraints and variables
-include("incidence_graph.jl") # IncidenceGraph
-get_bipartite_incidence_graph = IncidenceGraph.get_bipartite_incidence_graph
+include("incidence_graph.jl")
 
 # Methods to apply graph algorithms to JuMP models
-include("interface.jl") # Interface
-IncidenceGraphInterface = Interface.IncidenceGraphInterface
-get_adjacent = Interface.get_adjacent
-maximum_matching = Interface.maximum_matching
-dulmage_mendelsohn = Interface.dulmage_mendelsohn
+include("maximum_matching.jl")
+include("dulmage_mendelsohn.jl")
+include("interface.jl")
 
 end

src/dulmage_mendelsohn.jl

@@ -17,11 +17,9 @@
 #  This software is distributed under the 3-clause BSD license.
 #  ___________________________________________________________________________
 
-module DulmageMendelsohn
-
 import Graphs as gjl
-include("maximum_matching.jl") # MaximumMatching
-using .MaximumMatching: _is_valid_bipartition, maximum_matching
+
+import JuMPIn: maximum_matching, _is_valid_bipartition
 
 
 """
@@ -155,5 +153,3 @@ function dulmage_mendelsohn(graph::gjl.Graph, set1::Set)
         other2,
     ))
 end
-
-end

src/get_equality.jl

@@ -21,50 +21,50 @@
 Utility functions for identifying JuMP constraints that define equalities.
 
 """
-module GetEquality
-import JuMP as jmp
-import MathOptInterface as moi
-
-function get_set_of_constraint(
-    model::jmp.Model,
-    constraint::jmp.ConstraintRef,
-    index::moi.ConstraintIndex,
+
+import JuMP
+import MathOptInterface as MOI
+
+function _get_set_of_constraint(
+    model::JuMP.Model,
+    constraint::JuMP.ConstraintRef,
+    index::MOI.ConstraintIndex,
 )
-    set = moi.get(model, moi.ConstraintSet(), constraint)
+    set = MOI.get(model, MOI.ConstraintSet(), constraint)
     return set
 end
 
-function get_set_of_constraint(
-    model::jmp.Model,
-    constraint::jmp.ConstraintRef,
-    index::moi.Nonlinear.ConstraintIndex,
+function _get_set_of_constraint(
+    model::JuMP.Model,
+    constraint::JuMP.ConstraintRef,
+    index::MOI.Nonlinear.ConstraintIndex,
 )
     nl_con = model.nlp_model.constraints[index]
     return nl_con.set
 end
 
-function set_implies_equality(set::moi.EqualTo)::Bool
+function set_implies_equality(set::MOI.EqualTo)::Bool
     return true
 end
 
 # Q: How does Julia determine if an argument has the right type.
 # I.e. why is this interpreted as "set must be a subtype of Union(...)"
 # rather than "set must be an 'instance' of Union()".
 #function set_implies_equality(
-#    set::Union{moi.GreaterThan, moi.LessThan},
+#    set::Union{MOI.GreaterThan, MOI.LessThan},
 #    # Note that ^this works, but this doesn't
-#    # set::Type{<:Union{moi.GreaterThan, moi.LessThan}},
+#    # set::Type{<:Union{MOI.GreaterThan, MOI.LessThan}},
 #)::Bool
 #    return false
 #end
 
-function set_implies_equality(set::T)::Bool where T<:moi.AbstractVectorSet
-    throw(TypeError(set, moi.AbstractScalarSet, typeof(set)))
+function set_implies_equality(set::T)::Bool where T<:MOI.AbstractVectorSet
+    throw(TypeError(set, MOI.AbstractScalarSet, typeof(set)))
 end
 
 # NOTE: Have not implemented tolerance arg in any calling function yet.
 function set_implies_equality(
-    set::moi.Interval,
+    set::MOI.Interval,
     tolerance::Float64=Float64(0)
 )::Bool
     return abs(set.upper - set.lower) <= tolerance
@@ -75,9 +75,9 @@ end
 #
 # I intend this to catch anything that is a subtype of ConstraintSet.
 # Is the "subtype syntax" necessary?
-# It appears, e.g., moi.GreaterThan is not a subtype of moi.ConstraintSet.
+# It appears, e.g., MOI.GreaterThan is not a subtype of MOI.ConstraintSet.
 # This is non-intuitive for me...
-# So this won't catch arbitrary moi Sets...
+# So this won't catch arbitrary MOI Sets...
 # The right type to use is actually AbstractSet?
 # Nope. This doesn't catch GreatherThan/LessThan
 # ^ Wrong. Actually it does, but my syntax was wrong. I guess providing
@@ -103,7 +103,7 @@ types of constraints in [`is_equality`](@ref) and
 """
 function set_implies_equality(
     set::T
-)::Bool where T<:moi.AbstractSet
+)::Bool where T<:MOI.AbstractSet
     return false
 end
 
@@ -113,17 +113,17 @@ end
 Detect whether a constraint is an equality constraint.
 
 """
-function is_equality(constraint::jmp.ConstraintRef)::Bool
+function is_equality(constraint::JuMP.ConstraintRef)::Bool
     model = constraint.model
     index = constraint.index
-    set = get_set_of_constraint(model, constraint, index)
+    set = _get_set_of_constraint(model, constraint, index)
     return set_implies_equality(set)
 end
 
 function get_equality_constraints(
-    constraints::Vector{jmp.ConstraintRef}
-)::Vector{jmp.ConstraintRef}
-    eq_cons = Vector{jmp.ConstraintRef}()
+    constraints::Vector{JuMP.ConstraintRef}
+)::Vector{JuMP.ConstraintRef}
+    eq_cons = Vector{JuMP.ConstraintRef}()
     for con in constraints
         if is_equality(con)
             push!(eq_cons, con)
@@ -137,8 +137,6 @@ end
 
 Return a vector of equality constraints in the provided model.
 
-This function is also accessible via the `JuMPIn` module.
-
 # Example
 ```julia-repl
 julia> using JuMP
@@ -153,12 +151,10 @@ julia> display(eq_cons)
 ```
 
 """
-function get_equality_constraints(model::jmp.Model)::Vector{jmp.ConstraintRef}
-    constraints = jmp.all_constraints(
+function get_equality_constraints(model::JuMP.Model)::Vector{JuMP.ConstraintRef}
+    constraints = JuMP.all_constraints(
         model,
         include_variable_in_set_constraints=false,
     )
     return get_equality_constraints(constraints)
 end
-
-end # module get_equality