diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index a357dfc..ddce9c0 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.10.1","generation_timestamp":"2024-02-25T23:52:03","documenter_version":"1.2.1"}} \ No newline at end of file +{"documenter":{"julia_version":"1.10.1","generation_timestamp":"2024-02-26T00:45:43","documenter_version":"1.2.1"}} \ No newline at end of file diff --git a/dev/index.html b/dev/index.html index 65f3fc3..8d6ebbc 100644 --- a/dev/index.html +++ b/dev/index.html @@ -1,2 +1,2 @@ -Home · GraphOptInterface.jl
GitHub

GraphOptInterface

Documentation for GraphOptInterface.

GraphOptInterface.Edge — Type
Edge

An edge represents different types of coupling. For instance an Edge{Tuple{Node}} is an edge the couple variables within a single node. An Edge{Tuple{N,Node}} couple variables across one or more nodes.

source
GraphOptInterface.HyperMap — Type
HyperMap

A mapping from an OptiGraph to a graph view that supports various graph query functions. Currently supports a HyperGraph as the graph view.

source
GraphOptInterface.all_incident_edges — Method
all_incident_edges(hyper_map::HyperMap, nodes::Vector{Node})::Vector{Edge}

Return all of the edges within the optigraph in hyper_map that are incident to the vector of supplied nodes.

source
GraphOptInterface.all_neighbors — Method
all_neighbors(hyper_map::HyperMap, nodes::Vector{Node})::Vector{Node}

Return the neighbor nodes within the optigraph in hyper_map to the vector of supplied optigraph nodes.

source
GraphOptInterface.children_incident_edges — Method
children_incident_edges(hyper_map::HyperMap, graph::OptiGraph)::Vector{Edge}

Return all of the optigraph edges that are incident to the supplied graph that are strictly child connections.

source
GraphOptInterface.identify_edges — Method
identify_edges(hypergraph::HyperGraph,partitions::Vector{Vector{HyperNode}})

Identify both induced partition edges and cut edges given a partition of HyperNode vectors.

source
GraphOptInterface.identify_nodes — Method
identify_nodes(hypergraph::HyperGraph,partitions::Vector{Vector{HyperEdge}})

Identify both induced partition nodes and cut nodes given a partition of HyperEdge vectors.

source
GraphOptInterface.induced_edges — Method
induced_edges(hypergraph::HyperGraph,hypernodes::Vector{HyperNode})

Identify the induced hyperedges to a vector of HyperNodes.

NOTE: This currently does not support hypergraphs with unconnected nodes

source
GraphOptInterface.neighborhood — Method
neighborhood(g::HyperGraph,nodes::Vector{OptiNode},distance::Int64)

Retrieve the neighborhood within distance of nodes. Returns a vector of the original vertices and added vertices

source
GraphOptInterface.node_variables — Method
node_variables(edge::Edge)::Vector{Tuple{Node,MOI.VariableIndex}}

Return a vector of tuples where each tuple contains the node and variable index associated with each edge variable.

source
GraphOptInterface.non_parent_incident_edges — Method
non_parent_incident_edges(hyper_map::HyperMap, subgraph::OptiGraph)::Vector{Edge}

Return all of the optigraph edges that are incident to the supplied subgraph that are strictly not parent connections.

source
GraphOptInterface.non_parent_neighbors — Method
non_parent_neighbors(hyper_map::HyperMap, subgraph::OptiGraph)::Vector{Node}

Return the neighbor nodes in subgraph based on the optigraph in hyper_map that are not in the parent graph of `subgraph.

source
GraphOptInterface.parent_incident_edges — Method
parent_incident_edges(hyper_map::HyperMap, subgraph::OptiGraph)::Vector{Edge}

Return all of the optigraph edges that are incident to the supplied subgraph that are strictly parent connections.

source
GraphOptInterface.parent_neighbors — Method
parent_neighbors(hyper_map::HyperMap, subgraph::OptiGraph)::Vector{Node}

Return the neighbor nodes in subgraph based on the optigraph in hyper_map that are only in the parent graph of `subgraph.

