Generated on Fri Oct 19 11:25:44 2018 for Gecode by doxygen 1.6.3

Gecode::FloatVal Class Reference
[Float variables]

Float value type. More...

#include <float.hh>

List of all members.

Protected Types

typedef
gecode_boost::numeric::interval_lib::save_state
< Float::Rounding
R
 Used rounding policies.
typedef
gecode_boost::numeric::interval_lib::checking_strict
< FloatNum
P
 Used checking policy.
typedef
gecode_boost::numeric::interval
< FloatNum,
gecode_boost::numeric::interval_lib::policies
< R, P > > 
FloatValImpType
 Implementation type for float value.

Protected Member Functions

 FloatVal (const FloatValImpType &i)
 Initialize from implementation i.

Protected Attributes

FloatValImpType x
 Implementation of float value.

Friends

FloatVal operator+ (const FloatVal &x)
 Arithmetic operator.
FloatVal operator- (const FloatVal &x)
 Arithmetic operator.
FloatVal operator+ (const FloatVal &x, const FloatVal &y)
 Arithmetic operator.
FloatVal operator+ (const FloatVal &x, const FloatNum &y)
 Arithmetic operator.
FloatVal operator+ (const FloatNum &x, const FloatVal &y)
 Arithmetic operator.
FloatVal operator- (const FloatVal &x, const FloatVal &y)
 Arithmetic operator.
FloatVal operator- (const FloatVal &x, const FloatNum &y)
 Arithmetic operator.
FloatVal operator- (const FloatNum &x, const FloatVal &y)
 Arithmetic operator.
FloatVal operator* (const FloatVal &x, const FloatVal &y)
 Arithmetic operator.
FloatVal operator* (const FloatVal &x, const FloatNum &y)
 Arithmetic operator.
FloatVal operator* (const FloatNum &x, const FloatVal &y)
 Arithmetic operator.
FloatVal operator/ (const FloatVal &x, const FloatVal &y)
 Arithmetic operator.
FloatVal operator/ (const FloatVal &x, const FloatNum &y)
 Arithmetic operator.
FloatVal operator/ (const FloatNum &x, const FloatVal &y)
 Arithmetic operator.
bool operator< (const FloatVal &x, const FloatVal &y)
 Comparison operator.
bool operator< (const FloatVal &x, const FloatNum &y)
 Comparison operator.
bool operator< (const FloatNum &x, const FloatVal &y)
 Comparison operator.
bool operator<= (const FloatVal &x, const FloatVal &y)
 Comparison operator.
bool operator<= (const FloatVal &x, const FloatNum &y)
 Comparison operator.
bool operator<= (const FloatNum &x, const FloatVal &y)
 Comparison operator.
bool operator> (const FloatVal &x, const FloatVal &y)
 Comparison operator.
bool operator> (const FloatVal &x, const FloatNum &y)
 Comparison operator.
bool operator> (const FloatNum &x, const FloatVal &y)
 Comparison operator.
bool operator>= (const FloatVal &x, const FloatVal &y)
 Comparison operator.
bool operator>= (const FloatVal &x, const FloatNum &y)
 Comparison operator.
bool operator>= (const FloatNum &x, const FloatVal &y)
 Comparison operator.
bool operator== (const FloatVal &x, const FloatVal &y)
 Comparison operator.
bool operator== (const FloatVal &x, const FloatNum &y)
 Comparison operator.
bool operator== (const FloatNum &x, const FloatVal &y)
 Comparison operator.
bool operator!= (const FloatVal &x, const FloatVal &y)
 Comparison operator.
bool operator!= (const FloatVal &x, const FloatNum &y)
 Comparison operator.
bool operator!= (const FloatNum &x, const FloatVal &y)
 Comparison operator.
template<class Char , class Traits >
std::basic_ostream< Char,
Traits > & 
operator<< (std::basic_ostream< Char, Traits > &os, const FloatVal &x)
 Print float value x.
FloatVal abs (const FloatVal &x)
 Return absolute value of x.
FloatVal sqrt (const FloatVal &x)
 Return square root of x.
FloatVal sqr (const FloatVal &x)
 Return square of x.
FloatVal pow (const FloatVal &x, int n)
 Return n -th power of x.
FloatVal nroot (const FloatVal &x, int n)
 Return n -th root of x.
