Reference

mgtoolkit API

class mgtoolkit.library.ConditionalMetagraph(variables_set, propositions_set)

Represents a conditional metagraph that is instantiated using a set of variables and a set of propositions.

add_edges_from(edge_list)

Adds the given list of edges to the conditional metagraph. :param edge_list: list of Edge objects :return: None

edge_attributes_conflict(potential_conflicts_set, intersecting_attr_set)

Checks if given edge attributes conflict. :param potential_conflicts_set: set :return: boolean

static get_actions(attributes)

Filters the given list of attributes and returns a list of action-attribute values. :param attributes: list :return: list of strings

get_all_metapaths()

Retrieves all metapaths in the conditional metagraph. :return: List of Metapath objects

get_all_metapaths_from(source, target, prop_subset=None)

Retrieves all metapaths between given source and target in the conditional metagraph. :param source: set :param target: set :return: list of Metapath objects

get_context(true_propositions, false_propositions)

Retrieves the context metagraph for the given true and false propositions. :param true_propositions: set :param false_propositions: set :return: ConditionalMetagraph object

get_projection(variables_subset)

Gets the conditional metagraph projection for a subset of its variable set. :param variables_subset: set :return: Metagraph object

has_conflicts(metapath)

Checks whether the given metapath has any conflicts. :param metapath: Metapath object :return: boolean

has_redundancies(metapath)

Checks if given metapath has redundancies. :param metapath: Metapath object :return: boolean

is_connected(source, target, logical_expressions, interpretations)

Checks if subset1 is connected to subset2. :param source: set :param target: set :param logical_expressions: list of strings :param interpretations: lists of tuples :return: boolean

is_fully_connected(source, target, logical_expressions, interpretations)

Checks if subset1 is fully connected to subset2. :param source: set :param target: set :param logical_expressions: list of strings :param interpretations: lists of tuples :return: boolean

is_non_redundant(logical_expressions, interpretations)

Checks if a conditional metagraph is non redundant. :param logical_expressions: list of strings :param interpretations: lists of tuples :return: boolean

is_redundantly_connected(source, target, logical_expressions, interpretations)

Checks if subset1 is non-redundantly connected to subset2. :param source: set :param target: set :param logical_expressions: list of strings :param interpretations: lists of tuples :return: boolean

class mgtoolkit.library.Edge(invertex, outvertex, attributes=None, label=None)

Represents a metagraph edge.

invertex()

Returns the invertex of the edge. :return: set

label()

Returns the label of the edge. :return: string

outvertex()

Returns the outvertex of the edge. :return: set

class mgtoolkit.library.Metagraph(generator_set)

Represents a metagraph.

add_edge(edge)

Adds the given edge to the metagraph. :param edge: Edge object :return: None

add_edges_from(edge_list)

Adds the given list of edges to the metagraph. :param edge_list: list of Edge objects :return: None

add_metagraph(metagraph2)

Adds the given metagraph to current and returns the composed result. :param metagraph2: Metagraph object :return: Metagraph object

add_node(node)

Adds a node to the metagraph. :param node: Node object :return: None

add_nodes_from(nodes_list)

Adds nodes from the given list to the metagraph. :param nodes_list: list of Node objects :return: None

adjacency_matrix()

Returns the adjacency matrix of the metagraph. :return: numpy.matrix

adjacency_matrix_old()

Returns the adjacency matrix of the metagraph. :return: numpy.matrix

dominates(metagraph2)

Checks if the metagraph dominates that provided. :param metagraph2: Metagraph object :return: boolean

edges()

Returns a list of metagraph edges. :return: list of Edge objects.

equivalent(metagraph2)

Checks if current metagraph is equivalent to the metagraph provided. :param metagraph2: Metagraph object :return: boolean

get_all_metapaths_from(source, target)

Retrieves all metapaths between given source and target in the metagraph. :param source: set :param target: set :return: list of Metapath objects

