Generated on Mon May 30 22:31:56 2016 for Gecode by doxygen 1.6.1

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 variable view.
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 321 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 403 of file float.hh.

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

Used checking policy.

Definition at line 405 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 410 of file float.hh.


Constructor & Destructor Documentation

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

Initialize from implementation i.

Definition at line 55 of file val.hpp.

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

Default constructor.

Definition at line 49 of file val.hpp.

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

Initialize with float number n.

Definition at line 51 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 53 of file val.hpp.

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

Copy constructor.

Definition at line 57 of file val.hpp.


Member Function Documentation

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

Assignment operator.

Definition at line 60 of file val.hpp.

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

Assignment operator.

Definition at line 64 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 69 of file val.hpp.

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

Return lower bound.

Definition at line 74 of file val.hpp.

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

Return upper bound.

Definition at line 78 of file val.hpp.

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

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

Definition at line 82 of file val.hpp.

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

Return median of float value.

Definition at line 86 of file val.hpp.

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

Test whether float is tight.

Definition at line 91 of file val.hpp.

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

Test whether float is a singleton.

Definition at line 96 of file val.hpp.

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

Test whether n is included.

Definition at line 100 of file val.hpp.

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

Test whether zero is included.

Definition at line 104 of file val.hpp.

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

Return hull of x and y.

Definition at line 109 of file val.hpp.

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

Return $\pi/2$.

Definition at line 113 of file val.hpp.

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

Return lower bound of $\pi$.

Definition at line 118 of file val.hpp.

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

Return $2\pi$.

Definition at line 123 of file val.hpp.

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

Increment by n.

Definition at line 129 of file val.hpp.

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

Subtract by n.

Definition at line 133 of file val.hpp.

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

Multiply by n.

Definition at line 137 of file val.hpp.

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

Divide by n.

Definition at line 141 of file val.hpp.

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

Increment by v.

Definition at line 146 of file val.hpp.

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

Subtract by v.

Definition at line 150 of file val.hpp.

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

Multiply by v.

Definition at line 154 of file val.hpp.

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

Divide by v.

Definition at line 158 of file val.hpp.


Friends And Related Function Documentation

FloatVal operator+ ( const FloatVal x  )  [friend]

Arithmetic operator.

FloatVal operator- ( const FloatVal x  )  [friend]

Arithmetic operator.

ArrayTraits< ArgArray< T > >::ArgsType operator+ ( const FloatVal x,
const FloatVal y 
) [friend]

Arithmetic operator.

Concatenate x and y and return result

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

Arithmetic operator.

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

Arithmetic operator.

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

Arithmetic operator.

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

Arithmetic operator.

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

Arithmetic operator.

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

Arithmetic operator.

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

Arithmetic operator.

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

Arithmetic operator.

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

Arithmetic operator.

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

Arithmetic operator.

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

Arithmetic operator.

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

Comparison operator.

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

Comparison operator.

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

Comparison operator.

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

Comparison operator.

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

Comparison operator.

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

Comparison operator.

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

Comparison operator.

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

Comparison operator.

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

Comparison operator.

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

Comparison operator.

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

Comparison operator.

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

Comparison operator.

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

Comparison operator.

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

Comparison operator.

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

Comparison operator.

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

Comparison operator.

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

Comparison operator.

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

Comparison operator.

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

Print float variable view.

Print set variable x.

Print complement set view.

Print singleton set view.

Print universe set view.

Print empty set view.

Print constant set view.

Print set variable view.

Print AFC information (prints nothing).

Print activity values enclosed in curly brackets.

Print Boolean variable x.

Print integer variable x.

Print integer set s.

Print negated Boolean view.

Print Boolean view.

Print integer constant integer view.

Print long long-precision integer scale view.

Print integer-precision integer scale view.

Print integer offset view.

Print integer minus view.

Print optional task in format est:lst:pmin:pmax:ect:lct:m.

Print task in format est:lst:pmin:pmax:ect:lct.

Print optional task in format est:p:lct:m.

Print task in format est:p:lct.

Print integer variable view.

Print array elements enclosed in curly brackets.

Print optional task in format est:lst:pmin:pmax:c:ect:lct:m.

Print optional task in format est:[p,c]:lct:m.

Print task in format est:[p,c]:lct.

Print float variable x.

Print float value x.

Print scale view.

Print float offset view.

Print float minus view.

Print DFA d

Print TupleSet ts

Print regular expression r

Print matrix m

Definition at line 159 of file int-noview.hpp.

FloatVal abs ( const FloatVal x  )  [friend]

Return absolute value of x.

FloatVal sqrt ( const FloatVal x  )  [friend]

Return square root of x.

FloatVal sqr ( const FloatVal x  )  [friend]

Return square of x.

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

Return n -th power of x.

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

Return n -th root of x.

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

Return maximum of x and y.

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

Return maximum of x and y.

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

Return maximum of x and y.

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

Return minimum of x and y.

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

Return minimum of x and y.

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

Return minimum of x and y.

FloatVal exp ( const FloatVal x  )  [friend]

Return exponential of x.

FloatVal log ( const FloatVal x  )  [friend]

Return logarithm of x.

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

Trigonometric function argument reduction.

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

Trigonometric function argument reduction.

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

Trigonometric function argument reduction.

FloatVal sin ( const FloatVal x  )  [friend]

Return sine of x.

FloatVal cos ( const FloatVal x  )  [friend]

Return cosine of x.

FloatVal tan ( const FloatVal x  )  [friend]

Return tangent of x.

FloatVal asin ( const FloatVal x  )  [friend]

Return arcsine of x.

FloatVal acos ( const FloatVal x  )  [friend]

Return arccosine of x.

FloatVal atan ( const FloatVal x  )  [friend]

Return arctangent of x.

FloatVal sinh ( const FloatVal x  )  [friend]

Return hyperbolic of x.

FloatVal cosh ( const FloatVal x  )  [friend]

Return hyperbolic of x.

FloatVal tanh ( const FloatVal x  )  [friend]

Return hyperbolic of x.

FloatVal asinh ( const FloatVal x  )  [friend]

Return hyperbolic of x.

FloatVal acosh ( const FloatVal x  )  [friend]

Return hyperbolic of x.

FloatVal atanh ( const FloatVal x  )  [friend]

Return hyperbolic of x.

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.

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

Test whether x is a proper subset of y.

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

Test whether x and y overlap.

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

Return intersection of x and y.

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

Return hull of x and y.

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

Return hull of x and y.

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

Return hull of x and y.

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

Return hull of x and y.

Definition at line 523 of file val.hpp.


Member Data Documentation

Implementation of float value.

Definition at line 412 of file float.hh.


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