The base class for all elimination sequence algorithms used by triangulation algorithms. More...

#include <eliminationSequenceStrategy.h>

Inheritance diagram for gum::EliminationSequenceStrategy:

Collaboration diagram for gum::EliminationSequenceStrategy:

Public Member Functions
Accessors / Modifiers
virtual bool	setGraph (UndiGraph graph, const NodeProperty< Size > dom_sizes)
	sets a new graph to be triangulated
virtual NodeId	nextNodeToEliminate ()=0
	returns the new node to be eliminated within the triangulation algorithm
virtual void	askFillIns (bool do_it)=0
	if the elimination sequence is able to compute fill-ins, we indicate whether we want this feature to be activated
virtual bool	providesFillIns () const =0
	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.
virtual bool	providesGraphUpdate () const =0
	indicates whether the elimination sequence updates by itself the graph after a node has been eliminated
virtual void	eliminationUpdate (const NodeId node)
	performs all the graph/fill-ins updates provided (if any)
virtual const EdgeSet &	fillIns ()
	in case fill-ins are provided, this function returns the fill-ins due to all the nodes eliminated so far
virtual void	clear ()
	clears the sequence (to prepare, for instance, a new elimination sequence)
UndiGraph *	graph () const noexcept
	returns the current graph
const NodeProperty< Size > *	domainSizes () const noexcept
	returns the current domain sizes

Protected Attributes
UndiGraph *	graph_ {nullptr}
	the graph to be triangulated
const NodeProperty< Size > *	domain_sizes_ {nullptr}
	the domain sizes of the variables/nodes
NodeProperty< double >	log_domain_sizes_
	the log of the domain sizes of the variables/nodes

Static Private Member Functions
static const EdgeSet &	_empty_fill_ins_ ()
	an empty fill-ins set used by default

Constructors / Destructors
virtual	~EliminationSequenceStrategy ()
	destructor
virtual EliminationSequenceStrategy *	newFactory () const =0
	creates a new elimination sequence of the same type as the current object, but this sequence contains only an empty graph
virtual EliminationSequenceStrategy *	copyFactory () const =0
	virtual copy constructor
	EliminationSequenceStrategy ()
	default constructor
	EliminationSequenceStrategy (UndiGraph graph, const NodeProperty< Size > domain_sizes)
	constructor for a (tensorly) non empty graph
	EliminationSequenceStrategy (const EliminationSequenceStrategy &from)
	copy constructor
	EliminationSequenceStrategy (EliminationSequenceStrategy &&from)
	move constructor

Detailed Description

The base class for all elimination sequence algorithms used by triangulation algorithms.

Definition at line 68 of file eliminationSequenceStrategy.h.

Constructor & Destructor Documentation

◆ ~EliminationSequenceStrategy()

gum::EliminationSequenceStrategy::~EliminationSequenceStrategy ( )

virtual

destructor

Definition at line 107 of file eliminationSequenceStrategy.cpp.

                                                            {
    GUM_DESTRUCTOR(EliminationSequenceStrategy);
  }

References EliminationSequenceStrategy().

Here is the call graph for this function:

◆ EliminationSequenceStrategy() [1/4]

gum::EliminationSequenceStrategy::EliminationSequenceStrategy ( )

protected

default constructor

Definition at line 78 of file eliminationSequenceStrategy.cpp.

                                                           {
    GUM_CONSTRUCTOR(EliminationSequenceStrategy);
  }

References EliminationSequenceStrategy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EliminationSequenceStrategy() [2/4]

gum::EliminationSequenceStrategy::EliminationSequenceStrategy	(	UndiGraph *	graph,
		const NodeProperty< Size > *	domain_sizes )

protected

constructor for a (tensorly) non empty graph

Definition at line 83 of file eliminationSequenceStrategy.cpp.

                                                {
    EliminationSequenceStrategy::setGraph(graph, domain_sizes);
 
    GUM_CONSTRUCTOR(EliminationSequenceStrategy);
  }

References EliminationSequenceStrategy(), graph(), and setGraph().

