sheaf::index_traits< T > Struct Template Reference

Features describing T as an index type. More...

#include <index_traits.h>

Public Types
typedef T	index_type
	The index type. More...
typedef T	pod_type
	An integral type representing a relative index. More...

Static Public Member Functions
static pod_type	pod (const T &xindex)
	Converts an index type xindex to pod_type. More...
static void	put_pod (T &xindex, pod_type &xpod)
	Sets the pod of index type xindex to xpod. More...
static T	invalid ()
	The invalid index value. More...
static bool	is_valid (const T &xindex)
	True if xindex is valid. More...
static T	zero ()
	The additive identity. More...
static T	one ()
	The multiplicative identity. More...
static bool	is_positive (const T &xindex)
	True if xindex is >= zero(). More...
static bool	is_positive_definite (const T &xindex)
	True if xindex is > zero(). More...
static T	max ()
	The maximum valid value. More...
static T	min ()
	The minimum valid value. More...

Detailed Description

template<typename T>
struct sheaf::index_traits< T >

Features describing T as an index type.

Definition at line 38 of file index_traits.h.

Member Typedef Documentation

index_type

template<typename T>

typedef T sheaf::index_traits< T >::index_type

The index type.

Definition at line 43 of file index_traits.h.

pod_type

template<typename T>

typedef T sheaf::index_traits< T >::pod_type

An integral type representing a relative index.

Definition at line 48 of file index_traits.h.

Member Function Documentation

invalid()

template<typename T>

static T sheaf::index_traits< T >::invalid ( )

inlinestatic

The invalid index value.

Definition at line 70 of file index_traits.h.

References fiber_bundle::vd_algebra::max().

Referenced by sheaf::record_map< pod_index_type, pod_index_type >::clear(), sheaf::record_map< pod_index_type, pod_index_type >::external_id(), sheaf::invalid_block_initialization_policy< T >::initialize(), sheaf::record_map< pod_index_type, pod_index_type >::internal_id(), and sheaf::record_map< pod_index_type, pod_index_type >::record_map().

is_positive()

template<typename T>

static bool sheaf::index_traits< T >::is_positive ( const T &  xindex )

inlinestatic

True if xindex is >= zero().

Definition at line 102 of file index_traits.h.

is_positive_definite()

template<typename T>

static bool sheaf::index_traits< T >::is_positive_definite ( const T &  xindex )

inlinestatic

True if xindex is > zero().

Definition at line 110 of file index_traits.h.

is_valid()

template<typename T>

static bool sheaf::index_traits< T >::is_valid ( const T &  xindex )

inlinestatic

True if xindex is valid.

Definition at line 78 of file index_traits.h.

max()

template<typename T>

static T sheaf::index_traits< T >::max ( )

inlinestatic

The maximum valid value.

Definition at line 118 of file index_traits.h.

References fiber_bundle::vd_algebra::max().

min()

template<typename T>

static T sheaf::index_traits< T >::min ( )

inlinestatic

The minimum valid value.

Definition at line 126 of file index_traits.h.

References fiber_bundle::vd_algebra::min().

Referenced by sheaf::record_map< pod_index_type, pod_index_type >::clear(), and sheaf::record_map< pod_index_type, pod_index_type >::record_map().

one()

template<typename T>

static T sheaf::index_traits< T >::one ( )

inlinestatic

The multiplicative identity.

Definition at line 94 of file index_traits.h.

pod()

template<typename T>

static pod_type sheaf::index_traits< T >::pod ( const T &  xindex )

inlinestatic

Converts an index type xindex to pod_type.

Definition at line 53 of file index_traits.h.

put_pod()

template<typename T>

static void sheaf::index_traits< T >::put_pod ( T &  xindex, pod_type &  xpod  )

inlinestatic

Sets the pod of index type xindex to xpod.

Definition at line 61 of file index_traits.h.

Referenced by sheaf::record_map< pod_index_type, pod_index_type >::put_external_id(), and sheaf::record_map< pod_index_type, pod_index_type >::put_internal_id().

zero()

template<typename T>

static T sheaf::index_traits< T >::zero ( )

inlinestatic

The additive identity.

Definition at line 86 of file index_traits.h.

---

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

• index_traits.h