gum::prm::PRMAggregate< GUM_SCALAR > Class Template Reference

#include <PRMAggregate.h>

Inheritance diagram for gum::prm::PRMAggregate< GUM_SCALAR >:

Collaboration diagram for gum::prm::PRMAggregate< GUM_SCALAR >:

Public Member Functions
Constructor & destructor.
	PRMAggregate (const std::string &name, AggregateType aggType, const PRMType &rvType)
	Default constructor. More...
	PRMAggregate (const std::string &name, AggregateType aggType, const PRMType &rvType, Idx label)
	Default constructor. More...
virtual	~PRMAggregate ()
	Destructor. More...
Getters and Setters.
virtual PRMClassElement< GUM_SCALAR >::ClassElementType	elt_type () const
	See gum::PRMClassElement::elt_type(). More...
AggregateType	agg_type () const
	Returns the aggregate of *this. More...
Idx	label () const
	Returns the label's index on which this aggregate applies. More...
const std::string &	labelValue () const
	See gum::PRMClassElement::elt_type(). More...
std::shared_ptr< Idx >	sharedLabel () const
	Returns the shared_ptr holding this Aggregate label. More...
void	sharedLabel (std::shared_ptr< Idx > label)
	Sets the shared_ptr of this Aggregate. More...
void	setLabel (Idx idx)
	Set the aggregator's label. More...
void	setLabel (const std::string &label)
	See gum::PRMClassElement::elt_type(). More...
bool	hasLabel () const
	Returns true if the label is defined. More...
bool	isDecomposable () const
	Returns true if the aggregator is decomposable. More...
virtual void	addParent (const PRMClassElement< GUM_SCALAR > &elt)
	See gum::PRMClassElement::addParent_(). More...
virtual void	addChild (const PRMClassElement< GUM_SCALAR > &elt)
	See gum::PRMClassElement::addChild_(). More...
virtual PRMType &	type ()
	See gum::PRMClassElement::type(). More...
virtual const PRMType &	type () const
	See gum::PRMClassElement::type(). More...
virtual Potential< GUM_SCALAR > &	cpf ()
	Aggregates don't have Potential until they are instantiated as PRMAttribute, so this will raise an OperationNotAllowed exception. More...
virtual const Potential< GUM_SCALAR > &	cpf () const
	Aggregates don't have Potential until they are instantiated as PRMAttribute, so this will raise an OperationNotAllowed exception. More...
MultiDimImplementation< GUM_SCALAR > *	buildImpl () const
	Returns a pointer over an empty gum::MultiDimImplementation of the good type for this PRMAggregate. More...
virtual PRMAttribute< GUM_SCALAR > *	getCastDescendant () const
	See gum::PRMClassElement::elt_type(). More...
Getters & setters
NodeId	id () const
	Returns the NodeId of this element in it's class DAG. More...
virtual void	setId (NodeId id)
	Used to assign the id of this element. More...
virtual PRMObject::prm_type	obj_type () const
Fast access to random variable's properties
const std::string &	safeName () const
	Returns the safe name of this PRMClassElement, if any. More...
virtual std::string	cast (const PRMType &t) const
	Returns the name of the cast descendant with PRMType t of this PRMClassElement. More...
Getters & setters.
const std::string &	name () const
	Returns the name of this object. More...
void	name (const std::string &name)
	Change the name of the PRM Object. More...
Operators
bool	operator== (const PRMObject &obj) const
	To PRMObject are equal if they have the same name (which is unique). More...
bool	operator!= (const PRMObject &obj) const
	To PRMObject are equal if they have the same name (which is unique). More...

Protected Attributes
std::string	safeName_
	The safe name of this PRMClassElement. More...

Friends
class	PRMClass< GUM_SCALAR >

Built-in types.
enum	AggregateType : char {   AggregateType::MIN, AggregateType::MAX, AggregateType::COUNT, AggregateType::EXISTS,   AggregateType::FORALL, AggregateType::OR, AggregateType::AND, AggregateType::AMPLITUDE,   AggregateType::MEDIAN, AggregateType::SUM }
	The different type of aggregates we can have. More...
static AggregateType	str2enum (const std::string &str)
	Static method which returns the AggregateType given its string representation. More...

