Alien::ExtractionIndices Class Reference

Tool to iterate over a matrix. More...

#include <core/alien/data/utils/ExtractionIndices.h>

Public Member Functions
	ExtractionIndices (const Arccore::Integer rowStart, const Arccore::Integer rowRange, const Arccore::Integer colStart=-1, const Arccore::Integer colRange=-1)
	Constructor.
	~ExtractionIndices ()
	Free resources.
	ExtractionIndices (const ExtractionIndices &)=delete
	ExtractionIndices (ExtractionIndices &&)=delete
ExtractionIndices &	operator= (const ExtractionIndices &)=delete
ExtractionIndices &	operator= (ExtractionIndices &&)=delete
Arccore::Integer	rowStart () const
	Get the index of the starting row.
Arccore::Integer	rowRange () const
	Get the length of the row.
Arccore::Integer	colStart () const
	Get the index of the starting col.
Arccore::Integer	colRange () const
	Get the length of the col.
Arccore::Integer	toLocalRow (const Arccore::Integer uid) const
	Get the local index of a row given a global index.
Arccore::Integer	toLocalCol (const Arccore::Integer uid) const
	Get the local index of a col given a global index.

Detailed Description

Tool to iterate over a matrix.

Definition at line 41 of file ExtractionIndices.h.

Constructor & Destructor Documentation

ExtractionIndices()

Alien::ExtractionIndices::ExtractionIndices	(	const Arccore::Integer	rowStart,
		const Arccore::Integer	rowRange,
		const Arccore::Integer	colStart = -1,
		const Arccore::Integer	colRange = -1 )

Constructor.

Parameters

[in]	rowStart	The index of the starting row
[in]	rowRange	The length of the row
[in]	colStart	The index of the starting col
[in]	colRange	The length of the col

References colRange(), colStart(), ExtractionIndices(), rowRange(), rowStart(), toLocalCol(), and toLocalRow().

Referenced by ExtractionIndices().

~ExtractionIndices()

Alien::ExtractionIndices::~ExtractionIndices

(

)

Free resources.

Definition at line 48 of file ExtractionIndices.cc.

References ~ExtractionIndices().

Referenced by ~ExtractionIndices().

Member Function Documentation

colRange()

Integer Alien::ExtractionIndices::colRange

(

)

const

Get the length of the col.

Returns

The length of the col

Definition at line 81 of file ExtractionIndices.cc.

References colRange().

Referenced by colRange(), and ExtractionIndices().

colStart()

Integer Alien::ExtractionIndices::colStart

(

)

const

Get the index of the starting col.

Returns

The index of the starting col

Definition at line 72 of file ExtractionIndices.cc.

References colStart().

Referenced by colStart(), and ExtractionIndices().

rowRange()

Integer Alien::ExtractionIndices::rowRange

(

)

const

Get the length of the row.

Returns

The length of the row

Definition at line 63 of file ExtractionIndices.cc.

References rowRange().

Referenced by ExtractionIndices(), and rowRange().

rowStart()

Integer Alien::ExtractionIndices::rowStart

(

)

const

Get the index of the starting row.

Returns

The index of the starting row

Definition at line 54 of file ExtractionIndices.cc.

References rowStart().

Referenced by ExtractionIndices(), and rowStart().

toLocalCol()

Integer Alien::ExtractionIndices::toLocalCol

(

const Arccore::Integer

uid

)

const

Get the local index of a col given a global index.

Parameters

[in]

uid

The global index of a col

Returns

The local index of a col

Definition at line 99 of file ExtractionIndices.cc.

References toLocalCol().

Referenced by ExtractionIndices(), and toLocalCol().

toLocalRow()

Integer Alien::ExtractionIndices::toLocalRow

(

const Arccore::Integer

uid

)

const

Get the local index of a row given a global index.

Parameters

[in]

uid

The global index of a row

Returns

The local index of a row

Definition at line 90 of file ExtractionIndices.cc.

References toLocalRow().

Referenced by ExtractionIndices(), and toLocalRow().

---

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

• ExtractionIndices.h
• ExtractionIndices.cc