Nektar::StorageSmvBsr< T >::const_iterator Class Reference

#include <StorageSmvBsr.hpp>

Classes
struct	IterType

Public Member Functions
	const_iterator (MatrixStorage matType, IndexType begin, IndexType end, IndexType blkDim, const DataVectorType &val, const IndexVectorType &indx, const IndexVectorType &pntr)
	const_iterator (const const_iterator &src)
	~const_iterator ()
const_iterator	operator++ (int)
const_iterator &	operator++ ()
const IterType &	operator* ()
const IterType *	operator-> ()
bool	operator== (const const_iterator &rhs)
bool	operator!= (const const_iterator &rhs)

Private Member Functions
void	forward ()
CoordType	storageIndexToFullCoord (IndexType storageIndex)

Private Attributes
MatrixStorage	m_matType
IterType	m_iter
IndexType	m_begin
IndexType	m_end
IndexType	m_blkDim
const DataVectorType &	m_val
const IndexVectorType &	m_indx
const IndexVectorType &	m_pntr

Detailed Description

template<typename T>
class Nektar::StorageSmvBsr< T >::const_iterator

Definition at line 78 of file StorageSmvBsr.hpp.

Constructor & Destructor Documentation

const_iterator() [1/2]

template<typename DataType >

Nektar::StorageSmvBsr< DataType >::const_iterator::const_iterator	(	MatrixStorage	matType,
		IndexType	begin,
		IndexType	end,
		IndexType	blkDim,
		const DataVectorType &	val,
		const IndexVectorType &	indx,
		const IndexVectorType &	pntr
	)

Definition at line 51 of file StorageSmvBsr.cpp.

References Nektar::StorageSmvBsr< T >::begin(), Nektar::StorageSmvBsr< T >::const_iterator::IterType::first, Nektar::NekConstants::kNekSparseNonZeroTol, Nektar::StorageSmvBsr< T >::const_iterator::m_iter, Nektar::StorageSmvBsr< T >::const_iterator::m_val, Nektar::StorageSmvBsr< T >::const_iterator::IterType::nnzindex, Nektar::Array< OneD, const DataType >::num_elements(), Nektar::StorageSmvBsr< T >::const_iterator::IterType::second, Nektar::StorageSmvBsr< T >::const_iterator::IterType::storageindex, and Nektar::StorageSmvBsr< T >::const_iterator::storageIndexToFullCoord().

                                                    :
        m_matType(matType),
        m_iter(),
        m_begin(begin),
        m_end(end),
        m_blkDim(blkDim),
        m_val(val),
        m_indx(indx),
        m_pntr(pntr)
    {
        m_iter.nnzindex = begin;

        // Here we rewind the iterator to the 'begin'-th
        // nonzero double value. Consecutive nonzeros are
        // to lie within dense block and when it's done,
        // jump to the next dense block.
        // NB: m_val stores some explicit zeros that need to be skept.
        if (begin < end)
        {
            // determine offset of 'begin'-th nonzero value

            m_iter.storageindex = 0;
            m_iter.nnzindex     = 0;
            while(m_iter.nnzindex < begin)
            {
                // explicit zero?
                if (m_val[m_iter.storageindex] > NekConstants::kNekSparseNonZeroTol)
                {
                    m_iter.nnzindex++;
                }
                m_iter.storageindex++;
                if (m_iter.storageindex >= m_val.num_elements())
                {
                    std::cout << "const_iterator: 'begin' out stored values bounds" << std::endl;
                    throw 1;
                }
            }
            m_iter.second   = m_val[m_iter.storageindex];

            CoordType c = storageIndexToFullCoord(m_iter.storageindex);
            m_iter.first.first  = c.first;
            m_iter.first.second = c.second;
        }
    }

const_iterator() [2/2]

template<typename DataType >

Nektar::StorageSmvBsr< DataType >::const_iterator::const_iterator

(

const const_iterator &

src

)

Definition at line 133 of file StorageSmvBsr.cpp.

                                                                                  :
        m_matType(src.m_matType),
        m_iter(src.m_iter),
        m_begin(src.m_begin),
        m_end(src.m_end),
        m_val(src.m_val),
        m_indx(src.m_indx),
        m_pntr(src.m_pntr)
    {
    }

