chomp::homology::diGraph< wType >::posWeight Class Reference

A class for representing a positive number with negative values serving as the infinity (used in the Dijkstra algorithm). More...

Public Member Functions
	posWeight ()
	The default constructor. More...
	posWeight (const wType &_value)
	An optional constructor. More...
void	setInfinity ()
	Sets the value to the infinity. More...
bool	isInfinity () const
	Returns true iff the value corresponds to the infinity. More...
const wType &	getValue () const
	Returns the value stored in this object. More...

Private Attributes
wType	value
	The actual number. More...

Friends
bool	operator< (const posWeight &x, const posWeight &y)
	The < operator for comparing the numbers. More...
std::ostream &	operator<< (std::ostream &out, const posWeight &x)
	The operator for showing the number to the output stream. More...

Detailed Description

template<class wType = int>
class chomp::homology::diGraph< wType >::posWeight

A class for representing a positive number with negative values serving as the infinity (used in the Dijkstra algorithm).

Definition at line 514 of file digraph.h.

Constructor & Destructor Documentation

posWeight() [1/2]

template<class wType = int>

chomp::homology::diGraph< wType >::posWeight::posWeight ( )

inline

The default constructor.

Definition at line 518 of file digraph.h.

                {
                        value = 0;
                        return;
                }

References chomp::homology::diGraph< wType >::posWeight::value.

posWeight() [2/2]

template<class wType = int>

chomp::homology::diGraph< wType >::posWeight::posWeight ( const wType &  _value )

inlineexplicit

An optional constructor.

Definition at line 525 of file digraph.h.

                {
                        if (_value < 0)
                                value = 0;
                        else
                                value = _value;
                        return;
                }

References chomp::homology::diGraph< wType >::posWeight::value.

Member Function Documentation

getValue()

template<class wType = int>

const wType & chomp::homology::diGraph< wType >::posWeight::getValue ( ) const

inline

Returns the value stored in this object.

Definition at line 548 of file digraph.h.

                {
                        return value;
                }

References chomp::homology::diGraph< wType >::posWeight::value.

isInfinity()

template<class wType = int>

bool chomp::homology::diGraph< wType >::posWeight::isInfinity ( ) const

inline

Returns true iff the value corresponds to the infinity.

Definition at line 542 of file digraph.h.

                {
                        return (value < 0);
                }

References chomp::homology::diGraph< wType >::posWeight::value.

setInfinity()

template<class wType = int>

void chomp::homology::diGraph< wType >::posWeight::setInfinity ( )

inline

Sets the value to the infinity.

Definition at line 535 of file digraph.h.

                {
                        value = -1;
                        return;
                }

References chomp::homology::diGraph< wType >::posWeight::value.

Friends And Related Function Documentation

operator<

template<class wType = int>

bool operator< ( const posWeight &  x, const posWeight &  y  )

friend

The < operator for comparing the numbers.

Definition at line 554 of file digraph.h.

                {
                        if (y. isInfinity ())
                                return !(x. isInfinity ());
                        else if (x. isInfinity ())
                                return false;
                        return (x. value < y. value);
                }

operator<<

template<class wType = int>

std::ostream & operator<< ( std::ostream &  out, const posWeight &  x  )

friend

The operator for showing the number to the output stream.

Definition at line 565 of file digraph.h.

                {
                        if (x. isInfinity ())
                                out << "+oo";
                        else
                                out << x. getValue ();
                        return out;
                }

Member Data Documentation

value

template<class wType = int>

wType chomp::homology::diGraph< wType >::posWeight::value

private

The actual number.

Definition at line 577 of file digraph.h.

Referenced by chomp::homology::diGraph< wType >::posWeight::getValue(), chomp::homology::diGraph< wType >::posWeight::isInfinity(), chomp::homology::diGraph< wType >::posWeight::posWeight(), and chomp::homology::diGraph< wType >::posWeight::setInfinity().

---

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

• chomp/struct/digraph.h