SheafSystem  0.0.0.0
sheaf::index_traits< scoped_index > Struct Template Reference

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

#include <scoped_index.h>

Public Types

typedef scoped_index index_type
 The index type. More...
 
typedef index_type::pod_type pod_type
 The plain old data (POD) type associated with the index type. More...
 

Static Public Member Functions

static pod_type pod (const index_type &xindex)
 Converts an index type xindex to pod_type. More...
 
static void put_pod (index_type &xindex, pod_type &xpod)
 Sets the pod of an index type xindex to xpod. More...
 
static index_type invalid ()
 The invalid index value. More...
 
static bool is_valid (const index_type &xindex)
 True if xindex is valid. More...
 
static bool is_positive (const index_type &xindex)
 True if xindex is >= 0. More...
 
static bool is_positive_definite (const index_type &xindex)
 True if xindex is > 0. More...
 

Detailed Description

template<>
struct sheaf::index_traits< scoped_index >

Features describing scoped_index as an index type.

Definition at line 3753 of file scoped_index.h.

Member Typedef Documentation

◆ index_type

The index type.

Definition at line 3758 of file scoped_index.h.

◆ pod_type

The plain old data (POD) type associated with the index type.

Definition at line 3763 of file scoped_index.h.

Member Function Documentation

◆ invalid()

static index_type sheaf::index_traits< scoped_index >::invalid ( )
inlinestatic

The invalid index value.

Definition at line 3785 of file scoped_index.h.

◆ is_positive()

static bool sheaf::index_traits< scoped_index >::is_positive ( const index_type xindex)
inlinestatic

True if xindex is >= 0.

Definition at line 3801 of file scoped_index.h.

References sheaf::scoped_index::is_positive().

◆ is_positive_definite()

static bool sheaf::index_traits< scoped_index >::is_positive_definite ( const index_type xindex)
inlinestatic

True if xindex is > 0.

Definition at line 3809 of file scoped_index.h.

References sheaf::scoped_index::is_positive_definite().

◆ is_valid()

static bool sheaf::index_traits< scoped_index >::is_valid ( const index_type xindex)
inlinestatic

True if xindex is valid.

Definition at line 3793 of file scoped_index.h.

References sheaf::scoped_index::is_valid().

◆ pod()

static pod_type sheaf::index_traits< scoped_index >::pod ( const index_type xindex)
inlinestatic

Converts an index type xindex to pod_type.

Definition at line 3768 of file scoped_index.h.

References sheaf::scoped_index::pod().

◆ put_pod()

static void sheaf::index_traits< scoped_index >::put_pod ( index_type xindex,
pod_type xpod 
)
inlinestatic

Sets the pod of an index type xindex to xpod.

Definition at line 3776 of file scoped_index.h.

References sheaf::scoped_index::put_pod().


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