User Manual, Developers Guide and API Documentation

wifimac::pathselection::Metric Class Reference

Metric for the path-selection algorithms. More...

#include <pathselection/Metric.hpp>

Collaboration diagram for wifimac::pathselection::Metric:

Collaboration graph
[legend]

List of all members.

Public Member Functions

bool isInf () const
bool isNear (const Metric &m, const double limit=0.1) const
 Compares if two metrics are similar to each other by computing their relative deviation.
bool isNotInf () const
 Metric (const double &d)
 Metric (const Metric &m)
 Metric ()
bool operator!= (const Metric &m) const
Metric operator* (const double &d) const
Metric operator+ (const Metric &m) const
void operator+= (const Metric &m)
Metric operator- (const Metric &m) const
void operator-= (const Metric &m)
bool operator< (const Metric &m) const
bool operator<= (const Metric &m) const
void operator= (const Metric &m)
bool operator== (const Metric &m) const
bool operator> (const Metric &m) const
bool operator>= (const Metric &m) const
double toDouble () const
 Back-conversion to double if not inf.

Protected Attributes

bool inf
double value

Friends

std::ostream & operator<< (std::ostream &str, const wifimac::pathselection::Metric &m)


Detailed Description

Valid values are either a double > 0 or inifinity

Definition at line 42 of file Metric.hpp.


Constructor & Destructor Documentation

wifimac::pathselection::Metric::Metric (  )  [inline]

Definition at line 94 of file Metric.hpp.

wifimac::pathselection::Metric::Metric ( const Metric m  )  [inline]

Definition at line 99 of file Metric.hpp.

wifimac::pathselection::Metric::Metric ( const double d  )  [inline]

Definition at line 106 of file Metric.hpp.


Member Function Documentation

bool wifimac::pathselection::Metric::isInf (  )  const [inline]

Definition at line 224 of file Metric.hpp.

bool wifimac::pathselection::Metric::isNear ( const Metric m,
const double  limit = 0.1 
) const [inline]

Definition at line 234 of file Metric.hpp.

bool wifimac::pathselection::Metric::isNotInf (  )  const [inline]

Definition at line 229 of file Metric.hpp.

bool wifimac::pathselection::Metric::operator!= ( const Metric m  )  const [inline]

Definition at line 204 of file Metric.hpp.

Metric wifimac::pathselection::Metric::operator* ( const double d  )  const [inline]

Definition at line 141 of file Metric.hpp.

Metric wifimac::pathselection::Metric::operator+ ( const Metric m  )  const [inline]

Definition at line 127 of file Metric.hpp.

void wifimac::pathselection::Metric::operator+= ( const Metric m  )  [inline]

Metric wifimac::pathselection::Metric::operator- ( const Metric m  )  const [inline]

Definition at line 113 of file Metric.hpp.

void wifimac::pathselection::Metric::operator-= ( const Metric m  )  [inline]

bool wifimac::pathselection::Metric::operator< ( const Metric m  )  const [inline]

Definition at line 148 of file Metric.hpp.

bool wifimac::pathselection::Metric::operator<= ( const Metric m  )  const [inline]

Definition at line 185 of file Metric.hpp.

void wifimac::pathselection::Metric::operator= ( const Metric m  )  [inline]

Definition at line 217 of file Metric.hpp.

bool wifimac::pathselection::Metric::operator== ( const Metric m  )  const [inline]

Definition at line 190 of file Metric.hpp.

bool wifimac::pathselection::Metric::operator> ( const Metric m  )  const [inline]

Definition at line 164 of file Metric.hpp.

bool wifimac::pathselection::Metric::operator>= ( const Metric m  )  const [inline]

Definition at line 180 of file Metric.hpp.

double wifimac::pathselection::Metric::toDouble (  )  const [inline]

Definition at line 246 of file Metric.hpp.


Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  str,
const wifimac::pathselection::Metric m 
) [friend]

Definition at line 76 of file Metric.hpp.


Member Data Documentation

Definition at line 90 of file Metric.hpp.

Definition at line 89 of file Metric.hpp.


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

Generated on Sat May 26 03:32:44 2012 for openWNS by  doxygen 1.5.5