Private structure to represent data about a pattern. More...

Collaboration diagram for gum::prm::StructuredInference< GUM_SCALAR >::PData:

Public Member Functions
	PData (const gspan::Pattern &p, typename GSpan< GUM_SCALAR >::MatchedInstances &m)
	Default constructor.
	PData (const PData &source)
	Copy constructor.
	~PData ()
	Destructor.
NodeSet &	inners ()
	Returns the set of inner nodes.
NodeSet &	obs ()
	Returns the set of inner and observed nodes given all the matches of pattern.
NodeSet &	outputs ()
	Returns the set of outputs nodes given all the matches of pattern.
NodeSet &	queries ()
	Returns the set of queried nodes given all the matches of pattern.
const List< NodeSet > *	partial_order ()

Public Attributes
const gspan::Pattern &	pattern
	The pattern for which this represents data about it.
GSpan< GUM_SCALAR >::MatchedInstances &	matches
	A reference over the usable matches of pattern.
UndiGraph	graph
	A yet to be triangulated undigraph.
NodeProperty< Size >	mod
	The pattern's variables modalities.
Bijection< NodeId, std::string >	node2attr
	A bijection to easily keep track between graph and attributes, its of the form instance_name DOT attr_name.
NodeProperty< std::pair< Idx, std::string > >	map
	To ease translating tensors from one match to another.
Bijection< NodeId, const DiscreteVariable * >	vars
	Bijection between graph's nodes and their corresponding DiscreteVariable, for inference purpose.
NodeProperty< Tensor< GUM_SCALAR > * >	pots
	To handle barren nodes.
Set< NodeId >	barren
	Set of barren nodes.

Private Attributes
List< NodeSet >	_partial_order_
	We'll use a PartialOrderedTriangulation with three sets: output, nodes and obs with children outside the pattern and the other nodes.
List< NodeSet > *	_real_order_
	A copy of partial_order without empty sets.

Detailed Description

template<GUM_Numeric GUM_SCALAR>
struct gum::prm::StructuredInference< GUM_SCALAR >::PData

Private structure to represent data about a pattern.

Definition at line 161 of file structuredInference.h.

Constructor & Destructor Documentation

◆ PData() [1/2]

template<GUM_Numeric GUM_SCALAR>

gum::prm::StructuredInference< GUM_SCALAR >::PData::PData	(	const gspan::Pattern &	p,
		typename GSpan< GUM_SCALAR >::MatchedInstances &	m )

Default constructor.

Definition at line 793 of file structuredInference_tpl.h.

                                                         :
        pattern(p), matches(m), _real_order_(0) {
      GUM_CONSTRUCTOR(StructuredInference< GUM_SCALAR >::PData);
 
      for (int i = 0; i < 4; ++i)
        _partial_order_.push_front(NodeSet());
    }

References _partial_order_, _real_order_, matches, and pattern.

Referenced by PData().

Here is the caller graph for this function:

◆ PData() [2/2]

template<GUM_Numeric GUM_SCALAR>

gum::prm::StructuredInference< GUM_SCALAR >::PData::PData ( const PData & source )

Copy constructor.

References PData(), inners(), obs(), outputs(), partial_order(), and queries().

Here is the call graph for this function:

◆ ~PData()

template<GUM_Numeric GUM_SCALAR>

gum::prm::StructuredInference< GUM_SCALAR >::PData::~PData ( )

Destructor.

Definition at line 971 of file structuredInference_tpl.h.

                                                   {
      GUM_DESTRUCTOR(StructuredInference< GUM_SCALAR >::PData);
    }

Member Function Documentation

◆ inners()

template<GUM_Numeric GUM_SCALAR>

NodeSet & gum::prm::StructuredInference< GUM_SCALAR >::PData::inners ( )

Returns the set of inner nodes.

Definition at line 1024 of file structuredInference_tpl.h.

                                                            {
      return _partial_order_[0];
    }

References _partial_order_.

Referenced by PData(), gum::prm::StructuredInference< GUM_SCALAR >::_buildPatternGraph_(), gum::prm::StructuredInference< GUM_SCALAR >::_eliminateObservedNodes_(), gum::prm::StructuredInference< GUM_SCALAR >::_eliminateObservedNodesInSource_(), gum::prm::StructuredInference< GUM_SCALAR >::_insertNodeInElimLists_(), gum::prm::StructuredInference< GUM_SCALAR >::_reducePattern_(), gum::prm::StructuredInference< GUM_SCALAR >::_removeBarrenNodes_(), and gum::prm::StructuredInference< GUM_SCALAR >::_removeNode_().

