gum::JunctionTreeStrategy Class Reference

Base Class for all the algorithms producing a junction given a set of cliques/subcliques resulting from a triangulation. More...

#include <junctionTreeStrategy.h>

Inheritance diagram for gum::JunctionTreeStrategy:

Collaboration diagram for gum::JunctionTreeStrategy:

Public Member Functions
Accessors / Modifiers
virtual bool	requiresFillIns () const =0
	indicates whether the junction tree strategy needs fill-ins to work properly More...
virtual const CliqueGraph &	junctionTree ()=0
	returns the junction tree computed More...
virtual void	setTriangulation (StaticTriangulation *triangulation)=0
	assigns the triangulation to the junction tree strategy More...
virtual void	moveTriangulation (StaticTriangulation *triangulation)
	assigns a new triangulation to the junction tree strategy during a move construction More...
virtual const NodeProperty< NodeId > &	createdCliques ()=0
	returns, for each node, the clique of the junction tree which was created by its deletion More...
virtual NodeId	createdClique (const NodeId id)=0
	returns the Id of the clique of the junction tree created by the elimination of a given node during the triangulation process More...
virtual void	clear ()=0
	resets the current junction tree strategy data structures More...

Protected Attributes
StaticTriangulation *	triangulation_ {nullptr}
	the triangulation to which the junction tree is associated More...

Constructors / Destructors
virtual	~JunctionTreeStrategy ()
	destructor More...
virtual JunctionTreeStrategy *	newFactory () const =0
	create a clone not assigned to any triangulation algorithm More...
virtual JunctionTreeStrategy *	copyFactory (StaticTriangulation *triangulation=nullptr) const =0
	virtual copy constructor More...
	JunctionTreeStrategy ()
	default constructor More...
	JunctionTreeStrategy (const JunctionTreeStrategy &from)
	copy constructor More...
	JunctionTreeStrategy (JunctionTreeStrategy &&from)
	move constructor More...

Detailed Description

Base Class for all the algorithms producing a junction given a set of cliques/subcliques resulting from a triangulation.

Definition at line 47 of file junctionTreeStrategy.h.

Constructor & Destructor Documentation

~JunctionTreeStrategy()

gum::JunctionTreeStrategy::~JunctionTreeStrategy ( )

virtual

destructor

Definition at line 53 of file junctionTreeStrategy.cpp.

References gum::Set< Key, Alloc >::emplace().

                                              {
    // for debugging purposes
    GUM_DESTRUCTOR(JunctionTreeStrategy);
  }

Here is the call graph for this function:

JunctionTreeStrategy() [1/3]

gum::JunctionTreeStrategy::JunctionTreeStrategy ( )

protected

default constructor

Definition at line 34 of file junctionTreeStrategy.cpp.

References gum::Set< Key, Alloc >::emplace().

                                             {
    // for debugging purposes
    GUM_CONSTRUCTOR(JunctionTreeStrategy);
  }

Here is the call graph for this function:

JunctionTreeStrategy() [2/3]

gum::JunctionTreeStrategy::JunctionTreeStrategy ( const JunctionTreeStrategy &  from )

protected

copy constructor

Definition at line 40 of file junctionTreeStrategy.cpp.

References gum::Set< Key, Alloc >::emplace().

                                                                             :
      triangulation_(from.triangulation_) {   // for debugging purposes
    GUM_CONS_CPY(JunctionTreeStrategy);
  }

Here is the call graph for this function:

JunctionTreeStrategy() [3/3]

gum::JunctionTreeStrategy::JunctionTreeStrategy ( JunctionTreeStrategy &&  from )

protected

move constructor

Definition at line 46 of file junctionTreeStrategy.cpp.

References gum::Set< Key, Alloc >::emplace().

                                                                        :
      triangulation_(from.triangulation_) {
    // for debugging purposes
    GUM_CONS_MOV(JunctionTreeStrategy);
  }

Here is the call graph for this function:

Member Function Documentation

clear()

virtual void gum::JunctionTreeStrategy::clear ( )

pure virtual

resets the current junction tree strategy data structures

Implemented in gum::DefaultJunctionTreeStrategy.

copyFactory()

virtual JunctionTreeStrategy* gum::JunctionTreeStrategy::copyFactory ( StaticTriangulation *  triangulation = nullptr ) const

pure virtual

virtual copy constructor

Parameters

triangulation

if triangulation is different from nullptr, this becomes the new triangulation algorithm associated with the junction tree strategy

Implemented in gum::DefaultJunctionTreeStrategy.

createdClique()

virtual NodeId gum::JunctionTreeStrategy::createdClique ( const NodeId  id )

pure virtual

returns the Id of the clique of the junction tree created by the elimination of a given node during the triangulation process

Implemented in gum::DefaultJunctionTreeStrategy.

createdCliques()

virtual const NodeProperty< NodeId >& gum::JunctionTreeStrategy::createdCliques ( )

pure virtual

returns, for each node, the clique of the junction tree which was created by its deletion

Implemented in gum::DefaultJunctionTreeStrategy.

junctionTree()

virtual const CliqueGraph& gum::JunctionTreeStrategy::junctionTree ( )

pure virtual

returns the junction tree computed

The idea behind this method is that the JunctionTreeStrategy asks its assigned triangulation (see method setTriangulation) all the data it needs to compute correctly the junction tree. For instance, it may asks for a triangulated graph or an elimination tree, or even the order of elimination of the nodes, etc. All these data are available from the triangulation class. Knowing these data, the junctionTreeStrategy computes and returns a junction tree corresponding to the triangulated graph.

Implemented in gum::DefaultJunctionTreeStrategy.

moveTriangulation()

void gum::JunctionTreeStrategy::moveTriangulation ( StaticTriangulation *  triangulation )

virtual

assigns a new triangulation to the junction tree strategy during a move construction

Definition at line 60 of file junctionTreeStrategy.cpp.

References gum::Set< Key, Alloc >::emplace().

                                                                                 {
    triangulation_ = triangulation;
  }

Here is the call graph for this function:

newFactory()

virtual JunctionTreeStrategy* gum::JunctionTreeStrategy::newFactory ( ) const

pure virtual

create a clone not assigned to any triangulation algorithm

Implemented in gum::DefaultJunctionTreeStrategy.

requiresFillIns()

virtual bool gum::JunctionTreeStrategy::requiresFillIns ( ) const

pure virtual

indicates whether the junction tree strategy needs fill-ins to work properly

If the junctionTreeStrategy needs fill-ins to work properly, its assigned triangulation instance (see method setTriangulation) will be commited to compute them.

Implemented in gum::DefaultJunctionTreeStrategy.

setTriangulation()

virtual void gum::JunctionTreeStrategy::setTriangulation ( StaticTriangulation *  triangulation )

pure virtual

assigns the triangulation to the junction tree strategy

Implemented in gum::DefaultJunctionTreeStrategy.

Member Data Documentation

triangulation_

StaticTriangulation* gum::JunctionTreeStrategy::triangulation_ {nullptr}

protected

the triangulation to which the junction tree is associated

Definition at line 117 of file junctionTreeStrategy.h.

---

The documentation for this class was generated from the following files:

• agrum/tools/graphs/algorithms/triangulations/junctionTreeStrategies/junctionTreeStrategy.h
• agrum/tools/graphs/algorithms/triangulations/junctionTreeStrategies/junctionTreeStrategy.cpp