Nektar::NekSparseMatrix< SparseStorageType > Class Template Reference

#include <SparseMatrix.hpp>

Public Types
typedef SparseStorageType	StorageType
typedef SparseStorageType::DataType	DataType
typedef std::shared_ptr< SparseStorageType >	SparseStorageSharedPtr
typedef Array< OneD, DataType >	DataVectorType
typedef Array< OneD, const DataType >	ConstDataVectorType

Public Member Functions
	NekSparseMatrix (const SparseStorageSharedPtr &sparseStoragePtr)
	NekSparseMatrix (const NekSparseMatrix &src)
	~NekSparseMatrix ()
IndexType	GetRows () const
IndexType	GetColumns () const
IndexType	GetNumNonZeroEntries () const
const DataType	GetFillInRatio () const
size_t	GetMemoryFootprint () const
unsigned long	GetMulCallsCounter () const
const DataType	GetAvgRowDensity () const
IndexType	GetBandwidth ()
COOMatTypeSharedPtr	GetCooStorage ()
boost::call_traits< DataType >::const_reference	operator() (const IndexType row, const IndexType column) const
SparseStorageType::const_iterator	begin () const
SparseStorageType::const_iterator	end () const
void	Multiply (const DataVectorType &in, DataVectorType &out)
void	Multiply (const DataType *in, DataType *out)
void	writeSparsityPatternTo (std::ostream &out, IndexType blockSize=64)
void	writeBlockSparsityPatternTo (std::ostream &out, const IndexType blk_row=0, const IndexType blk_col=0, IndexType blockSize=64)
	Complementary routine to the previous. It generates exact non-zero pattern of a given block matrix entry to *this object. E.g., for a 6x6 matrix defined as A(i,i):=i, A(i,j):=0, block size = 2 and blk_row=blk_col=2 it produces 2x2 matrix with 5 and 6 along the diagonal. More...

Protected Attributes
unsigned long	m_mulCallsCounter
SparseStorageSharedPtr	m_sparseStorage

Detailed Description

template<typename SparseStorageType>
class Nektar::NekSparseMatrix< SparseStorageType >

Definition at line 58 of file SparseMatrix.hpp.

Member Typedef Documentation

ConstDataVectorType

template<typename SparseStorageType >

typedef Array<OneD, const DataType> Nektar::NekSparseMatrix< SparseStorageType >::ConstDataVectorType

Definition at line 65 of file SparseMatrix.hpp.

DataType

template<typename SparseStorageType >

typedef SparseStorageType::DataType Nektar::NekSparseMatrix< SparseStorageType >::DataType

Definition at line 62 of file SparseMatrix.hpp.

DataVectorType

template<typename SparseStorageType >

typedef Array<OneD, DataType> Nektar::NekSparseMatrix< SparseStorageType >::DataVectorType

Definition at line 64 of file SparseMatrix.hpp.

SparseStorageSharedPtr

template<typename SparseStorageType >

typedef std::shared_ptr<SparseStorageType> Nektar::NekSparseMatrix< SparseStorageType >::SparseStorageSharedPtr

Definition at line 63 of file SparseMatrix.hpp.

StorageType

template<typename SparseStorageType >

typedef SparseStorageType Nektar::NekSparseMatrix< SparseStorageType >::StorageType

Definition at line 61 of file SparseMatrix.hpp.

Constructor & Destructor Documentation

NekSparseMatrix() [1/2]

template<typename SparseStorageType >

Nektar::NekSparseMatrix< SparseStorageType >::NekSparseMatrix

(

const SparseStorageSharedPtr &

sparseStoragePtr

)

Definition at line 55 of file SparseMatrix.cpp.

    : m_mulCallsCounter(0), m_sparseStorage(sparseStoragePtr)
{
}

NekSparseMatrix() [2/2]

template<typename SparseStorageType >

Nektar::NekSparseMatrix< SparseStorageType >::NekSparseMatrix

(

const NekSparseMatrix< SparseStorageType > &

src

)

Definition at line 62 of file SparseMatrix.cpp.

    : m_mulCallsCounter(src.m_mulCallsCounter),
      m_sparseStorage(src.m_sparseStorage)
{
}

~NekSparseMatrix()

template<typename SparseStorageType >

Nektar::NekSparseMatrix< SparseStorageType >::~NekSparseMatrix

Definition at line 69 of file SparseMatrix.cpp.

{
}

Member Function Documentation

begin()

