gum::RangeVariable Class Reference

Defines a discrete random variable over an integer interval. More...

#include <rangeVariable.h>

Inheritance diagram for gum::RangeVariable:

Collaboration diagram for gum::RangeVariable:

Public Member Functions
virtual const std::string	domain () const
	string represent the domain of the variable More...
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
	RangeVariable (const std::string &aName, const std::string &aDesc, long minVal, long maxVal)
	constructors More...
	RangeVariable (const std::string &aName, const std::string &aDesc)
	by de default min=0, max=1 More...
	RangeVariable (const RangeVariable &aDRV)
	Copy Constructor. More...
virtual	~RangeVariable ()
	destructor More...
virtual RangeVariable *	clone () const
	Copy Factory. More...
Accessors / Modifiers
virtual Size	domainSize () const
	returns the size of the random discrete variable domain More...
virtual VarType	varType () const
	returns the type of variable More...
virtual std::string	label (Idx index) const
	Get the index-th label. More...
virtual double	numerical (Idx index) const
	get a numerical representation of the index-the value. More...
long	minVal () const
	Returns the lower bound. More...
void	setMinVal (long minVal)
	Set a new value for the lower bound. More...
long	maxVal () const
	Returns the upper bound. More...
void	setMaxVal (long maxVal)
	Set a new value of the upper bound. More...
bool	belongs (long val) const
	Returns true if the param belongs to the variable's interval. More...
virtual Idx	index (const std::string &) const
Operators
RangeVariable &	operator= (const RangeVariable &aRV)
	Copy operator. 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...
Operators
virtual bool	operator== (const Variable &aRV) const
	equality operator More...
