An Elimination sequence algorithm that imposes a given partial ordering on the nodes elimination sequence. More...

#include <defaultPartialOrderedEliminationSequenceStrategy.h>

Inheritance diagram for gum::DefaultPartialOrderedEliminationSequenceStrategy:

Collaboration diagram for gum::DefaultPartialOrderedEliminationSequenceStrategy:

Public Member Functions
Constructors / Destructors
	DefaultPartialOrderedEliminationSequenceStrategy (double theRatio=GUM_QUASI_RATIO, double theThreshold=GUM_WEIGHT_THRESHOLD)
	default constructor (uses an empty graph) More...

	DefaultPartialOrderedEliminationSequenceStrategy (UndiGraph graph, const NodeProperty< Size > dom_sizes, const List< NodeSet > *subsets, double ratio=GUM_QUASI_RATIO, double threshold=GUM_WEIGHT_THRESHOLD)
	constructor for an a priori non empty graph More...

	DefaultPartialOrderedEliminationSequenceStrategy (const DefaultPartialOrderedEliminationSequenceStrategy &from)
	copy constructor More...

	DefaultPartialOrderedEliminationSequenceStrategy (DefaultPartialOrderedEliminationSequenceStrategy &&from)
	move constructor More...

virtual	~DefaultPartialOrderedEliminationSequenceStrategy ()
	destructor More...

virtual DefaultPartialOrderedEliminationSequenceStrategy *	newFactory () const final
	creates a new elimination sequence of the same type as the current object, but this sequence contains only an empty graph More...

virtual DefaultPartialOrderedEliminationSequenceStrategy *	copyFactory () const final
	virtual copy constructor More...

Accessors / Modifiers
virtual bool	setGraph (UndiGraph graph, const NodeProperty< Size > dom_sizes) final
	sets a new graph to be triangulated More...

virtual void	clear () final
	clears the sequence (to prepare, for instance, a new elimination sequence) More...

virtual NodeId	nextNodeToEliminate () final
	returns the new node to be eliminated within the triangulation algorithm More...

virtual void	askFillIns (bool do_it) final
	if the elimination sequence is able to compute fill-ins, we indicate whether we want this feature to be activated More...

virtual bool	providesFillIns () const final
	indicates whether the fill-ins generated by the eliminated nodes, if needed, will be computed by the elimination sequence, or need be computed by the triangulation itself. More...

virtual bool	providesGraphUpdate () const final
	indicates whether the elimination sequence updates by itself the graph after a node has been eliminated More...

virtual void	eliminationUpdate (const NodeId node) final
	performs all the graph/fill-ins updates provided (if any) More...

virtual const EdgeSet &	fillIns () final
	in case fill-ins are provided, this function returns the fill-ins due to all the nodes eliminated so far More...

Accessors / Modifiers
virtual bool	setPartialOrder (const List< NodeSet > *subsets)
	sets a new partial ordering constraint on the elimination sequence More...

const List< NodeSet > *	partialOrder () const noexcept
	returns the current partial ordering More...

bool	isPartialOrderNeeded () const noexcept
	indicates if a new partial ordering is needed More...

Accessors / Modifiers
UndiGraph *	graph () const noexcept
	returns the current graph More...

const NodeProperty< Size > *	domainSizes () const noexcept
	returns the current domain sizes More...

Protected Attributes
const List< NodeSet > *	subsets_ {nullptr}
	the subsets constituting the partial ordering More...

List< NodeSet >::const_iterator	subset_iter_
	the iterator indicating which is the current subset on which we work More...

NodeSet	nodeset_
	the nodes which can be currently eliminated More...

bool	partial_order_needed_ {true}
	indicate whether a new partial ordering is necessary for the elimination More...

UndiGraph *	graph_ {nullptr}
	the graph to be triangulated More...

const NodeProperty< Size > *	domain_sizes_ {nullptr}
	the domain sizes of the variables/nodes More...

NodeProperty< double >	log_domain_sizes_
	the log of the domain sizes of the variables/nodes More...

