![]() |
Ginkgo Generated from branch based on main. Ginkgo version 1.10.0
A numerical linear algebra library targeting many-core architectures
|
HYBRID is a matrix format which splits the matrix into ELLPACK and COO format. More...
#include <ginkgo/core/matrix/hybrid.hpp>
Classes | |
| class | automatic |
| automatic is a strategy_type which decides the number of stored elements per row of the ell part automatically. More... | |
| class | column_limit |
| column_limit is a strategy_type which decides the number of stored elements per row of the ell part by specifying the number of columns. More... | |
| class | imbalance_bounded_limit |
| imbalance_bounded_limit is a strategy_type which decides the number of stored elements per row of the ell part. More... | |
| class | imbalance_limit |
| imbalance_limit is a strategy_type which decides the number of stored elements per row of the ell part according to the percent. More... | |
| class | minimal_storage_limit |
| minimal_storage_limit is a strategy_type which decides the number of stored elements per row of the ell part. More... | |
| class | strategy_type |
| strategy_type is to decide how to set the hybrid config. More... | |
Public Types | |
| using | value_type = ValueType |
| using | index_type = IndexType |
| using | mat_data = matrix_data<ValueType, IndexType> |
| using | device_mat_data = device_matrix_data<ValueType, IndexType> |
| using | coo_type = Coo<ValueType, IndexType> |
| using | ell_type = Ell<ValueType, IndexType> |
| using | absolute_type = remove_complex<Hybrid> |
| Public Types inherited from gko::EnablePolymorphicAssignment< Hybrid< default_precision, int32 > > | |
| using | result_type |
| Public Types inherited from gko::ConvertibleTo< Hybrid< default_precision, int32 > > | |
| using | result_type |
| Public Types inherited from gko::ConvertibleTo< Hybrid< next_precision< default_precision >, int32 > > | |
| using | result_type |
| Public Types inherited from gko::ConvertibleTo< Dense< default_precision > > | |
| using | result_type |
| Public Types inherited from gko::ConvertibleTo< Csr< default_precision, int32 > > | |
| using | result_type |
| Public Types inherited from gko::DiagonalExtractable< default_precision > | |
| using | value_type |
| Public Types inherited from gko::ReadableFromMatrixData< default_precision, int32 > | |
| using | value_type |
| using | index_type |
| Public Types inherited from gko::WritableToMatrixData< default_precision, int32 > | |
| using | value_type |
| using | index_type |
| Public Types inherited from gko::EnableAbsoluteComputation< remove_complex< Hybrid< default_precision, int32 > > > | |
| using | absolute_type |
Public Member Functions | |
| void | convert_to (Hybrid< next_precision< ValueType >, IndexType > *result) const override |
| void | move_to (Hybrid< 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 > *other) const override |
| void | move_to (Csr< ValueType, IndexType > *other) override |
| void | read (const mat_data &data) override |
| 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< 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. | |
| value_type * | get_ell_values () noexcept |
| Returns the values of the ell part. | |
| const value_type * | get_const_ell_values () const noexcept |
| Returns the values of the ell part. | |
| index_type * | get_ell_col_idxs () noexcept |
| Returns the column indexes of the ell part. | |
| const index_type * | get_const_ell_col_idxs () const noexcept |
| Returns the column indexes of the ell part. | |
| size_type | get_ell_num_stored_elements_per_row () const noexcept |
| Returns the number of stored elements per row of ell part. | |
| size_type | get_ell_stride () const noexcept |
| Returns the stride of the ell part. | |
| size_type | get_ell_num_stored_elements () const noexcept |
| Returns the number of elements explicitly stored in the ell part. | |
| value_type & | ell_val_at (size_type row, size_type idx) noexcept |
| Returns the idx-th non-zero element of the row-th row in the ell part. | |
| value_type | ell_val_at (size_type row, size_type idx) const noexcept |
| Returns the idx-th non-zero element of the row-th row in the ell part. | |
| index_type & | ell_col_at (size_type row, size_type idx) noexcept |
| Returns the idx-th column index of the row-th row in the ell part. | |
| index_type | ell_col_at (size_type row, size_type idx) const noexcept |
| Returns the idx-th column index of the row-th row in the ell part. | |
| const ell_type * | get_ell () const noexcept |
| Returns the matrix of the ell part. | |
| value_type * | get_coo_values () noexcept |
| Returns the values of the coo part. | |
| const value_type * | get_const_coo_values () const noexcept |
| Returns the values of the coo part. | |
| index_type * | get_coo_col_idxs () noexcept |
| Returns the column indexes of the coo part. | |
| const index_type * | get_const_coo_col_idxs () const noexcept |
| Returns the column indexes of the coo part. | |
| index_type * | get_coo_row_idxs () noexcept |
| Returns the row indexes of the coo part. | |
| const index_type * | get_const_coo_row_idxs () const noexcept |
| Returns the row indexes of the coo part. | |
| size_type | get_coo_num_stored_elements () const noexcept |
| Returns the number of elements explicitly stored in the coo part. | |
| const coo_type * | get_coo () const noexcept |
| Returns the matrix of the coo part. | |
| size_type | get_num_stored_elements () const noexcept |
| Returns the number of elements explicitly stored in the matrix. | |
| std::shared_ptr< strategy_type > | get_strategy () const noexcept |
| Returns the strategy. | |
| template<typename HybType> | |
| std::shared_ptr< typename HybType::strategy_type > | get_strategy () const |
| Returns the current strategy allowed in given hybrid format. | |
| Hybrid & | operator= (const Hybrid &) |
| Copy-assigns a Hybrid matrix. | |
| Hybrid & | operator= (Hybrid &&) |
| Move-assigns a Hybrid matrix. | |
| Hybrid (const Hybrid &) | |
| Copy-assigns a Hybrid matrix. | |
| Hybrid (Hybrid &&) | |
| Move-assigns a Hybrid matrix. | |
| Public Member Functions inherited from gko::EnableLinOp< Hybrid< default_precision, int32 > > | |
| const Hybrid< default_precision, int32 > * | apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const |
| Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< Hybrid< default_precision, int32 >, LinOp > | |
| std::unique_ptr< Hybrid< default_precision, int32 > > | create_default (std::shared_ptr< const Executor > exec) const |
| std::unique_ptr< Hybrid< default_precision, int32 > > | clone (std::shared_ptr< const Executor > exec) const |
| Hybrid< default_precision, int32 > * | copy_from (const PolymorphicObject *other) |
| Hybrid< default_precision, int32 > * | move_from (ptr_param< PolymorphicObject > other) |
| Hybrid< default_precision, int32 > * | clear () |
| Public Member Functions inherited from gko::LinOp | |
| 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. | |
| Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< 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 () |
| Public Member Functions inherited from gko::PolymorphicObject | |
| 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. | |
| Public Member Functions inherited from gko::log::EnableLogging< PolymorphicObject > | |
| 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. | |
| Public Member Functions inherited from gko::log::Loggable | |
| void | remove_logger (ptr_param< const Logger > logger) |
| Public Member Functions inherited from gko::EnablePolymorphicAssignment< Hybrid< 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< Hybrid< 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. | |
| Public Member Functions inherited from gko::ConvertibleTo< Dense< default_precision > > | |
| 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. | |
| Public Member Functions inherited from gko::ConvertibleTo< Csr< 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. | |
| Public Member Functions inherited from gko::DiagonalExtractable< default_precision > | |
| std::unique_ptr< LinOp > | extract_diagonal_linop () const override |
| Extracts the diagonal entries of the matrix into a vector. | |
| Public Member Functions inherited from gko::ReadableFromMatrixData< default_precision, int32 > | |
| virtual void | read (const matrix_data< default_precision, int32 > &data)=0 |
| Reads a matrix from a matrix_data structure. | |
| Public Member Functions inherited from gko::WritableToMatrixData< default_precision, int32 > | |
| virtual void | write (matrix_data< default_precision, int32 > &data) const=0 |
| Writes a matrix to a matrix_data structure. | |
| Public Member Functions inherited from gko::EnableAbsoluteComputation< remove_complex< Hybrid< default_precision, int32 > > > | |
| std::unique_ptr< LinOp > | compute_absolute_linop () const override |
| Gets the absolute LinOp. | |
Static Public Member Functions | |
| static std::unique_ptr< Hybrid > | create (std::shared_ptr< const Executor > exec, std::shared_ptr< strategy_type > strategy=std::make_shared< automatic >()) |
| Creates an uninitialized Hybrid matrix of specified method. | |
| static std::unique_ptr< Hybrid > | create (std::shared_ptr< const Executor > exec, const dim< 2 > &size, std::shared_ptr< strategy_type > strategy=std::make_shared< automatic >()) |
| Creates an uninitialized Hybrid matrix of the specified size and method. | |
| static std::unique_ptr< Hybrid > | create (std::shared_ptr< const Executor > exec, const dim< 2 > &size, size_type num_stored_elements_per_row, std::shared_ptr< strategy_type > strategy=std::make_shared< automatic >()) |
| Creates an uninitialized Hybrid matrix of the specified size and method. | |
| static std::unique_ptr< Hybrid > | create (std::shared_ptr< const Executor > exec, const dim< 2 > &size, size_type num_stored_elements_per_row, size_type stride, std::shared_ptr< strategy_type > strategy) |
| Creates an uninitialized Hybrid matrix of the specified size and method. | |
| static std::unique_ptr< Hybrid > | create (std::shared_ptr< const Executor > exec, const dim< 2 > &size, size_type num_stored_elements_per_row, size_type stride, size_type num_nonzeros={}, std::shared_ptr< strategy_type > strategy=std::make_shared< automatic >()) |
| Creates an uninitialized Hybrid matrix of the specified size and method. | |
HYBRID is a matrix format which splits the matrix into ELLPACK and COO format.
Achieve the excellent performance with a proper partition of ELLPACK and COO.
| ValueType | precision of matrix elements |
| IndexType | precision of matrix indexes |
| gko::matrix::Hybrid< ValueType, IndexType >::Hybrid | ( | const Hybrid< ValueType, IndexType > & | ) |
Copy-assigns a Hybrid matrix.
Inherits the executor, copies the Ell and Coo matrices.
References Hybrid().
Referenced by get_strategy(), Hybrid(), Hybrid(), operator=(), and operator=().
| gko::matrix::Hybrid< ValueType, IndexType >::Hybrid | ( | Hybrid< ValueType, IndexType > && | ) |
|
overridevirtual |
Gets the AbsoluteLinOp.
Implements gko::EnableAbsoluteComputation< remove_complex< Hybrid< default_precision, int32 > > >.
|
overridevirtual |
Compute absolute inplace on each element.
Implements gko::AbsoluteComputable.
|
static |
Creates an uninitialized Hybrid matrix of the specified size and method.
| exec | Executor associated to the matrix |
| size | size of the matrix |
| num_stored_elements_per_row | the number of stored elements per row |
| stride | stride of the rows |
| num_nonzeros | number of nonzeros |
| strategy | strategy of deciding the Hybrid config |
|
static |
Creates an uninitialized Hybrid matrix of the specified size and method.
| exec | Executor associated to the matrix |
| size | size of the matrix |
| num_stored_elements_per_row | the number of stored elements per row |
| stride | stride of the rows |
| strategy | strategy of deciding the Hybrid config |
|
static |
Creates an uninitialized Hybrid matrix of the specified size and method.
(ell_stride is set to the number of rows of the matrix.)
| exec | Executor associated to the matrix |
| size | size of the matrix |
| num_stored_elements_per_row | the number of stroed elements per row |
| strategy | strategy of deciding the Hybrid config |
|
static |
Creates an uninitialized Hybrid matrix of the specified size and method.
(ell_num_stored_elements_per_row is set to the number of cols of the matrix. ell_stride is set to the number of rows of the matrix.)
| exec | Executor associated to the matrix |
| size | size of the matrix |
| strategy | strategy of deciding the Hybrid config |
|
static |
Creates an uninitialized Hybrid matrix of specified method.
(ell_num_stored_elements_per_row is set to the number of cols of the matrix. ell_stride is set to the number of rows of the matrix.)
|
inlinenoexcept |
Returns the idx-th column index of the row-th row in the ell part.
| row | the row of the requested element |
| idx | the idx-th stored element of the row |
|
inlinenoexcept |
Returns the idx-th column index of the row-th row in the ell part.
| row | the row of the requested element |
| idx | the idx-th stored element of the row |
|
inlinenoexcept |
Returns the idx-th non-zero element of the row-th row in the ell part.
| row | the row of the requested element |
| idx | the idx-th stored element of the row |
|
inlinenoexcept |
Returns the idx-th non-zero element of the row-th row in the ell part.
| row | the row of the requested element |
| idx | the idx-th stored element of the row |
|
overridevirtual |
Extracts the diagonal entries of the matrix into a vector.
| diag | the vector into which the diagonal will be written |
Implements gko::DiagonalExtractable< default_precision >.
|
inlinenoexcept |
Returns the column indexes of the coo part.
|
inlinenoexcept |
Returns the row indexes of the coo part.
|
inlinenoexcept |
Returns the values of the coo part.
|
inlinenoexcept |
Returns the column indexes of the ell part.
|
inlinenoexcept |
Returns the values of the ell part.
|
inlinenoexcept |
Returns the matrix of the coo part.
|
inlinenoexcept |
Returns the column indexes of the coo part.
|
inlinenoexcept |
Returns the number of elements explicitly stored in the coo part.
|
inlinenoexcept |
Returns the row indexes of the coo part.
|
inlinenoexcept |
Returns the values of the coo part.
|
inlinenoexcept |
Returns the matrix of the ell part.
|
inlinenoexcept |
Returns the column indexes of the ell part.
|
inlinenoexcept |
Returns the number of elements explicitly stored in the ell part.
|
inlinenoexcept |
Returns the number of stored elements per row of ell part.
|
inlinenoexcept |
Returns the stride of the ell part.
|
inlinenoexcept |
Returns the values of the ell part.
|
inlinenoexcept |
Returns the number of elements explicitly stored in the matrix.
| std::shared_ptr< typename HybType::strategy_type > gko::matrix::Hybrid< ValueType, IndexType >::get_strategy | ( | ) | const |
Returns the current strategy allowed in given hybrid format.
| HybType | hybrid type |
References Hybrid().
|
inlinenoexcept |
Returns the strategy.
| Hybrid & gko::matrix::Hybrid< ValueType, IndexType >::operator= | ( | const Hybrid< ValueType, IndexType > & | ) |
| Hybrid & gko::matrix::Hybrid< ValueType, IndexType >::operator= | ( | Hybrid< ValueType, IndexType > && | ) |