Arcane: Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ > Class Template Reference

Arcane 4.1.12.0

Developer documentation

Loading...

Searching...

No Matches

Sparse matrix stored in CSR (Compressed Sparse Row) format. More...

#include </__w/arcaneframework.github.io/arcaneframework.github.io/framework/arccore/src/alina/arccore/alina/CSRMatrixView.h>

Collaboration diagram for Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >:

Public Types
typedef ValueType_	value_type
typedef ValueType_	val_type
typedef ColumnType_	col_type
using	ptr_type = RowIndexType_
using	RowIndexType = RowIndexType_
using	ColumnSpanType = SpanChooser<ColumnType_,sizeof(RowIndexType_)>::SpanType
using	ValueSpanType = SpanChooser<ValueType_,sizeof(RowIndexType_)>::SpanType

Public Member Functions
	CSRMatrixView (Int32 nb_row, RowIndexType nb_non_zero, ptr_type ptr_range, col_type col_range, val_type *val_range)
constexpr Int32	nbRow () const noexcept
	Number of row.
constexpr RowIndexType	nbNonZero () const noexcept
	Number of non-zero in the matrix.
constexpr Int32	nbNonZeroForRow (Int32 row) const
	Number of non-zero for the row row.
SmallSpan< RowIndexType >	rowIndexes () const noexcept
ColumnSpanType	columns () const noexcept
ValueSpanType	values () const noexcept
constexpr CSRRow< RowIndexType >	rowRange (Int32 row) const
constexpr CSRRowRange< RowIndexType >	rows () const
	Range of all rows of the matrix.
