KASKADE 7 development version
Public Member Functions | List of all members
Kaskade::LocalVector< Entry, SortedIdx > Class Template Reference

Providing a vector interface for contiguously stored entries. More...

#include <localVectors.hh>

Detailed Description

template<class Entry, class SortedIdx>
class Kaskade::LocalVector< Entry, SortedIdx >

Providing a vector interface for contiguously stored entries.

Template Parameters
Entrythe type of vector entries
SortedIdxa range of indices (global idx, local idx) sorted ascendingly by global idx

Definition at line 30 of file localVectors.hh.

Public Member Functions

 LocalVector (SortedIdx const &idx, Entry *data_)
 
SortedIdx idx () const
 A sequence of indices, sorted ascendingly by global idx. More...
 
size_t size () const
 The number of entries stored. More...
 
void relocate (Entry *newData)
 Resets the data pointer. More...
 
Entry & operator[] (int idx)
 Access the matrix entries. More...
 
Entry const & operator[] (int idx) const
 

Constructor & Destructor Documentation

◆ LocalVector()

template<class Entry , class SortedIdx >
Kaskade::LocalVector< Entry, SortedIdx >::LocalVector ( SortedIdx const &  idx,
Entry *  data_ 
)
inline

Definition at line 34 of file localVectors.hh.

Member Function Documentation

◆ idx()

template<class Entry , class SortedIdx >
SortedIdx Kaskade::LocalVector< Entry, SortedIdx >::idx ( ) const
inline

A sequence of indices, sorted ascendingly by global idx.

Definition at line 42 of file localVectors.hh.

Referenced by Kaskade::LocalVector< Entry, SortedIdx >::operator[](), and Kaskade::LocalVector< Entry, SortedIdx >::size().

◆ operator[]() [1/2]

template<class Entry , class SortedIdx >
Entry & Kaskade::LocalVector< Entry, SortedIdx >::operator[] ( int  idx)
inline

Access the matrix entries.

Definition at line 63 of file localVectors.hh.

◆ operator[]() [2/2]

template<class Entry , class SortedIdx >
Entry const & Kaskade::LocalVector< Entry, SortedIdx >::operator[] ( int  idx) const
inline

Definition at line 68 of file localVectors.hh.

◆ relocate()

template<class Entry , class SortedIdx >
void Kaskade::LocalVector< Entry, SortedIdx >::relocate ( Entry *  newData)
inline

Resets the data pointer.

Definition at line 55 of file localVectors.hh.

◆ size()

template<class Entry , class SortedIdx >
size_t Kaskade::LocalVector< Entry, SortedIdx >::size ( ) const
inline

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