FloatVal max (const FloatVal &x, const FloatVal &y)
 Return maximum of x and y.
FloatVal max (const FloatVal &x, const FloatNum &y)
 Return maximum of x and y.
FloatVal max (const FloatNum &x, const FloatVal &y)
 Return maximum of x and y.
FloatVal min (const FloatVal &x, const FloatVal &y)
 Return minimum of x and y.
FloatVal min (const FloatVal &x, const FloatNum &y)
 Return minimum of x and y.
FloatVal min (const FloatNum &x, const FloatVal &y)
 Return minimum of x and y.
FloatVal exp (const FloatVal &x)
 Return exponential of x.
FloatVal log (const FloatVal &x)
 Return logarithm of x.
FloatVal fmod (const FloatVal &x, const FloatVal &y)
 Trigonometric function argument reduction.
FloatVal fmod (const FloatVal &x, const FloatNum &y)
 Trigonometric function argument reduction.
FloatVal fmod (const FloatNum &x, const FloatVal &y)
 Trigonometric function argument reduction.
FloatVal sin (const FloatVal &x)
 Return sine of x.
FloatVal cos (const FloatVal &x)
 Return cosine of x.
FloatVal tan (const FloatVal &x)
 Return tangent of x.
FloatVal asin (const FloatVal &x)
 Return arcsine of x.
FloatVal acos (const FloatVal &x)
 Return arccosine of x.
FloatVal atan (const FloatVal &x)
 Return arctangent of x.
FloatVal sinh (const FloatVal &x)
 Return hyperbolic of x.
FloatVal cosh (const FloatVal &x)
 Return hyperbolic of x.
FloatVal tanh (const FloatVal &x)
 Return hyperbolic of x.
FloatVal asinh (const FloatVal &x)
 Return hyperbolic of x.
FloatVal acosh (const FloatVal &x)
 Return hyperbolic of x.
FloatVal atanh (const FloatVal &x)
 Return hyperbolic of x.
bool Float::subset (const FloatVal &x, const FloatVal &y)
bool Float::proper_subset (const FloatVal &x, const FloatVal &y)
bool Float::overlap (const FloatVal &x, const FloatVal &y)
FloatVal Float::intersect (const FloatVal &x, const FloatVal &y)
FloatVal Float::hull (const FloatVal &x, const FloatVal &y)
FloatVal Float::hull (const FloatVal &x, const FloatNum &y)
FloatVal Float::hull (const FloatNum &x, const FloatVal &y)
FloatVal Float::hull (const FloatNum &x, const FloatNum &y)

Related Functions

(Note that these are not member functions.)



bool subset (const FloatVal &x, const FloatVal &y)
 Test whether x is a subset of y.
bool proper_subset (const FloatVal &x, const FloatVal &y)
 Test whether x is a proper subset of y.
bool overlap (const FloatVal &x, const FloatVal &y)
 Test whether x and y overlap.
FloatVal intersect (const FloatVal &x, const FloatVal &y)
 Return intersection of x and y.
FloatVal hull (const FloatVal &x, const FloatVal &y)
 Return hull of x and y.
FloatVal hull (const FloatVal &x, const FloatNum &y)
 Return hull of x and y.
FloatVal hull (const FloatNum &x, const FloatVal &y)
 Return hull of x and y.
FloatVal hull (const FloatNum &x, const FloatNum &y)
 Return hull of x and y.

Constructors and initialization



 FloatVal (void)
 Default constructor.
 FloatVal (const FloatNum &n)
 Initialize with float number n.
 FloatVal (const FloatNum &l, const FloatNum &u)
 Initialize with lower bound l and upper bound u.
 FloatVal (const FloatVal &v)
 Copy constructor.
FloatValoperator= (const FloatNum &n)
 Assignment operator.
FloatValoperator= (const FloatVal &v)
 Assignment operator.
void assign (FloatNum const &l, FloatNum const &u)
 Assign lower bound l and upper bound u.

Value access



FloatNum min (void) const
 Return lower bound.
FloatNum max (void) const
 Return upper bound.
FloatNum size (void) const
 Return size of float value (distance between maximum and minimum).
FloatNum med (void) const
 Return median of float value.

Value tests



bool tight (void) const
 Test whether float is tight.
