OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
FConstSlice< T, S > Class Template Reference

Constant version of FSlice. More...

#include <FSlice.h>

Inheritance diagram for FConstSlice< T, S >:
Collaboration diagram for FConstSlice< T, S >:

Public Types

typedef std::random_access_iterator_tag iterator_category
 The iterator tag, taken from the standard template library.
typedef const T value_type
 The value type.
typedef std::ptrdiff_t difference_type
 The pointer difference type.
typedef const T * pointer
 The pointer type.
typedef const T & reference
 The reference type.

Public Member Functions

 FConstSlice (const T *)
 Constructor from array and stride.
 FConstSlice (const FConstSlice &rhs)
FConstSlice & operator= (const FConstSlice &)
bool operator== (const FConstSlice &rhs) const
bool operator!= (const FConstSlice &rhs) const
FConstSlice & operator++ ()
 Increment (iterate forward).
FConstSlice operator++ (int)
 Increment (iterate forward).
FConstSlice & operator-- ()
 Decrement (iterate backward).
FConstSlice operator-- (int)
 Decrement (iterate backward).
FConstSlice & operator+= (std::ptrdiff_t)
 Add multiple stride and assign.
FConstSlice & operator-= (std::ptrdiff_t)
 Subtract multiple stride and assign.
FConstSlice operator+ (std::ptrdiff_t) const
 Add multiple stride.
FConstSlice operator- (std::ptrdiff_t) const
 Subtract multiple stride.
difference_type operator- (const FConstSlice &) const
 Get pointer difference.
const T & operator* () const
 Dereference.
const T & operator[] (int) const
 Delegate.

Private Attributes

const T * cursor

Detailed Description

template<class T, int S>
class FConstSlice< T, S >

Constant version of FSlice.

Definition at line 101 of file FSlice.h.

Member Typedef Documentation

◆ difference_type

template<class T, int S>
typedef std::ptrdiff_t FConstSlice< T, S >::difference_type

The pointer difference type.

Definition at line 112 of file FSlice.h.

◆ iterator_category

template<class T, int S>
typedef std::random_access_iterator_tag FConstSlice< T, S >::iterator_category

The iterator tag, taken from the standard template library.

Definition at line 106 of file FSlice.h.

◆ pointer

template<class T, int S>
typedef const T* FConstSlice< T, S >::pointer

The pointer type.

Definition at line 115 of file FSlice.h.

◆ reference

template<class T, int S>
typedef const T& FConstSlice< T, S >::reference

The reference type.

Definition at line 118 of file FSlice.h.

◆ value_type

template<class T, int S>
typedef const T FConstSlice< T, S >::value_type

The value type.

Definition at line 109 of file FSlice.h.

Constructor & Destructor Documentation

◆ FConstSlice() [1/2]

template<class T, int S>
FConstSlice< T, S >::FConstSlice ( const T * array)
inline

Constructor from array and stride.

Definition at line 293 of file FSlice.h.

References cursor.

Referenced by FConstSlice(), operator!=(), operator+(), operator++(), operator++(), operator+=(), operator-(), operator-(), operator--(), operator--(), operator-=(), operator=(), and operator==().

◆ FConstSlice() [2/2]

template<class T, int S>
FConstSlice< T, S >::FConstSlice ( const FConstSlice< T, S > & rhs)
inline

Definition at line 298 of file FSlice.h.

References cursor, and FConstSlice().

Here is the call graph for this function:

Member Function Documentation

◆ operator!=()

template<class T, int S>
bool FConstSlice< T, S >::operator!= ( const FConstSlice< T, S > & rhs) const
inline

Definition at line 314 of file FSlice.h.

References cursor, and FConstSlice().

Here is the call graph for this function:

◆ operator*()

template<class T, int S>
const T & FConstSlice< T, S >::operator* ( ) const
inline

Dereference.

Definition at line 375 of file FSlice.h.

References cursor.

◆ operator+()

template<class T, int S>
FConstSlice< T, S > FConstSlice< T, S >::operator+ ( std::ptrdiff_t n) const
inline

Add multiple stride.

Definition at line 357 of file FSlice.h.

References FConstSlice().

Here is the call graph for this function:

◆ operator++() [1/2]

template<class T, int S>
FConstSlice< T, S > & FConstSlice< T, S >::operator++ ( )
inline

Increment (iterate forward).

Definition at line 319 of file FSlice.h.

References cursor, and FConstSlice().

Here is the call graph for this function:

◆ operator++() [2/2]

template<class T, int S>
FConstSlice< T, S > FConstSlice< T, S >::operator++ ( int )
inline

Increment (iterate forward).

Definition at line 325 of file FSlice.h.

References cursor, and FConstSlice().

Here is the call graph for this function:

◆ operator+=()

template<class T, int S>
FConstSlice< T, S > & FConstSlice< T, S >::operator+= ( std::ptrdiff_t n)
inline

Add multiple stride and assign.

Definition at line 345 of file FSlice.h.

References cursor, and FConstSlice().

Here is the call graph for this function:

◆ operator-() [1/2]

template<class T, int S>
FConstSlice< T, S >::difference_type FConstSlice< T, S >::operator- ( const FConstSlice< T, S > & rhs) const
inline

Get pointer difference.

Definition at line 370 of file FSlice.h.

References cursor, and FConstSlice().

Here is the call graph for this function:

◆ operator-() [2/2]

template<class T, int S>
FConstSlice< T, S > FConstSlice< T, S >::operator- ( std::ptrdiff_t n) const
inline

Subtract multiple stride.

Definition at line 363 of file FSlice.h.

References FConstSlice().

Here is the call graph for this function:

◆ operator--() [1/2]

template<class T, int S>
FConstSlice< T, S > & FConstSlice< T, S >::operator-- ( )
inline

Decrement (iterate backward).

Definition at line 332 of file FSlice.h.

References cursor, and FConstSlice().

Here is the call graph for this function:

◆ operator--() [2/2]

template<class T, int S>
FConstSlice< T, S > FConstSlice< T, S >::operator-- ( int )
inline

Decrement (iterate backward).

Definition at line 338 of file FSlice.h.

References cursor, and FConstSlice().

Here is the call graph for this function:

◆ operator-=()

template<class T, int S>
FConstSlice< T, S > & FConstSlice< T, S >::operator-= ( std::ptrdiff_t n)
inline

Subtract multiple stride and assign.

Definition at line 351 of file FSlice.h.

References cursor, and FConstSlice().

Here is the call graph for this function:

◆ operator=()

template<class T, int S>
FConstSlice< T, S > & FConstSlice< T, S >::operator= ( const FConstSlice< T, S > & rhs)
inline

Definition at line 303 of file FSlice.h.

References cursor, and FConstSlice().

Here is the call graph for this function:

◆ operator==()

template<class T, int S>
bool FConstSlice< T, S >::operator== ( const FConstSlice< T, S > & rhs) const
inline

Definition at line 309 of file FSlice.h.

References cursor, and FConstSlice().

Here is the call graph for this function:

◆ operator[]()

template<class T, int S>
const T & FConstSlice< T, S >::operator[] ( int n) const
inline

Delegate.

Definition at line 380 of file FSlice.h.

References cursor.

Member Data Documentation

◆ cursor

template<class T, int S>
const T* FConstSlice< T, S >::cursor
mutableprivate

Definition at line 163 of file FSlice.h.

Referenced by FConstSlice(), FConstSlice(), operator!=(), operator*(), operator++(), operator++(), operator+=(), operator-(), operator--(), operator--(), operator-=(), operator=(), operator==(), and operator[]().

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