Protected Member Functions
bool	isPartialOrderNeeded_ (const List< NodeSet > *subsets) const
	indicate whether a partial ordering is compatible with the current graph More...

Detailed Description

An Elimination sequence algorithm that imposes a given partial ordering on the nodes elimination sequence.

Class DefaultPartialOrderedEliminationSequenceStrategy implements an elimination sequence algorithm that satisfies a partial ordering, that is, the set of all the nodes is divided into several subsets. All the nodes of the first subset must be eliminated before the nodes of the second, which must be eliminated before those of the third subset, and so on. Within a subset, the ordering is determined as follows:

the nodes that are simplicial (i.e., those that already form a clique

with their neighbors) are eliminated first

then the nodes that are almost simplicial (i.e. if we remove one of their

neighbors, they become simplicial) and that create small cliques, are eliminated (see Bodlaender's safe reductions)

the quasi simplicial nodes (i.e., the nodes that do not require many

fill-ins to create cliques) that would create small cliques, are eliminated

finally, the heuristic proposed by Kjaerulff(90) is used to compute the

last nodes to be eliminated.

Definition at line 81 of file defaultPartialOrderedEliminationSequenceStrategy.h.

Constructor & Destructor Documentation

◆ DefaultPartialOrderedEliminationSequenceStrategy() [1/4]

gum::DefaultPartialOrderedEliminationSequenceStrategy::DefaultPartialOrderedEliminationSequenceStrategy	(	double	theRatio = `GUM_QUASI_RATIO`,
		double	theThreshold = `GUM_WEIGHT_THRESHOLD`
	)

default constructor (uses an empty graph)

Parameters

theRatio	the ratio used by the SimplicialSet included in the DefaultEliminationSequenceStrategy
theThreshold	the weight threshhold of the SimplicialSet included in the DefaultEliminationSequenceStrategy

Definition at line 38 of file defaultPartialOrderedEliminationSequenceStrategy.cpp.

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

                                                                                             :
       _simplicial_ratio_(theRatio),
       _simplicial_threshold_(theThreshold) {
     // for debugging purposes
     GUM_CONSTRUCTOR(DefaultPartialOrderedEliminationSequenceStrategy);
   }

Here is the call graph for this function:

◆ DefaultPartialOrderedEliminationSequenceStrategy() [2/4]

gum::DefaultPartialOrderedEliminationSequenceStrategy::DefaultPartialOrderedEliminationSequenceStrategy	(	UndiGraph *	graph,
		const NodeProperty< Size > *	dom_sizes,
		const List< NodeSet > *	subsets,
		double	ratio = `GUM_QUASI_RATIO`,
		double	threshold = `GUM_WEIGHT_THRESHOLD`
	)

constructor for an a priori non empty graph

Parameters

graph	the graph to be triangulated, i.e., the nodes of which will be eliminated
dom_sizes	thedomain sizes of the nodes/variables
subsets	the list of the subsets constituting the partial ordering
ratio	the ratio used by the SimplicialSet included in the DefaultEliminationSequenceStrategy
threshold	the weight threshhold of the SimplicialSet included in the DefaultEliminationSequenceStrategy

Warning: Note that we allow dom_sizes to be defined over nodes/variables that do not belong to graph. These sizes will simply be ignored. However, it is compulsory that all the nodes of graph belong to dom_sizes; the graph is altered during the triangulation.; note that, by aGrUM's rule, the graph, the domain sizes and the sequence are not copied but only referenced by the elimination sequence algorithm.

Definition at line 47 of file defaultPartialOrderedEliminationSequenceStrategy.cpp.

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

                                                                                              :
       _simplicial_ratio_(ratio),
       _simplicial_threshold_(threshold) {
     setGraph(graph, dom_sizes);
     setPartialOrder(subsets);
 
     // for debugging purposes
     GUM_CONSTRUCTOR(DefaultPartialOrderedEliminationSequenceStrategy);
   }

Here is the call graph for this function:

◆ DefaultPartialOrderedEliminationSequenceStrategy() [3/4]

gum::DefaultPartialOrderedEliminationSequenceStrategy::DefaultPartialOrderedEliminationSequenceStrategy ( const DefaultPartialOrderedEliminationSequenceStrategy & from )

copy constructor

Warning: The newly created elimination sequence strategy points toward the same undirected graph as the one contained in from but each strategy possesses its own simplicial set. As a result, if both elimination strategies are used at the same time, they will probably result in a mess because their simplicial sets won't be synchronized correctly with the changing undirected graph. So, whenever using this copy constructor, be sure that either from or the newly created strategy is used for a triangulation but not both. This will necessarily be OK in DefaultTriangulations.

Definition at line 63 of file defaultPartialOrderedEliminationSequenceStrategy.cpp.

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

                                                                       :
       PartialOrderedEliminationSequenceStrategy(from),
       // no need to set  _log_weights_ because the copy of the simplicial set
       // will set it properly
       _simplicial_set_(new SimplicialSet(*from._simplicial_set_,
                                          graph_,
                                          &log_domain_sizes_,
                                          &_log_weights_,
                                          false)),
       _simplicial_ratio_(from._simplicial_ratio_),
       _simplicial_threshold_(from._simplicial_threshold_),
       _provide_fill_ins_(from._provide_fill_ins_) {
     // for debugging purposes
     GUM_CONS_CPY(DefaultPartialOrderedEliminationSequenceStrategy);
   }

Here is the call graph for this function:

◆ DefaultPartialOrderedEliminationSequenceStrategy() [4/4]

gum::DefaultPartialOrderedEliminationSequenceStrategy::DefaultPartialOrderedEliminationSequenceStrategy ( DefaultPartialOrderedEliminationSequenceStrategy && from )

move constructor

Definition at line 82 of file defaultPartialOrderedEliminationSequenceStrategy.cpp.

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

                                                                  :
       PartialOrderedEliminationSequenceStrategy(std::move(from)),
       _log_weights_(std::move(from._log_weights_)), _simplicial_set_(from._simplicial_set_),
       _simplicial_ratio_(from._simplicial_ratio_),
       _simplicial_threshold_(from._simplicial_threshold_),
       _provide_fill_ins_(from._provide_fill_ins_) {
     _simplicial_set_->replaceLogWeights(&from._log_weights_, &_log_weights_);
     from._simplicial_set_ = nullptr;
 
     // for debugging purposes
     GUM_CONS_MOV(DefaultPartialOrderedEliminationSequenceStrategy);
   }

Here is the call graph for this function:

◆ ~DefaultPartialOrderedEliminationSequenceStrategy()

gum::DefaultPartialOrderedEliminationSequenceStrategy::~DefaultPartialOrderedEliminationSequenceStrategy ( )

virtual

destructor

Definition at line 98 of file defaultPartialOrderedEliminationSequenceStrategy.cpp.

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

                                                          {
     // for debugging purposes
     GUM_DESTRUCTOR(DefaultPartialOrderedEliminationSequenceStrategy);
 
     if (_simplicial_set_) delete _simplicial_set_;
   }

Here is the call graph for this function:

Member Function Documentation

◆ _createSimplicialSet_()

void gum::DefaultPartialOrderedEliminationSequenceStrategy::_createSimplicialSet_ ( )

private

create a new simplicial set suited for the current graph

Definition at line 106 of file defaultPartialOrderedEliminationSequenceStrategy.cpp.

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

                                                                                {
     // remove the old simplicial set, if any
     if (_simplicial_set_ != nullptr) {
       delete _simplicial_set_;
       _simplicial_set_ = nullptr;
     }
 
     if (graph_ != nullptr) {
       // create a simplicial set suited for the graph
       _simplicial_set_ = new SimplicialSet(graph_,
                                            &log_domain_sizes_,
                                            &_log_weights_,
                                            _simplicial_ratio_,
                                            _simplicial_threshold_);
 
       _simplicial_set_->setFillIns(_provide_fill_ins_);
     }
   }

Here is the call graph for this function:

◆ _nodeToEliminate_()

NodeId gum::DefaultPartialOrderedEliminationSequenceStrategy::_nodeToEliminate_ ( const PriorityQueue< NodeId, double > & possibleNodes )

private

returns the best possible node to be eliminated

this function is used by method nextNodeToEliminate

Definition at line 149 of file defaultPartialOrderedEliminationSequenceStrategy.cpp.

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

                                                            {
     bool   found     = false;
     double min_score = 0;
     NodeId best_node = 0;
 
     for (const auto node: nodeset_) {
       try {
         double score = possibleNodes.priority(node);
 
         if (!found || (score < min_score)) {
           found     = true;
           min_score = score;
           best_node = node;
         }
       } catch (NotFound&) {}
     }
 
     if (!found) { GUM_ERROR(NotFound, "no possible node to eliminate") }
 
     return best_node;
   }

Here is the call graph for this function:

◆ askFillIns()

void gum::DefaultPartialOrderedEliminationSequenceStrategy::askFillIns ( bool do_it )

finalvirtual

if the elimination sequence is able to compute fill-ins, we indicate whether we want this feature to be activated

if the elimination sequence is able to compute fill-ins, we indicatewhether we want this feature to be activated

Parameters

do_it when true and the elimination sequence has the ability to compute fill-ins, the elimination sequence will actually compute them (for the triangulation to use them), else they will not be available.

Implements gum::EliminationSequenceStrategy.

Definition at line 218 of file defaultPartialOrderedEliminationSequenceStrategy.cpp.

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

                                                                               {
     _provide_fill_ins_ = do_it;
 
     if (_simplicial_set_) _simplicial_set_->setFillIns(_provide_fill_ins_);
   }

Here is the call graph for this function:

◆ clear()

void gum::DefaultPartialOrderedEliminationSequenceStrategy::clear ( )

finalvirtual

clears the sequence (to prepare, for instance, a new elimination sequence)

Reimplemented from gum::PartialOrderedEliminationSequenceStrategy.

Definition at line 138 of file defaultPartialOrderedEliminationSequenceStrategy.cpp.

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

                                                                {
     PartialOrderedEliminationSequenceStrategy::clear();
     _log_weights_.clear();
 
     if (_simplicial_set_ != nullptr) {
       delete _simplicial_set_;
       _simplicial_set_ = nullptr;
     }
   }

Here is the call graph for this function:

◆ copyFactory()

DefaultPartialOrderedEliminationSequenceStrategy * gum::DefaultPartialOrderedEliminationSequenceStrategy::copyFactory ( ) const

finalvirtual

virtual copy constructor

Warning: The newly created elimination sequence strategy points toward the same undirected graph as the one contained in the current strategy but each strategy possesses its own simplicial set. As a result, if both elimination strategies are used at the same time, they will probably result in a mess because their simplicial sets won't be synchronized correctly with the changing undirected graph. So, whenever using this virtual copy constructor, be sure that either the current or the newly created strategy is used for a triangulation but not both. This will necessarily be OK in DefaultTriangulations.

Implements gum::PartialOrderedEliminationSequenceStrategy.

Definition at line 280 of file defaultPartialOrderedEliminationSequenceStrategy.cpp.

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

                                                                          {
     return new DefaultPartialOrderedEliminationSequenceStrategy(*this);
   }

Here is the call graph for this function:

◆ domainSizes()

INLINE const NodeProperty< Size > * gum::EliminationSequenceStrategy::domainSizes ( ) const

noexceptinherited

returns the current domain sizes

Definition at line 40 of file eliminationSequenceStrategy_inl.h.

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

                                                                                              {
     return domain_sizes_;
   }

Here is the call graph for this function:

◆ eliminationUpdate()

void gum::DefaultPartialOrderedEliminationSequenceStrategy::eliminationUpdate ( const NodeId node )

finalvirtual

performs all the graph/fill-ins updates provided (if any)

performs all the graph/fill-ins updates provided

Parameters

node	the node the elimination of which requires the graph update

Reimplemented from gum::EliminationSequenceStrategy.

Definition at line 238 of file defaultPartialOrderedEliminationSequenceStrategy.cpp.

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

                                                                                           {
     // check whether we can do something
     if (_simplicial_set_ != nullptr) {
       _simplicial_set_->makeClique(id);
       _simplicial_set_->eraseClique(id);
 
       if (!partial_order_needed_) {
         // remove the node from nodeset_
         nodeset_.erase(id);
 
         if (nodeset_.empty()) {
           // go to the next non-empty subset
           for (++subset_iter_; subset_iter_ != subsets_->cend(); ++subset_iter_) {
             for (const auto node: *subset_iter_) {
               if (graph_->existsNode(node)) { nodeset_.insert(node); }
             }
             if (!nodeset_.empty()) break;
           }
         }
       }
     }
   }

Here is the call graph for this function:

◆ fillIns()

const EdgeSet & gum::DefaultPartialOrderedEliminationSequenceStrategy::fillIns ( )

finalvirtual

in case fill-ins are provided, this function returns the fill-ins due to all the nodes eliminated so far

in case fill-ins are provided, this function returns the fill-ins generated after the last node elimination

Reimplemented from gum::EliminationSequenceStrategy.

Definition at line 263 of file defaultPartialOrderedEliminationSequenceStrategy.cpp.

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

                                                                            {
     if (!_provide_fill_ins_ || (_simplicial_set_ == nullptr))
       return EliminationSequenceStrategy::fillIns();
     else
       return _simplicial_set_->fillIns();
   }

Here is the call graph for this function:

◆ graph()

INLINE UndiGraph * gum::EliminationSequenceStrategy::graph ( ) const

noexceptinherited

returns the current graph

Definition at line 36 of file eliminationSequenceStrategy_inl.h.

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

36 { return graph_; }

gum::EliminationSequenceStrategy::graph_

UndiGraph * graph_

the graph to be triangulated

Definition: eliminationSequenceStrategy.h:155

Here is the call graph for this function:

◆ isPartialOrderNeeded()

INLINE bool gum::PartialOrderedEliminationSequenceStrategy::isPartialOrderNeeded ( ) const

noexceptinherited

indicates if a new partial ordering is needed

if the current partial ordering does not contain all the nodes of the graph or if the graph itself is not defined (nullptr) a new partial ordering will be needed for the next triangulation

Definition at line 44 of file partialOrderedEliminationSequenceStrategy_inl.h.

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

                                                                                              {
     return partial_order_needed_;
   }

Here is the call graph for this function:

◆ isPartialOrderNeeded_()

bool gum::PartialOrderedEliminationSequenceStrategy::isPartialOrderNeeded_ ( const List< NodeSet > * subsets ) const

protectedinherited

indicate whether a partial ordering is compatible with the current graph

The method checks whether all the nodes of the graph belong to the partial ordering.

Returns: true if some nodes in graph_ do not belong to subsets or if graph_ is not defnined (nullptr)

Definition at line 99 of file partialOrderedEliminationSequenceStrategy.cpp.

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

                                            {
     if ((graph_ == nullptr) || (subsets == nullptr)) return true;
 
     // determine the set of nodes in the subsets that belong to the graph
     NodeSet nodes_found(graph_->size() / 2);
     for (const auto& nodes: *subsets) {
       for (const auto node: nodes) {
         if (graph_->existsNode(node)) { nodes_found.insert(node); }
       }
     }
 
     // check that the size of nodes_found is equal to that of the graph
     return nodes_found.size() != graph_->size();
   }

Here is the call graph for this function:

◆ newFactory()

DefaultPartialOrderedEliminationSequenceStrategy * gum::DefaultPartialOrderedEliminationSequenceStrategy::newFactory ( ) const

finalvirtual

creates a new elimination sequence of the same type as the current object, but this sequence contains only an empty graph

Warning: you must deallocate by yourself the object returned

Returns: an empty clone of the current object with the same type

Implements gum::PartialOrderedEliminationSequenceStrategy.

Definition at line 273 of file defaultPartialOrderedEliminationSequenceStrategy.cpp.

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

                                                                         {
     return new DefaultPartialOrderedEliminationSequenceStrategy(_simplicial_ratio_,
                                                                 _simplicial_threshold_);
   }

Here is the call graph for this function:

◆ nextNodeToEliminate()

NodeId gum::DefaultPartialOrderedEliminationSequenceStrategy::nextNodeToEliminate ( )

finalvirtual

returns the new node to be eliminated within the triangulation algorithm

Exceptions

NotFound exception is thrown if there is no more node to eliminate in the graph

Implements gum::EliminationSequenceStrategy.

Definition at line 173 of file defaultPartialOrderedEliminationSequenceStrategy.cpp.

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

                                                                                {
     // if there is no simplicial set, send an exception
     if (graph_ == nullptr) GUM_ERROR(NotFound, "the graph is empty")
 
     if (partial_order_needed_)
       GUM_ERROR(NotFound,
                 "the partial order does not cover all the nodes "
                 "of the graph");
 
     if (nodeset_.empty()) { GUM_ERROR(NotFound, "no node is admissible") }
 
     // select a node to be eliminated: try simplicial nodes, then almost
     // simplicial nodes, then quasi-simplicial nodes
     // note that if graph_ != nullptr,  _simplicial_set_ has been allocated
     try {
       return _nodeToEliminate_(_simplicial_set_->allSimplicialNodes());
     } catch (NotFound&) {}
 
     try {
       return _nodeToEliminate_(_simplicial_set_->allAlmostSimplicialNodes());
     } catch (NotFound&) {}
 
     try {
       return _nodeToEliminate_(_simplicial_set_->allQuasiSimplicialNodes());
     } catch (NotFound&) {}
 
     // here: select the node through Kjaerulff's heuristic
     auto   iter      = nodeset_.cbegin();
     double min_score = _log_weights_[*iter];
     NodeId best_node = *iter;
 
     for (++iter; iter != nodeset_.cend(); ++iter) {
       double score = _log_weights_[*iter];
 
       if (score < min_score) {
         min_score = score;
         best_node = *iter;
       }
     }
 
     return best_node;
   }

Here is the call graph for this function:

◆ partialOrder()

INLINE const List< NodeSet > * gum::PartialOrderedEliminationSequenceStrategy::partialOrder ( ) const

noexceptinherited

returns the current partial ordering

Definition at line 38 of file partialOrderedEliminationSequenceStrategy_inl.h.

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

                                                                                       {
     return subsets_;
   }

Here is the call graph for this function:

◆ providesFillIns()

bool gum::DefaultPartialOrderedEliminationSequenceStrategy::providesFillIns ( ) const

finalvirtual

indicates whether the fill-ins generated by the eliminated nodes, if needed, will be computed by the elimination sequence, or need be computed by the triangulation itself.

indicates whether the new fill-ins generated by a new eliminated node, if needed, will be computed by the elimination sequence, or need be computed by the triangulation itself.

An elimination sequence provides fill-ins to its triangulation if and only if it has the ability to compute them and it has been asked to do so (by method askFillIns)

Implements gum::EliminationSequenceStrategy.

Definition at line 227 of file defaultPartialOrderedEliminationSequenceStrategy.cpp.

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

                                                                                {
     return _provide_fill_ins_;
   }

Here is the call graph for this function:

◆ providesGraphUpdate()

bool gum::DefaultPartialOrderedEliminationSequenceStrategy::providesGraphUpdate ( ) const

finalvirtual

indicates whether the elimination sequence updates by itself the graph after a node has been eliminated

Implements gum::EliminationSequenceStrategy.

Definition at line 233 of file defaultPartialOrderedEliminationSequenceStrategy.cpp.

                                                                                    {
     return true;
   }

◆ setGraph()

bool gum::DefaultPartialOrderedEliminationSequenceStrategy::setGraph	(	UndiGraph *	graph,
		const NodeProperty< Size > *	dom_sizes
	)

finalvirtual

sets a new graph to be triangulated

The elimination sequence algorithms reinitializes its data to start a new triangulation with graph Graph and a new partial ordrering

Parameters

graph	the new graph to be triangulated
dom_sizes	the domain sizes of the nodes/variables

Warning: Note that we allow dom_sizes to be defined over nodes/variables that do not belong to graph. These sizes will simply be ignored. However, it is compulsory that all the nodes of graph belong to dom_sizes; the graph is altered during the triangulation.; note that, by aGrUM's rule, the graph and the domain sizes are not copied but only referenced by the elimination sequence algorithm.

Reimplemented from gum::PartialOrderedEliminationSequenceStrategy.

Definition at line 126 of file defaultPartialOrderedEliminationSequenceStrategy.cpp.

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

                                                {
     if (PartialOrderedEliminationSequenceStrategy::setGraph(graph, domain_sizes)) {
       _createSimplicialSet_();
       return true;
     }
 
     return false;
   }

Here is the call graph for this function:

◆ setPartialOrder()

bool gum::PartialOrderedEliminationSequenceStrategy::setPartialOrder ( const List< NodeSet > * subsets )

virtualinherited

sets a new partial ordering constraint on the elimination sequence

sets a new partial order

Parameters

subsets the list of the subsets constituting the partial ordering

Returns: true if the new partial order has been successfully assigned (i.e., if all the nodes of the graph belong to one of the subsets)

Warning: if the subsets contain some nodes that do not belong to the graph, then these nodes are simply ignored.; note that, by aGrUM's rule, the partial ordering is not copied but only referenced by the elimination sequence algorithm.

Definition at line 116 of file partialOrderedEliminationSequenceStrategy.cpp.

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

                                                                                                 {
     // check that the partial order contains all the nodes of the graph
     partial_order_needed_ = isPartialOrderNeeded_(subsets);
 
     if (!partial_order_needed_) {
       subsets_ = subsets;
 
       // initialize properly the set of nodes that can be currently eliminated:
       // find the first subset that contains some node(s) of the graph
       nodeset_.clear();
       for (subset_iter_ = subsets_->cbegin(); subset_iter_ != subsets_->cend(); ++subset_iter_) {
         for (const auto node: *subset_iter_) {
           if (graph_->existsNode(node)) { nodeset_.insert(node); }
         }
         if (!nodeset_.empty()) return true;
       }
     }
 
     return false;
   }

Here is the call graph for this function:

Member Data Documentation

◆ _log_weights_

NodeProperty< double > gum::DefaultPartialOrderedEliminationSequenceStrategy::_log_weights_

private

for each node, the weight of the clique created by the node's elimination

Definition at line 223 of file defaultPartialOrderedEliminationSequenceStrategy.h.

◆ _provide_fill_ins_

bool gum::DefaultPartialOrderedEliminationSequenceStrategy::_provide_fill_ins_ {false}

private

indicates whether we compute new fill-ins

Definition at line 235 of file defaultPartialOrderedEliminationSequenceStrategy.h.

◆ _simplicial_ratio_

double gum::DefaultPartialOrderedEliminationSequenceStrategy::_simplicial_ratio_

private

the ratio used by simplicial_set for its quasi-simplicial nodes

Definition at line 229 of file defaultPartialOrderedEliminationSequenceStrategy.h.

◆ _simplicial_set_

SimplicialSet* gum::DefaultPartialOrderedEliminationSequenceStrategy::_simplicial_set_ {nullptr}

private

the simplicial set used for determining the best nodes to eliminate

Definition at line 226 of file defaultPartialOrderedEliminationSequenceStrategy.h.

◆ _simplicial_threshold_

double gum::DefaultPartialOrderedEliminationSequenceStrategy::_simplicial_threshold_

private

the threshold used by simplicial_set to determine small cliques

Definition at line 232 of file defaultPartialOrderedEliminationSequenceStrategy.h.

◆ domain_sizes_

const NodeProperty< Size >* gum::EliminationSequenceStrategy::domain_sizes_ {nullptr}

protectedinherited

the domain sizes of the variables/nodes

Definition at line 158 of file eliminationSequenceStrategy.h.

◆ graph_

UndiGraph* gum::EliminationSequenceStrategy::graph_ {nullptr}

protectedinherited

the graph to be triangulated

Definition at line 155 of file eliminationSequenceStrategy.h.

◆ log_domain_sizes_

NodeProperty< double > gum::EliminationSequenceStrategy::log_domain_sizes_

protectedinherited

the log of the domain sizes of the variables/nodes

Definition at line 161 of file eliminationSequenceStrategy.h.

◆ nodeset_

NodeSet gum::PartialOrderedEliminationSequenceStrategy::nodeset_

protectedinherited

the nodes which can be currently eliminated

Definition at line 133 of file partialOrderedEliminationSequenceStrategy.h.

◆ partial_order_needed_

bool gum::PartialOrderedEliminationSequenceStrategy::partial_order_needed_ {true}

protectedinherited

indicate whether a new partial ordering is necessary for the elimination

Definition at line 136 of file partialOrderedEliminationSequenceStrategy.h.

◆ subset_iter_

List< NodeSet >::const_iterator gum::PartialOrderedEliminationSequenceStrategy::subset_iter_

protectedinherited

the iterator indicating which is the current subset on which we work

Definition at line 130 of file partialOrderedEliminationSequenceStrategy.h.

◆ subsets_

const List< NodeSet >* gum::PartialOrderedEliminationSequenceStrategy::subsets_ {nullptr}

protectedinherited

the subsets constituting the partial ordering

Definition at line 127 of file partialOrderedEliminationSequenceStrategy.h.

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

agrum/tools/graphs/algorithms/triangulations/eliminationStrategies/defaultPartialOrderedEliminationSequenceStrategy.h
agrum/tools/graphs/algorithms/triangulations/eliminationStrategies/defaultPartialOrderedEliminationSequenceStrategy.cpp

Public Member Functions

Protected Attributes

Protected Member Functions

Detailed Description

the nodes that are simplicial (i.e., those that already form a clique

then the nodes that are almost simplicial (i.e. if we remove one of their

the quasi simplicial nodes (i.e., the nodes that do not require many

finally, the heuristic proposed by Kjaerulff(90) is used to compute the

Constructor & Destructor Documentation

◆ DefaultPartialOrderedEliminationSequenceStrategy() [1/4]

◆ DefaultPartialOrderedEliminationSequenceStrategy() [2/4]

◆ DefaultPartialOrderedEliminationSequenceStrategy() [3/4]

◆ DefaultPartialOrderedEliminationSequenceStrategy() [4/4]

◆ ~DefaultPartialOrderedEliminationSequenceStrategy()

Member Function Documentation

◆ _createSimplicialSet_()

◆ _nodeToEliminate_()

◆ askFillIns()

◆ clear()

◆ copyFactory()

◆ domainSizes()

◆ eliminationUpdate()

◆ fillIns()

◆ graph()

◆ isPartialOrderNeeded()

◆ isPartialOrderNeeded_()

◆ newFactory()

◆ nextNodeToEliminate()

◆ partialOrder()

◆ providesFillIns()

◆ providesGraphUpdate()

◆ setGraph()

◆ setPartialOrder()

Member Data Documentation

◆ _log_weights_

◆ _provide_fill_ins_

◆ _simplicial_ratio_

◆ _simplicial_set_

◆ _simplicial_threshold_

◆ domain_sizes_

◆ graph_

◆ log_domain_sizes_

◆ nodeset_

◆ partial_order_needed_

◆ subset_iter_

◆ subsets_