Gecode::FloatVar Class Reference
[Float variables]

Float variables. More...

#include <float.hh>

List of all members.

Related Functions
(Note that these are not member functions.)
template<class Char , class Traits >
std::basic_ostream< Char, Traits > &	operator<< (std::basic_ostream< Char, Traits > &os, const FloatVar &x)
	Print float variable x.
Constructors and initialization
	FloatVar (void)
	Default constructor.
	FloatVar (const FloatVar &y)
	Initialize from float variable y.
	FloatVar (const Float::FloatView &y)
	Initialize from float view y.
	FloatVar (Space &home, FloatNum min, FloatNum max)
	Initialize variable with range domain.
Value access
FloatVal	domain (void) const
	Return domain.
FloatNum	min (void) const
	Return minimum of domain.
FloatNum	max (void) const
	Return maximum of domain.
FloatNum	med (void) const
	Return median of domain.
FloatNum	size (void) const
	Return size of domain (distance between maximum and minimum).
FloatVal	val (void) const
	Return assigned value.
Domain tests
bool	in (const FloatVal &n) const
	Test whether n is contained in domain.

---

Detailed Description

Float variables.

Definition at line 870 of file float.hh.

---

Constructor & Destructor Documentation

Gecode::FloatVar::FloatVar

(

void

)

[inline]

Default constructor.

Definition at line 44 of file float.hpp.

Gecode::FloatVar::FloatVar

(

const FloatVar &

y

)

[inline]

Initialize from float variable y.

Definition at line 46 of file float.hpp.

Gecode::FloatVar::FloatVar

(

const Float::FloatView &

y

)

[inline]

Initialize from float view y.

Definition at line 49 of file float.hpp.

Gecode::FloatVar::FloatVar	(	Space &	home,
		FloatNum	min,
		FloatNum	max
	)

Initialize variable with range domain.

The variable is created with a domain ranging from min to max. The following exceptions might be thrown:

• If min is greater than max, an exception of type Gecode::Float::VariableEmptyDomain is thrown.
• If min or max exceed the limits for floats as defined in Gecode::Float::Limits, an exception of type Gecode::Float::OutOfLimits is thrown.

Definition at line 40 of file float.cpp.

---

Member Function Documentation

FloatVal Gecode::FloatVar::domain

(

void

)

const [inline]

Return domain.

Definition at line 72 of file float.hpp.

FloatNum Gecode::FloatVar::min

(

void

)

const [inline]

Return minimum of domain.

Definition at line 59 of file float.hpp.

FloatNum Gecode::FloatVar::max

(

void

)

const [inline]

Return maximum of domain.

Definition at line 67 of file float.hpp.

FloatNum Gecode::FloatVar::med

(

void

)

const [inline]

Return median of domain.

Definition at line 63 of file float.hpp.

FloatNum Gecode::FloatVar::size

(

void

)

const [inline]

Return size of domain (distance between maximum and minimum).

Definition at line 77 of file float.hpp.

FloatVal Gecode::FloatVar::val

(

void

)

const [inline]

Return assigned value.

Throws an exception of type Float::ValOfUnassignedVar if variable is not yet assigned.

Definition at line 53 of file float.hpp.

bool Gecode::FloatVar::in

(

const FloatVal &

n

)

const [inline]

Test whether n is contained in domain.

Definition at line 82 of file float.hpp.

---

Friends And Related Function Documentation

template<class Char , class Traits >

std::basic_ostream< Char, Traits > & operator<<	(	std::basic_ostream< Char, Traits > &	os,
		const FloatVar &	x
	)			[related]

Print float variable x.

Definition at line 40 of file print.hpp.

---

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

• gecode/float.hh
• gecode/float/var/float.cpp
• gecode/float/var/float.hpp