Built-in type
enum	ClassElementType {   prm_attribute, prm_aggregate, prm_refslot, prm_slotchain,   prm_parameter }
	Returns true if obj_ptr is of type PRMReferenceSlot. More...
static std::string	enum2str (ClassElementType type)
	Returns true if obj_ptr is of type PRMReferenceSlot. More...
static INLINE bool	isReferenceSlot (const PRMClassElement< GUM_SCALAR > &elt)
	Returns true if obj_ptr is of type PRMReferenceSlot. More...
static INLINE bool	isAttribute (const PRMClassElement< GUM_SCALAR > &elt)
	Returns true if obj_ptr is of type PRMAttribute. More...
static INLINE bool	isAggregate (const PRMClassElement< GUM_SCALAR > &elt)
	Return true if obj is of type PRMAggregate. More...
static INLINE bool	isSlotChain (const PRMClassElement< GUM_SCALAR > &elt)
	Return true if obj is of type PRMSlotChain. More...
static INLINE bool	isParameter (const PRMClassElement< GUM_SCALAR > &elt)
	Return true if obj is of type PRMParameter. More...

Built-in types.
enum	prm_type : char {   prm_type::ALL, prm_type::CLASS, prm_type::PRM_INTERFACE, prm_type::CLASS_ELT,   prm_type::TYPE, prm_type::SYSTEM, prm_type::INSTANCE }
	Enumeration of the different types of objects handled by a PRM. More...
static std::string	enum2str (prm_type type)
	Returns the string representation of a PRMObject. More...
static std::string	LEFT_CAST ()
	Enumeration of the different types of objects handled by a PRM. More...
static std::string	RIGHT_CAST ()
	Enumeration of the different types of objects handled by a PRM. More...
static INLINE bool	isClass (const PRMObject &obj)
	Returns true if obj_ptr is of type Class. More...
static INLINE bool	isInterface (const PRMObject &obj)
	Returns true if obj_ptr is of type PRMInterface. More...
static INLINE bool	isInstance (const PRMObject &obj)
	Returns true if obj_ptr is of type PRMInstance. More...

Detailed Description

template<typename GUM_SCALAR>
class gum::prm::PRMAggregate< GUM_SCALAR >

Definition at line 69 of file PRMAggregate.h.

Member Enumeration Documentation

AggregateType

template<typename GUM_SCALAR>

enum gum::prm::PRMAggregate::AggregateType : char

strong

The different type of aggregates we can have.

Enumerator
MIN
MAX
COUNT
EXISTS
FORALL
OR
AND
AMPLITUDE
MEDIAN
SUM

Definition at line 79 of file PRMAggregate.h.

                               : char
      {
        MIN,
        MAX,
        COUNT,
        EXISTS,
        FORALL,
        OR,
        AND,
        AMPLITUDE,
        MEDIAN,
        SUM
      };

ClassElementType

template<typename GUM_SCALAR>

enum gum::prm::PRMClassElement::ClassElementType

inherited

Returns true if obj_ptr is of type PRMReferenceSlot.

Enumerator
prm_attribute
prm_aggregate
prm_refslot
prm_slotchain
prm_parameter

Definition at line 94 of file PRMClassElement.h.

      {
        prm_attribute,
        prm_aggregate,
        prm_refslot,
        prm_slotchain,
        prm_parameter
      };

prm_type

enum gum::prm::PRMObject::prm_type : char

stronginherited

Enumeration of the different types of objects handled by a PRM.

The "all" type is used to tell that we want any kind of PRMType (useful with iterators for example). No PRMObject will ever have "all" as type.

Enumerator
ALL
CLASS
PRM_INTERFACE
CLASS_ELT
TYPE
SYSTEM
INSTANCE

Definition at line 68 of file PRMObject.h.

                          : char
      {
        ALL,
        CLASS,
        PRM_INTERFACE,
        CLASS_ELT,
        TYPE,
        SYSTEM,
        INSTANCE
      };

Constructor & Destructor Documentation

PRMAggregate() [1/3]

template<typename GUM_SCALAR >

gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate	(	const std::string &	name,
		AggregateType	aggType,
		const PRMType &	rvType
	)

Default constructor.

Parameters

name	The name of this aggregate.
aggType	The aggregate type of this aggregate.
rvType	The random variable type of this aggregate, which is copied.