constexpr CSRRowRange< RowIndexType >	subrows (RowIndexType begin, RowIndexType size) const
	Range of rows from interval [begin,begin+size[.
constexpr ptr_type	ptr (Int32 i) const
constexpr col_type	col (RowIndexType i) const
constexpr val_type	val (RowIndexType i) const
ptr_type &	ptr (Int32 i)
col_type &	col (RowIndexType i)
val_type &	val (RowIndexType i)
constexpr val_type &	value (CSRRowColumnIndex< RowIndexType > rc_index) const
	Value of the matrix for the given RowColumnIndex rc_index.
constexpr col_type	column (CSRRowColumnIndex< RowIndexType > rc_index) const
	Value of the matrix for the given RowColumnIndex rc_index.

Private Attributes
val_type *	m_values = nullptr
RowIndexType *	m_row_indexes = nullptr
col_type *	m_columns = nullptr
Int32	m_nb_row = 0
RowIndexType	m_nb_non_zero = 0

Detailed Description

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>
class Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >

Sparse matrix stored in CSR (Compressed Sparse Row) format.

Definition at line 278 of file CSRMatrixView.h.

Member Typedef Documentation

◆ col_type

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

typedef ColumnType_ Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::col_type

Definition at line 284 of file CSRMatrixView.h.

◆ ColumnSpanType

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

using Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::ColumnSpanType = SpanChooser<ColumnType_,sizeof(RowIndexType_)>::SpanType

Definition at line 287 of file CSRMatrixView.h.

◆ ptr_type

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

using Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::ptr_type = RowIndexType_

Definition at line 285 of file CSRMatrixView.h.

◆ RowIndexType

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

using Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::RowIndexType = RowIndexType_

Definition at line 286 of file CSRMatrixView.h.

◆ val_type

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

typedef ValueType_ Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::val_type

Definition at line 283 of file CSRMatrixView.h.

◆ value_type

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

typedef ValueType_ Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::value_type

Definition at line 282 of file CSRMatrixView.h.

◆ ValueSpanType

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

using Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::ValueSpanType = SpanChooser<ValueType_,sizeof(RowIndexType_)>::SpanType

Definition at line 288 of file CSRMatrixView.h.

Constructor & Destructor Documentation

◆ CSRMatrixView()

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::CSRMatrixView	(	Int32	nb_row,
		RowIndexType	nb_non_zero,
		ptr_type *	ptr_range,
		col_type *	col_range,
		val_type *	val_range )

inline

Definition at line 294 of file CSRMatrixView.h.

Member Function Documentation

◆ col() [1/2]

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

col_type & Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::col ( RowIndexType i )

inline

Definition at line 363 of file CSRMatrixView.h.

◆ col() [2/2]

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

col_type Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::col ( RowIndexType i ) const

inlineconstexpr

Definition at line 347 of file CSRMatrixView.h.

◆ column()

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

col_type Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::column ( CSRRowColumnIndex< RowIndexType > rc_index ) const

inlineconstexpr

Value of the matrix for the given RowColumnIndex rc_index.

Definition at line 380 of file CSRMatrixView.h.

◆ columns()

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

ColumnSpanType Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::columns ( ) const

inlinenoexcept

Definition at line 318 of file CSRMatrixView.h.

◆ nbNonZero()

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

RowIndexType Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::nbNonZero ( ) const

inlineconstexprnoexcept

Number of non-zero in the matrix.

Definition at line 308 of file CSRMatrixView.h.

◆ nbNonZeroForRow()

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

Int32 Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::nbNonZeroForRow ( Int32 row ) const

inlineconstexpr

Number of non-zero for the row row.

Definition at line 311 of file CSRMatrixView.h.

◆ nbRow()

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

Int32 Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::nbRow ( ) const

inlineconstexprnoexcept

Number of row.

Definition at line 306 of file CSRMatrixView.h.

◆ ptr() [1/2]

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

ptr_type & Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::ptr ( Int32 i )

inline

Definition at line 358 of file CSRMatrixView.h.

◆ ptr() [2/2]

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

ptr_type Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::ptr ( Int32 i ) const

inlineconstexpr

Definition at line 342 of file CSRMatrixView.h.

◆ rowIndexes()

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

SmallSpan< RowIndexType > Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::rowIndexes ( ) const

inlinenoexcept

Definition at line 317 of file CSRMatrixView.h.

◆ rowRange()

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

CSRRow< RowIndexType > Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::rowRange ( Int32 row ) const

inlinenodiscardconstexpr

Definition at line 323 of file CSRMatrixView.h.

◆ rows()

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

CSRRowRange< RowIndexType > Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::rows ( ) const

inlineconstexpr

Range of all rows of the matrix.

Definition at line 330 of file CSRMatrixView.h.

◆ subrows()

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

CSRRowRange< RowIndexType > Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::subrows	(	RowIndexType	begin,
		RowIndexType	size ) const

inlineconstexpr

Range of rows from interval [begin,begin+size[.

Definition at line 335 of file CSRMatrixView.h.

◆ val() [1/2]

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

val_type & Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::val ( RowIndexType i )

inline

Definition at line 368 of file CSRMatrixView.h.

◆ val() [2/2]

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

val_type Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::val ( RowIndexType i ) const

inlineconstexpr

Definition at line 352 of file CSRMatrixView.h.

◆ value()

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

val_type & Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::value ( CSRRowColumnIndex< RowIndexType > rc_index ) const

inlineconstexpr

Value of the matrix for the given RowColumnIndex rc_index.

Definition at line 375 of file CSRMatrixView.h.

◆ values()

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

ValueSpanType Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::values ( ) const

inlinenoexcept

Definition at line 319 of file CSRMatrixView.h.

Member Data Documentation

◆ m_columns

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

col_type* Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::m_columns = nullptr

private

Definition at line 389 of file CSRMatrixView.h.

◆ m_nb_non_zero

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

RowIndexType Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::m_nb_non_zero = 0

private

Definition at line 391 of file CSRMatrixView.h.

◆ m_nb_row

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

Int32 Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::m_nb_row = 0

private

Definition at line 390 of file CSRMatrixView.h.

◆ m_row_indexes

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

RowIndexType* Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::m_row_indexes = nullptr

private

Definition at line 388 of file CSRMatrixView.h.

◆ m_values

template<typename ValueType_, typename ColumnType_, typename RowIndexType_>

val_type* Arcane::Alina::CSRMatrixView< ValueType_, ColumnType_, RowIndexType_ >::m_values = nullptr

private

Definition at line 387 of file CSRMatrixView.h.

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

Arcane
Alina
CSRMatrixView
Generated on for Arcane by 1.16.1