virtual bool	operator!= (const Variable &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

Defines a discrete random variable over an integer interval.

It is technically possible to create RangeVariable with minVal > maxVal (or modify in that way an already created RangeVariable). The result is an empty variable (i.e. empty() returns true). If maxVal - minVal < 0, then domainsize() = 0.

Definition at line 53 of file rangeVariable.h.

Constructor & Destructor Documentation

RangeVariable() [1/3]

gum::RangeVariable::RangeVariable	(	const std::string &	aName,
		const std::string &	aDesc,
		long	minVal,
		long	maxVal
	)

constructors

Definition at line 40 of file rangeVariable.cpp.

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

                                                          :
      DiscreteVariable(aName, aDesc),
      _minBound_(minVal), _maxBound_(maxVal) {
    GUM_CONSTRUCTOR(RangeVariable);
  }

Here is the call graph for this function:

RangeVariable() [2/3]

gum::RangeVariable::RangeVariable	(	const std::string &	aName,
		const std::string &	aDesc
	)

by de default min=0, max=1

Definition at line 49 of file rangeVariable.cpp.

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

                                                                             :
      DiscreteVariable(aName, aDesc), _minBound_(0), _maxBound_(1) {
    GUM_CONSTRUCTOR(RangeVariable);
  }

Here is the call graph for this function:

RangeVariable() [3/3]

gum::RangeVariable::RangeVariable

(

const RangeVariable &

aDRV

)

Copy Constructor.

If aDRV haves any listener, it will not be copied.

Parameters

aDRV	the variable we copy

Definition at line 59 of file rangeVariable.cpp.

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

                                                        :
      DiscreteVariable(aDRV), _minBound_(aDRV._minBound_), _maxBound_(aDRV._maxBound_) {
    GUM_CONS_CPY(RangeVariable);
  }

Here is the call graph for this function:

~RangeVariable()

gum::RangeVariable::~RangeVariable ( )

virtual

destructor

Definition at line 67 of file rangeVariable.cpp.

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

                                {
    GUM_DESTRUCTOR(RangeVariable);
    ;
  }

Here is the call graph for this function:

Member Function Documentation

belongs()

INLINE bool gum::RangeVariable::belongs

(

long

val

)

const

Returns true if the param belongs to the variable's interval.

Definition at line 88 of file rangeVariable_inl.h.

                                                   {
    return ((_minBound_ <= val) && (val <= _maxBound_));
  }

clone()

INLINE RangeVariable * gum::RangeVariable::clone ( ) const

virtual

Copy Factory.

Returns

Returns a pointer on a new copy of this.

Implements gum::DiscreteVariable.

Definition at line 37 of file rangeVariable_inl.h.

{ return new RangeVariable(*this); }

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::RangeVariable::domain ( ) const

virtual

string represent the domain of the variable

Implements gum::DiscreteVariable.

Definition at line 72 of file rangeVariable.cpp.

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

                                              {
    std::stringstream s;
    s << "[" << minVal() << "," << maxVal() << "]";
    return s.str();
  }

Here is the call graph for this function:

domainSize()

INLINE Size gum::RangeVariable::domainSize ( ) const

virtual

returns the size of the random discrete variable domain

Warning

: It is technically possible to create RangeVariable with minVal

maxVal

(or modify in that way an already created RangeVariable). The result is an empty variable (i.e. empty() returns true). If maxVal - minVal < 0, then domainsize() = 0.

Implements gum::DiscreteVariable.

Definition at line 40 of file rangeVariable_inl.h.

                                              {
    return (_maxBound_ < _minBound_) ? Size(0) : Size(_maxBound_ + 1 - _minBound_);
  }

empty()

bool gum::DiscreteVariable::empty ( ) const

inherited

Returns

true if the domainSize() < 2;

index()

INLINE Idx gum::RangeVariable::index ( const std::string &  label ) const

virtual

Returns

the modality index from the label

Exceptions

NotFound

Implements gum::DiscreteVariable.

Definition at line 64 of file rangeVariable_inl.h.

                                                              {
    std::istringstream i(label);
    long               target;

    if (!(i >> target)) { GUM_ERROR(NotFound, "Bad label : " << label << " for " << *this) }

    if (!belongs(target)) { GUM_ERROR(NotFound, "Bad label : " << label << " for " << *this) }

    return static_cast< Idx >(target - _minBound_);
  }

label()

INLINE std::string gum::RangeVariable::label ( Idx  index ) const

virtual

Get the index-th label.

Parameters

index

the index of the label we wish to return

Exceptions

OutOfBound

Implements gum::DiscreteVariable.

Definition at line 47 of file rangeVariable_inl.h.

                                                        {
    long target = static_cast< long >(indice) + _minBound_;
    if (belongs(target)) {
      std::stringstream strBuff;
      strBuff << target;
      return strBuff.str();
    } else {
      GUM_ERROR(OutOfBounds, "Indice out of bounds.")
    }
  }

labels()

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

inherited

vector of labels

maxVal()

INLINE long gum::RangeVariable::maxVal

(

)

const

Returns the upper bound.

Definition at line 82 of file rangeVariable_inl.h.

{ return _maxBound_; }

minVal()

INLINE long gum::RangeVariable::minVal

(

)

const

Returns the lower bound.

Definition at line 76 of file rangeVariable_inl.h.

{ return _minBound_; }

name()

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

inherited

returns the name of the variable

numerical()

INLINE double gum::RangeVariable::numerical ( Idx  index ) const

virtual

get a numerical representation of the index-the value.

Implements gum::DiscreteVariable.

Definition at line 59 of file rangeVariable_inl.h.

                                                  {
    return double(_minBound_ + static_cast< long >(indice));
  }

operator!=() [1/2]

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

virtualinherited

inequality operator

Reimplemented in gum::IntegerVariable.

operator!=() [2/2]

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

virtualinherited

inequality operator

operator=()

INLINE RangeVariable & gum::RangeVariable::operator=

(

const RangeVariable &

aRV

)

Copy operator.

Parameters

aRV	to be copied

Returns

a ref to *this

Definition at line 95 of file rangeVariable_inl.h.

                                                                         {
    _minBound_ = aRV._minBound_;
    _maxBound_ = aRV._maxBound_;
    return *this;
  }

operator==() [1/2]

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

virtualinherited

equality operator

Reimplemented in gum::IntegerVariable.

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

setMaxVal()

INLINE void gum::RangeVariable::setMaxVal

(

long

maxVal

)

Set a new value of the upper bound.

Definition at line 85 of file rangeVariable_inl.h.

{ _maxBound_ = maxVal; }

setMinVal()

INLINE void gum::RangeVariable::setMinVal

(

long

minVal

)

Set a new value for the lower bound.

Definition at line 79 of file rangeVariable_inl.h.

{ _minBound_ = minVal; }

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()

INLINE VarType gum::RangeVariable::varType ( ) const

virtual

returns the type of variable

Implements gum::DiscreteVariable.

Definition at line 101 of file rangeVariable_inl.h.

{ return VarType::Range; }

Member Data Documentation

_maxBound_

long gum::RangeVariable::_maxBound_

private

The upper bound.

Definition at line 160 of file rangeVariable.h.

_minBound_

long gum::RangeVariable::_minBound_

private

The lower bound.

Definition at line 157 of file rangeVariable.h.

---

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

• agrum/tools/variables/rangeVariable.h
• agrum/tools/variables/rangeVariable.cpp
• agrum/tools/variables/rangeVariable_inl.h