Definition at line 46 of file PRMAggregate_tpl.h.

                                                                        :
        PRMClassElement< GUM_SCALAR >(name),
        agg_type__(aggType), type__(new PRMType(rvType)),
        label__(std::shared_ptr< Idx >(new Idx(INT_MAX))) {
      GUM_CONSTRUCTOR(PRMAggregate);
      this->safeName_ = PRMObject::LEFT_CAST() + type__->name()
                      + PRMObject::RIGHT_CAST() + name;
      this->type__->variable().setName(name);
    }

PRMAggregate() [2/3]

template<typename GUM_SCALAR >

gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate	(	const std::string &	name,
		AggregateType	aggType,
		const PRMType &	rvType,
		Idx	label
	)

Default constructor.

Parameters

name	The name of this aggregate.
aggType	The aggregate type of this aggregate.
rvType	The random variable type of this aggregate, which is copied.
label	The index of the label on which this aggregate applies.

Definition at line 59 of file PRMAggregate_tpl.h.

                                                                       :
        PRMClassElement< GUM_SCALAR >(name),
        agg_type__(aggType), type__(new PRMType(rvType)),
        label__(std::shared_ptr< Idx >(new Idx(label))) {
      GUM_CONSTRUCTOR(PRMAggregate);
      this->safeName_ = PRMObject::LEFT_CAST() + type__->name()
                      + PRMObject::RIGHT_CAST() + name;
      this->type__->variable().setName(name);
    }

~PRMAggregate()

template<typename GUM_SCALAR >

gum::prm::PRMAggregate< GUM_SCALAR >::~PRMAggregate ( )

virtual

Destructor.

Definition at line 73 of file PRMAggregate_tpl.h.

                                              {
      GUM_DESTRUCTOR(PRMAggregate);
      delete type__;
    }

PRMAggregate() [3/3]

template<typename GUM_SCALAR>

gum::prm::PRMAggregate< GUM_SCALAR >::PRMAggregate ( const PRMAggregate< GUM_SCALAR > &  source )

private

Copy constructor. Don't use it.

Definition at line 79 of file PRMAggregate_tpl.h.

                                                 :
        PRMClassElement< GUM_SCALAR >(source) {
      GUM_CONS_CPY(PRMAggregate);
      GUM_ERROR(FatalError, "illegal call to gum::PRMAggregate copy constructor.");
    }

Member Function Documentation

addChild()

template<typename GUM_SCALAR>

INLINE void gum::prm::PRMAggregate< GUM_SCALAR >::addChild ( const PRMClassElement< GUM_SCALAR > &  elt )

virtual

See gum::PRMClassElement::addChild_().

Implements gum::prm::PRMClassElement< GUM_SCALAR >.

Definition at line 238 of file PRMAggregate_tpl.h.

                                                 {}

addParent()

template<typename GUM_SCALAR>

INLINE void gum::prm::PRMAggregate< GUM_SCALAR >::addParent ( const PRMClassElement< GUM_SCALAR > &  elt )

virtual

See gum::PRMClassElement::addParent_().

Implements gum::prm::PRMClassElement< GUM_SCALAR >.

Definition at line 233 of file PRMAggregate_tpl.h.

                                                 {}

agg_type()

template<typename GUM_SCALAR >

INLINE PRMAggregate< GUM_SCALAR >::AggregateType gum::prm::PRMAggregate< GUM_SCALAR >::agg_type

(

)

const

Returns the aggregate of *this.

Definition at line 100 of file PRMAggregate_tpl.h.

                                                  {
      return agg_type__;
    }

buildImpl()

template<typename GUM_SCALAR >

INLINE MultiDimImplementation< GUM_SCALAR > * gum::prm::PRMAggregate< GUM_SCALAR >::buildImpl

(

)

const

Returns a pointer over an empty gum::MultiDimImplementation of the good type for this PRMAggregate.

This should be use when manipulating instantiations of aggregates.

