gum::IntegerVariable Class Reference

class IntegerVariable More...

#include <integerVariable.h>

Inheritance diagram for gum::IntegerVariable:

Collaboration diagram for gum::IntegerVariable:

Public Member Functions
Idx	operator[] (const std::string &label) const
	from the label to its index in var. More...
std::string	toString () const
	string version of *this More...
std::string	toStringWithDescription () const
	string version of *this using description attribute instead of name. More...
Constructors / Destructors
	IntegerVariable (const std::string &aName, const std::string &aDesc="")
	constructor More...
	IntegerVariable (const std::string &aName, const std::string &aDesc, const std::vector< int > &domain)
	constructor assigning a domain to the variable More...
	IntegerVariable (const IntegerVariable &from)
	Copy constructor. More...
	IntegerVariable (IntegerVariable &&from)
	move constructor More...
virtual IntegerVariable *	clone () const
	virtual copy constructor More...
virtual	~IntegerVariable ()
	destructor More...
Operators
IntegerVariable &	operator= (const IntegerVariable &from)
	copy operator More...
IntegerVariable &	operator= (IntegerVariable &&from)
	move operator More...
virtual bool	operator== (const Variable &var) const
	equality operator More...
virtual bool	operator!= (const Variable &var) const
	inequality operator More...
Accessors / Modifiers
virtual Size	domainSize () const
	returns the domain size of the discrete random variable More...
virtual VarType	varType () const
	returns the type of variable More...
virtual Idx	index (const std::string &label) const
	returns the index of a given label More...
virtual std::string	label (Idx index) const
	returns a string corresponding to the ith value of the domain More...
virtual double	numerical (Idx index) const
	get a integer representation of the value at a given index More...
virtual const std::string	domain () const
	Returns the domain as a string. More...
const Sequence< int > &	integerDomain () const
	returns the domain as a sequence of values More...
IntegerVariable &	addValue (int value)
	add a new value to the domain size More...
void	changeValue (int old_value, int new_value)
	substitute a value by another one More...
void	eraseValue (int value)
	erase a value from the domain of the variable More...
void	eraseValues ()
	clear the domain of the variable More...
Accessors / Modifiers
bool	empty () const
std::vector< std::string >	labels () const
	vector of labels More...
Operators
virtual bool	operator== (const DiscreteVariable &aRV) const
	equality operator More...
virtual bool	operator!= (const DiscreteVariable &aRV) const
	inequality operator More...
Accessors / Modifiers
void	setName (const std::string &theValue)
	sets the name of the variable More...
const std::string &	name () const
	returns the name of the variable More...
void	setDescription (const std::string &theValue) const
	sets the description of the variable More...
const std::string &	description () const
	returns the description of the variable More...

Protected Member Functions
void	copy_ (const Variable &aRV)
	protected copy More...

Detailed Description

class IntegerVariable

The class representing discrete integer random variables

Definition at line 47 of file integerVariable.h.

Constructor & Destructor Documentation

IntegerVariable() [1/4]

gum::IntegerVariable::IntegerVariable	(	const std::string &	aName,
		const std::string &	aDesc = ""
	)

constructor

Parameters

aName	the name of the variable
aDesc	the Description of the variable, if any

IntegerVariable() [2/4]

gum::IntegerVariable::IntegerVariable	(	const std::string &	aName,
		const std::string &	aDesc,
		const std::vector< int > &	domain
	)

constructor assigning a domain to the variable

Parameters

aName	the name of the variable
aDesc	the Description of the variable, if any
domain	the domain (set of values) of the variable

Definition at line 31 of file integerVariable.cpp.

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

                                                                   :
      DiscreteVariable(aName, aDesc) {
    // get the values in increasing order
    std::vector< int > dom = domain;
    std::sort(dom.begin(), dom.end());

    // store the sorted values into a sequence
    _domain_.resize(dom.size());
    for (const int val : dom) {
      _domain_ << val;
    }

    // for debugging purposes
    GUM_CONSTRUCTOR(IntegerVariable);
  }

Here is the call graph for this function:

IntegerVariable() [3/4]

gum::IntegerVariable::IntegerVariable

(

const IntegerVariable &

from

)

Copy constructor.

Parameters

from	the variable we copy

IntegerVariable() [4/4]

gum::IntegerVariable::IntegerVariable

(

IntegerVariable &&

from

)

move constructor

~IntegerVariable()

virtual gum::IntegerVariable::~IntegerVariable ( )

virtual

destructor

Member Function Documentation

addValue()

IntegerVariable & gum::IntegerVariable::addValue

(

int

value

)

add a new value to the domain size

Exceptions

DuplicateElement

is raised if the variable already contains the value

Returns

*this which allows : v.addValue(1).addValue(2)...;

Definition at line 82 of file integerVariable.cpp.

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

                                                      {
    const Size size = _domain_.size();
    if (size == Size(0) || (_domain_[size - 1] < value)) {
      _domain_.insert(value);
    } else {
      // here, the value must not be inserted at the end of the sequence.
      // it is faster to reconstruct the sequence from scratch
      std::vector< int > values;
      values.reserve(_domain_.size() + 1);
      for (const auto val: _domain_)
        values.push_back(val);
      values.push_back(value);
      std::sort(values.begin(), values.end());

      Sequence< int > new_domain(_domain_.size() + 1);
      for (const auto val: values)
        new_domain.insert(val);
      _domain_ = std::move(new_domain);
    }

    return *this;
  }

