Advanced Multi-Physics (AMP)
On-Line Documentation
Public Member Functions | Public Attributes | List of all members
AMP::Range< TYPE > Class Template Referencefinal

Simple range class. More...

#include <ArraySize.h>

Public Member Functions

constexpr TYPE get (size_t index) const
 Get the ith values in the range.
 
constexpr Range ()
 Empty constructor.
 
constexpr Range (const TYPE &i_, const TYPE &j_, const TYPE &k_=1)
 
constexpr size_t size () const
 Get the number of values in the range.
 

Public Attributes

TYPE i
 
TYPE j
 
TYPE k
 

Detailed Description

template<class TYPE = size_t>
class AMP::Range< TYPE >

Simple range class.

Definition at line 78 of file ArraySize.h.

Constructor & Destructor Documentation

◆ Range() [1/2]

template<class TYPE = size_t>
constexpr AMP::Range< TYPE >::Range ( )
inlineconstexpr

Empty constructor.

Definition at line 82 of file ArraySize.h.

◆ Range() [2/2]

template<class TYPE = size_t>
constexpr AMP::Range< TYPE >::Range ( const TYPE &  i_,
const TYPE &  j_,
const TYPE &  k_ = 1 
)
inlineconstexpr

Create a range i:k:j (or i:j)

Parameters
i_Starting value
j_Ending value
k_Increment value

Definition at line 90 of file ArraySize.h.

Member Function Documentation

◆ get()

template<class TYPE = size_t>
constexpr TYPE AMP::Range< TYPE >::get ( size_t  index) const
inlineconstexpr

Get the ith values in the range.

Definition at line 116 of file ArraySize.h.

References CONSTEXPR_IF, AMP::Range< TYPE >::i, and AMP::Range< TYPE >::k.

◆ size()

template<class TYPE = size_t>
constexpr size_t AMP::Range< TYPE >::size ( ) const
inlineconstexpr

Get the number of values in the range.

Definition at line 96 of file ArraySize.h.

References CONSTEXPR_IF, AMP::Range< TYPE >::i, AMP::Range< TYPE >::j, and AMP::Range< TYPE >::k.

Member Data Documentation

◆ i

template<class TYPE = size_t>
TYPE AMP::Range< TYPE >::i

Definition at line 132 of file ArraySize.h.

Referenced by AMP::Range< TYPE >::get(), AMP::operator<<(), and AMP::Range< TYPE >::size().

◆ j

template<class TYPE = size_t>
TYPE AMP::Range< TYPE >::j

Definition at line 132 of file ArraySize.h.

Referenced by AMP::operator<<(), and AMP::Range< TYPE >::size().

◆ k

template<class TYPE = size_t>
TYPE AMP::Range< TYPE >::k

Definition at line 132 of file ArraySize.h.

Referenced by AMP::Range< TYPE >::get(), AMP::operator<<(), and AMP::Range< TYPE >::size().


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



Advanced Multi-Physics (AMP)
Oak Ridge National Laboratory
Idaho National Laboratory
Los Alamos National Laboratory
This page automatically produced from the
source code by doxygen
Last updated: Tue Mar 10 2026 13:06:42.
Comments on this page