Definition at line 191 of file PRMAggregate_tpl.h.

                                                       {
      switch (agg_type()) {
        case AggregateType::MIN: {
          return new aggregator::Min< GUM_SCALAR >();
        }
        case AggregateType::MAX: {
          return new aggregator::Max< GUM_SCALAR >();
        }
        case AggregateType::OR: {
          return new aggregator::Or< GUM_SCALAR >();
        }
        case AggregateType::AND: {
          return new aggregator::And< GUM_SCALAR >();
        }
        case AggregateType::AMPLITUDE: {
          return new aggregator::Amplitude< GUM_SCALAR >();
        }
        case AggregateType::MEDIAN: {
          return new aggregator::Median< GUM_SCALAR >();
        }
        case AggregateType::EXISTS: {
          return new aggregator::Exists< GUM_SCALAR >(label());
        }
        case AggregateType::FORALL: {
          return new aggregator::Forall< GUM_SCALAR >(label());
        }
        case AggregateType::COUNT: {
          return new aggregator::Count< GUM_SCALAR >(label());
        }
        case AggregateType::SUM: {
          return new aggregator::Sum< GUM_SCALAR >();
        }
        default: {
          GUM_ERROR(OperationNotAllowed, "Unknown aggregator.");
        }
      }
      return nullptr;
    }

cast()

template<typename GUM_SCALAR >

INLINE std::string gum::prm::PRMClassElement< GUM_SCALAR >::cast ( const PRMType &  t ) const

virtualinherited

Returns the name of the cast descendant with PRMType t of this PRMClassElement.

Parameters

t	The type in which we want to cast this PRMClassElement.

Exceptions

OperationNotAllowed

If the cast is impossible.

Definition at line 75 of file PRMClassElement_tpl.h.

                                                                     {
      if (type().isSubTypeOf(t)) {
        return PRMObject::LEFT_CAST() + t.name() + PRMObject::RIGHT_CAST()
             + name();
      } else {
        GUM_ERROR(OperationNotAllowed, "illegal cast");
      }
    }

cpf() [1/2]

template<typename GUM_SCALAR >

INLINE Potential< GUM_SCALAR > & gum::prm::PRMAggregate< GUM_SCALAR >::cpf ( )

virtual

Aggregates don't have Potential until they are instantiated as PRMAttribute, so this will raise an OperationNotAllowed exception.

See gum::PRMClassElement::cpf().

Definition at line 180 of file PRMAggregate_tpl.h.

                                                                    {
      GUM_ERROR(OperationNotAllowed, "This is an aggregate.");
    }

cpf() [2/2]

template<typename GUM_SCALAR >

INLINE const Potential< GUM_SCALAR > & gum::prm::PRMAggregate< GUM_SCALAR >::cpf ( ) const

virtual

Aggregates don't have Potential until they are instantiated as PRMAttribute, so this will raise an OperationNotAllowed exception.

See gum::PRMClassElement::cpf().

Implements gum::prm::PRMClassElement< GUM_SCALAR >.

Definition at line 185 of file PRMAggregate_tpl.h.

                                                                                {
      GUM_ERROR(OperationNotAllowed, "This is an aggregate.");
    }

elt_type()

template<typename GUM_SCALAR >

INLINE PRMClassElement< GUM_SCALAR >::ClassElementType gum::prm::PRMAggregate< GUM_SCALAR >::elt_type ( ) const

virtual

See gum::PRMClassElement::elt_type().

Implements gum::prm::PRMClassElement< GUM_SCALAR >.

Definition at line 94 of file PRMAggregate_tpl.h.

                                                  {
      return this->prm_aggregate;
    }

enum2str() [1/2]

static std::string gum::prm::PRMObject::enum2str ( prm_type  type )

inlinestaticinherited

Returns the string representation of a PRMObject.

Definition at line 83 of file PRMObject.h.

                                               {
        switch (type) {
          case prm_type::CLASS:
            return "PRMType::CLASS";

          case prm_type::CLASS_ELT:
            return "PRMType::CLASS_ELT";

          case prm_type::TYPE:
            return "PRMType::TYPE";

          case prm_type::SYSTEM:
            return "PRMType::SYSTEM";

          case prm_type::INSTANCE:
            return "PRMType::INSTANCE";

          case prm_type::PRM_INTERFACE:
            return "PRMType::PRM_INTERFACE";

          default:
            return "unknown";
        }
      }

enum2str() [2/2]

template<typename GUM_SCALAR>

static std::string gum::prm::PRMClassElement< GUM_SCALAR >::enum2str ( ClassElementType  type )

inlinestaticinherited

Returns true if obj_ptr is of type PRMReferenceSlot.

