Skip to content

api.md

Latest commit

 

History

History
418 lines (259 loc) · 13 KB

api.md

File metadata and controls

418 lines (259 loc) · 13 KB

Summary

Members Descriptions
namespace litegraph LiteGraph namespace

namespace litegraph

Summary

Members Descriptions
enum dir_t direction type enum, can be [AtoB,BtoA,Both]
class litegraph::Edge example edge Class
class litegraph::Graph templated Graph class. Contains methods to generate and interact node-edges graphs.
class litegraph::Node example node Class

Members

enum dir_t

Values Descriptions
AtoB source to destination
BtoA destination to source
Both bidirectional

direction type enum, can be [AtoB,BtoA,Both]

class litegraph::Edge

example edge Class

Summary

Members Descriptions
public inline Edge(int val)
public inline virtual ~Edge()

Members

public inline Edge(int val)

public inline virtual ~Edge()

class litegraph::Graph

templated Graph class. Contains methods to generate and interact node-edges graphs.

Parameters

  • T node Class

  • E edge Class

Summary

Members Descriptions
public inline Graph() graph constructor
public inline ~Graph() graph distructor
public void add_nodes(int num) adds a number of generic nodes to the graph
public void add_node(const T & node) adds a node/vertex to the graph
public void add_node(const T & node,std::string name) adds a node/vertex to the graph
public void add_edge(int src,int dst,dir_t dir,const E & edge) adds an edge to the graph, in between two nodes
public void add_edge(std::string src,std::string dst,dir_t dir,const E & edge)
public void remove_edge(int A,int B) removes a previously added edge from the graph
public T & operator[](int node_id) node selection operator (by id)
public T operator[](int node_id) const node selection operator (by id)
public T & operator[](std::string node_name) node selection operator (by name)
public T operator[](std::string node_name) const node selection operator (by name)
public E & operator()(int src,int dst) edge selection operator (from node src to node dst)
public E operator()(int src,int dst) const edge operator (from node src to node dst)
public std::string name(int node_id) retrieves node name from its id
public int id(std::string node_name) retrieves node id from its name
public int size() retrives graph size (number of nodes)
public bool is_edge(int src,int dst) checks if an edge is present in between two nodes
public std::set< int > neighbors(int node_id) const returns a set of neighbouring (distance 1) nodes
public Matrix2D< int > seek_loops() check the walk matrices for graph loops
public bool has_loops(int node_id) checks if a specific node (or the graph in general) has loops
public void print_walk(int id) prints walk matrices
public void print_loops() prints loop matrix Node_id x Steps

Members

public inline Graph()

graph constructor

public inline ~Graph()

public void add_nodes(int num)

adds a number of generic nodes to the graph

Parameters

  • T node Class

  • E edge Class

Parameters

  • num number of nodes to be added

Returns

void

public void add_node(const T & node)

adds a node/vertex to the graph

Parameters

  • T node Class

  • E edge Class

Parameters

  • node [optional] node class instance to associate with vertex

Returns

void

public void add_node(const T & node,std::string name)

adds a node/vertex to the graph

Parameters

  • T node Class

  • E edge Class

Parameters

  • node [optional] node class instance to associate with vertex

  • name node name

Returns

void

public void add_edge(int src,int dst,dir_t dir,const E & edge)

adds an edge to the graph, in between two nodes

Parameters

  • T node Class

  • E edge Class

Parameters

  • src source node id

  • dst destination node id

  • dir edge direction (src->dst by default) [member of dir_t enum]

  • edge [optional] edge Class instance to associate with link

Returns

void

public void add_edge(std::string src,std::string dst,dir_t dir,const E & edge)

public void remove_edge(int A,int B)

removes a previously added edge from the graph

Parameters

  • T node Class

  • E edge Class

Parameters

  • src source node id

  • dst dst node id

Returns

void

public T & operator[](int node_id)

node selection operator (by id)

Parameters

  • T node Class

  • E edge Class

Parameters

  • node_name node id

Returns

node Class instance (by reference)

public T operator[](int node_id) const

node selection operator (by id)

Parameters

  • T node Class

  • E edge Class

Parameters

  • node_name node id

Returns

node Class instance (by copy)

public T & operator[](std::string node_name)

node selection operator (by name)

Parameters

  • T node Class

  • E edge Class

Parameters

  • node_name node name

Returns

node Class instance (by reference)

public T operator[](std::string node_name) const

node selection operator (by name)

Parameters

  • T node Class

  • E edge Class

Parameters

  • node_name node name

Returns

node Class instance (by copy)

public E & operator()(int src,int dst)

edge selection operator (from node src to node dst)

Parameters

  • T node Class

  • E edge Class

Parameters

  • src source node

  • dst dest node

Returns

edge Class instance (by reference)

public E operator()(int src,int dst) const

edge operator (from node src to node dst)

Parameters

  • T node Class

  • E edge Class

Parameters

  • src source node

  • dst dest node

Returns

edge Class instance (by copy)

public std::string name(int node_id)

retrieves node name from its id

Parameters

  • T node Class

  • E edge Class

Parameters

  • node_id target node id

Returns

string node name

public int id(std::string node_name)

retrieves node id from its name

Parameters

  • T node Class

  • E edge Class

Parameters

  • node_name node name

Returns

int node id

public int size()

retrives graph size (number of nodes)

Parameters

  • T node Class

  • E edge Class

Returns

int nodes number

public bool is_edge(int src,int dst)

checks if an edge is present in between two nodes

Parameters

  • T node Class

  • E edge Class

Parameters

  • src source node id

  • dst destination node id

Returns

bool (is there an edge ?)

public std::set< int > neighbors(int node_id) const

returns a set of neighbouring (distance 1) nodes

Parameters

  • T node Class

  • E edge Class

Parameters

  • node_id target node id

Returns

set of node ids

public Matrix2D< int > seek_loops()

check the walk matrices for graph loops

Parameters

  • T node Class

  • E edge Class

Returns

loopMatrix

public bool has_loops(int node_id)

checks if a specific node (or the graph in general) has loops

Parameters

  • T node Class

  • E edge Class

Parameters

  • node_id target node

Returns

bool (node has loops?)

public void print_walk(int id)

prints walk matrices

Parameters

  • T node Class

  • E edge Class

Parameters

  • id step distance/level

Returns

void

public void print_loops()

prints loop matrix Node_id x Steps

Parameters

  • T node Class

  • E edge Class

Returns

void

class litegraph::Node

example node Class

Summary

Members Descriptions
public inline Node(int val)
public inline virtual ~Node()

Members

public inline Node(int val)

public inline virtual ~Node()

Generated by Moxygen