Here is the call graph for this function:

◆ EliminationSequenceStrategy() [3/4]

gum::EliminationSequenceStrategy::EliminationSequenceStrategy ( const EliminationSequenceStrategy & from )

protected

copy constructor

Definition at line 92 of file eliminationSequenceStrategy.cpp.

                                               :
      graph_(from.graph_), domain_sizes_(from.domain_sizes_),
      log_domain_sizes_(from.log_domain_sizes_) {
    GUM_CONS_CPY(EliminationSequenceStrategy);
  }

References EliminationSequenceStrategy(), domain_sizes_, graph_, and log_domain_sizes_.

Here is the call graph for this function:

◆ EliminationSequenceStrategy() [4/4]

gum::EliminationSequenceStrategy::EliminationSequenceStrategy ( EliminationSequenceStrategy && from )

protected

move constructor

Definition at line 100 of file eliminationSequenceStrategy.cpp.

                                                                                             :
      graph_(from.graph_), domain_sizes_(from.domain_sizes_),
      log_domain_sizes_(std::move(from.log_domain_sizes_)) {
    GUM_CONS_MOV(EliminationSequenceStrategy);
  }

References EliminationSequenceStrategy(), domain_sizes_, graph_, and log_domain_sizes_.

Here is the call graph for this function:

Member Function Documentation

◆ _empty_fill_ins_()

const EdgeSet & gum::EliminationSequenceStrategy::_empty_fill_ins_ ( )

staticprivate

an empty fill-ins set used by default

Definition at line 60 of file eliminationSequenceStrategy.cpp.

                                                               {
#ifdef GUM_DEBUG_MODE
    static bool first_use = true;
    if (first_use) {
      first_use = false;
      __debug__::_dec_creation_("Set", " __empty_edge_set", 0, "static variable correction", 0);
      __debug__::_dec_creation_("HashTable",
                                " __empty_edge_set",
                                0,
                                "static variable correction",
                                0);
    }
#endif
    static EdgeSet empty_fill_ins;
    return empty_fill_ins;
  }

Referenced by fillIns().

Here is the caller graph for this function:

◆ askFillIns()

virtual void gum::EliminationSequenceStrategy::askFillIns ( bool do_it )

pure virtual

if the elimination sequence is able to compute fill-ins, we indicate whether 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.

Implemented in gum::DefaultEliminationSequenceStrategy, gum::DefaultPartialOrderedEliminationSequenceStrategy, and gum::OrderedEliminationSequenceStrategy.

◆ clear()

void gum::EliminationSequenceStrategy::clear ( )

virtual

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

Reimplemented in gum::DefaultEliminationSequenceStrategy, gum::DefaultPartialOrderedEliminationSequenceStrategy, gum::OrderedEliminationSequenceStrategy, and gum::PartialOrderedEliminationSequenceStrategy.

Definition at line 119 of file eliminationSequenceStrategy.cpp.

                                          {
    graph_        = nullptr;
    domain_sizes_ = nullptr;
    log_domain_sizes_.clear();
  }

References domain_sizes_, graph_, and log_domain_sizes_.

Referenced by gum::DefaultEliminationSequenceStrategy::clear(), gum::OrderedEliminationSequenceStrategy::clear(), gum::PartialOrderedEliminationSequenceStrategy::clear(), and setGraph().

Here is the caller graph for this function:

◆ copyFactory()

virtual EliminationSequenceStrategy * gum::EliminationSequenceStrategy::copyFactory ( ) const

pure virtual

virtual copy constructor

Returns: a full clone of the current object

Implemented in gum::DefaultEliminationSequenceStrategy, gum::DefaultPartialOrderedEliminationSequenceStrategy, gum::OrderedEliminationSequenceStrategy, gum::PartialOrderedEliminationSequenceStrategy, and gum::UnconstrainedEliminationSequenceStrategy.

References EliminationSequenceStrategy(), and graph().

Referenced by gum::StaticTriangulation::StaticTriangulation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ domainSizes()

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

noexcept

returns the current domain sizes