bool singleton (void) const
 Test whether float is a singleton.
bool in (FloatNum n) const
 Test whether n is included.
bool zero_in (void) const
 Test whether zero is included.

Update operators



FloatValoperator+= (const FloatNum &n)
 Increment by n.
FloatValoperator-= (const FloatNum &n)
 Subtract by n.
FloatValoperator*= (const FloatNum &n)
 Multiply by n.
FloatValoperator/= (const FloatNum &n)
 Divide by n.
FloatValoperator+= (const FloatVal &v)
 Increment by v.
FloatValoperator-= (const FloatVal &v)
 Subtract by v.
FloatValoperator*= (const FloatVal &v)
 Multiply by v.
FloatValoperator/= (const FloatVal &v)
 Divide by v.

Float value construction



static FloatVal hull (FloatNum x, FloatNum y)
 Return hull of x and y.
static FloatVal pi_half (void)
 Return $\pi/2$.
static FloatVal pi (void)
 Return lower bound of $\pi$.
static FloatVal pi_twice (void)
 Return $2\pi$.

Detailed Description

Float value type.

Definition at line 334 of file float.hh.


Member Typedef Documentation

typedef gecode_boost::numeric::interval_lib::save_state<Float::Rounding> Gecode::FloatVal::R [protected]

Used rounding policies.

Definition at line 416 of file float.hh.

typedef gecode_boost::numeric::interval_lib::checking_strict<FloatNum> Gecode::FloatVal::P [protected]

Used checking policy.

Definition at line 418 of file float.hh.

typedef gecode_boost::numeric::interval<FloatNum, gecode_boost::numeric::interval_lib::policies<R, P> > Gecode::FloatVal::FloatValImpType [protected]

Implementation type for float value.

Definition at line 423 of file float.hh.


Constructor & Destructor Documentation

Gecode::FloatVal::FloatVal ( const FloatValImpType i  )  [inline, explicit, protected]

Initialize from implementation i.

Definition at line 51 of file val.hpp.

Gecode::FloatVal::FloatVal ( void   )  [inline]

Default constructor.

Definition at line 45 of file val.hpp.

Gecode::FloatVal::FloatVal ( const FloatNum n  )  [inline]

Initialize with float number n.

Definition at line 47 of file val.hpp.

Gecode::FloatVal::FloatVal ( const FloatNum l,
const FloatNum u 
) [inline]

Initialize with lower bound l and upper bound u.

Definition at line 49 of file val.hpp.

Gecode::FloatVal::FloatVal ( const FloatVal v  )  [inline]

Copy constructor.

Definition at line 53 of file val.hpp.


Member Function Documentation

FloatVal & Gecode::FloatVal::operator= ( const FloatNum n  )  [inline]

Assignment operator.

Definition at line 56 of file val.hpp.

FloatVal & Gecode::FloatVal::operator= ( const FloatVal v  )  [inline]

Assignment operator.

Definition at line 60 of file val.hpp.

void Gecode::FloatVal::assign ( FloatNum const &  l,
FloatNum const &  u 
) [inline]

Assign lower bound l and upper bound u.

Definition at line 65 of file val.hpp.

FloatNum Gecode::FloatVal::min ( void   )  const [inline]

Return lower bound.

Definition at line 70 of file val.hpp.

FloatNum Gecode::FloatVal::max ( void   )  const [inline]

Return upper bound.

Definition at line 74 of file val.hpp.

FloatNum Gecode::FloatVal::size ( void   )  const [inline]

Return size of float value (distance between maximum and minimum).

Definition at line 78 of file val.hpp.

FloatNum Gecode::FloatVal::med ( void   )  const [inline]

Return median of float value.

Definition at line 82 of file val.hpp.

bool Gecode::FloatVal::tight ( void   )  const [inline]

Test whether float is tight.

Definition at line 87 of file val.hpp.

bool Gecode::FloatVal::singleton ( void   )  const [inline]

Test whether float is a singleton.

Definition at line 92 of file val.hpp.

bool Gecode::FloatVal::in ( FloatNum  n  )  const [inline]

Test whether n is included.

Definition at line 96 of file val.hpp.

bool Gecode::FloatVal::zero_in ( void   )  const [inline]

Test whether zero is included.