Here is the caller graph for this function:

◆ obs()

template<GUM_Numeric GUM_SCALAR>

NodeSet & gum::prm::StructuredInference< GUM_SCALAR >::PData::obs ( )

Returns the set of inner and observed nodes given all the matches of pattern.

Definition at line 1029 of file structuredInference_tpl.h.

                                                         {
      return _partial_order_[1];
    }

References _partial_order_.

Referenced by PData(), gum::prm::StructuredInference< GUM_SCALAR >::_buildPatternGraph_(), gum::prm::StructuredInference< GUM_SCALAR >::_eliminateObservedNodes_(), gum::prm::StructuredInference< GUM_SCALAR >::_eliminateObservedNodesInSource_(), gum::prm::StructuredInference< GUM_SCALAR >::_insertNodeInElimLists_(), and gum::prm::StructuredInference< GUM_SCALAR >::_reducePattern_().

Here is the caller graph for this function:

◆ outputs()

template<GUM_Numeric GUM_SCALAR>

NodeSet & gum::prm::StructuredInference< GUM_SCALAR >::PData::outputs ( )

Returns the set of outputs nodes given all the matches of pattern.

Definition at line 1034 of file structuredInference_tpl.h.

                                                             {
      return _partial_order_[2];
    }

References _partial_order_.

Referenced by PData(), gum::prm::StructuredInference< GUM_SCALAR >::_buildPatternGraph_(), and gum::prm::StructuredInference< GUM_SCALAR >::_insertNodeInElimLists_().

Here is the caller graph for this function:

◆ partial_order()

template<GUM_Numeric GUM_SCALAR>

const List< NodeSet > * gum::prm::StructuredInference< GUM_SCALAR >::PData::partial_order ( )

Definition at line 813 of file structuredInference_tpl.h.

                                                                                 {
      if (!_real_order_) {
        _real_order_ = new List< NodeSet >();
 
        for (const auto& set: _partial_order_)
          if (set.size() > 0) _real_order_->insert(set);
      }
 
      return _real_order_;
    }

References gum::List< Val >::List(), _partial_order_, and _real_order_.

Referenced by PData(), and gum::prm::StructuredInference< GUM_SCALAR >::_reducePattern_().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ queries()

template<GUM_Numeric GUM_SCALAR>

NodeSet & gum::prm::StructuredInference< GUM_SCALAR >::PData::queries ( )

Returns the set of queried nodes given all the matches of pattern.

Definition at line 1039 of file structuredInference_tpl.h.

                                                             {
      return _partial_order_[3];
    }

References _partial_order_.

Referenced by PData(), gum::prm::StructuredInference< GUM_SCALAR >::_buildPatternGraph_(), and gum::prm::StructuredInference< GUM_SCALAR >::_reducePattern_().

Here is the caller graph for this function:

Member Data Documentation

◆ _partial_order_

template<GUM_Numeric GUM_SCALAR>

List< NodeSet > gum::prm::StructuredInference< GUM_SCALAR >::PData::_partial_order_

private

We'll use a PartialOrderedTriangulation with three sets: output, nodes and obs with children outside the pattern and the other nodes.

Definition at line 218 of file structuredInference.h.

Referenced by PData(), inners(), obs(), outputs(), partial_order(), and queries().

◆ _real_order_

template<GUM_Numeric GUM_SCALAR>

List< NodeSet >* gum::prm::StructuredInference< GUM_SCALAR >::PData::_real_order_

private

A copy of partial_order without empty sets.

Definition at line 220 of file structuredInference.h.

Referenced by PData(), and partial_order().

◆ barren

template<GUM_Numeric GUM_SCALAR>

Set< NodeId > gum::prm::StructuredInference< GUM_SCALAR >::PData::barren

Set of barren nodes.

Definition at line 185 of file structuredInference.h.

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::_buildPatternGraph_(), gum::prm::StructuredInference< GUM_SCALAR >::_reducePattern_(), and gum::prm::StructuredInference< GUM_SCALAR >::_removeBarrenNodes_().

◆ graph

template<GUM_Numeric GUM_SCALAR>

UndiGraph gum::prm::StructuredInference< GUM_SCALAR >::PData::graph

A yet to be triangulated undigraph.

Definition at line 167 of file structuredInference.h.

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::_buildPatternGraph_(), gum::prm::StructuredInference< GUM_SCALAR >::_reducePattern_(), gum::prm::StructuredInference< GUM_SCALAR >::_removeBarrenNodes_(), and gum::prm::StructuredInference< GUM_SCALAR >::_removeNode_().