~const_iterator()

template<typename DataType >

Nektar::StorageSmvBsr< DataType >::const_iterator::~const_iterator

(

)

Definition at line 145 of file StorageSmvBsr.cpp.

    {
    }

Member Function Documentation

forward()

template<typename DataType >

void Nektar::StorageSmvBsr< DataType >::const_iterator::forward ( )

private

Definition at line 189 of file StorageSmvBsr.cpp.

References Nektar::StorageSmvBsr< T >::const_iterator::IterType::first, Nektar::NekConstants::kNekSparseNonZeroTol, Nektar::StorageSmvBsr< T >::const_iterator::m_end, Nektar::StorageSmvBsr< T >::const_iterator::m_iter, Nektar::StorageSmvBsr< T >::const_iterator::m_val, Nektar::StorageSmvBsr< T >::const_iterator::IterType::nnzindex, Nektar::Array< OneD, const DataType >::num_elements(), Nektar::StorageSmvBsr< T >::const_iterator::IterType::second, Nektar::StorageSmvBsr< T >::const_iterator::IterType::storageindex, and Nektar::StorageSmvBsr< T >::const_iterator::storageIndexToFullCoord().

Referenced by Nektar::StorageSmvBsr< T >::const_iterator::operator++().

    {
        while((m_iter.storageindex+1 < m_val.num_elements()) &&
              (m_val[++m_iter.storageindex] <= NekConstants::kNekSparseNonZeroTol));

        m_iter.nnzindex++;

        if (m_iter.storageindex >= m_val.num_elements())
        {
            m_iter.nnzindex = m_end;
            return;
        }

        m_iter.second   = m_val[m_iter.storageindex];

        CoordType c = storageIndexToFullCoord(m_iter.storageindex);
        m_iter.first.first  = c.first;
        m_iter.first.second = c.second;
    }

operator!=()

template<typename DataType >

bool Nektar::StorageSmvBsr< DataType >::const_iterator::operator!=

(

const const_iterator &

rhs

)

Definition at line 183 of file StorageSmvBsr.cpp.

References Nektar::StorageSmvBsr< T >::const_iterator::m_iter, and Nektar::StorageSmvBsr< T >::const_iterator::IterType::nnzindex.

    {
        return !(m_iter.nnzindex == rhs.m_iter.nnzindex);
    }

operator*()

template<typename DataType >

const StorageSmvBsr< DataType >::const_iterator::IterType & Nektar::StorageSmvBsr< DataType >::const_iterator::operator*

(

)

Definition at line 165 of file StorageSmvBsr.cpp.

References Nektar::StorageSmvBsr< T >::const_iterator::m_iter.

    {
        return m_iter;
    }

operator++() [1/2]

template<typename DataType >

StorageSmvBsr< DataType >::const_iterator Nektar::StorageSmvBsr< DataType >::const_iterator::operator++

(

int

)

Definition at line 150 of file StorageSmvBsr.cpp.

References Nektar::StorageSmvBsr< T >::const_iterator::forward().

    {
        const_iterator out = *this;
        forward();
        return out;
    }

operator++() [2/2]

template<typename DataType >

StorageSmvBsr< DataType >::const_iterator & Nektar::StorageSmvBsr< DataType >::const_iterator::operator++

(

)

Definition at line 158 of file StorageSmvBsr.cpp.

References Nektar::StorageSmvBsr< T >::const_iterator::forward().

    {
        forward();
        return *this;
    }

operator->()

template<typename DataType >

const StorageSmvBsr< DataType >::const_iterator::IterType * Nektar::StorageSmvBsr< DataType >::const_iterator::operator->

(

)

Definition at line 171 of file StorageSmvBsr.cpp.

References Nektar::StorageSmvBsr< T >::const_iterator::m_iter.

    {
        return &m_iter;
    }

operator==()

template<typename DataType >

bool Nektar::StorageSmvBsr< DataType >::const_iterator::operator==

(

const const_iterator &

rhs

)

Definition at line 177 of file StorageSmvBsr.cpp.