Definition at line 103 of file PRMClassElement.h.

                                                       {
        switch (type) {
          case prm_attribute:
            return "prm_attribute";

          case prm_aggregate:
            return "prm_aggregate";

          case prm_refslot:
            return "prm_refslot";

          case prm_slotchain:
            return "prm_slotchain";

          case prm_parameter:
            return "prm_parameter";

          default:
            return "unknown";
        }
      }

getCastDescendant()

template<typename GUM_SCALAR >

PRMAttribute< GUM_SCALAR > * gum::prm::PRMAggregate< GUM_SCALAR >::getCastDescendant ( ) const

virtual

See gum::PRMClassElement::elt_type().

Implements gum::prm::PRMClassElement< GUM_SCALAR >.

Definition at line 243 of file PRMAggregate_tpl.h.

                                                           {
      PRMScalarAttribute< GUM_SCALAR >* cast = 0;

      try {
        cast = new PRMScalarAttribute< GUM_SCALAR >(this->name(),
                                                    type().superType());
      } catch (NotFound&) {
        GUM_ERROR(OperationNotAllowed,
                  "this PRMAggregate can not have cast descendant");
      }

      cast->addParent(*this);
      const DiscreteVariable& my_var   = type().variable();
      DiscreteVariable&       cast_var = cast->type().variable();
      Instantiation           inst(cast->cpf());

      for (inst.setFirst(); !inst.end(); inst.inc()) {
        if (type().label_map()[inst.val(my_var)] == inst.val(cast_var)) {
          cast->cpf().set(inst, 1);
        } else {
          cast->cpf().set(inst, 0);
        }
      }

      return cast;
    }

hasLabel()

template<typename GUM_SCALAR >

INLINE bool gum::prm::PRMAggregate< GUM_SCALAR >::hasLabel

(

)

const

Returns true if the label is defined.

Definition at line 126 of file PRMAggregate_tpl.h.

                                                           {
      return *label__ != INT_MAX;
    }

id()

template<typename GUM_SCALAR >

INLINE NodeId gum::prm::PRMClassElement< GUM_SCALAR >::id ( ) const

inherited

Returns the NodeId of this element in it's class DAG.

Definition at line 54 of file PRMClassElement_tpl.h.

                                                          {
      return id__;
    }

isAggregate()

template<typename GUM_SCALAR>

static INLINE bool gum::prm::PRMClassElement< GUM_SCALAR >::isAggregate ( const PRMClassElement< GUM_SCALAR > &  elt )

inlinestaticinherited

Return true if obj is of type PRMAggregate.

Definition at line 137 of file PRMClassElement.h.

                                                                               {
        return elt.elt_type() == prm_aggregate;
      }

isAttribute()

template<typename GUM_SCALAR>

static INLINE bool gum::prm::PRMClassElement< GUM_SCALAR >::isAttribute ( const PRMClassElement< GUM_SCALAR > &  elt )

inlinestaticinherited

Returns true if obj_ptr is of type PRMAttribute.

Definition at line 132 of file PRMClassElement.h.

                                                                               {
        return elt.elt_type() == prm_attribute;
      }

isClass()

static INLINE bool gum::prm::PRMObject::isClass ( const PRMObject &  obj )

inlinestaticinherited

Returns true if obj_ptr is of type Class.

Definition at line 109 of file PRMObject.h.

References gum::prm::PRMObject::PRMObject().

                                                       {
        return obj.obj_type() == prm_type::CLASS;
      }

Here is the call graph for this function:

isDecomposable()

template<typename GUM_SCALAR >

INLINE bool gum::prm::PRMAggregate< GUM_SCALAR >::isDecomposable

(

)

const

Returns true if the aggregator is decomposable.

