5#ifndef GKO_PUBLIC_CORE_MATRIX_BATCH_CSR_HPP_
6#define GKO_PUBLIC_CORE_MATRIX_BATCH_CSR_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/types.hpp>
18#include <ginkgo/core/base/utils.hpp>
19#include <ginkgo/core/matrix/csr.hpp>
46template <
typename ValueType = default_precision,
typename IndexType =
int32>
51 Csr<next_precision<next_precision<ValueType>>, IndexType>>,
53 public ConvertibleTo<Csr<next_precision<ValueType>, IndexType>> {
56 friend class Csr<previous_precision<ValueType>, IndexType>;
57 static_assert(std::is_same<IndexType, int32>::value,
58 "IndexType must be a 32 bit integer");
64 using value_type = ValueType;
65 using index_type = IndexType;
76 friend class Csr<previous_precision<previous_precision<ValueType>>,
84 result)
const override;
197 GKO_ASSERT(batch_id < this->get_num_batch_items());
199 batch_id * this->get_num_elements_per_item());
214 GKO_ASSERT(batch_id < this->get_num_batch_items());
216 batch_id * this->get_num_elements_per_item());
237 std::shared_ptr<const Executor> exec,
257 static std::unique_ptr<Csr>
create(std::shared_ptr<const Executor> exec,
268 template <
typename InputValueType,
typename ColIndexType,
271 "explicitly construct the gko::array arguments instead of passing "
275 std::initializer_list<InputValueType> values,
276 std::initializer_list<ColIndexType> col_idxs,
277 std::initializer_list<RowPtrType> row_ptrs)
303 std::shared_ptr<const Executor> exec,
const batch_dim<2>& sizes,
304 gko::detail::const_array_view<value_type>&& values,
305 gko::detail::const_array_view<index_type>&& col_idxs,
306 gko::detail::const_array_view<index_type>&& row_ptrs);
372 Csr(std::shared_ptr<const Executor> exec,
376 Csr(std::shared_ptr<const Executor> exec,
const batch_dim<2>& size,
380 values_{exec,
std::move(values)},
381 col_idxs_{exec,
std::move(col_idxs)},
382 row_ptrs_{exec,
std::move(row_ptrs)}
385 auto max_num_elems = this->get_common_size()[0] *
386 this->get_common_size()[1] *
387 this->get_num_batch_items();
388 GKO_ASSERT(values_.
get_size() <= max_num_elems);
389 GKO_ASSERT_EQ(row_ptrs_.
get_size(), this->get_common_size()[0] + 1);
393 void apply_impl(
const MultiVector<value_type>* b,
394 MultiVector<value_type>* x)
const;
396 void apply_impl(
const MultiVector<value_type>* alpha,
397 const MultiVector<value_type>* b,
398 const MultiVector<value_type>* beta,
399 MultiVector<value_type>* x)
const;
ConvertibleTo interface is used to mark that the implementer can be converted to the object of Result...
Definition polymorphic_object.hpp:470
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:662
The first step in using the Ginkgo library consists of creating an executor.
Definition executor.hpp:615
An array is a container which encapsulates fixed-sized arrays, stored on the Executor tied to the arr...
Definition logger.hpp:25
value_type * get_data() noexcept
Returns a pointer to the block of memory used to store the elements of the array.
Definition array.hpp:673
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:682
size_type get_size() const noexcept
Returns the number of elements in the array.
Definition array.hpp:656
Definition batch_lin_op.hpp:59
The EnableBatchLinOp mixin can be used to provide sensible default implementations of the majority of...
Definition batch_lin_op.hpp:252
MultiVector stores multiple vectors in a batched fashion and is useful for batched operations.
Definition logger.hpp:41
Csr is a general sparse matrix format that stores the column indices for each nonzero entry and a cum...
Definition batch_csr.hpp:53
void scale(const array< value_type > &row_scale, const array< value_type > &col_scale)
Performs in-place row and column scaling for this matrix.
const Csr * apply(ptr_param< const MultiVector< value_type > > b, ptr_param< MultiVector< value_type > > x) const
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_csr.hpp:195
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...
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_csr.hpp:172
Csr * apply(ptr_param< const MultiVector< value_type > > b, ptr_param< MultiVector< value_type > > x)
Apply the matrix to a multi-vector.
value_type * get_values() noexcept
Returns a pointer to the array of values of the matrix.
Definition batch_csr.hpp:113
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
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.
const index_type * get_const_row_ptrs() const noexcept
Returns a pointer to the array of row pointers of the matrix.
Definition batch_csr.hpp:160
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.
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.
index_type * get_col_idxs() noexcept
Returns a pointer to the array of column indices of the matrix.
Definition batch_csr.hpp:132
const index_type * get_const_col_idxs() const noexcept
Returns a pointer to the array of column indices of the matrix.
Definition batch_csr.hpp:141
size_type get_num_elements_per_item() const noexcept
Returns the number of stored elements in each batch item.
Definition batch_csr.hpp:182
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_csr.hpp:211
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.
const value_type * get_const_values() const noexcept
Returns a pointer to the array of values of the matrix.
Definition batch_csr.hpp:122
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.
index_type * get_row_ptrs() noexcept
Returns a pointer to the array of row pointers of the matrix.
Definition batch_csr.hpp:151
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...
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition sparsity_csr.hpp:21
This class is used for function parameters in the place of raw pointers.
Definition utils_helper.hpp:41
The Ginkgo namespace.
Definition abstract_factory.hpp:20
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:260
typename detail::next_precision_impl< T >::type next_precision
Obtains the next type in the singly-linked precision list with half.
Definition math.hpp:438
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:279
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:89
A type representing the dimensions of a multidimensional batch object.
Definition batch_dim.hpp:27