References Nektar::StorageSmvBsr< T >::const_iterator::m_iter, and Nektar::StorageSmvBsr< T >::const_iterator::IterType::nnzindex.

    {
        return m_iter.nnzindex == rhs.m_iter.nnzindex;
    }

storageIndexToFullCoord()

template<typename DataType >

CoordType Nektar::StorageSmvBsr< DataType >::const_iterator::storageIndexToFullCoord ( IndexType  storageIndex )

private

Definition at line 104 of file StorageSmvBsr.cpp.

References Nektar::StorageSmvBsr< T >::const_iterator::m_blkDim, Nektar::StorageSmvBsr< T >::const_iterator::m_indx, and Nektar::StorageSmvBsr< T >::const_iterator::m_pntr.

Referenced by Nektar::StorageSmvBsr< T >::const_iterator::const_iterator(), and Nektar::StorageSmvBsr< T >::const_iterator::forward().

    {
        // find local row and column indices within this block

        const IndexType elms       = m_blkDim*m_blkDim;
        const IndexType block      = storageIndex / elms;
        const IndexType loc_offset = storageIndex % elms;
        const IndexType loc_row    = loc_offset % m_blkDim;
        const IndexType loc_col    = loc_offset / m_blkDim;

        // find block row and block column

        IndexType block_col = m_indx[block];
        IndexType block_row = 0;
        while(block >= m_pntr[block_row+1])
        {
            block_row++;
        }

        // full matrix coordinates of this nonzero entry

        CoordType coord;
        coord.first  = block_row*m_blkDim + loc_row;
        coord.second = block_col*m_blkDim + loc_col;
        return coord;
    }

Member Data Documentation

m_begin

template<typename T >

IndexType Nektar::StorageSmvBsr< T >::const_iterator::m_begin

private

Definition at line 115 of file StorageSmvBsr.hpp.

m_blkDim

template<typename T >

IndexType Nektar::StorageSmvBsr< T >::const_iterator::m_blkDim

private

Definition at line 117 of file StorageSmvBsr.hpp.

Referenced by Nektar::StorageSmvBsr< T >::const_iterator::storageIndexToFullCoord().

m_end

template<typename T >

IndexType Nektar::StorageSmvBsr< T >::const_iterator::m_end

private

Definition at line 116 of file StorageSmvBsr.hpp.

Referenced by Nektar::StorageSmvBsr< T >::const_iterator::forward().

m_indx

template<typename T >

const IndexVectorType& Nektar::StorageSmvBsr< T >::const_iterator::m_indx

private

Definition at line 119 of file StorageSmvBsr.hpp.

Referenced by Nektar::StorageSmvBsr< T >::const_iterator::storageIndexToFullCoord().

m_iter

template<typename T >

IterType Nektar::StorageSmvBsr< T >::const_iterator::m_iter

private

Definition at line 114 of file StorageSmvBsr.hpp.

Referenced by Nektar::StorageSmvBsr< T >::const_iterator::const_iterator(), Nektar::StorageSmvBsr< T >::const_iterator::forward(), Nektar::StorageSmvBsr< T >::const_iterator::operator!=(), Nektar::StorageSmvBsr< T >::const_iterator::operator*(), Nektar::StorageSmvBsr< T >::const_iterator::operator->(), and Nektar::StorageSmvBsr< T >::const_iterator::operator==().

m_matType

template<typename T >

MatrixStorage Nektar::StorageSmvBsr< T >::const_iterator::m_matType

private

Definition at line 113 of file StorageSmvBsr.hpp.

m_pntr

template<typename T >

const IndexVectorType& Nektar::StorageSmvBsr< T >::const_iterator::m_pntr

private

Definition at line 120 of file StorageSmvBsr.hpp.

Referenced by Nektar::StorageSmvBsr< T >::const_iterator::storageIndexToFullCoord().

m_val

template<typename T >

const DataVectorType& Nektar::StorageSmvBsr< T >::const_iterator::m_val

private

Definition at line 118 of file StorageSmvBsr.hpp.

Referenced by Nektar::StorageSmvBsr< T >::const_iterator::const_iterator(), and Nektar::StorageSmvBsr< T >::const_iterator::forward().