Definition at line 59 of file eliminationSequenceStrategy_inl.h.

                                                                                             {
    return domain_sizes_;
  }

References domain_sizes_.

Referenced by providesGraphUpdate().

Here is the caller graph for this function:

◆ eliminationUpdate()

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

virtual

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

Parameters

node	the node the elimination of which requires the graph update

Reimplemented in gum::DefaultEliminationSequenceStrategy, gum::DefaultPartialOrderedEliminationSequenceStrategy, and gum::OrderedEliminationSequenceStrategy.

Definition at line 112 of file eliminationSequenceStrategy.cpp.

112{}

◆ fillIns()

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

virtual

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

Reimplemented in gum::DefaultEliminationSequenceStrategy, gum::DefaultPartialOrderedEliminationSequenceStrategy, and gum::OrderedEliminationSequenceStrategy.

Definition at line 116 of file eliminationSequenceStrategy.cpp.

116{ return _empty_fill_ins_(); }

gum::EliminationSequenceStrategy::_empty_fill_ins_

static const EdgeSet & _empty_fill_ins_()

an empty fill-ins set used by default

Definition eliminationSequenceStrategy.cpp:60

References _empty_fill_ins_().

Referenced by gum::DefaultEliminationSequenceStrategy::fillIns(), gum::DefaultPartialOrderedEliminationSequenceStrategy::fillIns(), and gum::OrderedEliminationSequenceStrategy::fillIns().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ graph()

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

noexcept

returns the current graph

Definition at line 56 of file eliminationSequenceStrategy_inl.h.

56{ return graph_; }

References graph_.

Here is the caller graph for this function:

◆ newFactory()

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

pure virtual

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

Implemented in gum::DefaultEliminationSequenceStrategy, gum::DefaultPartialOrderedEliminationSequenceStrategy, gum::OrderedEliminationSequenceStrategy, gum::PartialOrderedEliminationSequenceStrategy, and gum::UnconstrainedEliminationSequenceStrategy.

References EliminationSequenceStrategy().

Here is the call graph for this function:

◆ nextNodeToEliminate()

virtual NodeId gum::EliminationSequenceStrategy::nextNodeToEliminate ( )

pure virtual

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

Implemented in gum::DefaultEliminationSequenceStrategy, gum::DefaultPartialOrderedEliminationSequenceStrategy, and gum::OrderedEliminationSequenceStrategy.

◆ providesFillIns()

virtual bool gum::EliminationSequenceStrategy::providesFillIns ( ) const

pure virtual

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.

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)

Implemented in gum::DefaultEliminationSequenceStrategy, gum::DefaultPartialOrderedEliminationSequenceStrategy, and gum::OrderedEliminationSequenceStrategy.

◆ providesGraphUpdate()

virtual bool gum::EliminationSequenceStrategy::providesGraphUpdate ( ) const

pure virtual

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

Some algorithms have more informations than the triangulation algorithm to update the graph after a node has been eliminated. They can thus exploit these informations to update the graph faster than the triangulation itself. Hence the latter should delegate this operation to the elimination sequence. This is the case, for instance, for the defaultEliminationSequenceStrategy, which uses a SimplicialSet that knows that some eliminated nodes do not require any fill-in.

Implemented in gum::DefaultEliminationSequenceStrategy, gum::DefaultPartialOrderedEliminationSequenceStrategy, and gum::OrderedEliminationSequenceStrategy.

References domainSizes().

Here is the call graph for this function:

◆ setGraph()

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

virtual

sets a new graph to be triangulated

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

Parameters

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

Returns: true if the data structures were modified (if the graph or the domain sizes did not change, then there is no need to update the data structures).

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 can be 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 in gum::DefaultEliminationSequenceStrategy, gum::DefaultPartialOrderedEliminationSequenceStrategy, gum::OrderedEliminationSequenceStrategy, and gum::PartialOrderedEliminationSequenceStrategy.