Definition at line 100 of file val.hpp.

FloatVal Gecode::FloatVal::hull ( FloatNum  x,
FloatNum  y 
) [inline, static]

Return hull of x and y.

Definition at line 105 of file val.hpp.

FloatVal Gecode::FloatVal::pi_half ( void   )  [inline, static]

Return $\pi/2$.

Definition at line 109 of file val.hpp.

FloatVal Gecode::FloatVal::pi ( void   )  [inline, static]

Return lower bound of $\pi$.

Definition at line 114 of file val.hpp.

FloatVal Gecode::FloatVal::pi_twice ( void   )  [inline, static]

Return $2\pi$.

Definition at line 119 of file val.hpp.

FloatVal & Gecode::FloatVal::operator+= ( const FloatNum n  )  [inline]

Increment by n.

Definition at line 125 of file val.hpp.

FloatVal & Gecode::FloatVal::operator-= ( const FloatNum n  )  [inline]

Subtract by n.

Definition at line 129 of file val.hpp.

FloatVal & Gecode::FloatVal::operator*= ( const FloatNum n  )  [inline]

Multiply by n.

Definition at line 133 of file val.hpp.

FloatVal & Gecode::FloatVal::operator/= ( const FloatNum n  )  [inline]

Divide by n.

Definition at line 137 of file val.hpp.

FloatVal & Gecode::FloatVal::operator+= ( const FloatVal v  )  [inline]

Increment by v.

Definition at line 142 of file val.hpp.

FloatVal & Gecode::FloatVal::operator-= ( const FloatVal v  )  [inline]

Subtract by v.

Definition at line 146 of file val.hpp.

FloatVal & Gecode::FloatVal::operator*= ( const FloatVal v  )  [inline]

Multiply by v.

Definition at line 150 of file val.hpp.

FloatVal & Gecode::FloatVal::operator/= ( const FloatVal v  )  [inline]

Divide by v.

Definition at line 154 of file val.hpp.


Friends And Related Function Documentation

FloatVal operator+ ( const FloatVal x  )  [friend]

Arithmetic operator.

Definition at line 164 of file val.hpp.

FloatVal operator- ( const FloatVal x  )  [friend]

Arithmetic operator.

Definition at line 168 of file val.hpp.

FloatVal operator+ ( const FloatVal x,
const FloatVal y 
) [friend]

Arithmetic operator.

Definition at line 174 of file val.hpp.

FloatVal operator+ ( const FloatVal x,
const FloatNum y 
) [friend]

Arithmetic operator.

Definition at line 178 of file val.hpp.

FloatVal operator+ ( const FloatNum x,
const FloatVal y 
) [friend]

Arithmetic operator.

Definition at line 182 of file val.hpp.

FloatVal operator- ( const FloatVal x,
const FloatVal y 
) [friend]

Arithmetic operator.

Definition at line 187 of file val.hpp.

FloatVal operator- ( const FloatVal x,
const FloatNum y 
) [friend]

Arithmetic operator.

Definition at line 191 of file val.hpp.

FloatVal operator- ( const FloatNum x,
const FloatVal y 
) [friend]

Arithmetic operator.

Definition at line 195 of file val.hpp.

FloatVal operator* ( const FloatVal x,
const FloatVal y 
) [friend]

Arithmetic operator.

Definition at line 200 of file val.hpp.

FloatVal operator* ( const FloatVal x,
const FloatNum y 
) [friend]

Arithmetic operator.

Definition at line 204 of file val.hpp.

FloatVal operator* ( const FloatNum x,
const FloatVal y 
) [friend]

Arithmetic operator.

Definition at line 208 of file val.hpp.

FloatVal operator/ ( const FloatVal x,
const FloatVal y 
) [friend]

Arithmetic operator.

Definition at line 213 of file val.hpp.

FloatVal operator/ ( const FloatVal x,
const FloatNum y 
) [friend]

Arithmetic operator.

Definition at line 217 of file val.hpp.

FloatVal operator/ ( const FloatNum x,
const FloatVal y 
) [friend]

Arithmetic operator.

Definition at line 221 of file val.hpp.

bool operator< ( const FloatVal x,
const FloatVal y 
) [friend]

Comparison operator.

Definition at line 226 of file val.hpp.

