|
void | convert_to (MultiVector< next_precision< ValueType > > *result) const override |
|
void | move_to (MultiVector< next_precision< ValueType > > *result) override |
|
void | convert_to (MultiVector< next_precision< next_precision< ValueType > > > *result) const override |
|
void | move_to (MultiVector< next_precision< next_precision< ValueType > > > *result) override |
|
std::unique_ptr< unbatch_type > | create_view_for_item (size_type item_id) |
| Creates a mutable view (of matrix::Dense type) of one item of the Batch MultiVector object.
|
|
std::unique_ptr< const unbatch_type > | create_const_view_for_item (size_type item_id) const |
| Creates a mutable view (of matrix::Dense type) of one item of the Batch MultiVector object.
|
|
batch_dim< 2 > | get_size () const |
| Returns the batch size.
|
|
size_type | get_num_batch_items () const |
| Returns the number of batch items.
|
|
dim< 2 > | get_common_size () const |
| Returns the common size of the batch items.
|
|
value_type * | get_values () noexcept |
| Returns a pointer to the array of values of the multi-vector.
|
|
const value_type * | get_const_values () const noexcept |
| Returns a pointer to the array of values of the multi-vector.
|
|
value_type * | get_values_for_item (size_type batch_id) noexcept |
| Returns a pointer to the array of values of the multi-vector 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 multi-vector for a specific batch item.
|
|
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_cumulative_offset (size_type batch_id) const |
| Get the cumulative storage size offset.
|
|
value_type & | at (size_type batch_id, size_type row, size_type col) |
| Returns a single element for a particular batch item.
|
|
value_type | at (size_type batch_id, size_type row, size_type col) const |
| Returns a single element for a particular batch item.
|
|
ValueType & | at (size_type batch_id, size_type idx) noexcept |
| Returns a single element for a particular batch item.
|
|
ValueType | at (size_type batch_id, size_type idx) const noexcept |
| Returns a single element for a particular batch item.
|
|
void | scale (ptr_param< const MultiVector< ValueType > > alpha) |
| Scales the vector with a scalar (aka: BLAS scal).
|
|
void | add_scaled (ptr_param< const MultiVector< ValueType > > alpha, ptr_param< const MultiVector< ValueType > > b) |
| Adds b scaled by alpha to the vector (aka: BLAS axpy).
|
|
void | compute_dot (ptr_param< const MultiVector< ValueType > > b, ptr_param< MultiVector< ValueType > > result) const |
| Computes the column-wise dot product of each multi-vector in this batch and its corresponding entry in b .
|
|
void | compute_conj_dot (ptr_param< const MultiVector< ValueType > > b, ptr_param< MultiVector< ValueType > > result) const |
| Computes the column-wise conjugate dot product of each multi-vector in this batch and its corresponding entry in b .
|
|
void | compute_norm2 (ptr_param< MultiVector< remove_complex< ValueType > > > result) const |
| Computes the Euclidean (L^2) norm of each multi-vector in this batch.
|
|
void | fill (ValueType value) |
| Fills the input MultiVector with a given value.
|
|
std::unique_ptr< MultiVector< default_precision > > | create_default (std::shared_ptr< const Executor > exec) const |
|
std::unique_ptr< MultiVector< default_precision > > | create_default () const |
|
std::unique_ptr< MultiVector< default_precision > > | clone (std::shared_ptr< const Executor > exec) const |
|
std::unique_ptr< MultiVector< default_precision > > | clone () const |
|
MultiVector< default_precision > * | copy_from (const PolymorphicObject *other) |
|
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, MultiVector< default_precision > > * | copy_from (std::unique_ptr< Derived > &&other) |
|
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, MultiVector< default_precision > > * | copy_from (const std::unique_ptr< Derived > &other) |
|
MultiVector< default_precision > * | copy_from (const std::shared_ptr< const PolymorphicObject > &other) |
|
MultiVector< default_precision > * | move_from (ptr_param< PolymorphicObject > other) |
|
MultiVector< default_precision > * | 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.
|
|
void | remove_logger (ptr_param< const Logger > logger) |
|
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 |
|
void | convert_to (ptr_param< result_type > result) const |
|
void | move_to (ptr_param< result_type > result) |
|
virtual void | convert_to (result_type *result) const=0 |
| Converts the implementer to an object of type result_type.
|
|
void | convert_to (ptr_param< result_type > result) const |
|
virtual void | move_to (result_type *result)=0 |
| Converts the implementer to an object of type result_type by moving data from this object.
|
|
void | move_to (ptr_param< result_type > result) |
|
virtual void | convert_to (result_type *result) const=0 |
| Converts the implementer to an object of type result_type.
|
|
void | convert_to (ptr_param< result_type > result) const |
|
virtual void | move_to (result_type *result)=0 |
| Converts the implementer to an object of type result_type by moving data from this object.
|
|
void | move_to (ptr_param< result_type > result) |
|
template<typename ValueType = default_precision>
class gko::batch::MultiVector< ValueType >
MultiVector stores multiple vectors in a batched fashion and is useful for batched operations.
For example, if you want to store two batch items with multi-vectors of size (3 x 2) given below:
[1 2 ; 3 4 1 2 ; 3 4 1 2 ; 3 4]
In memory, they would be stored as a single array: [1 2 1 2 1 2 3 4 3 4 3 4].
Access functions @at can help access individual item if necessary.
The values of the different batch items are stored consecutively and in each batch item, the multi-vectors are stored in a row-major fashion.
- Template Parameters
-
ValueType | precision of multi-vector elements |