![]() |
Ginkgo Generated from branch based on main. Ginkgo version 1.10.0
A numerical linear algebra library targeting many-core architectures
|
Csr is a general sparse matrix format that stores the column indices for each nonzero entry and a cumulative sum of the number of nonzeros in each row. More...
#include <ginkgo/core/matrix/batch_csr.hpp>
Public Types | |
| using | value_type = ValueType |
| using | index_type = IndexType |
| using | unbatch_type = gko::matrix::Csr<value_type, index_type> |
| using | absolute_type = remove_complex<Csr> |
| using | complex_type = to_complex<Csr> |
| Public Types inherited from gko::EnablePolymorphicAssignment< Csr< default_precision, int32 > > | |
| using | result_type |
| Public Types inherited from gko::ConvertibleTo< Csr< default_precision, int32 > > | |
| using | result_type |
| Public Types inherited from gko::ConvertibleTo< Csr< next_precision< default_precision >, int32 > > | |
| using | result_type |
Public Member Functions | |
| void | convert_to (Csr< next_precision< ValueType >, IndexType > *result) const override |
| void | move_to (Csr< next_precision< ValueType >, IndexType > *result) override |
| std::unique_ptr< unbatch_type > | create_view_for_item (size_type item_id) |
| Creates a mutable view (of matrix::Csr type) of one item of the batch::matrix::Csr<value_type> object. | |
| std::unique_ptr< const unbatch_type > | create_const_view_for_item (size_type item_id) const |
| Creates a mutable view (of matrix::Csr type) of one item of the batch::matrix::Csr<value_type> object. | |
| value_type * | get_values () noexcept |
| Returns a pointer to the array of values of the matrix. | |
| const value_type * | get_const_values () const noexcept |
| Returns a pointer to the array of values of the matrix. | |
| index_type * | get_col_idxs () noexcept |
| Returns a pointer to the array of column indices of the matrix. | |
| const index_type * | get_const_col_idxs () const noexcept |
| Returns a pointer to the array of column indices of the matrix. | |
| index_type * | get_row_ptrs () noexcept |
| Returns a pointer to the array of row pointers of the matrix. | |
| const index_type * | get_const_row_ptrs () const noexcept |
| Returns a pointer to the array of row pointers of the matrix. | |
| size_type | get_num_stored_elements () const noexcept |
| Returns the number of elements explicitly stored in the batch matrix, cumulative across all the batch items. | |
| size_type | get_num_elements_per_item () const noexcept |
| Returns the number of stored elements in each batch item. | |
| value_type * | get_values_for_item (size_type batch_id) noexcept |
| Returns a pointer to the array of values of the matrix for a specific batch item. | |
| const value_type * | get_const_values_for_item (size_type batch_id) const noexcept |
| Returns a pointer to the array of values of the matrix for a specific batch item. | |
| Csr * | apply (ptr_param< const MultiVector< value_type > > b, ptr_param< MultiVector< value_type > > x) |
| Apply the matrix to a multi-vector. | |
| Csr * | apply (ptr_param< const MultiVector< value_type > > alpha, ptr_param< const MultiVector< value_type > > b, ptr_param< const MultiVector< value_type > > beta, ptr_param< MultiVector< value_type > > x) |
| Apply the matrix to a multi-vector with a linear combination of the given input vector. | |
| const Csr * | apply (ptr_param< const MultiVector< value_type > > b, ptr_param< MultiVector< value_type > > x) const |
| const Csr * | apply (ptr_param< const MultiVector< value_type > > alpha, ptr_param< const MultiVector< value_type > > b, ptr_param< const MultiVector< value_type > > beta, ptr_param< MultiVector< value_type > > x) const |
| void | scale (const array< value_type > &row_scale, const array< value_type > &col_scale) |
| Performs in-place row and column scaling for this matrix. | |
| void | add_scaled_identity (ptr_param< const MultiVector< value_type > > alpha, ptr_param< const MultiVector< value_type > > beta) |
| Performs the operation this = alpha*I + beta*this. | |
| Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< Csr< default_precision, int32 >, BatchLinOp > | |
| std::unique_ptr< Csr< default_precision, int32 > > | create_default (std::shared_ptr< const Executor > exec) const |
| std::unique_ptr< Csr< default_precision, int32 > > | clone (std::shared_ptr< const Executor > exec) const |
| Csr< default_precision, int32 > * | copy_from (const PolymorphicObject *other) |
| Csr< default_precision, int32 > * | move_from (ptr_param< PolymorphicObject > other) |
| Csr< default_precision, int32 > * | clear () |
| Public Member Functions inherited from gko::EnablePolymorphicAssignment< Csr< default_precision, int32 > > | |
| void | convert_to (result_type *result) const override |
| void | move_to (result_type *result) override |
| Public Member Functions inherited from gko::ConvertibleTo< Csr< next_precision< default_precision >, int32 > > | |
| virtual void | convert_to (result_type *result) const=0 |
| Converts the implementer to an object of type result_type. | |
| virtual void | move_to (result_type *result)=0 |
| Converts the implementer to an object of type result_type by moving data from this object. | |
Static Public Member Functions | |
| static std::unique_ptr< Csr > | create (std::shared_ptr< const Executor > exec, const batch_dim< 2 > &size=batch_dim< 2 >{}, size_type num_nonzeros_per_item={}) |
| Creates an uninitialized Csr matrix of the specified size. | |
| static std::unique_ptr< Csr > | create (std::shared_ptr< const Executor > exec, const batch_dim< 2 > &size, array< value_type > values, array< index_type > col_idxs, array< index_type > row_ptrs) |
| Creates a Csr matrix from an already allocated (and initialized) array. | |
| template<typename InputValueType, typename ColIndexType, typename RowPtrType> | |
| static std::unique_ptr< Csr > | create (std::shared_ptr< const Executor > exec, const batch_dim< 2 > &size, std::initializer_list< InputValueType > values, std::initializer_list< ColIndexType > col_idxs, std::initializer_list< RowPtrType > row_ptrs) |
| create(std::shared_ptr<const Executor>,const batch_dim<2>&, array<value_type>, array<index_type>,array<index_type>) | |
| static std::unique_ptr< const Csr > | create_const (std::shared_ptr< const Executor > exec, const batch_dim< 2 > &sizes, gko::detail::const_array_view< value_type > &&values, gko::detail::const_array_view< index_type > &&col_idxs, gko::detail::const_array_view< index_type > &&row_ptrs) |
| Creates a constant (immutable) batch csr matrix from a constant array. | |
Friends | |
| class | EnablePolymorphicObject< Csr, BatchLinOp > |
| class | Csr< to_complex< ValueType >, IndexType > |
| class | Csr< previous_precision< ValueType >, IndexType > |
Csr is a general sparse matrix format that stores the column indices for each nonzero entry and a cumulative sum of the number of nonzeros in each row.
It is one of the most popular sparse matrix formats due to its versatility and ability to store a wide range of sparsity patterns in an efficient fashion.
| ValueType | value precision of matrix elements |
| IndexType | index precision of matrix elements |
| void gko::batch::matrix::Csr< ValueType, IndexType >::add_scaled_identity | ( | ptr_param< const MultiVector< value_type > > | alpha, |
| ptr_param< const MultiVector< value_type > > | beta ) |
Performs the operation this = alpha*I + beta*this.
| alpha | the scalar for identity |
| beta | the scalar to multiply this matrix |
| Csr * gko::batch::matrix::Csr< ValueType, IndexType >::apply | ( | ptr_param< const MultiVector< value_type > > | alpha, |
| ptr_param< const MultiVector< value_type > > | b, | ||
| ptr_param< const MultiVector< value_type > > | beta, | ||
| ptr_param< MultiVector< value_type > > | x ) |
Apply the matrix to a multi-vector with a linear combination of the given input vector.
Represents the matrix vector multiplication, x = alpha * A
| alpha | the scalar to scale the matrix-vector product with |
| b | the multi-vector to be applied to |
| beta | the scalar to scale the x vector with |
| x | the output multi-vector |
| const Csr * gko::batch::matrix::Csr< ValueType, IndexType >::apply | ( | ptr_param< const MultiVector< value_type > > | alpha, |
| ptr_param< const MultiVector< value_type > > | b, | ||
| ptr_param< const MultiVector< value_type > > | beta, | ||
| ptr_param< MultiVector< value_type > > | x ) const |
| Csr * gko::batch::matrix::Csr< ValueType, IndexType >::apply | ( | ptr_param< const MultiVector< value_type > > | b, |
| ptr_param< MultiVector< value_type > > | x ) |
Apply the matrix to a multi-vector.
Represents the matrix vector multiplication, x = A * b, where x and b are both multi-vectors.
| b | the multi-vector to be applied to |
| x | the output multi-vector |
| const Csr * gko::batch::matrix::Csr< ValueType, IndexType >::apply | ( | ptr_param< const MultiVector< value_type > > | b, |
| ptr_param< MultiVector< value_type > > | x ) const |
|
static |
Creates a Csr matrix from an already allocated (and initialized) array.
The column indices array needs to be the same for all batch items.
| exec | Executor associated to the matrix |
| size | size of the matrix |
| values | array of matrix values |
| col_idxs | the col_idxs array of a single batch item of the matrix. |
| row_ptrs | the row_ptrs array of a single batch item of the matrix. |
|
inlinestatic |
|
static |
Creates a constant (immutable) batch csr matrix from a constant array.
Only a single sparsity pattern (column indices and row pointers) is stored and hence the user needs to ensure that each batch item has the same sparsity pattern.
| exec | the executor to create the matrix on |
| size | the dimensions of the matrix |
| values | the value array of the matrix |
| col_idxs | the col_idxs array of a single batch item of the matrix. |
| row_ptrs | the row_ptrs array of a single batch item of the matrix. |
| std::unique_ptr< const unbatch_type > gko::batch::matrix::Csr< ValueType, IndexType >::create_const_view_for_item | ( | size_type | item_id | ) | const |
Creates a mutable view (of matrix::Csr type) of one item of the batch::matrix::Csr<value_type> object.
Does not perform any deep copies, but only returns a view of the data.
| item_id | The index of the batch item |
| std::unique_ptr< unbatch_type > gko::batch::matrix::Csr< ValueType, IndexType >::create_view_for_item | ( | size_type | item_id | ) |
Creates a mutable view (of matrix::Csr type) of one item of the batch::matrix::Csr<value_type> object.
Does not perform any deep copies, but only returns a view of the data.
| item_id | The index of the batch item |
|
inlinenoexcept |
Returns a pointer to the array of column indices of the matrix.
|
inlinenoexcept |
Returns a pointer to the array of column indices of the matrix.
|
inlinenoexcept |
Returns a pointer to the array of row pointers of the matrix.
|
inlinenoexcept |
Returns a pointer to the array of values of the matrix.
|
inlinenoexcept |
Returns a pointer to the array of values of the matrix for a specific batch item.
| batch_id | the id of the batch item. |
|
inlinenoexcept |
Returns the number of stored elements in each batch item.
Referenced by get_const_values_for_item(), and get_values_for_item().
|
inlinenoexcept |
Returns the number of elements explicitly stored in the batch matrix, cumulative across all the batch items.
Referenced by get_num_elements_per_item().
|
inlinenoexcept |
Returns a pointer to the array of row pointers of the matrix.
|
inlinenoexcept |
Returns a pointer to the array of values of the matrix.
|
inlinenoexcept |
Returns a pointer to the array of values of the matrix for a specific batch item.
| batch_id | the id of the batch item. |
| void gko::batch::matrix::Csr< ValueType, IndexType >::scale | ( | const array< value_type > & | row_scale, |
| const array< value_type > & | col_scale ) |
Performs in-place row and column scaling for this matrix.
| row_scale | the row scalars |
| col_scale | the column scalars |