get_closure()

Returns the closure matrix (i.e., A*) of the metagraph. :return: numpy.matrix

static get_coinputs(edge, x_i)

Returns the set of co-inputs for element x_i in the given edge. :param edge: Edge object :param x_i: invertex element :return: set

static get_cooutputs(edge, x_j)

Returns the set of co-outputs for element x_j in the given edge. :param edge: Edge object :param x_j: outvertex element :return: set

get_edges(invertex, outvertex)

Retrieves all edges between a given invertex and outvertex. :param invertex: set :param outvertex: set :return: list of Edge objects.

get_efm(generator_subset)

Gets the element-flow metagraph. :param generator_subset: set :return: Metagraph object

get_inverse()

Gets the inverse metagraph. :return: Metagraph object

get_minimal_cutset(source, target)

Retrieves the minimal cutset between a given source and target. :param source: set :param target: set :return: list of Edge objects

get_projection(generator_subset)

Gets the metagraph projection for a subset of the generating set. :param generator_subset: set :return: Metagraph object

incidence_matrix()

Gets the metagraph projection for a subset of the generating set. :return: numpy.matrix

is_bridge(edge_list, source, target)

Checks if a given edge list forms a bridge between a source and a target. :param edge_list: list of Edge objects :param source: set :param target: set :return: boolean

is_cutset(edge_list, source, target)

Checks if an edge list is a cutset between a given source and target. :param edge_list: list of Edge objects :param source: set :param target: set :return: boolean

is_dominant_metapath(metapath)

Checks if the given metapath is a dominant metapath. :param metapath: Metapath object :return: boolean

is_edge_dominant_metapath(metapath)

Checks if the given metapath is an edge-dominant metapath. :param metapath: Metapath object :return: boolean

is_input_dominant_metapath(metapath)

Checks if the given metapath is an input-dominant metapath. :param metapath: Metapath object :return: boolean

is_metapath(metapath_candidate)

Checks if the given candidate is a metapath. :param metapath_candidate: Metapath object :return: boolean

is_redundant_edge(edge, metapath, source, target)

Checks if the given edge is redundant for the given metapath. :param edge: Edge object :param metapath: Metapath object :param source: set :param target: set :return: boolean

multiply_metagraph(metagraph2)

Multiplies the metagraph with that provided and returns the result. :param metagraph2: Metagraph object :return: Metagraph object

nodes()

Returns a list of metagraph nodes. :return: list of Node objects

remove_edge(edge)

Removes the given edge from the metagraph. :param edge: Edge object :return:None

remove_edges_from(edge_list)

Removes edges from the given list from the metagraph. :param edge_list: list of Edge objects :return: None

remove_node(node)

Removes a specified node from the metagraph. :param node: Node object :return: None

remove_nodes_from(nodes_list)

Removes nodes from the given list from the metagraph. :param nodes_list: list of Node objects :return: None

class mgtoolkit.library.Metapath(source, target, edge_list)

Represents a metapath between a source and a target node in a metagraph.

dominates(metapath)

Checks whether current metapath dominates that provided. :param metapath: Metapath object :return: boolean

edge_list()

Returns the list of edges of the metapath. :return: set

source()

Returns the source of the metapath. :return: set

target()

Returns the target of the metapath. :return: set

class mgtoolkit.library.Node(element_set)

Represents a metagraph node.

get_element_set()

Returns the node elements :return: set

class mgtoolkit.library.Triple(coinputs, cooutputs, edges)

Captures a set of co-inputs, co-outputs and edges between two metagraph elements.

coinputs()

The co-inputs of the Triple object :return: set

cooutputs()

The co-outputs of the Triple object :return: set

edges()

The edges of the Triple object :return: set

mgtoolkit.library.singleton(cls)

A helper function to ease implementing singletons. This should be used as a decorator to the class that should be a singleton. :param cls: class that should be a singleton :return: singleton instance of the class