Replaced gensym with UUIDs

Author: dlcole3

Project.toml

@@ -18,6 +18,7 @@ Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
 Requires = "ae029012-a4dd-5104-9daa-d747884805df"
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+UUIDs = "cf7118a7-6976-5b1a-9a39-7adc72f591a4"
 
 [compat]
 Graphs = "1"

src/Plasmo.jl

@@ -17,6 +17,7 @@ using Graphs
 using Printf
 using Distributed
 using DistributedArrays
+using UUIDs
 
 using MathOptInterface
 const MOI = MathOptInterface

src/aggregate.jl

@@ -67,15 +67,15 @@ end
 ### Aggregate Functions
 
 """
-    aggregate(graph::OptiGraph; name=gensym())
+    aggregate(graph::OptiGraph; name=Symbol(UUIDs.uuid4()))
 
 Aggregate an optigraph into a graph containing a single optinode. An optional 
 `name` can be used to name the new optigraph.
 Returns the new optinode (which points to a new graph with `source_graph(node)`) and a 
 mapping from the original graph variables and constraints to the new node variables and 
 constraints.
 """
-function aggregate(graph::OptiGraph; name=gensym())
+function aggregate(graph::OptiGraph; name=Symbol(UUIDs.uuid4()))
     # aggregate into a graph containing a single optinode
     new_graph = OptiGraph(; name=name)
     new_node, ref_map = _copy_graph_elements_to!(new_graph, graph)
@@ -388,7 +388,7 @@ how many levels of subgraphs remain in the new aggregated optigraph. For example
 Return a new aggregated optigraph and reference map that maps elements from the old 
 optigraph to the new aggregate optigraph.
 """
-function aggregate_to_depth(graph::OptiGraph, max_depth::Int64=0; name=gensym())
+function aggregate_to_depth(graph::OptiGraph, max_depth::Int64=0; name=Symbol(UUIDs.uuid4()))
     if num_subgraphs(graph) == 0
         error("`aggregate_to_depth` requires the graph to contain subgraphs.")
     end

src/backends/moi_backend.jl

@@ -357,7 +357,7 @@ end
 function MOI.set(
     backend::GraphMOIBackend, attr::MOI.UserDefinedFunction, node::OptiNode, args...
 )
-    registered_name = Symbol(gensym(), node.label, ".", attr.name)
+    registered_name = Symbol(Symbol(UUIDs.uuid4()), node.label, ".", attr.name)
     MOI.set(
         backend.moi_backend, MOI.UserDefinedFunction(registered_name, attr.arity), args...
     )
@@ -367,7 +367,7 @@ end
 
 # TODO: set operator on graph directly
 function MOI.set(backend::GraphMOIBackend, attr::MOI.UserDefinedFunction, args...)
-    registered_name = Symbol(gensym(), backend.optigraph.label, ".", attr.name)
+    registered_name = Symbol(Symbol(UUIDs.uuid4()), backend.optigraph.label, ".", attr.name)
     MOI.set(
         backend.moi_backend, MOI.UserDefinedFunction(registered_name, attr.arity), args...
     )

src/distributed/core_types.jl

@@ -199,11 +199,11 @@ const RemoteOptiRef = Union{
 A constructor function for building a RemoteOptiGraph. The actual optigraph object of the
 RemoteOptiGraph object is stored on the worker `worker`. A name can be passed as a keyword argument
 """
-function RemoteOptiGraph(; name::Symbol=Symbol(:rg, gensym()), worker::Int=1)
+function RemoteOptiGraph(; name::Symbol=Symbol(:rg, Symbol(UUIDs.uuid4())), worker::Int=1)
     if !(worker in procs())
         error("The provided worker $worker is not in existing workers: $(procs())")
     end
-    darray = distribute([OptiGraph(name=name)], procs=[worker]) #gensym may not return a symbol that is unique on the worker...
+    darray = distribute([OptiGraph(name=name)], procs=[worker])
     rgraph = RemoteOptiGraph(
         worker, 
         darray, 

src/distributed/optinode.jl

@@ -82,9 +82,7 @@ function add_node(rgraph::RemoteOptiGraph)
 
     f = @spawnat wid begin
         lgraph = localpart(darray)[1]
-        # I think gensym is only unique to the worker, so we 
-        # tack on the worker id to ensure it is globally unique
-        n = add_node(lgraph; index=Symbol(gensym(), ".w$wid"))
+        n = add_node(lgraph; index=Symbol(UUIDs.uuid4()))
         _convert_local_to_proxy(lgraph, n)
     end
     pnode = fetch(f)

src/optigraph.jl

@@ -21,7 +21,7 @@ function _initialize_optigraph(name::Symbol)
     return graph
 end
 
-function OptiGraph(; name::Symbol=Symbol(:g, gensym()))
+function OptiGraph(; name::Symbol=Symbol(:g, Symbol(UUIDs.uuid4())))
     graph = _initialize_optigraph(name)
     # default is to use a CachingOptimizer backend
     graph.backend = cached_moi_backend(graph)
@@ -30,7 +30,7 @@ end
 
 function direct_moi_graph(
     backend::Union{MOI.ModelLike,MOI.OptimizerWithAttributes};
-    name::Symbol=Symbol(:g, gensym()),
+    name::Symbol=Symbol(:g, Symbol(UUIDs.uuid4())),
 )
     graph = _initialize_optigraph(name)
     graph.backend = direct_moi_backend(graph, backend)
@@ -49,7 +49,7 @@ function Base.string(graph::OptiGraph)
         %16s %9s %16s
         %16s %9s %16s
         """,
-        "$(name(graph))",
+        "",
         "#local elements",
         "#total elements",
         "Nodes:",
@@ -180,7 +180,7 @@ Add a new optinode to `graph`. By default, the node label is set to be "n<i+1>"
 the number of nodes in the graph.
 """
 function add_node(
-    graph::OptiGraph; label=Symbol(graph.label, Symbol(".n"), length(graph.optinodes) + 1), index = gensym()
+    graph::OptiGraph; label=Symbol(graph.label, Symbol(".n"), length(graph.optinodes) + 1), index = Symbol(UUIDs.uuid4())
 )
     node_index = NodeIndex(index)
     node = OptiNode(Ref(graph), node_index, Ref(label))
@@ -461,19 +461,19 @@ end
 # manage subgraphs
 
 """
-    add_subgraph(graph::OptiGraph; name::Symbol=Symbol(:sg,gensym()))
+    add_subgraph(graph::OptiGraph; name::Symbol=Symbol(:sg, Symbol(UUIDs.uuid4())))
 
 Create and add a new subgraph to the optigraph `graph`.
 """
-function add_subgraph(graph::OptiGraph; name::Symbol=Symbol(:sg, gensym()))
+function add_subgraph(graph::OptiGraph; name::Symbol=Symbol(:sg, Symbol(UUIDs.uuid4())))
     subgraph = OptiGraph(; name=name)
     subgraph.parent_graph = graph
     push!(graph.subgraphs, subgraph)
     return subgraph
 end
 
 """
-    add_subgraph(graph::OptiGraph; name::Symbol=Symbol(:sg,gensym()))
+    add_subgraph(graph::OptiGraph; name::Symbol=Symbol(:sg, Symbol(UUIDs.uuid4())))
 
 Add an existing subgraph to an optigraph. The subgraph cannot already be part of another
 optigraph. It also should not have nodes that already exist in the optigraph.