bool operator< ( const FloatVal x,
const FloatNum y 
) [friend]

Comparison operator.

Definition at line 234 of file val.hpp.

bool operator< ( const FloatNum x,
const FloatVal y 
) [friend]

Comparison operator.

Definition at line 334 of file val.hpp.

bool operator<= ( const FloatVal x,
const FloatVal y 
) [friend]

Comparison operator.

Definition at line 243 of file val.hpp.

bool operator<= ( const FloatVal x,
const FloatNum y 
) [friend]

Comparison operator.

Definition at line 251 of file val.hpp.

bool operator<= ( const FloatNum x,
const FloatVal y 
) [friend]

Comparison operator.

Definition at line 338 of file val.hpp.

bool operator> ( const FloatVal x,
const FloatVal y 
) [friend]

Comparison operator.

Definition at line 260 of file val.hpp.

bool operator> ( const FloatVal x,
const FloatNum y 
) [friend]

Comparison operator.

Definition at line 268 of file val.hpp.

bool operator> ( const FloatNum x,
const FloatVal y 
) [friend]

Comparison operator.

Definition at line 342 of file val.hpp.

bool operator>= ( const FloatVal x,
const FloatVal y 
) [friend]

Comparison operator.

Definition at line 277 of file val.hpp.

bool operator>= ( const FloatVal x,
const FloatNum y 
) [friend]

Comparison operator.

Definition at line 285 of file val.hpp.

bool operator>= ( const FloatNum x,
const FloatVal y 
) [friend]

Comparison operator.

Definition at line 346 of file val.hpp.

bool operator== ( const FloatVal x,
const FloatVal y 
) [friend]

Comparison operator.

Definition at line 294 of file val.hpp.

bool operator== ( const FloatVal x,
const FloatNum y 
) [friend]

Comparison operator.

Definition at line 302 of file val.hpp.

bool operator== ( const FloatNum x,
const FloatVal y 
) [friend]

Comparison operator.

Definition at line 350 of file val.hpp.

bool operator!= ( const FloatVal x,
const FloatVal y 
) [friend]

Comparison operator.

Definition at line 317 of file val.hpp.

bool operator!= ( const FloatVal x,
const FloatNum y 
) [friend]

Comparison operator.

Definition at line 325 of file val.hpp.

bool operator!= ( const FloatNum x,
const FloatVal y 
) [friend]

Comparison operator.

Definition at line 354 of file val.hpp.

template<class Char , class Traits >
std::basic_ostream< Char, Traits > & operator<< ( std::basic_ostream< Char, Traits > &  os,
const FloatVal x 
) [friend]

Print float value x.

Definition at line 360 of file val.hpp.

FloatVal abs ( const FloatVal x  )  [friend]

Return absolute value of x.

Definition at line 365 of file val.hpp.

FloatVal sqrt ( const FloatVal x  )  [friend]

Return square root of x.

Definition at line 369 of file val.hpp.

FloatVal sqr ( const FloatVal x  )  [friend]

Return square of x.

Definition at line 373 of file val.hpp.

FloatVal pow ( const FloatVal x,
int  n 
) [friend]

Return n -th power of x.

Definition at line 377 of file val.hpp.

FloatVal nroot ( const FloatVal x,
int  n 
) [friend]

Return n -th root of x.

Definition at line 381 of file val.hpp.

FloatVal max ( const FloatVal x,
const FloatVal y 
) [friend]

Return maximum of x and y.

Definition at line 386 of file val.hpp.

FloatVal max ( const FloatVal x,
const FloatNum y 
) [friend]

Return maximum of x and y.

Definition at line 390 of file val.hpp.

FloatVal max ( const FloatNum x,
const FloatVal y 
) [friend]

Return maximum of x and y.

Definition at line 394 of file val.hpp.

FloatVal min ( const FloatVal x,
const FloatVal y 
) [friend]

Return minimum of x and y.

Definition at line 398 of file val.hpp.

FloatVal min ( const FloatVal x,
const FloatNum y 
) [friend]

Return minimum of x and y.

Definition at line 402 of file val.hpp.

FloatVal min ( const FloatNum x,
const FloatVal y 
) [friend]

Return minimum of x and y.

Definition at line 406 of file val.hpp.

FloatVal exp ( const FloatVal x  )  [friend]

