NeoN::la::CooSparsityPattern< IndexType > Class Template Reference

row and column index representation of a mesh More...

#include <cooSparsityPattern.hpp>

Inheritance diagram for NeoN::la::CooSparsityPattern< IndexType >:

Public Types
using	SparsityIndexType = IndexType

Public Member Functions
	CooSparsityPattern (const CooSparsityPattern &sp)
	create an "empty" SparsityPattern with a given size
	CooSparsityPattern (Vector< IndexType > &&colIdx, Vector< IndexType > &&rowIdxs, Dimensions dim)
CooSparsityPattern	copyToExecutor (Executor dstExec) const override
	~CooSparsityPattern ()=default
const Executor &	exec () const
	getter for executor
const Vector< IndexType > &	colIdxs () const
	const getter for colIdxs
Vector< IndexType > &	colIdxs ()
	getter for colIdxs
const Vector< IndexType > &	rowIdxs () const
	returns the COO per-entry row indices (one per nnz)
Vector< IndexType > &	rowIdxs ()
	returns the non-const COO per-entry row indices (one per nnz)
const Vector< IndexType > &	rowOffs () const
	returns the COO per-entry row indices (one per nnz)
Vector< IndexType > &	rowOffs ()
	returns the non-const COO per-entry row indices (one per nnz)
localIdx	rows () const
localIdx	nnz () const
Dimensions	dimension () const
SparsityView< IndexType >	view () const
	Get a view representation of the matrix's data.
Public Member Functions inherited from NeoN::SupportsCopyTo< CooSparsityPattern< IndexType > >
virtual	~SupportsCopyTo ()=default
CooSparsityPattern< IndexType >	copyToHost () const

Detailed Description

template<typename IndexType>
class NeoN::la::CooSparsityPattern< IndexType >

row and column index representation of a mesh

This class implements the finite volume 3/5/7 pt stencil specific generation of sparsity patterns from a given unstructured mesh

Definition at line 23 of file cooSparsityPattern.hpp.

Member Typedef Documentation

SparsityIndexType

template<typename IndexType >

using NeoN::la::CooSparsityPattern< IndexType >::SparsityIndexType = IndexType

Definition at line 30 of file cooSparsityPattern.hpp.

Constructor & Destructor Documentation

CooSparsityPattern() [1/2]

template<typename IndexType >

NeoN::la::CooSparsityPattern< IndexType >::CooSparsityPattern

(

const CooSparsityPattern< IndexType > &

sp

)

create an "empty" SparsityPattern with a given size

CooSparsityPattern() [2/2]

template<typename IndexType >

NeoN::la::CooSparsityPattern< IndexType >::CooSparsityPattern	(	Vector< IndexType > &&	colIdx,
		Vector< IndexType > &&	rowIdxs,
		Dimensions	dim
	)

~CooSparsityPattern()

template<typename IndexType >

NeoN::la::CooSparsityPattern< IndexType >::~CooSparsityPattern ( )

default

Member Function Documentation

colIdxs() [1/2]

template<typename IndexType >

Vector< IndexType > & NeoN::la::CooSparsityPattern< IndexType >::colIdxs ( )

inline

getter for colIdxs

Definition at line 53 of file cooSparsityPattern.hpp.

colIdxs() [2/2]

template<typename IndexType >

const Vector< IndexType > & NeoN::la::CooSparsityPattern< IndexType >::colIdxs ( ) const

inline

const getter for colIdxs

Definition at line 50 of file cooSparsityPattern.hpp.

copyToExecutor()

template<typename IndexType >

CooSparsityPattern NeoN::la::CooSparsityPattern< IndexType >::copyToExecutor ( Executor  dstExec ) const

inlineoverridevirtual

Implements NeoN::SupportsCopyTo< CooSparsityPattern< IndexType > >.

Definition at line 37 of file cooSparsityPattern.hpp.

dimension()

template<typename IndexType >

Dimensions NeoN::la::CooSparsityPattern< IndexType >::dimension ( ) const

inline

Definition at line 71 of file cooSparsityPattern.hpp.

exec()

template<typename IndexType >

const Executor & NeoN::la::CooSparsityPattern< IndexType >::exec ( ) const

inline

getter for executor

Definition at line 47 of file cooSparsityPattern.hpp.

nnz()

template<typename IndexType >

localIdx NeoN::la::CooSparsityPattern< IndexType >::nnz ( ) const

inline

Definition at line 69 of file cooSparsityPattern.hpp.

rowIdxs() [1/2]

template<typename IndexType >

Vector< IndexType > & NeoN::la::CooSparsityPattern< IndexType >::rowIdxs ( )

inline

returns the non-const COO per-entry row indices (one per nnz)

Definition at line 59 of file cooSparsityPattern.hpp.

rowIdxs() [2/2]

template<typename IndexType >

const Vector< IndexType > & NeoN::la::CooSparsityPattern< IndexType >::rowIdxs ( ) const

inline

returns the COO per-entry row indices (one per nnz)

Definition at line 56 of file cooSparsityPattern.hpp.

rowOffs() [1/2]

template<typename IndexType >

Vector< IndexType > & NeoN::la::CooSparsityPattern< IndexType >::rowOffs ( )

inline

returns the non-const COO per-entry row indices (one per nnz)

Definition at line 65 of file cooSparsityPattern.hpp.

rowOffs() [2/2]

template<typename IndexType >

const Vector< IndexType > & NeoN::la::CooSparsityPattern< IndexType >::rowOffs ( ) const

inline

returns the COO per-entry row indices (one per nnz)

Definition at line 62 of file cooSparsityPattern.hpp.

rows()

template<typename IndexType >

localIdx NeoN::la::CooSparsityPattern< IndexType >::rows ( ) const

inline

Definition at line 67 of file cooSparsityPattern.hpp.

view()

template<typename IndexType >

SparsityView< IndexType > NeoN::la::CooSparsityPattern< IndexType >::view ( ) const

inline

Get a view representation of the matrix's data.

Returns

MatrixView for easy access to matrix elements.

Definition at line 77 of file cooSparsityPattern.hpp.

---

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

• /home/runner/work/NeoN/NeoN/include/NeoN/linearAlgebra/cooSparsityPattern.hpp