Template Numerical Library version\ main:8b8c8226
|
Implementation of sparse multidiagonal matrix. More...
#include <TNL/Matrices/MultidiagonalMatrixView.h>
Public Types | |
using | BaseType = MatrixView< Real, Device, Index > |
using | ConstRowView = typename RowView::ConstRowView |
Type for accessing constant matrix rows. | |
using | ConstViewType = MultidiagonalMatrixView< std::add_const_t< Real >, Device, Index, Organization > |
Matrix view type for constant instances. | |
using | DeviceType = Device |
The device where the matrix is allocated. | |
using | DiagonalsOffsetsView = Containers::VectorView< std::conditional_t< std::is_const< Real >::value, std::add_const_t< Index >, Index >, Device, Index > |
using | HostDiagonalsOffsetsView = Containers::VectorView< std::conditional_t< std::is_const< Real >::value, std::add_const_t< Index >, Index >, Devices::Host, Index > |
using | IndexerType = details::MultidiagonalMatrixIndexer< std::remove_const_t< Index >, Organization==Algorithms::Segments::RowMajorOrder > |
using | IndexType = Index |
The type used for matrix elements indexing. | |
using | RealType = Real |
The type of matrix elements. | |
using | RowView = MultidiagonalMatrixRowView< ValuesViewType, IndexerType, DiagonalsOffsetsView > |
Type for accessing matrix rows. | |
template<typename _Real = Real, typename _Device = Device, typename _Index = Index, ElementsOrganization Organization_ = Algorithms::Segments::DefaultElementsOrganization< Device >::getOrganization()> | |
using | Self = MultidiagonalMatrixView< _Real, _Device, _Index, Organization_ > |
Helper type for getting self type or its modifications. | |
using | ValuesViewType = typename BaseType::ValuesView |
using | ViewType = MultidiagonalMatrixView< Real, Device, Index, Organization > |
Type of related matrix view. | |
![]() | |
using | ConstRowsCapacitiesTypeView = typename RowsCapacitiesTypeView::ConstViewType |
using | ConstValuesView = typename ValuesView::ConstViewType |
Type of constant vector view holding values of matrix elements. | |
using | ConstViewType = MatrixView< typename std::add_const_t< Real >, Device, Index > |
Type of base matrix view for constant instances. More... | |
using | DeviceType = Device |
The device where the matrix is allocated. | |
using | IndexType = Index |
The type used for matrix elements indexing. | |
using | RealType = Real |
The type of matrix elements. | |
using | RowsCapacitiesType = Containers::Vector< Index, Device, Index > |
using | RowsCapacitiesTypeView = Containers::VectorView< Index, Device, Index > |
using | ValuesView = Containers::VectorView< Real, Device, Index > |
Type of vector view holding values of matrix elements. | |
using | ViewType = MatrixView< Real, Device, Index > |
Type of base matrix view. More... | |
Public Member Functions | |
__cuda_callable__ | MultidiagonalMatrixView ()=default |
Constructor with no parameters. | |
__cuda_callable__ | MultidiagonalMatrixView (const MultidiagonalMatrixView &view)=default |
Copy constructor. More... | |
__cuda_callable__ | MultidiagonalMatrixView (const ValuesViewType &values, const DiagonalsOffsetsView &diagonalsOffsets, const HostDiagonalsOffsetsView &hostDiagonalsOffsets, const IndexerType &indexer) |
Constructor with all necessary data and views. More... | |
__cuda_callable__ | MultidiagonalMatrixView (MultidiagonalMatrixView &&view) noexcept=default |
Move constructor. More... | |
__cuda_callable__ void | addElement (IndexType row, IndexType column, const RealType &value, const RealType &thisElementMultiplicator=1.0) |
Add element at given row and column to given value. More... | |
template<typename Real_ , typename Device_ , typename Index_ , ElementsOrganization Organization_> | |
void | addMatrix (const MultidiagonalMatrixView< Real_, Device_, Index_, Organization_ > &matrix, const RealType &matrixMultiplicator=1.0, const RealType &thisMatrixMultiplicator=1.0) |
template<typename Function > | |
void | forAllElements (Function &function) |
This method calls forElements for all matrix rows. More... | |
template<typename Function > | |
void | forAllElements (Function &function) const |
This method calls forElements for all matrix rows (for constant instances). More... | |
template<typename Function > | |
void | forAllRows (Function &&function) |
Method for parallel iteration over all matrix rows. More... | |
template<typename Function > | |
void | forAllRows (Function &&function) const |
Method for parallel iteration over all matrix rows for constant instances. More... | |
template<typename Function > | |
void | forElements (IndexType begin, IndexType end, Function &function) |
Method for iteration over all matrix rows for non-constant instances. More... | |
template<typename Function > | |
void | forElements (IndexType begin, IndexType end, Function &function) const |
Method for iteration over all matrix rows for constant instances. More... | |
template<typename Function > | |
void | forRows (IndexType begin, IndexType end, Function &&function) |
Method for parallel iteration over matrix rows from interval [ begin, end). More... | |
template<typename Function > | |
void | forRows (IndexType begin, IndexType end, Function &&function) const |
Method for parallel iteration over matrix rows from interval [ begin, end) for constant instances. More... | |
template<typename Vector > | |
void | getCompressedRowLengths (Vector &rowLengths) const |
Computes number of non-zeros in each row. More... | |
ConstViewType | getConstView () const |
Returns a non-modifiable view of the multidiagonal matrix. More... | |
__cuda_callable__ IndexType | getDiagonalsCount () const |
Returns number of diagonals. More... | |
__cuda_callable__ RealType | getElement (IndexType row, IndexType column) const |
Returns value of matrix element at position given by its row and column index. More... | |
__cuda_callable__ IndexerType & | getIndexer () |
This method returns matrix elements indexer used by this matrix. More... | |
__cuda_callable__ const IndexerType & | getIndexer () const |
This method returns matrix elements indexer used by this matrix. More... | |
IndexType | getNonzeroElementsCount () const override |
Returns number of non-zero matrix elements. More... | |
__cuda_callable__ IndexType | getPaddingIndex () const |
Returns padding index denoting padding zero elements. More... | |
__cuda_callable__ RowView | getRow (IndexType rowIdx) |
Non-constant getter of simple structure for accessing given matrix row. More... | |
__cuda_callable__ ConstRowView | getRow (IndexType rowIdx) const |
Constant getter of simple structure for accessing given matrix row. More... | |
template<typename Vector > | |
void | getRowCapacities (Vector &rowCapacities) const |
Compute capacities of all rows. More... | |
IndexType | getRowLength (IndexType row) const |
std::string | getSerializationTypeVirtual () const override |
Returns string with serialization type. More... | |
template<typename Real2 , typename Index2 > | |
void | getTransposition (const MultidiagonalMatrixView< Real2, Device, Index2 > &matrix, const RealType &matrixMultiplicator=1.0) |
ViewType | getView () |
Returns a modifiable view of the multidiagonal matrix. More... | |
template<typename Real_ , typename Device_ , typename Index_ , ElementsOrganization Organization_> | |
bool | operator!= (const MultidiagonalMatrixView< Real_, Device_, Index_, Organization_ > &matrix) const |
Comparison operator with another multidiagonal matrix. More... | |
MultidiagonalMatrixView & | operator= (const MultidiagonalMatrixView &view) |
Assignment of exactly the same matrix type. More... | |
template<typename Real_ , typename Device_ , typename Index_ , ElementsOrganization Organization_> | |
bool | operator== (const MultidiagonalMatrixView< Real_, Device_, Index_, Organization_ > &matrix) const |
Comparison operator with another multidiagonal matrix. More... | |
void | print (std::ostream &str) const override |
Method for printing the matrix to output stream. More... | |
template<typename Fetch , typename Reduce , typename Keep , typename FetchReal > | |
void | reduceAllRows (Fetch &fetch, Reduce &reduce, Keep &keep, const FetchReal &identity) |
Method for performing general reduction on all matrix rows. More... | |
template<typename Fetch , typename Reduce , typename Keep , typename FetchReal > | |
void | reduceAllRows (Fetch &fetch, Reduce &reduce, Keep &keep, const FetchReal &identity) const |
Method for performing general reduction on all matrix rows for constant instances. More... | |
template<typename Fetch , typename Reduce , typename Keep , typename FetchReal > | |
void | reduceRows (IndexType begin, IndexType end, Fetch &fetch, Reduce &reduce, Keep &keep, const FetchReal &identity) |
Method for performing general reduction on matrix rows. More... | |
template<typename Fetch , typename Reduce , typename Keep , typename FetchReal > | |
void | reduceRows (IndexType begin, IndexType end, Fetch &fetch, Reduce &reduce, Keep &keep, const FetchReal &identity) const |
Method for performing general reduction on matrix rows for constant instances. More... | |
void | save (const String &fileName) const |
Method for saving the matrix to the file with given filename. More... | |
void | save (File &file) const override |
Method for saving the matrix to a file. More... | |
template<typename Function > | |
void | sequentialForAllRows (Function &function) |
This method calls sequentialForRows for all matrix rows. More... | |
template<typename Function > | |
void | sequentialForAllRows (Function &function) const |
This method calls sequentialForRows for all matrix rows (for constant instances). More... | |
template<typename Function > | |
void | sequentialForRows (IndexType begin, IndexType end, Function &function) |
Method for sequential iteration over all matrix rows for non-constant instances. More... | |
template<typename Function > | |
void | sequentialForRows (IndexType begin, IndexType end, Function &function) const |
Method for sequential iteration over all matrix rows for constant instances. More... | |
__cuda_callable__ void | setElement (IndexType row, IndexType column, const RealType &value) |
Sets element at given row and column to given value. More... | |
void | setValue (const RealType &value) |
Set all matrix elements to given value. More... | |
template<typename InVector , typename OutVector > | |
void | vectorProduct (const InVector &inVector, OutVector &outVector, RealType matrixMultiplicator=1.0, RealType outVectorMultiplicator=0.0, IndexType begin=0, IndexType end=0) const |
Computes product of matrix and vector. More... | |
![]() | |
__cuda_callable__ | MatrixView () |
Basic constructor with no parameters. | |
__cuda_callable__ | MatrixView (const MatrixView &view)=default |
Shallow copy constructor. More... | |
__cuda_callable__ | MatrixView (IndexType rows, IndexType columns, ValuesView values) |
Constructor with matrix dimensions and matrix elements values. More... | |
__cuda_callable__ | MatrixView (MatrixView &&view) noexcept=default |
Move constructor. More... | |
IndexType | getAllocatedElementsCount () const |
Tells the number of allocated matrix elements. More... | |
__cuda_callable__ IndexType | getColumns () const |
Returns number of matrix columns. More... | |
virtual IndexType | getNonzeroElementsCount () const |
Computes a current number of nonzero matrix elements. More... | |
__cuda_callable__ IndexType | getRows () const |
Returns number of matrix rows. More... | |
virtual std::string | getSerializationTypeVirtual () const =0 |
__cuda_callable__ ValuesView & | getValues () |
Returns a reference to a vector with the matrix elements values. More... | |
__cuda_callable__ const ValuesView & | getValues () const |
Returns a constant reference to a vector with the matrix elements values. More... | |
template<typename Matrix > | |
bool | operator!= (const Matrix &matrix) const |
Comparison operator with another arbitrary matrix view type. More... | |
template<typename MatrixT > | |
bool | operator!= (const MatrixT &matrix) const |
__cuda_callable__ MatrixView & | operator= (const MatrixView &view) |
Shallow copy of the matrix view. More... | |
template<typename Matrix > | |
bool | operator== (const Matrix &matrix) const |
Comparison operator with another arbitrary matrix view type. More... | |
template<typename MatrixT > | |
bool | operator== (const MatrixT &matrix) const |
virtual void | print (std::ostream &str) const |
Method for printing the matrix view to output stream. More... | |
void | save (const String &fileName) const |
Method for saving the matrix view to a file. More... | |
virtual void | save (File &file) const |
Method for saving the matrix view to a file. More... | |
Static Public Member Functions | |
static std::string | getSerializationType () |
Returns string with serialization type. More... | |
Protected Attributes | |
DiagonalsOffsetsView | diagonalsOffsets |
HostDiagonalsOffsetsView | hostDiagonalsOffsets |
IndexerType | indexer |
![]() | |
IndexType | columns |
IndexType | rows |
ValuesView | values |
Implementation of sparse multidiagonal matrix.
It serves as an accessor to SparseMatrix for example when passing the matrix to lambda functions. SparseMatrix view can be also created in CUDA kernels.
See MultidiagonalMatrix for more details.
Real | is a type of matrix elements. |
Device | is a device where the matrix is allocated. |
Index | is a type for indexing of the matrix elements. |
Organization | tells the ordering of matrix elements. It is either RowMajorOrder or ColumnMajorOrder. |
__cuda_callable__ TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::MultidiagonalMatrixView | ( | const ValuesViewType & | values, |
const DiagonalsOffsetsView & | diagonalsOffsets, | ||
const HostDiagonalsOffsetsView & | hostDiagonalsOffsets, | ||
const IndexerType & | indexer | ||
) |
Constructor with all necessary data and views.
values | is a vector view with matrix elements values |
diagonalsOffsets | is a vector view with diagonals offsets |
hostDiagonalsOffsets | is a vector view with a copy of diagonals offsets on the host |
indexer | is an indexer of matrix elements |
|
default |
Copy constructor.
view | is an input multidiagonal matrix view. |
|
defaultnoexcept |
Move constructor.
view | is an input multidiagonal matrix view. |
__cuda_callable__ void TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::addElement | ( | IndexType | row, |
IndexType | column, | ||
const RealType & | value, | ||
const RealType & | thisElementMultiplicator = 1.0 |
||
) |
Add element at given row and column to given value.
This method can be called from the host system (CPU) no matter where the matrix is allocated. If the matrix is allocated on GPU this method can be called even from device kernels. If the matrix is allocated in GPU device this method is called from CPU, it transfers values of each matrix element separately and so the performance is very low. For higher performance see. MultidiagonalMatrix::getRow or MultidiagonalMatrix::forElements and MultidiagonalMatrix::forAllElements. The call may fail if the matrix row capacity is exhausted.
row | is row index of the element. |
column | is columns index of the element. |
value | is the value the element will be set to. |
thisElementMultiplicator | is multiplicator the original matrix element value is multiplied by before addition of given value. |
void TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::forAllElements | ( | Function & | function | ) |
This method calls forElements for all matrix rows.
See MultidiagonalMatrix::forElements.
Function | is a type of lambda function that will operate on matrix elements. |
function | is an instance of the lambda function to be called in each row. |
void TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::forAllElements | ( | Function & | function | ) | const |
This method calls forElements for all matrix rows (for constant instances).
See MultidiagonalMatrix::forElements.
Function | is a type of lambda function that will operate on matrix elements. |
function | is an instance of the lambda function to be called in each row. |
void TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::forAllRows | ( | Function && | function | ) |
Method for parallel iteration over all matrix rows.
In each row, given lambda function is performed. Each row is processed by at most one thread unlike the method MultidiagonalMatrixView::forAllElements where more than one thread can be mapped to each row.
Function | is type of the lambda function. |
function | is an instance of the lambda function to be called for each row. |
RowView represents matrix row - see TNL::Matrices::MultidiagonalMatrixView::RowView.
void TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::forAllRows | ( | Function && | function | ) | const |
Method for parallel iteration over all matrix rows for constant instances.
In each row, given lambda function is performed. Each row is processed by at most one thread unlike the method MultidiagonalMatrixView::forAllElements where more than one thread can be mapped to each row.
Function | is type of the lambda function. |
function | is an instance of the lambda function to be called for each row. |
RowView represents matrix row - see TNL::Matrices::MultidiagonalMatrixView::RowView.
void TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::forElements | ( | IndexType | begin, |
IndexType | end, | ||
Function & | function | ||
) |
Method for iteration over all matrix rows for non-constant instances.
Function | is type of lambda function that will operate on matrix elements. It is should have form like |
where
rowIdx is an index of the matrix row.
localIdx parameter is a rank of the non-zero element in given row. It is also, in fact, index of the matrix subdiagonal.
columnIdx is a column index of the matrix element.
value is a reference to the matrix element value. It can be used even for changing the matrix element value.
begin | defines beginning of the range [ begin, end ) of rows to be processed. |
end | defines ending of the range [ begin, end ) of rows to be processed. |
function | is an instance of the lambda function to be called in each row. |
void TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::forElements | ( | IndexType | begin, |
IndexType | end, | ||
Function & | function | ||
) | const |
Method for iteration over all matrix rows for constant instances.
Function | is type of lambda function that will operate on matrix elements. It is should have form like |
where
rowIdx is an index of the matrix row.
localIdx parameter is a rank of the non-zero element in given row. It is also, in fact, index of the matrix subdiagonal.
columnIdx is a column index of the matrix element.
value is the matrix element value.
begin | defines beginning of the range [ begin, end ) of rows to be processed. |
end | defines ending of the range [ begin, end ) of rows to be processed. |
function | is an instance of the lambda function to be called in each row. |
void TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::forRows | ( | IndexType | begin, |
IndexType | end, | ||
Function && | function | ||
) |
Method for parallel iteration over matrix rows from interval [ begin, end).
In each row, given lambda function is performed. Each row is processed by at most one thread unlike the method MultidiagonalMatrixView::forElements where more than one thread can be mapped to each row.
Function | is type of the lambda function. |
begin | defines beginning of the range [ begin,end ) of rows to be processed. |
end | defines ending of the range [ begin, end ) of rows to be processed. |
function | is an instance of the lambda function to be called for each row. |
RowView represents matrix row - see TNL::Matrices::MultidiagonalMatrixView::RowView.
void TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::forRows | ( | IndexType | begin, |
IndexType | end, | ||
Function && | function | ||
) | const |
Method for parallel iteration over matrix rows from interval [ begin, end) for constant instances.
In each row, given lambda function is performed. Each row is processed by at most one thread unlike the method MultidiagonalMatrixView::forElements where more than one thread can be mapped to each row.
Function | is type of the lambda function. |
begin | defines beginning of the range [ begin,end ) of rows to be processed. |
end | defines ending of the range [ begin, end ) of rows to be processed. |
function | is an instance of the lambda function to be called for each row. |
RowView represents matrix row - see TNL::Matrices::MultidiagonalMatrixView::RowView.
void TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::getCompressedRowLengths | ( | Vector & | rowLengths | ) | const |
Computes number of non-zeros in each row.
rowLengths | is a vector into which the number of non-zeros in each row will be stored. |
auto TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::getConstView |
Returns a non-modifiable view of the multidiagonal matrix.
__cuda_callable__ Index TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::getDiagonalsCount |
Returns number of diagonals.
__cuda_callable__ Real TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::getElement | ( | IndexType | row, |
IndexType | column | ||
) | const |
Returns value of matrix element at position given by its row and column index.
This method can be called from the host system (CPU) no matter where the matrix is allocated. If the matrix is allocated on GPU this method can be called even from device kernels. If the matrix is allocated in GPU device this method is called from CPU, it transfers values of each matrix element separately and so the performance is very low. For higher performance see. MultidiagonalMatrix::getRow or MultidiagonalMatrix::forElements and MultidiagonalMatrix::forAllElements.
row | is a row index of the matrix element. |
column | i a column index of the matrix element. |
__cuda_callable__ auto TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::getIndexer |
This method returns matrix elements indexer used by this matrix.
__cuda_callable__ auto TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::getIndexer |
This method returns matrix elements indexer used by this matrix.
|
overridevirtual |
Returns number of non-zero matrix elements.
This method really counts the non-zero matrix elements and so it returns zero for matrix having all allocated elements set to zero.
Reimplemented from TNL::Matrices::MatrixView< Real, Device, Index >.
__cuda_callable__ Index TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::getPaddingIndex |
Returns padding index denoting padding zero elements.
These elements are used for efficient data alignment in memory.
__cuda_callable__ auto TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::getRow | ( | IndexType | rowIdx | ) |
Non-constant getter of simple structure for accessing given matrix row.
rowIdx | is matrix row index. |
__cuda_callable__ auto TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::getRow | ( | IndexType | rowIdx | ) | const |
Constant getter of simple structure for accessing given matrix row.
rowIdx | is matrix row index. |
void TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::getRowCapacities | ( | Vector & | rowCapacities | ) | const |
Compute capacities of all rows.
The row capacities are not stored explicitly and must be computed.
rowCapacities | is a vector where the row capacities will be stored. |
|
static |
Returns string with serialization type.
The string has a form Matrices::MultidiagonalMatrix< RealType, [any_device], IndexType, Organization, [any_allocator], [any_allocator] >
.
See MultidiagonalMatrix::getSerializationType.
|
overridevirtual |
Returns string with serialization type.
See MultidiagonalMatrix::getSerializationType.
Implements TNL::Matrices::MatrixView< Real, Device, Index >.
auto TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::getView |
Returns a modifiable view of the multidiagonal matrix.
bool TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::operator!= | ( | const MultidiagonalMatrixView< Real_, Device_, Index_, Organization_ > & | matrix | ) | const |
Comparison operator with another multidiagonal matrix.
Real_ | is Real type of the source matrix. |
Device_ | is Device type of the source matrix. |
Index_ | is Index type of the source matrix. |
Organization_ | is Organization of the source matrix. |
matrix | is the source matrix view. |
MultidiagonalMatrixView< Real, Device, Index, Organization > & TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::operator= | ( | const MultidiagonalMatrixView< Real, Device, Index, Organization > & | view | ) |
Assignment of exactly the same matrix type.
view | is input matrix view for the assignment. |
bool TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::operator== | ( | const MultidiagonalMatrixView< Real_, Device_, Index_, Organization_ > & | matrix | ) | const |
Comparison operator with another multidiagonal matrix.
Real_ | is Real type of the source matrix. |
Device_ | is Device type of the source matrix. |
Index_ | is Index type of the source matrix. |
Organization_ | is Organization of the source matrix. |
matrix | is the source matrix view. |
|
overridevirtual |
Method for printing the matrix to output stream.
str | is the output stream. |
Reimplemented from TNL::Matrices::MatrixView< Real, Device, Index >.
void TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::reduceAllRows | ( | Fetch & | fetch, |
Reduce & | reduce, | ||
Keep & | keep, | ||
const FetchReal & | identity | ||
) |
Method for performing general reduction on all matrix rows.
Fetch | is a type of lambda function for data fetch declared as |
The return type of this lambda can be any non void.
Reduce | is a type of lambda function for reduction declared as |
Keep | is a type of lambda function for storing results of reduction in each row. It is declared as keep( IndexType rowIdx, const RealType& value ) . |
FetchValue | is type returned by the Fetch lambda function. |
fetch | is an instance of lambda function for data fetch. |
reduce | is an instance of lambda function for reduction. |
keep | in an instance of lambda function for storing results. |
identity | is the identity element for the reduction operation, i.e. element which does not change the result of the reduction. |
void TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::reduceAllRows | ( | Fetch & | fetch, |
Reduce & | reduce, | ||
Keep & | keep, | ||
const FetchReal & | identity | ||
) | const |
Method for performing general reduction on all matrix rows for constant instances.
Fetch | is a type of lambda function for data fetch declared as |
The return type of this lambda can be any non void.
Reduce | is a type of lambda function for reduction declared as |
Keep | is a type of lambda function for storing results of reduction in each row. It is declared as |
FetchValue | is type returned by the Fetch lambda function. |
fetch | is an instance of lambda function for data fetch. |
reduce | is an instance of lambda function for reduction. |
keep | in an instance of lambda function for storing results. |
identity | is the identity element for the reduction operation, i.e. element which does not change the result of the reduction. |
void TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::reduceRows | ( | IndexType | begin, |
IndexType | end, | ||
Fetch & | fetch, | ||
Reduce & | reduce, | ||
Keep & | keep, | ||
const FetchReal & | identity | ||
) |
Method for performing general reduction on matrix rows.
Fetch | is a type of lambda function for data fetch declared as |
The return type of this lambda can be any non void.
Reduce | is a type of lambda function for reduction declared as |
Keep | is a type of lambda function for storing results of reduction in each row. It is declared as |
FetchValue | is type returned by the Fetch lambda function. |
begin | defines beginning of the range [ begin, end ) of rows to be processed. |
end | defines ending of the range [ begin, end ) of rows to be processed. |
fetch | is an instance of lambda function for data fetch. |
reduce | is an instance of lambda function for reduction. |
keep | in an instance of lambda function for storing results. |
identity | is the identity element for the reduction operation, i.e. element which does not change the result of the reduction. |
void TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::reduceRows | ( | IndexType | begin, |
IndexType | end, | ||
Fetch & | fetch, | ||
Reduce & | reduce, | ||
Keep & | keep, | ||
const FetchReal & | identity | ||
) | const |
Method for performing general reduction on matrix rows for constant instances.
Fetch | is a type of lambda function for data fetch declared as |
The return type of this lambda can be any non void.
Reduce | is a type of lambda function for reduction declared as |
Keep | is a type of lambda function for storing results of reduction in each row. It is declared as |
FetchValue | is type returned by the Fetch lambda function. |
begin | defines beginning of the range [ begin, end ) of rows to be processed. |
end | defines ending of the range [ begin, end ) of rows to be processed. |
fetch | is an instance of lambda function for data fetch. |
reduce | is an instance of lambda function for reduction. |
keep | in an instance of lambda function for storing results. |
identity | is the identity element for the reduction operation, i.e. element which does not change the result of the reduction. |
void TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::save | ( | const String & | fileName | ) | const |
Method for saving the matrix to the file with given filename.
fileName | is name of the file. |
|
overridevirtual |
Method for saving the matrix to a file.
file | is the output file. |
Reimplemented from TNL::Matrices::MatrixView< Real, Device, Index >.
void TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::sequentialForAllRows | ( | Function & | function | ) |
This method calls sequentialForRows for all matrix rows.
See MultidiagonalMatrixView::sequentialForAllRows.
Function | is a type of lambda function that will operate on matrix elements. |
function | is an instance of the lambda function to be called in each row. |
void TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::sequentialForAllRows | ( | Function & | function | ) | const |
This method calls sequentialForRows for all matrix rows (for constant instances).
See MultidiagonalMatrixView::sequentialForRows.
Function | is a type of lambda function that will operate on matrix elements. |
function | is an instance of the lambda function to be called in each row. |
void TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::sequentialForRows | ( | IndexType | begin, |
IndexType | end, | ||
Function & | function | ||
) |
Method for sequential iteration over all matrix rows for non-constant instances.
Function | is type of lambda function that will operate on matrix elements. It is should have form like |
RowView represents matrix row - see TNL::Matrices::MultidiagonalMatrixView::RowView.
begin | defines beginning of the range [ begin, end ) of rows to be processed. |
end | defines ending of the range [ begin, end ) of rows to be processed. |
function | is an instance of the lambda function to be called in each row. |
void TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::sequentialForRows | ( | IndexType | begin, |
IndexType | end, | ||
Function & | function | ||
) | const |
Method for sequential iteration over all matrix rows for constant instances.
Function | is type of lambda function that will operate on matrix elements. It is should have form like |
RowView represents matrix row - see TNL::Matrices::MultidiagonalMatrixView::RowView.
begin | defines beginning of the range [ begin, end ) of rows to be processed. |
end | defines ending of the range [ begin, end ) of rows to be processed. |
function | is an instance of the lambda function to be called in each row. |
__cuda_callable__ void TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::setElement | ( | IndexType | row, |
IndexType | column, | ||
const RealType & | value | ||
) |
Sets element at given row and column to given value.
This method can be called from the host system (CPU) no matter where the matrix is allocated. If the matrix is allocated on GPU this method can be called even from device kernels. If the matrix is allocated in GPU device this method is called from CPU, it transfers values of each matrix element separately and so the performance is very low. For higher performance see. MultidiagonalMatrix::getRow or MultidiagonalMatrix::forElements and MultidiagonalMatrix::forAllElements. The call may fail if the matrix row capacity is exhausted.
row | is row index of the element. |
column | is columns index of the element. |
value | is the value the element will be set to. |
void TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::setValue | ( | const RealType & | value | ) |
Set all matrix elements to given value.
value | is the new value of all matrix elements. |
void TNL::Matrices::MultidiagonalMatrixView< Real, Device, Index, Organization >::vectorProduct | ( | const InVector & | inVector, |
OutVector & | outVector, | ||
RealType | matrixMultiplicator = 1.0 , |
||
RealType | outVectorMultiplicator = 0.0 , |
||
IndexType | begin = 0 , |
||
IndexType | end = 0 |
||
) | const |
Computes product of matrix and vector.
More precisely, it computes:
InVector | is type of input vector. It can be TNL::Containers::Vector, TNL::Containers::VectorView, TNL::Containers::Array, TNL::Containers::ArrayView, or similar container. |
OutVector | is type of output vector. It can be TNL::Containers::Vector, TNL::Containers::VectorView, TNL::Containers::Array, TNL::Containers::ArrayView, or similar container. |
inVector | is input vector. |
outVector | is output vector. |
matrixMultiplicator | is a factor by which the matrix is multiplied. It is one by default. |
outVectorMultiplicator | is a factor by which the outVector is multiplied before added to the result of matrix-vector product. It is zero by default. |
begin | is the beginning of the rows range for which the vector product is computed. It is zero by default. |
end | is the end of the rows range for which the vector product is computed. It is number if the matrix rows by default. |