Here is the call graph for this function:

changeValue()

void gum::IntegerVariable::changeValue	(	int	old_value,
		int	new_value
	)

substitute a value by another one

clone()

virtual IntegerVariable* gum::IntegerVariable::clone ( ) const

virtual

virtual copy constructor

Implements gum::DiscreteVariable.

copy_()

void gum::Variable::copy_ ( const Variable &  aRV )

protectedinherited

protected copy

Parameters

aRV	to be copied

description()

const std::string& gum::Variable::description ( ) const

inherited

returns the description of the variable

domain()

const std::string gum::IntegerVariable::domain ( ) const

virtual

Returns the domain as a string.

Implements gum::DiscreteVariable.

Definition at line 62 of file integerVariable.cpp.

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

                                                {
    std::stringstream s;
    s << "<";

    const Size size = domainSize();
    if (size > 0) {
      s << _domain_[0];

      for (Idx i = 1; i < size; ++i) {
        s << ',' << _domain_[i];
      }
    }

    s << ">";

    return s.str();
  }

Here is the call graph for this function:

domainSize()

virtual Size gum::IntegerVariable::domainSize ( ) const

virtual

returns the domain size of the discrete random variable

Implements gum::DiscreteVariable.

empty()

bool gum::DiscreteVariable::empty ( ) const

inherited

Returns

true if the domainSize() < 2;

eraseValue()

void gum::IntegerVariable::eraseValue

(

int

value

)

erase a value from the domain of the variable

eraseValues()

void gum::IntegerVariable::eraseValues

(

)

clear the domain of the variable

index()

virtual Idx gum::IntegerVariable::index ( const std::string &  label ) const

virtual

returns the index of a given label

Parameters

label

searched label

Returns

the index of this label

Exceptions

NotFound

Implements gum::DiscreteVariable.

integerDomain()

const Sequence< int >& gum::IntegerVariable::integerDomain

(

)

const

returns the domain as a sequence of values

label()

virtual std::string gum::IntegerVariable::label ( Idx  index ) const

virtual

returns a string corresponding to the ith value of the domain

Implements gum::DiscreteVariable.

labels()

std::vector< std::string > gum::DiscreteVariable::labels ( ) const

inherited

vector of labels

name()

const std::string& gum::Variable::name ( ) const

inherited

returns the name of the variable

numerical()

virtual double gum::IntegerVariable::numerical ( Idx  index ) const

virtual

get a integer representation of the value at a given index

Implements gum::DiscreteVariable.

operator!=() [1/2]

virtual bool gum::IntegerVariable::operator!= ( const Variable &  var ) const

virtual

inequality operator

Reimplemented from gum::Variable.

operator!=() [2/2]

virtual bool gum::DiscreteVariable::operator!= ( const DiscreteVariable &  aRV ) const

virtualinherited

inequality operator

operator=() [1/2]

IntegerVariable& gum::IntegerVariable::operator=

(

const IntegerVariable &

from

)

copy operator

Parameters

from	the integer discrete random variable we copy

operator=() [2/2]

IntegerVariable& gum::IntegerVariable::operator=

(

IntegerVariable &&

from

)

move operator

Parameters

from	the integer discrete random variable we copy

operator==() [1/2]

bool gum::IntegerVariable::operator== ( const Variable &  var ) const

virtual

equality operator

Reimplemented from gum::Variable.

Definition at line 51 of file integerVariable.cpp.

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

                                                            {
    try {
      const IntegerVariable& xvar = dynamic_cast<const IntegerVariable&>(var);
      return Variable::operator==(var) && (xvar._domain_ == _domain_);
    } catch (std::bad_cast&) {
      return false;
    }
  }

Here is the call graph for this function:

operator==() [2/2]

virtual bool gum::DiscreteVariable::operator== ( const DiscreteVariable &  aRV ) const

virtualinherited

equality operator

operator[]()

Idx gum::DiscreteVariable::operator[] ( const std::string &  label ) const

inlineinherited

from the label to its index in var.

Warning

This operation may have different complexity in different subclasses.

Exceptions

NotFound

Definition at line 139 of file discreteVariable.h.

{ return index(label); };

setDescription()

void gum::Variable::setDescription ( const std::string &  theValue ) const

inherited

sets the description of the variable

Warning

since description is mutable, setDescription() is const

Parameters

theValue

setName()

void gum::Variable::setName ( const std::string &  theValue )

inherited

sets the name of the variable

Parameters

theValue

toString()

std::string gum::DiscreteVariable::toString ( ) const

inherited

string version of *this

toStringWithDescription()

std::string gum::DiscreteVariable::toStringWithDescription ( ) const

inherited

string version of *this using description attribute instead of name.

varType()

virtual VarType gum::IntegerVariable::varType ( ) const

virtual

returns the type of variable

Implements gum::DiscreteVariable.

Member Data Documentation

_domain_

Sequence< int > gum::IntegerVariable::_domain_

private

the domain of the variable

Definition at line 158 of file integerVariable.h.

---

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

• agrum/tools/variables/integerVariable.h
• agrum/tools/variables/integerVariable.cpp