Definition at line 126 of file eliminationSequenceStrategy.cpp.

                                                                                    {
    // check that both the graph and the domain sizes are different from nullptr
    // or else that both are equal to nullptr
    if (((graph != nullptr) && (dom_sizes == nullptr))
        || ((graph == nullptr) && (dom_sizes != nullptr))) {
      GUM_ERROR(GraphError,
                "EliminationSequenceStrategy: one of the graph or the set of "
                "domain sizes is a null pointer.");
    }
 
    // check that each node has a domain size
    if (graph != nullptr) {
      for (const auto node: *graph)
        if (!dom_sizes->exists(node))
          GUM_ERROR(GraphError,
                    "EliminationSequenceStrategy needs a domain size "
                    "for every node in the graph.");
    }
 
    // avoid empty modifications
    if ((graph != graph_) || (dom_sizes != domain_sizes_)) {
      // remove, if any, the current graph
      clear();
 
      // assign a new graph
      graph_        = graph;
      domain_sizes_ = dom_sizes;
 
      if (graph_ != nullptr) {
        // compute the log of the modalities
        log_domain_sizes_.resize(graph_->sizeNodes() / 2);
 
        for (const auto node: *graph_)
          log_domain_sizes_.insert(node, std::log((*domain_sizes_)[node]));
      }
 
      return true;
    }
 
    return false;
  }

References clear(), domain_sizes_, gum::HashTable< Key, Val >::exists(), graph(), graph_, GUM_ERROR, and log_domain_sizes_.

Referenced by EliminationSequenceStrategy(), gum::DefaultEliminationSequenceStrategy::setGraph(), gum::OrderedEliminationSequenceStrategy::setGraph(), and gum::PartialOrderedEliminationSequenceStrategy::setGraph().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ domain_sizes_

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

protected

the domain sizes of the variables/nodes

Definition at line 177 of file eliminationSequenceStrategy.h.

177{nullptr};

Referenced by EliminationSequenceStrategy(), EliminationSequenceStrategy(), clear(), domainSizes(), and setGraph().

◆ graph_

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

protected

the graph to be triangulated

Definition at line 174 of file eliminationSequenceStrategy.h.

174{nullptr};

◆ log_domain_sizes_

NodeProperty< double > gum::EliminationSequenceStrategy::log_domain_sizes_

protected

the log of the domain sizes of the variables/nodes

Definition at line 180 of file eliminationSequenceStrategy.h.

Referenced by gum::DefaultEliminationSequenceStrategy::DefaultEliminationSequenceStrategy(), gum::DefaultPartialOrderedEliminationSequenceStrategy::DefaultPartialOrderedEliminationSequenceStrategy(), EliminationSequenceStrategy(), EliminationSequenceStrategy(), gum::DefaultEliminationSequenceStrategy::_createSimplicialSet_(), gum::DefaultPartialOrderedEliminationSequenceStrategy::_createSimplicialSet_(), clear(), and setGraph().

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

agrum/base/graphs/algorithms/triangulations/eliminationStrategies/eliminationSequenceStrategy.h
agrum/base/graphs/algorithms/triangulations/eliminationStrategies/eliminationSequenceStrategy.cpp
agrum/base/graphs/algorithms/triangulations/eliminationStrategies/eliminationSequenceStrategy_inl.h

Public Member Functions

Protected Attributes

Static Private Member Functions

Constructors / Destructors

Detailed Description

Constructor & Destructor Documentation

◆ ~EliminationSequenceStrategy()

◆ EliminationSequenceStrategy() [1/4]

◆ EliminationSequenceStrategy() [2/4]

◆ EliminationSequenceStrategy() [3/4]

◆ EliminationSequenceStrategy() [4/4]

Member Function Documentation

◆ _empty_fill_ins_()

◆ askFillIns()

◆ clear()

◆ copyFactory()

◆ domainSizes()

◆ eliminationUpdate()

◆ fillIns()

◆ graph()

◆ newFactory()

◆ nextNodeToEliminate()

◆ providesFillIns()

◆ providesGraphUpdate()

◆ setGraph()

Member Data Documentation

◆ domain_sizes_

◆ graph_

◆ log_domain_sizes_