source
Graphs.LinAlg.incidence_matrix — Method
Graphs.incidence_matrix(hypergraph::HyperGraph)

Obtain the incidence matrix representation of hypergraph. Rows correspond to vertices. Columns correspond to hyperedges. Returns a sparse matrix.

source
+Home · GraphOptInterface.jl
GitHub

GraphOptInterface

Documentation for GraphOptInterface.

GraphOptInterface.Edge — Type
Edge

An edge represents different types of coupling. For instance an Edge{Tuple{Node}} is an edge the couple variables within a single node. An Edge{Tuple{N,Node}} couple variables across one or more nodes.

source
GraphOptInterface.HyperMap — Type
HyperMap

A mapping from an OptiGraph to a graph view that supports various graph query functions. Currently supports a HyperGraph as the graph view.

source
GraphOptInterface.all_incident_edges — Method
all_incident_edges(hyper_map::HyperMap, nodes::Vector{Node})::Vector{Edge}

Return all of the edges within the optigraph in hyper_map that are incident to the vector of supplied nodes.

source
GraphOptInterface.all_neighbors — Method
all_neighbors(hyper_map::HyperMap, nodes::Vector{Node})::Vector{Node}

Return the neighbor nodes within the optigraph in hyper_map to the vector of supplied optigraph nodes.

source
GraphOptInterface.children_incident_edges — Method
children_incident_edges(hyper_map::HyperMap, graph::OptiGraph)::Vector{Edge}

Return all of the optigraph edges that are incident to the supplied graph that are strictly child connections.

source
GraphOptInterface.identify_edges — Method
identify_edges(hypergraph::HyperGraph,partitions::Vector{Vector{HyperNode}})

Identify both induced partition edges and cut edges given a partition of HyperNode vectors.

source
GraphOptInterface.identify_nodes — Method
identify_nodes(hypergraph::HyperGraph,partitions::Vector{Vector{HyperEdge}})

Identify both induced partition nodes and cut nodes given a partition of HyperEdge vectors.

source
GraphOptInterface.induced_edges — Method
induced_edges(hypergraph::HyperGraph,hypernodes::Vector{HyperNode})

Identify the induced hyperedges to a vector of HyperNodes.

NOTE: This currently does not support hypergraphs with unconnected nodes

source
GraphOptInterface.neighborhood — Method
neighborhood(g::HyperGraph,nodes::Vector{OptiNode},distance::Int64)

Retrieve the neighborhood within distance of nodes. Returns a vector of the original vertices and added vertices

source
GraphOptInterface.node_variables — Method
node_variables(edge::Edge)::Vector{Tuple{Node,MOI.VariableIndex}}

Return a vector of tuples where each tuple contains the node and variable index associated with each edge variable.

source
GraphOptInterface.non_parent_incident_edges — Method
non_parent_incident_edges(hyper_map::HyperMap, subgraph::OptiGraph)::Vector{Edge}

Return all of the optigraph edges that are incident to the supplied subgraph that are strictly not parent connections.

source
GraphOptInterface.non_parent_neighbors — Method
non_parent_neighbors(hyper_map::HyperMap, subgraph::OptiGraph)::Vector{Node}

Return the neighbor nodes in subgraph based on the optigraph in hyper_map that are not in the parent graph of `subgraph.

source
GraphOptInterface.parent_incident_edges — Method
parent_incident_edges(hyper_map::HyperMap, subgraph::OptiGraph)::Vector{Edge}

Return all of the optigraph edges that are incident to the supplied subgraph that are strictly parent connections.

source
GraphOptInterface.parent_neighbors — Method
parent_neighbors(hyper_map::HyperMap, subgraph::OptiGraph)::Vector{Node}

Return the neighbor nodes in subgraph based on the optigraph in hyper_map that are only in the parent graph of `subgraph.

source
Graphs.LinAlg.incidence_matrix — Method
Graphs.incidence_matrix(hypergraph::HyperGraph)

Obtain the incidence matrix representation of hypergraph. Rows correspond to vertices. Columns correspond to hyperedges. Returns a sparse matrix.

source