◆ map

template<GUM_Numeric GUM_SCALAR>

NodeProperty< std::pair< Idx, std::string > > gum::prm::StructuredInference< GUM_SCALAR >::PData::map

To ease translating tensors from one match to another.

Definition at line 176 of file structuredInference.h.

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::_buildPatternGraph_(), gum::prm::StructuredInference< GUM_SCALAR >::_eliminateObservedNodes_(), gum::prm::StructuredInference< GUM_SCALAR >::_eliminateObservedNodesInSource_(), gum::prm::StructuredInference< GUM_SCALAR >::_removeNode_(), and gum::prm::StructuredInference< GUM_SCALAR >::_translatePotSet_().

◆ matches

template<GUM_Numeric GUM_SCALAR>

GSpan<GUM_SCALAR>::MatchedInstances& gum::prm::StructuredInference< GUM_SCALAR >::PData::matches

A reference over the usable matches of pattern.

Definition at line 165 of file structuredInference.h.

Referenced by PData(), gum::prm::StructuredInference< GUM_SCALAR >::_allInstanceNoRefAttr_(), gum::prm::StructuredInference< GUM_SCALAR >::_buildPatternGraph_(), gum::prm::StructuredInference< GUM_SCALAR >::_insertNodeInElimLists_(), gum::prm::StructuredInference< GUM_SCALAR >::_reducePattern_(), and gum::prm::StructuredInference< GUM_SCALAR >::_translatePotSet_().

◆ mod

template<GUM_Numeric GUM_SCALAR>

NodeProperty< Size > gum::prm::StructuredInference< GUM_SCALAR >::PData::mod

The pattern's variables modalities.

Definition at line 169 of file structuredInference.h.

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::_buildPatternGraph_(), gum::prm::StructuredInference< GUM_SCALAR >::_reducePattern_(), and gum::prm::StructuredInference< GUM_SCALAR >::_removeNode_().

◆ node2attr

template<GUM_Numeric GUM_SCALAR>

Bijection< NodeId, std::string > gum::prm::StructuredInference< GUM_SCALAR >::PData::node2attr

A bijection to easily keep track between graph and attributes, its of the form instance_name DOT attr_name.

Definition at line 174 of file structuredInference.h.

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::_buildPatternGraph_(), and gum::prm::StructuredInference< GUM_SCALAR >::_removeNode_().

◆ pattern

template<GUM_Numeric GUM_SCALAR>

const gspan::Pattern& gum::prm::StructuredInference< GUM_SCALAR >::PData::pattern

The pattern for which this represents data about it.

Definition at line 163 of file structuredInference.h.

Referenced by PData().

◆ pots

template<GUM_Numeric GUM_SCALAR>

NodeProperty< Tensor< GUM_SCALAR >* > gum::prm::StructuredInference< GUM_SCALAR >::PData::pots

To handle barren nodes.

Definition at line 183 of file structuredInference.h.

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::_removeNode_().

◆ vars

template<GUM_Numeric GUM_SCALAR>

Bijection< NodeId, const DiscreteVariable* > gum::prm::StructuredInference< GUM_SCALAR >::PData::vars

Bijection between graph's nodes and their corresponding DiscreteVariable, for inference purpose.

Definition at line 181 of file structuredInference.h.

Referenced by gum::prm::StructuredInference< GUM_SCALAR >::_buildPatternGraph_(), gum::prm::StructuredInference< GUM_SCALAR >::_eliminateObservedNodes_(), gum::prm::StructuredInference< GUM_SCALAR >::_eliminateObservedNodesInSource_(), gum::prm::StructuredInference< GUM_SCALAR >::_reducePattern_(), gum::prm::StructuredInference< GUM_SCALAR >::_removeBarrenNodes_(), gum::prm::StructuredInference< GUM_SCALAR >::_removeNode_(), and gum::prm::StructuredInference< GUM_SCALAR >::_translatePotSet_().

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

agrum/PRM/inference/structuredInference.h
agrum/PRM/inference/structuredInference_tpl.h

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PData() [1/2]

◆ PData() [2/2]

◆ ~PData()

Member Function Documentation

◆ inners()

◆ obs()

◆ outputs()

◆ partial_order()

◆ queries()

Member Data Documentation

◆ _partial_order_

◆ _real_order_

◆ barren

◆ graph

◆ map

◆ matches

◆ mod

◆ node2attr

◆ pattern

◆ pots

◆ vars