Class ComponentConstraintGraph

• Defined in File TFCUtils.py

Class Documentation

class ComponentConstraintGraph

Creates a graph of all valid ways in which component constraints can be embedded.

Public Functions

__init__(self, list[str] N, list[ComponentConstraintDict] E)

Class constructor.

Parameters
----------
N : list[str]
    A list of strings that specify the node names. These node names typically coincide with
    the names of the dependent variables.
E : list[ComponentConstraintDict]
    The ComponentConstraintDict is a dictionary with the following fields:
    * name - Name of the component constraint.
    * node0 - The name of one of the nodes that makes up the component constraint.  Must correspond with an element of the list given in N.
    * node1 - The name of one of the nodes that makes up the component constraint.  Must correspond with an element of the list given in N.

SaveGraphs(self, Path outputDir, bool allGraphs=False, bool savePDFs=False)

Saves the graphs.
The graphs are saved in a clickable HTML structure. They can also be saved as PDFs.

Parameters
----------
outputDir : Path
    Output directory to save in.

allGraphs : bool, optional
     Boolean that conrols whether all graphs are saved or just valid graphs. (Default value = False)

savePDFs : bool, optional
     Boolean that controls whether the graphs are also saved as PDFs. (Default value = False)

Public Members

nNodes

nEdges

targets

goodTargets

N

E