template<typename SparseStorageType >

SparseStorageType::const_iterator Nektar::NekSparseMatrix< SparseStorageType >::begin

Definition at line 109 of file SparseMatrix.cpp.

{
    return m_sparseStorage->begin();
}

References Nektar::NekSparseMatrix< SparseStorageType >::begin().

Referenced by Nektar::NekSparseMatrix< SparseStorageType >::begin().

end()

template<typename SparseStorageType >

SparseStorageType::const_iterator Nektar::NekSparseMatrix< SparseStorageType >::end

Definition at line 116 of file SparseMatrix.cpp.

{
    return m_sparseStorage->end();
}

References Nektar::NekSparseMatrix< SparseStorageType >::end().

Referenced by Nektar::NekSparseMatrix< SparseStorageType >::end().

GetAvgRowDensity()

template<typename SparseStorageType >

const SparseStorageType::DataType Nektar::NekSparseMatrix< SparseStorageType >::GetAvgRowDensity

Definition at line 152 of file SparseMatrix.cpp.

{
    return (DataType)m_sparseStorage->GetNumNonZeroEntries() /
           (DataType)m_sparseStorage->GetRows();
}

References Nektar::NekSparseMatrix< SparseStorageType >::GetNumNonZeroEntries().

GetBandwidth()

template<typename SparseStorageType >

IndexType Nektar::NekSparseMatrix< SparseStorageType >::GetBandwidth

Definition at line 159 of file SparseMatrix.cpp.

{
    int bandwidth = 0;
 
    typename SparseStorageType::const_iterator entry = m_sparseStorage->begin();
 
    for (; entry != m_sparseStorage->end(); ++entry)
    {
        bandwidth = (std::max)(
            bandwidth,
            2 * std::abs((int)(entry->first.first - entry->first.second + 1)));
    }
    return bandwidth;
}

References tinysimd::abs().

GetColumns()

template<typename SparseStorageType >

IndexType Nektar::NekSparseMatrix< SparseStorageType >::GetColumns

Definition at line 80 of file SparseMatrix.cpp.

{
    return m_sparseStorage->GetColumns();
}

Referenced by Nektar::operator<<().

GetCooStorage()

template<typename SparseStorageType >

COOMatTypeSharedPtr Nektar::NekSparseMatrix< SparseStorageType >::GetCooStorage

Definition at line 175 of file SparseMatrix.cpp.

{
    COOMatTypeSharedPtr coo(new COOMatType());
 
    typename SparseStorageType::const_iterator entry = m_sparseStorage->begin();
    for (; entry != m_sparseStorage->end(); entry++)
    {
        (*coo)[std::make_pair(entry->first.first, entry->first.second)] =
            entry->second;
    }
    return coo;
}

GetFillInRatio()

template<typename SparseStorageType >

const NekSparseMatrix< SparseStorageType >::DataType Nektar::NekSparseMatrix< SparseStorageType >::GetFillInRatio

Definition at line 93 of file SparseMatrix.cpp.

{
    return m_sparseStorage->GetFillInRatio();
}

References Nektar::NekSparseMatrix< SparseStorageType >::GetFillInRatio().

Referenced by Nektar::NekSparseMatrix< SparseStorageType >::GetFillInRatio().

GetMemoryFootprint()

template<typename SparseStorageType >

size_t Nektar::NekSparseMatrix< SparseStorageType >::GetMemoryFootprint

Definition at line 138 of file SparseMatrix.cpp.

{
    return m_sparseStorage->GetMemoryUsage() + sizeof(SparseStorageSharedPtr) +
           sizeof(unsigned long); // mulCallsCounter
}

GetMulCallsCounter()

template<typename SparseStorageType >

unsigned long Nektar::NekSparseMatrix< SparseStorageType >::GetMulCallsCounter

Definition at line 145 of file SparseMatrix.cpp.

{
    return m_mulCallsCounter;
}

GetNumNonZeroEntries()

template<typename SparseStorageType >

IndexType Nektar::NekSparseMatrix< SparseStorageType >::GetNumNonZeroEntries

Definition at line 86 of file SparseMatrix.cpp.

{
    return m_sparseStorage->GetNumNonZeroEntries();
}

Referenced by Nektar::NekSparseMatrix< SparseStorageType >::GetAvgRowDensity().

GetRows()

template<typename SparseStorageType >

IndexType Nektar::NekSparseMatrix< SparseStorageType >::GetRows