Definition at line 131 of file PRMAggregate_tpl.h.

                                                                 {
      switch (agg_type()) {
        case AggregateType::MIN: {
          return aggregator::Min< GUM_SCALAR >().isDecomposable();
        }
        case AggregateType::MAX: {
          return aggregator::Max< GUM_SCALAR >().isDecomposable();
        }
        case AggregateType::OR: {
          return aggregator::Or< GUM_SCALAR >().isDecomposable();
        }
        case AggregateType::AND: {
          return aggregator::And< GUM_SCALAR >().isDecomposable();
        }
        case AggregateType::AMPLITUDE: {
          return aggregator::Amplitude< GUM_SCALAR >().isDecomposable();
        }
        case AggregateType::MEDIAN: {
          return aggregator::Median< GUM_SCALAR >().isDecomposable();
        }
        case AggregateType::EXISTS: {
          return aggregator::Exists< GUM_SCALAR >(label()).isDecomposable();
        }
        case AggregateType::FORALL: {
          return aggregator::Forall< GUM_SCALAR >(label()).isDecomposable();
        }
        case AggregateType::COUNT: {
          return aggregator::Count< GUM_SCALAR >(label()).isDecomposable();
        }
        case AggregateType::SUM: {
          return aggregator::Sum< GUM_SCALAR >().isDecomposable();
        }
        default: {
          GUM_ERROR(OperationNotAllowed, "Unknown aggregator.");
        }
      }
    }

isInstance()

static INLINE bool gum::prm::PRMObject::isInstance ( const PRMObject &  obj )

inlinestaticinherited

Returns true if obj_ptr is of type PRMInstance.

Definition at line 119 of file PRMObject.h.

References gum::prm::PRMObject::PRMObject().

                                                          {
        return obj.obj_type() == prm_type::INSTANCE;
      }

Here is the call graph for this function:

isInterface()

static INLINE bool gum::prm::PRMObject::isInterface ( const PRMObject &  obj )

inlinestaticinherited

Returns true if obj_ptr is of type PRMInterface.

Definition at line 114 of file PRMObject.h.

References gum::prm::PRMObject::PRMObject().

                                                           {
        return obj.obj_type() == prm_type::PRM_INTERFACE;
      }

Here is the call graph for this function:

isParameter()

template<typename GUM_SCALAR>

static INLINE bool gum::prm::PRMClassElement< GUM_SCALAR >::isParameter ( const PRMClassElement< GUM_SCALAR > &  elt )

inlinestaticinherited

Return true if obj is of type PRMParameter.

Definition at line 147 of file PRMClassElement.h.

                                                                               {
        return elt.elt_type() == prm_parameter;
      }

isReferenceSlot()

template<typename GUM_SCALAR>

static INLINE bool gum::prm::PRMClassElement< GUM_SCALAR >::isReferenceSlot ( const PRMClassElement< GUM_SCALAR > &  elt )

inlinestaticinherited

Returns true if obj_ptr is of type PRMReferenceSlot.

Definition at line 127 of file PRMClassElement.h.

                                                                   {
        return elt.elt_type() == prm_refslot;
      }

isSlotChain()

template<typename GUM_SCALAR>

static INLINE bool gum::prm::PRMClassElement< GUM_SCALAR >::isSlotChain ( const PRMClassElement< GUM_SCALAR > &  elt )

inlinestaticinherited

Return true if obj is of type PRMSlotChain.

Definition at line 142 of file PRMClassElement.h.

                                                                               {
        return elt.elt_type() == prm_slotchain;
      }

label()

template<typename GUM_SCALAR >

INLINE Idx gum::prm::PRMAggregate< GUM_SCALAR >::label

(

)

const

Returns the label's index on which this aggregate applies.

Exceptions

OperationNotAllowed

Raised if the aggregate does not applies on a label.

Definition at line 105 of file PRMAggregate_tpl.h.

                                                       {
      if (*label__ != INT_MAX) return *label__;
      GUM_ERROR(OperationNotAllowed, "no label defined for this aggregate");
    }

labelValue()

template<typename GUM_SCALAR >

INLINE const std::string & gum::prm::PRMAggregate< GUM_SCALAR >::labelValue

(

)

const

See gum::PRMClassElement::elt_type().

Definition at line 111 of file PRMAggregate_tpl.h.

                                                                         {
      return label_value__;
    }

LEFT_CAST()

static std::string gum::prm::PRMObject::LEFT_CAST ( )

inlinestaticinherited

Enumeration of the different types of objects handled by a PRM.

The "all" type is used to tell that we want any kind of PRMType (useful with iterators for example). No PRMObject will ever have "all" as type.

Definition at line 79 of file PRMObject.h.

{ return "("; }

name() [1/2]

INLINE const std::string & gum::prm::PRMObject::name ( ) const

inherited

Returns the name of this object.

