Spatial C++ Library
Generic Multi-Dimensional Containers and Spatial Operations
spatial::details::Dynamic_rank Struct Reference

The dimension value is stored by a member of the object, but can be modified at run time. More...

#include <spatial_rank.hpp>

Public Member Functions

dimension_type operator() () const
 Returns the dimension for the rank stored in _rank. More...
 
 Dynamic_rank (dimension_type rank=1)
 Build a rank with a default dimension of 1. More...
 

Private Attributes

dimension_type _rank
 The value that stores the rank dimension. More...
 

Detailed Description

The dimension value is stored by a member of the object, but can be modified at run time.

Definition at line 42 of file spatial_rank.hpp.

Constructor & Destructor Documentation

spatial::details::Dynamic_rank::Dynamic_rank ( dimension_type  rank = 1)
explicit

Build a rank with a default dimension of 1.

Parameters
rankThe magnitude of the rank.

Definition at line 51 of file spatial_rank.hpp.

Member Function Documentation

dimension_type spatial::details::Dynamic_rank::operator() ( ) const

Returns the dimension for the rank stored in _rank.

Definition at line 45 of file spatial_rank.hpp.

Member Data Documentation

dimension_type spatial::details::Dynamic_rank::_rank
private

The value that stores the rank dimension.

Definition at line 57 of file spatial_rank.hpp.


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