GraphSignals

A indexing structure for accessing neighbors of a vertex.

FeaturedGraph(graph, node_feature, edge_feature, global_feature, mt, directed)

A feature-equipped graph structure for passing graph to layer in order to provide graph dynamically. References to graph or features are hold in this type.

Arguments

• graph: should be a adjacency matrix, SimpleGraph, SimpleDiGraph (from LightGraphs) or SimpleWeightedGraph,

SimpleWeightedDiGraph (from SimpleWeightedGraphs).

• node_feature: node features attached to graph.
• edge_feature: edge features attached to graph.
• gloabl_feature: gloabl graph features attached to graph.
• mask: mask for graph.
• mt: matrix type for graph in matrix form. if graph is in matrix form, mt is recorded as one of :adjm,

:laplacian, :normalized or :scaled. Otherwise, :nonmatrix is recorded.

• directed: the direction of graph. it is true for directed graph; it is false for undirected graph.

NullGraph()

Null object for FeaturedGraph.

adjacency_list(::AbstractFeaturedGraph)

Get adjacency list of graph.

adjacency_list(adj)

Transform a adjacency matrix into a adjacency list.

aggregate_index(ei; direction=:undirected, kind=:edge)

Generate index structure for scatter operation.

Arguments

• ei::EdgeIndex: The reference graph.
• direction::Symbol: The direction of an edge to be choose to aggregate. It must be one of :undirected, :inward and :outward.
• kind::Symbol: To aggregate feature upon edge or vertex. It must be one of :edge and :vertex.

edge_feature(::AbstractFeaturedGraph)

Get edge feature attached to graph.

edge_scatter(aggr, E, ei, direction=:undirected)

Scatter operation for aggregating edge feature into vertex feature.

Arguments

• aggr: aggregating operators, e.g. +.
• E: Edge features with size of (#feature, #edge).
• ei::EdgeIndex: The reference graph.
• direction::Symbol: The direction of an edge to be choose to aggregate. It must be one of :undirected, :inward and :outward.

fetch_graph(g1, g2)

Fetch graph from g1 or g2. If there is only one graph available, fetch that one. Otherwise, fetch the first one.

global_feature(::AbstractFeaturedGraph)

Get global feature attached to graph.

Support adjacency matrix

graph(::AbstractFeaturedGraph)

Get referenced graph.

has_edge_feature(::AbstractFeaturedGraph)

Check if edge feature is available or not.

has_global_feature(::AbstractFeaturedGraph)

Check if global feature is available or not.

has_graph(::AbstractFeaturedGraph)

Check if graph is available or not.

has_node_feature(::AbstractFeaturedGraph)

Check if node feature is available or not.

mask(fg, m)

A syntax sugar for masking graph.

Returns a GraphMask.

neighbor_scatter(aggr, X, ei, direction=:undirected)

Scatter operation for aggregating neighbor vertex feature together.

Arguments

• aggr: aggregating operators, e.g. +.
• X: Vertex features with size of (#feature, #vertex).
• ei::EdgeIndex: The reference graph.
• direction::Symbol: The direction of an edge to be choose to aggregate. It must be one of :undirected, :inward and :outward.

node_feature(::AbstractFeaturedGraph)

Get node feature attached to graph.

Order the edges in a graph by giving a unique integer to each edge.

ne(::AbstractFeaturedGraph)

Get edge number of graph.

nv(::AbstractFeaturedGraph)

Get node number of graph.