Definition at line 74 of file SparseMatrix.cpp.

{
    return m_sparseStorage->GetRows();
}

Referenced by Nektar::operator<<().

Multiply() [1/2]

template<typename SparseStorageType >

void Nektar::NekSparseMatrix< SparseStorageType >::Multiply	(	const DataType *	in,
		DataType *	out
	)

Definition at line 130 of file SparseMatrix.cpp.

{
    m_sparseStorage->Multiply(in, out);
    m_mulCallsCounter++;
}

Multiply() [2/2]

template<typename SparseStorageType >

void Nektar::NekSparseMatrix< SparseStorageType >::Multiply	(	const DataVectorType &	in,
		DataVectorType &	out
	)

Definition at line 122 of file SparseMatrix.cpp.

{
    m_sparseStorage->Multiply(in, out);
    m_mulCallsCounter++;
}

operator()()

template<typename SparseStorageType >

boost::call_traits< typename SparseStorageType::DataType >::const_reference Nektar::NekSparseMatrix< SparseStorageType >::operator()	(	const IndexType	row,
		const IndexType	column
	)		const

Definition at line 101 of file SparseMatrix.cpp.

{
    return m_sparseStorage->GetValue(row, column);
}

writeBlockSparsityPatternTo()

template<typename SparseStorageType >

void Nektar::NekSparseMatrix< SparseStorageType >::writeBlockSparsityPatternTo	(	std::ostream &	out,
		const IndexType	blk_row = 0,
		const IndexType	blk_col = 0,
		IndexType	blockSize = 64
	)

Complementary routine to the previous. It generates exact non-zero pattern of a given block matrix entry to *this object. E.g., for a 6x6 matrix defined as A(i,i):=i, A(i,j):=0, block size = 2 and blk_row=blk_col=2 it produces 2x2 matrix with 5 and 6 along the diagonal.

Definition at line 236 of file SparseMatrix.cpp.

{
    blockSize = (std::min)(blockSize, m_sparseStorage->GetRows());
    std::vector<std::vector<int>> grid(blockSize);
    for (int row = 0; row < blockSize; row++)
    {
        grid[row].resize(blockSize, 0);
    }
 
    typename SparseStorageType::const_iterator entry = m_sparseStorage->begin();
    for (; entry != m_sparseStorage->end(); entry++)
    {
        const IndexType row = entry->first.first;
        const IndexType col = entry->first.second;
 
        if (blk_row != row / blockSize)
            continue;
        if (blk_col != col / blockSize)
            continue;
        grid[row % blockSize][col % blockSize]++;
    }
 
    for (int row = 0; row < blockSize; row++)
    {
        for (int col = 0; col < blockSize; col++)
        {
            out << grid[row][col] << " ";
        }
        out << std::endl;
    }
}

writeSparsityPatternTo()

template<typename SparseStorageType >

void Nektar::NekSparseMatrix< SparseStorageType >::writeSparsityPatternTo	(	std::ostream &	out,
		IndexType	blockSize = 64
	)

Definition at line 196 of file SparseMatrix.cpp.

{
    const int matRows  = m_sparseStorage->GetRows();
    const int gridRows = matRows / blockSize + (matRows % blockSize > 0);
    const int gridCols = gridRows;
 
    std::vector<std::vector<int>> grid(gridRows);
    for (int row = 0; row < gridRows; row++)
    {
        grid[row].resize(gridCols, 0);
    }
 
    typename SparseStorageType::const_iterator entry = m_sparseStorage->begin();
    for (; entry != m_sparseStorage->end(); entry++)
    {
        const IndexType row = entry->first.first;
        const IndexType col = entry->first.second;
        const int gridRow   = row / blockSize;
        const int gridCol   = col / blockSize;
        grid[gridRow][gridCol]++;
    }
 
    for (int row = 0; row < gridRows; row++)
    {
        for (int col = 0; col < gridCols; col++)
        {
            out << grid[row][col] << " ";
        }
        out << std::endl;
    }
}

Member Data Documentation

m_mulCallsCounter

template<typename SparseStorageType >

unsigned long Nektar::NekSparseMatrix< SparseStorageType >::m_mulCallsCounter

protected

Definition at line 100 of file SparseMatrix.hpp.

m_sparseStorage

template<typename SparseStorageType >

SparseStorageSharedPtr Nektar::NekSparseMatrix< SparseStorageType >::m_sparseStorage

protected

Definition at line 101 of file SparseMatrix.hpp.