Definition at line 34 of file PRMObject_inl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

{ return name__; }

Here is the call graph for this function:

name() [2/2]

INLINE void gum::prm::PRMObject::name ( const std::string &  name )

inherited

Change the name of the PRM Object.

Warning

Don't do this unless you know what you are doing !

Definition at line 38 of file PRMObject_inl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

{ name__ = name; }

Here is the call graph for this function:

obj_type()

template<typename GUM_SCALAR >

INLINE PRMObject::prm_type gum::prm::PRMClassElement< GUM_SCALAR >::obj_type ( ) const

virtualinherited

See also

gum::PRMObject::obj_type().

Implements gum::prm::PRMObject.

Definition at line 59 of file PRMClassElement_tpl.h.

                                                                           {
      return prm_type::CLASS_ELT;
    }

operator!=()

INLINE bool gum::prm::PRMObject::operator!= ( const PRMObject &  obj ) const

inherited

To PRMObject are equal if they have the same name (which is unique).

Definition at line 48 of file PRMObject_inl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

                                                         {
      return name__ != obj.name();
    }

Here is the call graph for this function:

operator=()

template<typename GUM_SCALAR>

PRMAggregate< GUM_SCALAR > & gum::prm::PRMAggregate< GUM_SCALAR >::operator= ( const PRMAggregate< GUM_SCALAR > &  source )

private

Copy operator. Don't use it.

Definition at line 87 of file PRMAggregate_tpl.h.

                                                 {
      GUM_ERROR(FatalError, "illegal call to gum::PRMAggregate copy operator.");
    }

operator==()

INLINE bool gum::prm::PRMObject::operator== ( const PRMObject &  obj ) const

inherited

To PRMObject are equal if they have the same name (which is unique).

Definition at line 42 of file PRMObject_inl.h.

References gum::prm::ParamScopeData< GUM_SCALAR >::ParamScopeData().

                                                         {
      return name__ == obj.name();
    }

Here is the call graph for this function:

RIGHT_CAST()

static std::string gum::prm::PRMObject::RIGHT_CAST ( )

inlinestaticinherited

Enumeration of the different types of objects handled by a PRM.

The "all" type is used to tell that we want any kind of PRMType (useful with iterators for example). No PRMObject will ever have "all" as type.

Definition at line 80 of file PRMObject.h.

{ return ")"; }

safeName()

template<typename GUM_SCALAR >

INLINE const std::string & gum::prm::PRMClassElement< GUM_SCALAR >::safeName ( ) const

inherited

Returns the safe name of this PRMClassElement, if any.

This will only work if this PRMClassElement is an PRMAttribute or an PRMAggregate.

Returns

Returns the safe name of this PRMClassElement.

Exceptions

NotFound&

Raised if this PRMClassElement does not have any safe name.

Definition at line 69 of file PRMClassElement_tpl.h.

                                                                          {
      return safeName_;
    }

setId()

template<typename GUM_SCALAR >

INLINE void gum::prm::PRMClassElement< GUM_SCALAR >::setId ( NodeId  id )

virtualinherited

Used to assign the id of this element.

Definition at line 64 of file PRMClassElement_tpl.h.

                                                              {
      id__ = id;
    }

setLabel() [1/2]

template<typename GUM_SCALAR >

INLINE void gum::prm::PRMAggregate< GUM_SCALAR >::setLabel

(

Idx

idx

)

Set the aggregator's label.

Definition at line 116 of file PRMAggregate_tpl.h.

                                                            {
      (*label__) = idx;
    }

setLabel() [2/2]

template<typename GUM_SCALAR >

INLINE void gum::prm::PRMAggregate< GUM_SCALAR >::setLabel

(

const std::string &

label

)

See gum::PRMClassElement::elt_type().

Definition at line 121 of file PRMAggregate_tpl.h.

                                                                           {
      label_value__ = value;
    }

sharedLabel() [1/2]

template<typename GUM_SCALAR >

INLINE std::shared_ptr< Idx > gum::prm::PRMAggregate< GUM_SCALAR >::sharedLabel

(

)

const

Returns the shared_ptr holding this Aggregate label.

This is used for inherited Aggregates to share labels in O3PRM.

Definition at line 271 of file PRMAggregate_tpl.h.

                                                                              {
      return label__;
    }

