STK::Arithmetic< Integer > Struct Template Reference

Specialization for Integer (long). More...

#include <STK_Integer.h>

Inheritance diagram for STK::Arithmetic< Integer >:

List of all members.

Static Public Member Functions
static Integer	max () throw ()
	We are using the maximal value of the Integer Type for NA values.
static Integer	NA () throw ()
	Adding a Non Avalaible (NA) special number.
static bool	isNA (Integer const &x) throw ()
	Test if x is a Non Avalaible (NA) special number.
static bool	isInfinite (Integer const &x) throw ()
	Test if x is infinite.
static bool	isFinite (Integer const &x) throw ()
	Test if x is finite : i.e.
Static Public Attributes
static const bool	hasNA = true
	True if the type has a representation for a "Not Available".

---

Detailed Description

template<>
struct STK::Arithmetic< Integer >

Specialization for Integer (long).

We are using the largest element of the underlying Type for representing NA (not available) discrete numbers.

Definition at line 59 of file STK_Integer.h.

---

Member Function Documentation

static Integer STK::Arithmetic< Integer >::max

(

)

throw () [inline, static]

We are using the maximal value of the Integer Type for NA values.

Definition at line 63 of file STK_Integer.h.

References STK::max().

  { return std::numeric_limits<Integer>::max() -1; }

static Integer STK::Arithmetic< Integer >::NA

(

)

throw () [inline, static]

Adding a Non Avalaible (NA) special number.

Definition at line 68 of file STK_Integer.h.

References STK::max().

  { return std::numeric_limits<Integer>::max();}

static bool STK::Arithmetic< Integer >::isNA

(

Integer const &

x

)

throw () [inline, static]

Test if x is a Non Avalaible (NA) special number.

Parameters:

x	the Integer number to test.

Definition at line 78 of file STK_Integer.h.

References STK::max().

  { return (x==std::numeric_limits<Integer>::max());}

static bool STK::Arithmetic< Integer >::isInfinite

(

Integer const &

x

)

throw () [inline, static]

Test if x is infinite.

Parameters:

x	the Integer number to test.

Definition at line 84 of file STK_Integer.h.

  { return false; }

static bool STK::Arithmetic< Integer >::isFinite

(

Integer const &

x

)

throw () [inline, static]

Test if x is finite : i.e.

if x is not infinite and x is not a NA value.

Parameters:

x	the value to test.

Definition at line 91 of file STK_Integer.h.

References STK::Arithmetic< TYPE >::isNA().

  { return (!isNA(x));}

---

Member Data Documentation

const bool STK::Arithmetic< Integer >::hasNA = true [static]

True if the type has a representation for a "Not Available".

Definition at line 73 of file STK_Integer.h.

---

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

• STK_Integer.h