 |
Ginkgo
Generated from pipelines/2017069469 branch based on develop. Ginkgo version 1.11.0
A numerical linear algebra library targeting many-core architectures
|
5 #ifndef GKO_PUBLIC_CORE_MATRIX_BATCH_DENSE_HPP_
6 #define GKO_PUBLIC_CORE_MATRIX_BATCH_DENSE_HPP_
9 #include <initializer_list>
12 #include <ginkgo/core/base/array.hpp>
13 #include <ginkgo/core/base/batch_lin_op.hpp>
14 #include <ginkgo/core/base/batch_multi_vector.hpp>
15 #include <ginkgo/core/base/executor.hpp>
16 #include <ginkgo/core/base/mtx_io.hpp>
17 #include <ginkgo/core/base/range_accessors.hpp>
18 #include <ginkgo/core/base/types.hpp>
19 #include <ginkgo/core/base/utils.hpp>
20 #include <ginkgo/core/matrix/dense.hpp>
47 template <
typename ValueType = default_precision>
49 #if GINKGO_ENABLE_HALF || GINKGO_ENABLE_BFLOAT16
52 #if GINKGO_ENABLE_HALF && GINKGO_ENABLE_BFLOAT16
64 using value_type = ValueType;
65 using index_type =
int32;
75 #if GINKGO_ENABLE_HALF || GINKGO_ENABLE_BFLOAT16
85 #if GINKGO_ENABLE_HALF && GINKGO_ENABLE_BFLOAT16
122 GKO_ASSERT(batch_id < this->get_num_batch_items());
123 return batch_id * this->get_common_size()[0] *
124 this->get_common_size()[1];
159 GKO_ASSERT(batch_id < this->get_num_batch_items());
160 return values_.
get_data()[linearize_index(batch_id, row, col)];
168 GKO_ASSERT(batch_id < this->get_num_batch_items());
169 return values_.
get_const_data()[linearize_index(batch_id, row, col)];
188 GKO_ASSERT(batch_id < this->get_num_batch_items());
189 return values_.
get_data()[linearize_index(batch_id, idx)];
197 GKO_ASSERT(batch_id < this->get_num_batch_items());
211 GKO_ASSERT(batch_id < this->get_num_batch_items());
225 GKO_ASSERT(batch_id < this->get_num_batch_items());
259 static std::unique_ptr<Dense>
create(
260 std::shared_ptr<const Executor> exec,
277 static std::unique_ptr<Dense>
create(std::shared_ptr<const Executor> exec,
285 template <
typename InputValueType>
287 "explicitly construct the gko::array argument instead of passing an"
291 std::initializer_list<InputValueType> values)
311 std::shared_ptr<const Executor> exec,
const batch_dim<2>& sizes,
312 gko::detail::const_array_view<ValueType>&& values);
393 Dense(std::shared_ptr<const Executor> exec,
396 Dense(std::shared_ptr<const Executor> exec,
const batch_dim<2>& size,
399 void apply_impl(
const MultiVector<value_type>* b,
400 MultiVector<value_type>* x)
const;
402 void apply_impl(
const MultiVector<value_type>* alpha,
403 const MultiVector<value_type>* b,
404 const MultiVector<value_type>* beta,
405 MultiVector<value_type>* x)
const;
411 row * this->get_size().get_common_size()[1] + col;
416 return linearize_index(batch, idx / this->get_common_size()[1],
417 idx % this->get_common_size()[1]);
420 array<value_type> values_;
429 #endif // GKO_PUBLIC_CORE_MATRIX_BATCH_DENSE_HPP_
The EnableBatchLinOp mixin can be used to provide sensible default implementations of the majority of...
Definition: batch_lin_op.hpp:250
size_type get_num_batch_items() const
Get the number of batch items stored.
Definition: batch_dim.hpp:36
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.
Definition: batch_dense.hpp:209
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.
Definition: batch_dense.hpp:222
dim< dimensionality, dimension_type > get_common_size() const
Get the common size of the batch items.
Definition: batch_dim.hpp:43
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.
size_type get_num_elements_per_item() const noexcept
Returns the number of stored elements in each batch item.
Definition: batch_dense.hpp:246
ValueType & at(size_type batch_id, size_type idx) noexcept
Returns a single element for a particular batch item.
Definition: batch_dense.hpp:186
Dense is a matrix format which explicitly stores all values of the matrix.
Definition: dense_cache.hpp:28
Definition: batch_lin_op.hpp:59
static std::unique_ptr< const Dense > create_const(std::shared_ptr< const Executor > exec, const batch_dim< 2 > &sizes, gko::detail::const_array_view< ValueType > &&values)
Creates a constant (immutable) batch dense matrix from a constant array.
value_type at(size_type batch_id, size_type row, size_type col) const
Returns a single element for a particular batch item.
Definition: batch_dense.hpp:166
std::size_t size_type
Integral type used for allocation quantities.
Definition: types.hpp:90
value_type & at(size_type batch_id, size_type row, size_type col)
Returns a single element for a particular batch item.
Definition: batch_dense.hpp:157
MultiVector stores multiple vectors in a batched fashion and is useful for batched operations.
Definition: batch_multi_vector.hpp:52
const value_type * get_const_values() const noexcept
Returns a pointer to the array of values of the multi-vector.
Definition: batch_dense.hpp:141
The Ginkgo namespace.
Definition: abstract_factory.hpp:20
Dense * apply(ptr_param< const MultiVector< value_type >> b, ptr_param< MultiVector< value_type >> x)
Apply the matrix to a multi-vector.
ValueType at(size_type batch_id, size_type idx) const noexcept
Returns a single element for a particular batch item.
Definition: batch_dense.hpp:195
std::unique_ptr< const unbatch_type > create_const_view_for_item(size_type item_id) const
Creates a mutable view (of gko::matrix::Dense type) of one item of the batch::matrix::Dense<value_typ...
std::unique_ptr< unbatch_type > create_view_for_item(size_type item_id)
Creates a mutable view (of gko::matrix::Dense type) of one item of the batch::matrix::Dense<value_typ...
This class is used for function parameters in the place of raw pointers.
Definition: utils_helper.hpp:41
value_type * get_data() noexcept
Returns a pointer to the block of memory used to store the elements of the array.
Definition: array.hpp:687
static std::unique_ptr< Dense > create(std::shared_ptr< const Executor > exec, const batch_dim< 2 > &size=batch_dim< 2 >{})
Creates an uninitialized Dense matrix of the specified size.
size_type get_num_stored_elements() const noexcept
Returns the number of elements explicitly stored in the batch matrix, cumulative across all the batch...
Definition: batch_dense.hpp:236
typename detail::find_precision_impl< T, step >::type next_precision
Obtains the next move type of T in the singly-linked precision corresponding bfloat16/half.
Definition: math.hpp:466
typename detail::find_precision_impl< T, -step >::type previous_precision
Obtains the previous move type of T in the singly-linked precision corresponding bfloat16/half.
Definition: math.hpp:473
ConvertibleTo interface is used to mark that the implementer can be converted to the object of Result...
Definition: polymorphic_object.hpp:479
std::int32_t int32
32-bit signed integral type.
Definition: types.hpp:107
The first step in using the Ginkgo library consists of creating an executor.
Definition: executor.hpp:615
value_type * get_values() noexcept
Returns a pointer to the array of values of the multi-vector.
Definition: batch_dense.hpp:132
const value_type * get_const_data() const noexcept
Returns a constant pointer to the block of memory used to store the elements of the array.
Definition: array.hpp:696
Dense is a batch matrix format which explicitly stores all values of the matrix in each of the batche...
Definition: batch_dense.hpp:48
size_type get_size() const noexcept
Returns the number of elements in the array.
Definition: array.hpp:670
typename detail::remove_complex_s< T >::type remove_complex
Obtain the type which removed the complex of complex/scalar type or the template parameter of class b...
Definition: math.hpp:264
size_type get_cumulative_offset(size_type batch_id) const
Get the cumulative storage size offset.
Definition: batch_dense.hpp:120
void scale_add(ptr_param< const MultiVector< value_type >> alpha, ptr_param< const batch::matrix::Dense< value_type >> b)
Performs the operation this = alpha*this + b.
typename detail::to_complex_s< T >::type to_complex
Obtain the type which adds the complex of complex/scalar type or the template parameter of class by a...
Definition: math.hpp:283
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition: polymorphic_object.hpp:667