sharedLabel() [2/2]

template<typename GUM_SCALAR >

INLINE void gum::prm::PRMAggregate< GUM_SCALAR >::sharedLabel

(

std::shared_ptr< Idx >

label

)

Sets the shared_ptr of this Aggregate.

This is used for inherited aggregates to share labels in O3PRM.

Definition at line 277 of file PRMAggregate_tpl.h.

                                                                         {
      this->label__ = label;
    }

str2enum()

template<typename GUM_SCALAR>

static AggregateType gum::prm::PRMAggregate< GUM_SCALAR >::str2enum ( const std::string &  str )

inlinestatic

Static method which returns the AggregateType given its string representation.

We suppose that str is given either entirely in lower case or upper case. It will also match if only the first letter is in upper case.

Exceptions

Raise

NotFound exception if no matches is found.

Definition at line 101 of file PRMAggregate.h.

                                                          {
        if (toLower(str) == "min") {
          return AggregateType::MIN;
        } else if (toLower(str) == "max") {
          return AggregateType::MAX;
        } else if (toLower(str) == "count") {
          return AggregateType::COUNT;
        } else if (toLower(str) == "exists") {
          return AggregateType::EXISTS;
        } else if (toLower(str) == "or") {
          return AggregateType::OR;
        } else if (toLower(str) == "and") {
          return AggregateType::AND;
        } else if (toLower(str) == "forall") {
          return AggregateType::FORALL;
        } else if (toLower(str) == "amplitude") {
          return AggregateType::AMPLITUDE;
        } else if (toLower(str) == "median") {
          return AggregateType::MEDIAN;
        } else if (toLower(str) == "sum") {
          return AggregateType::SUM;
        } else {
          std::string msg = "Unknown aggregate: ";
          msg.append(str);
          GUM_ERROR(NotFound, msg);
        }
      }

type() [1/2]

template<typename GUM_SCALAR >

INLINE PRMType & gum::prm::PRMAggregate< GUM_SCALAR >::type ( )

virtual

See gum::PRMClassElement::type().

Implements gum::prm::PRMClassElement< GUM_SCALAR >.

Definition at line 170 of file PRMAggregate_tpl.h.

                                                     {
      return *type__;
    }

type() [2/2]

template<typename GUM_SCALAR >

INLINE const PRMType & gum::prm::PRMAggregate< GUM_SCALAR >::type ( ) const

virtual

See gum::PRMClassElement::type().

Implements gum::prm::PRMClassElement< GUM_SCALAR >.

Definition at line 175 of file PRMAggregate_tpl.h.

                                                                 {
      return *type__;
    }

Friends And Related Function Documentation

PRMClass< GUM_SCALAR >

template<typename GUM_SCALAR>

friend class PRMClass< GUM_SCALAR >

friend

Definition at line 70 of file PRMAggregate.h.

Member Data Documentation

agg_type__

template<typename GUM_SCALAR>

AggregateType gum::prm::PRMAggregate< GUM_SCALAR >::agg_type__

private

The AggregateType of this aggregate.

Definition at line 269 of file PRMAggregate.h.

label__

template<typename GUM_SCALAR>

std::shared_ptr< Idx > gum::prm::PRMAggregate< GUM_SCALAR >::label__

private

Some aggregators applies only on a given label. This attribute must have the concerned Idx. If not initialized the pointer equals 0. It is deleted with the aggregate.

Definition at line 278 of file PRMAggregate.h.

label_value__

template<typename GUM_SCALAR>

std::string gum::prm::PRMAggregate< GUM_SCALAR >::label_value__

private

The AggregateType of this aggregate.

Definition at line 280 of file PRMAggregate.h.

safeName_

template<typename GUM_SCALAR>

std::string gum::prm::PRMClassElement< GUM_SCALAR >::safeName_

protectedinherited

The safe name of this PRMClassElement.

Definition at line 266 of file PRMClassElement.h.

type__

template<typename GUM_SCALAR>

PRMType* gum::prm::PRMAggregate< GUM_SCALAR >::type__

private

The random variable type of this aggregate It is deleted with the aggregate.

Definition at line 273 of file PRMAggregate.h.

---

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

• agrum/PRM/elements/PRMAggregate.h
• agrum/PRM/elements/PRMAggregate_tpl.h