|
void | convert_to (Fbcsr< next_precision< ValueType >, IndexType > *result) const override |
void | move_to (Fbcsr< next_precision< ValueType >, IndexType > *result) override |
void | convert_to (Dense< ValueType > *other) const override |
void | move_to (Dense< ValueType > *other) override |
void | convert_to (Csr< ValueType, IndexType > *result) const override |
| Converts the matrix to CSR format.
|
void | move_to (Csr< ValueType, IndexType > *result) override |
void | convert_to (SparsityCsr< ValueType, IndexType > *result) const override |
| Get the block sparsity pattern in CSR-like format.
|
void | move_to (SparsityCsr< ValueType, IndexType > *result) override |
void | read (const mat_data &data) override |
| Reads a matrix_data into Fbcsr format.
|
void | read (const device_mat_data &data) override |
void | read (device_mat_data &&data) override |
void | write (mat_data &data) const override |
std::unique_ptr< LinOp > | transpose () const override |
| Returns a LinOp representing the transpose of the Transposable object.
|
std::unique_ptr< LinOp > | conj_transpose () const override |
| Returns a LinOp representing the conjugate transpose of the Transposable object.
|
std::unique_ptr< Diagonal< ValueType > > | extract_diagonal () const override |
| Extracts the diagonal entries of the matrix into a vector.
|
std::unique_ptr< absolute_type > | compute_absolute () const override |
| Gets the AbsoluteLinOp.
|
void | compute_absolute_inplace () override |
| Compute absolute inplace on each element.
|
void | sort_by_column_index () |
| Sorts the values blocks and block-column indices in each row by column index.
|
bool | is_sorted_by_column_index () const |
| Tests if all row entry pairs (value, col_idx) are sorted by column index.
|
value_type * | get_values () noexcept |
const value_type * | get_const_values () const noexcept |
index_type * | get_col_idxs () noexcept |
const index_type * | get_const_col_idxs () const noexcept |
index_type * | get_row_ptrs () noexcept |
const index_type * | get_const_row_ptrs () const noexcept |
size_type | get_num_stored_elements () const noexcept |
size_type | get_num_stored_blocks () const noexcept |
int | get_block_size () const noexcept |
index_type | get_num_block_rows () const noexcept |
index_type | get_num_block_cols () const noexcept |
Fbcsr & | operator= (const Fbcsr &) |
| Copy-assigns an Fbcsr matrix.
|
Fbcsr & | operator= (Fbcsr &&) |
| Move-assigns an Fbcsr matrix.
|
| Fbcsr (const Fbcsr &) |
| Copy-constructs an Ell matrix.
|
| Fbcsr (Fbcsr &&) |
| Move-constructs an Fbcsr matrix.
|
const Fbcsr< default_precision, int32 > * | apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const |
std::unique_ptr< Fbcsr< default_precision, int32 > > | create_default (std::shared_ptr< const Executor > exec) const |
std::unique_ptr< Fbcsr< default_precision, int32 > > | clone (std::shared_ptr< const Executor > exec) const |
Fbcsr< default_precision, int32 > * | copy_from (const PolymorphicObject *other) |
Fbcsr< default_precision, int32 > * | move_from (ptr_param< PolymorphicObject > other) |
Fbcsr< default_precision, int32 > * | clear () |
LinOp * | apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) |
| Applies a linear operator to a vector (or a sequence of vectors).
|
const LinOp * | apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const |
LinOp * | apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) |
| Performs the operation x = alpha * op(b) + beta * x.
|
const LinOp * | apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) const |
const dim< 2 > & | get_size () const noexcept |
| Returns the size of the operator.
|
virtual bool | apply_uses_initial_guess () const |
| Returns true if the linear operator uses the data given in x as an initial guess.
|
LinOp & | operator= (const LinOp &)=default |
| Copy-assigns a LinOp.
|
LinOp & | operator= (LinOp &&other) |
| Move-assigns a LinOp.
|
| LinOp (const LinOp &)=default |
| Copy-constructs a LinOp.
|
| LinOp (LinOp &&other) |
| Move-constructs a LinOp.
|
std::unique_ptr< LinOp > | create_default (std::shared_ptr< const Executor > exec) const |
std::unique_ptr< LinOp > | clone (std::shared_ptr< const Executor > exec) const |
LinOp * | copy_from (const PolymorphicObject *other) |
LinOp * | move_from (ptr_param< PolymorphicObject > other) |
LinOp * | clear () |
PolymorphicObject & | operator= (const PolymorphicObject &) |
std::unique_ptr< PolymorphicObject > | create_default (std::shared_ptr< const Executor > exec) const |
| Creates a new "default" object of the same dynamic type as this object.
|
std::unique_ptr< PolymorphicObject > | create_default () const |
| Creates a new "default" object of the same dynamic type as this object.
|
std::unique_ptr< PolymorphicObject > | clone (std::shared_ptr< const Executor > exec) const |
| Creates a clone of the object.
|
std::unique_ptr< PolymorphicObject > | clone () const |
| Creates a clone of the object.
|
PolymorphicObject * | copy_from (const PolymorphicObject *other) |
| Copies another object into this object.
|
template<typename Derived, typename Deleter> |
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, PolymorphicObject > * | copy_from (std::unique_ptr< Derived, Deleter > &&other) |
| Moves another object into this object.
|
template<typename Derived, typename Deleter> |
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, PolymorphicObject > * | copy_from (const std::unique_ptr< Derived, Deleter > &other) |
| Copies another object into this object.
|
PolymorphicObject * | copy_from (const std::shared_ptr< const PolymorphicObject > &other) |
| Copies another object into this object.
|
PolymorphicObject * | move_from (ptr_param< PolymorphicObject > other) |
| Moves another object into this object.
|
PolymorphicObject * | clear () |
| Transforms the object into its default state.
|
std::shared_ptr< const Executor > | get_executor () const noexcept |
| Returns the Executor of the object.
|
void | add_logger (std::shared_ptr< const Logger > logger) override |
| Adds a new logger to the list of subscribed loggers.
|
void | remove_logger (const Logger *logger) override |
| Removes a logger from the list of subscribed loggers.
|
const std::vector< std::shared_ptr< const Logger > > & | get_loggers () const override |
| Returns the vector containing all loggers registered at this object.
|
void | clear_loggers () override |
| Remove all loggers registered at this object.
|
void | remove_logger (ptr_param< const Logger > logger) |
void | convert_to (result_type *result) const override |
void | move_to (result_type *result) override |
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.
|
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.
|
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.
|
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.
|
virtual void | read (const matrix_data< default_precision, int32 > &data)=0 |
| Reads a matrix from a matrix_data structure.
|
virtual void | write (matrix_data< default_precision, int32 > &data) const=0 |
| Writes a matrix to a matrix_data structure.
|
std::unique_ptr< LinOp > | compute_absolute_linop () const override |
| Gets the absolute LinOp.
|
|
static std::unique_ptr< Fbcsr > | create (std::shared_ptr< const Executor > exec, int block_size=1) |
| Creates an uninitialized FBCSR matrix with the given block size.
|
static std::unique_ptr< Fbcsr > | create (std::shared_ptr< const Executor > exec, const dim< 2 > &size, size_type num_nonzeros, int block_size) |
| Creates an uninitialized FBCSR matrix of the specified size.
|
static std::unique_ptr< Fbcsr > | create (std::shared_ptr< const Executor > exec, const dim< 2 > &size, int block_size, array< value_type > values, array< index_type > col_idxs, array< index_type > row_ptrs) |
| Creates a FBCSR matrix from already allocated (and initialized) row pointer, column index and value arrays.
|
template<typename InputValueType, typename InputColumnIndexType, typename InputRowPtrType> |
static std::unique_ptr< Fbcsr > | create (std::shared_ptr< const Executor > exec, const dim< 2 > &size, int block_size, std::initializer_list< InputValueType > values, std::initializer_list< InputColumnIndexType > col_idxs, std::initializer_list< InputRowPtrType > row_ptrs) |
| create(std::shared_ptr<const Executor>,const dim<2>&, int, array<value_type>, array<index_type>,array<index_type>)
|
static std::unique_ptr< const Fbcsr > | create_const (std::shared_ptr< const Executor > exec, const dim< 2 > &size, int blocksize, gko::detail::const_array_view< ValueType > &&values, gko::detail::const_array_view< IndexType > &&col_idxs, gko::detail::const_array_view< IndexType > &&row_ptrs) |
| Creates a constant (immutable) Fbcsr matrix from a constant array.
|
template<typename ValueType = default_precision, typename IndexType = int32>
class gko::matrix::Fbcsr< ValueType, IndexType >
Fixed-block compressed sparse row storage matrix format.
FBCSR is a matrix format meant for matrices having a natural block structure made up of small, dense, disjoint blocks. It is similar to CSR
- See also
- Csr. However, unlike Csr, each non-zero location stores a small dense block of entries having a constant size. This reduces the number of integers that need to be stored in order to refer to a given non-zero entry, and enables efficient implementation of certain block methods.
The block size is expected to be known in advance and passed to the constructor.
- Note
- The total number of rows and the number of columns are expected to be divisible by the block size.
The nonzero elements are stored in a 1D array row-wise, and accompanied with a row pointer array which stores the starting index of each block-row. An additional block-column index array is used to identify the block-column of each nonzero block.
The Fbcsr LinOp supports different operations:
A->apply(b, x)
A->apply(alpha, b, beta, x)
Dense is a matrix format which explicitly stores all values of the matrix.
Definition dense.hpp:120
Fixed-block compressed sparse row storage matrix format.
Definition fbcsr.hpp:116
- Template Parameters
-
ValueType | precision of matrix elements |
IndexType | precision of matrix indexes |