JunctionTree

class otagrum.JunctionTree(jt, names)

JunctionTree interface.

Parameters:
jt : pyAgrum.CliqueGraph

Junction tree

names : sequence of str

Node names

Methods

getClassName(self) Accessor to the object’s name.
getClique(self, nod) Clique accessor
getCliquesCollection(self) Cliques accessor
getDescription(self) Size accessor
getEdges(self) Edges accessor
getMarginal(self, indices) Marginal tree accessor
getNeighbours(self, id) Neighbours accessor
getNodes(self) Nodes accessor
getSeparator(self, edge) Separator accessor
getSeparatorsCollection(self) Separators accessor
getSize(self) Size accessor
__init__(self, jt, names)

x.__init__(…) initializes x; see help(type(x)) for signature

getClassName(self)

Accessor to the object’s name.

Returns:
class_name : str

The object class name (object.__class__.__name__).

getClique(self, nod)

Clique accessor

Parameters:
node : int

Node associated to the desired clique

Returns:
clique : openturns.Indices

Clique associated to the desired node

getCliquesCollection(self)

Cliques accessor

Returns:
cliques : sequence of openturns.Indices

List of cliques

getDescription(self)

Size accessor

Returns:
names : sequence of str

Node names

getEdges(self)

Edges accessor

Returns:
edges : pyAgrum.EdgeSet

List of edges

getMarginal(self, indices)

Marginal tree accessor

Parameters:
nodes : openturns.Indices

Nodes list

Returns:
marginal : JunctionTree

Marginal junction tree

getNeighbours(self, id)

Neighbours accessor

Parameters:
node : int

Node associated to the desired neighbours

Returns:
neighbours : pyAgrum.NodeSet

Neighbours associated to the desired node

getNodes(self)

Nodes accessor

Returns:
nodes : pyAgrum.NodeSet

List of nodes

getSeparator(self, edge)

Separator accessor

Parameters:
edge : pyAgrum.Edge

Arc associated to the desired clique

Returns:
separator : openturns.Indices

Separator associated to the desired arc

getSeparatorsCollection(self)

Separators accessor

Returns:
separators : sequence of openturns.Indices

List of separators

getSize(self)

Size accessor

Returns:
size : int

Number of nodes in the tree