Return exponential of x.

Definition at line 413 of file val.hpp.

FloatVal log ( const FloatVal x  )  [friend]

Return logarithm of x.

Definition at line 417 of file val.hpp.

FloatVal fmod ( const FloatVal x,
const FloatVal y 
) [friend]

Trigonometric function argument reduction.

Definition at line 422 of file val.hpp.

FloatVal fmod ( const FloatVal x,
const FloatNum y 
) [friend]

Trigonometric function argument reduction.

Definition at line 426 of file val.hpp.

FloatVal fmod ( const FloatNum x,
const FloatVal y 
) [friend]

Trigonometric function argument reduction.

Definition at line 430 of file val.hpp.

FloatVal sin ( const FloatVal x  )  [friend]

Return sine of x.

Definition at line 435 of file val.hpp.

FloatVal cos ( const FloatVal x  )  [friend]

Return cosine of x.

Definition at line 439 of file val.hpp.

FloatVal tan ( const FloatVal x  )  [friend]

Return tangent of x.

Definition at line 443 of file val.hpp.

FloatVal asin ( const FloatVal x  )  [friend]

Return arcsine of x.

Definition at line 447 of file val.hpp.

FloatVal acos ( const FloatVal x  )  [friend]

Return arccosine of x.

Definition at line 451 of file val.hpp.

FloatVal atan ( const FloatVal x  )  [friend]

Return arctangent of x.

Definition at line 455 of file val.hpp.

FloatVal sinh ( const FloatVal x  )  [friend]

Return hyperbolic of x.

Definition at line 460 of file val.hpp.

FloatVal cosh ( const FloatVal x  )  [friend]

Return hyperbolic of x.

Definition at line 464 of file val.hpp.

FloatVal tanh ( const FloatVal x  )  [friend]

Return hyperbolic of x.

Definition at line 468 of file val.hpp.

FloatVal asinh ( const FloatVal x  )  [friend]

Return hyperbolic of x.

Definition at line 472 of file val.hpp.

FloatVal acosh ( const FloatVal x  )  [friend]

Return hyperbolic of x.

Definition at line 476 of file val.hpp.

FloatVal atanh ( const FloatVal x  )  [friend]

Return hyperbolic of x.

Definition at line 480 of file val.hpp.

bool Float::subset ( const FloatVal x,
const FloatVal y 
) [friend]
bool Float::proper_subset ( const FloatVal x,
const FloatVal y 
) [friend]
bool Float::overlap ( const FloatVal x,
const FloatVal y 
) [friend]
FloatVal Float::intersect ( const FloatVal x,
const FloatVal y 
) [friend]
FloatVal Float::hull ( const FloatVal x,
const FloatVal y 
) [friend]
FloatVal Float::hull ( const FloatVal x,
const FloatNum y 
) [friend]
FloatVal Float::hull ( const FloatNum x,
const FloatVal y 
) [friend]
FloatVal Float::hull ( const FloatNum x,
const FloatNum y 
) [friend]
bool subset ( const FloatVal x,
const FloatVal y 
) [related]

Test whether x is a subset of y.

Definition at line 490 of file val.hpp.

bool proper_subset ( const FloatVal x,
const FloatVal y 
) [related]

Test whether x is a proper subset of y.

Definition at line 494 of file val.hpp.

bool overlap ( const FloatVal x,
const FloatVal y 
) [related]

Test whether x and y overlap.

Definition at line 498 of file val.hpp.

FloatVal intersect ( const FloatVal x,
const FloatVal y 
) [related]

Return intersection of x and y.

Definition at line 503 of file val.hpp.

FloatVal hull ( const FloatVal x,
const FloatVal y 
) [related]

Return hull of x and y.

Definition at line 507 of file val.hpp.

FloatVal hull ( const FloatVal x,
const FloatNum y 
) [related]

Return hull of x and y.

Definition at line 511 of file val.hpp.

FloatVal hull ( const FloatNum x,
const FloatVal y 
) [related]

Return hull of x and y.

Definition at line 515 of file val.hpp.

FloatVal hull ( const FloatNum x,
const FloatNum y 
) [related]

Return hull of x and y.

Definition at line 519 of file val.hpp.


Member Data Documentation

Implementation of float value.

Definition at line 425 of file float.hh.


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