5#ifndef GKO_PUBLIC_CORE_MATRIX_DENSE_HPP_
6#define GKO_PUBLIC_CORE_MATRIX_DENSE_HPP_
9#include <initializer_list>
12#include <ginkgo/core/base/array.hpp>
13#include <ginkgo/core/base/exception_helpers.hpp>
14#include <ginkgo/core/base/executor.hpp>
15#include <ginkgo/core/base/lin_op.hpp>
16#include <ginkgo/core/base/range_accessors.hpp>
17#include <ginkgo/core/base/types.hpp>
18#include <ginkgo/core/base/utils.hpp>
19#include <ginkgo/core/matrix/permutation.hpp>
20#include <ginkgo/core/matrix/scaled_permutation.hpp>
24namespace experimental {
28template <
typename ValueType>
35template <
typename ValueType>
47template <
typename ValueType,
typename IndexType>
50template <
typename ValueType,
typename IndexType>
53template <
typename ValueType>
56template <
typename ValueType,
typename IndexType>
59template <
typename ValueType,
typename IndexType>
62template <
typename ValueType,
typename IndexType>
65template <
typename ValueType,
typename IndexType>
68template <
typename ValueType,
typename IndexType>
87template <
typename ValueType = default_precision>
91#if GINKGO_ENABLE_HALF || GINKGO_ENABLE_BFLOAT16
94#if GINKGO_ENABLE_HALF && GINKGO_ENABLE_BFLOAT16
139 friend class experimental::distributed::detail::VectorCache<ValueType>;
177 using value_type = ValueType;
178 using index_type =
int64;
185 using real_type = absolute_type;
203 return (*other).create_with_same_config();
222 return (*other).create_with_type_of_impl(exec, size, size[1]);
238 return (*other).create_with_type_of_impl(exec, size, stride);
256 return (*other).create_with_type_of_impl(exec, size, stride);
269 return other->create_view_of_impl();
282 return other->create_const_view_of_impl();
291#if GINKGO_ENABLE_HALF || GINKGO_ENABLE_BFLOAT16
301#if GINKGO_ENABLE_HALF && GINKGO_ENABLE_BFLOAT16
367 void read(
const mat_data& data)
override;
369 void read(
const mat_data32& data)
override;
371 void read(
const device_mat_data& data)
override;
373 void read(
const device_mat_data32& data)
override;
375 void read(device_mat_data&& data)
override;
377 void read(device_mat_data32&& data)
override;
379 void write(mat_data& data)
const override;
381 void write(mat_data32& data)
const override;
408 void fill(
const ValueType value);
466 bool invert =
false)
const;
475 bool invert =
false)
const;
550 bool invert =
false)
const;
560 bool invert =
false)
const;
586 const array<int32>* permutation_indices)
const override;
589 const array<int64>* permutation_indices)
const override;
610 const array<int32>* permutation_indices)
const override;
613 const array<int64>* permutation_indices)
const override;
635 const array<int32>* permutation_indices)
const override;
638 const array<int64>* permutation_indices)
const override;
724 const array<int32>* permutation_indices)
const override;
727 const array<int64>* permutation_indices)
const override;
748 const array<int32>* permutation_indices)
const override;
751 const array<int64>* permutation_indices)
const override;
772 const array<int32>* permutation_indices)
const override;
775 const array<int64>* permutation_indices)
const override;
860 value_type*
get_values() noexcept {
return values_.get_data(); }
871 return values_.get_const_data();
888 return values_.get_size();
903 return values_.get_data()[linearize_index(row, col)];
911 return values_.get_const_data()[linearize_index(row, col)];
930 return values_.get_data()[linearize_index(idx)];
938 return values_.get_const_data()[linearize_index(idx)];
1136 return this->create_submatrix_impl(
rows,
columns, stride);
1177 static std::unique_ptr<Dense>
create(std::shared_ptr<const Executor> exec,
1197 static std::unique_ptr<Dense>
create(std::shared_ptr<const Executor> exec,
1206 template <
typename InputValueType>
1208 "explicitly construct the gko::array argument instead of passing an"
1212 std::initializer_list<InputValueType> values,
size_type stride)
1230 std::shared_ptr<const Executor> exec,
const dim<2>& size,
1231 gko::detail::const_array_view<ValueType>&& values,
size_type stride);
1260 Dense(std::shared_ptr<const Executor> exec,
const dim<2>& size = {},
1263 Dense(std::shared_ptr<const Executor> exec,
const dim<2>& size,
1272 virtual std::unique_ptr<Dense> create_with_same_config()
const
1285 virtual std::unique_ptr<Dense> create_with_type_of_impl(
1286 std::shared_ptr<const Executor> exec,
const dim<2>& size,
1298 virtual std::unique_ptr<Dense> create_view_of_impl()
1314 virtual std::unique_ptr<const Dense> create_const_view_of_impl()
const
1324 template <
typename IndexType>
1325 void convert_impl(Coo<ValueType, IndexType>* result)
const;
1327 template <
typename IndexType>
1328 void convert_impl(Csr<ValueType, IndexType>* result)
const;
1330 template <
typename IndexType>
1331 void convert_impl(Ell<ValueType, IndexType>* result)
const;
1333 template <
typename IndexType>
1334 void convert_impl(Fbcsr<ValueType, IndexType>* result)
const;
1336 template <
typename IndexType>
1337 void convert_impl(Hybrid<ValueType, IndexType>* result)
const;
1339 template <
typename IndexType>
1340 void convert_impl(Sellp<ValueType, IndexType>* result)
const;
1342 template <
typename IndexType>
1343 void convert_impl(SparsityCsr<ValueType, IndexType>* result)
const;
1351 virtual void scale_impl(
const LinOp* alpha);
1359 virtual void inv_scale_impl(
const LinOp* alpha);
1367 virtual void add_scaled_impl(
const LinOp* alpha,
const LinOp* b);
1375 virtual void sub_scaled_impl(
const LinOp* alpha,
const LinOp* b);
1383 virtual void compute_dot_impl(
const LinOp* b,
LinOp* result)
const;
1391 virtual void compute_conj_dot_impl(
const LinOp* b,
LinOp* result)
const;
1399 virtual void compute_norm2_impl(
LinOp* result)
const;
1407 virtual void compute_norm1_impl(
LinOp* result)
const;
1415 virtual void compute_squared_norm2_impl(
LinOp* result)
const;
1420 virtual void compute_mean_impl(
LinOp* result)
const;
1430 void resize(gko::dim<2> new_size);
1439 virtual std::unique_ptr<Dense> create_submatrix_impl(
1442 void apply_impl(
const LinOp* b,
LinOp* x)
const override;
1444 void apply_impl(
const LinOp* alpha,
const LinOp* b,
const LinOp* beta,
1445 LinOp* x)
const override;
1449 return row * stride_ + col;
1454 return linearize_index(idx / this->
get_size()[1],
1458 template <
typename IndexType>
1459 void permute_impl(
const Permutation<IndexType>* permutation,
1462 template <
typename IndexType>
1463 void permute_impl(
const Permutation<IndexType>* row_permutation,
1464 const Permutation<IndexType>* col_permutation,
1465 bool invert,
Dense* output)
const;
1467 template <
typename IndexType>
1468 void scale_permute_impl(
1469 const ScaledPermutation<ValueType, IndexType>* permutation,
1472 template <
typename IndexType>
1473 void scale_permute_impl(
1474 const ScaledPermutation<ValueType, IndexType>* row_permutation,
1475 const ScaledPermutation<ValueType, IndexType>* column_permutation,
1476 bool invert,
Dense* output)
const;
1478 template <
typename OutputType,
typename IndexType>
1479 void row_gather_impl(
const array<IndexType>* row_idxs,
1482 template <
typename OutputType,
typename IndexType>
1484 const array<IndexType>* row_idxs,
1490 array<value_type> values_;
1492 void add_scaled_identity_impl(
const LinOp* a,
const LinOp* b)
override;
1502template <
typename ValueType>
1503struct temporary_clone_helper<matrix::Dense<ValueType>> {
1504 static std::unique_ptr<matrix::Dense<ValueType>> create(
1505 std::shared_ptr<const Executor> exec, matrix::Dense<ValueType>* ptr,
1527template <
typename VecPtr>
1528std::unique_ptr<matrix::Dense<typename detail::pointee<VecPtr>::value_type>>
1531 using value_type =
typename detail::pointee<VecPtr>::value_type;
1543template <
typename VecPtr>
1545 const matrix::Dense<typename detail::pointee<VecPtr>::value_type>>
1548 using value_type =
typename detail::pointee<VecPtr>::value_type;
1573template <
typename Matrix,
typename... TArgs>
1575 size_type stride, std::initializer_list<typename Matrix::value_type> vals,
1576 std::shared_ptr<const Executor> exec, TArgs&&... create_args)
1580 auto tmp = dense::create(exec->get_master(),
dim<2>{num_rows, 1}, stride);
1582 for (
const auto& elem : vals) {
1583 tmp->at(idx) = elem;
1586 auto mtx = Matrix::create(exec, std::forward<TArgs>(create_args)...);
1611template <
typename Matrix,
typename... TArgs>
1613 std::initializer_list<typename Matrix::value_type> vals,
1614 std::shared_ptr<const Executor> exec, TArgs&&... create_args)
1617 std::forward<TArgs>(create_args)...);
1641template <
typename Matrix,
typename... TArgs>
1644 std::initializer_list<std::initializer_list<typename Matrix::value_type>>
1646 std::shared_ptr<const Executor> exec, TArgs&&... create_args)
1650 size_type num_cols = num_rows > 0 ? begin(vals)->size() : 1;
1652 dense::create(exec->get_master(),
dim<2>{num_rows, num_cols}, stride);
1654 for (
const auto& row : vals) {
1656 for (
const auto& elem : row) {
1657 tmp->at(ridx, cidx) = elem;
1662 auto mtx = Matrix::create(exec, std::forward<TArgs>(create_args)...);
1689template <
typename Matrix,
typename... TArgs>
1691 std::initializer_list<std::initializer_list<typename Matrix::value_type>>
1693 std::shared_ptr<const Executor> exec, TArgs&&... create_args)
1697 std::forward<TArgs>(create_args)...);
ConvertibleTo interface is used to mark that the implementer can be converted to the object of Result...
Definition polymorphic_object.hpp:479
The EnableAbsoluteComputation mixin provides the default implementations of compute_absolute_linop an...
Definition lin_op.hpp:794
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition lin_op.hpp:879
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:668
The first step in using the Ginkgo library consists of creating an executor.
Definition executor.hpp:615
Definition lin_op.hpp:117
LinOp(const LinOp &)=default
Copy-constructs a LinOp.
const dim< 2 > & get_size() const noexcept
Returns the size of the operator.
Definition lin_op.hpp:210
Linear operators which support permutation should implement the Permutable interface.
Definition lin_op.hpp:484
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition polymorphic_object.hpp:243
A LinOp implementing this interface can read its data from a matrix_data structure.
Definition lin_op.hpp:605
Adds the operation M <- a I + b M for matrix M, identity operator I and scalars a and b,...
Definition lin_op.hpp:818
Linear operators which support transposition should implement the Transposable interface.
Definition lin_op.hpp:433
A LinOp implementing this interface can write its data to a matrix_data structure.
Definition lin_op.hpp:660
An array is a container which encapsulates fixed-sized arrays, stored on the Executor tied to the arr...
Definition array.hpp:166
This type is a device-side equivalent to matrix_data.
Definition device_matrix_data.hpp:36
Vector is a format which explicitly stores (multiple) distributed column vectors in a dense storage f...
Definition vector.hpp:77
COO stores a matrix in the coordinate matrix format.
Definition coo.hpp:65
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition csr.hpp:126
Dense is a matrix format which explicitly stores all values of the matrix.
Definition dense.hpp:120
std::unique_ptr< Dense > scale_permute(ptr_param< const ScaledPermutation< value_type, int64 > > row_permutation, ptr_param< const ScaledPermutation< value_type, int64 > > column_permutation, bool invert=false) const
value_type & at(size_type row, size_type col) noexcept
Returns a single element of the matrix.
Definition dense.hpp:901
void compute_norm1(ptr_param< LinOp > result) const
Computes the column-wise (L^1) norm of this matrix.
void compute_absolute(ptr_param< absolute_type > output) const
Writes the absolute values of this matrix into an existing matrix.
void compute_norm2(ptr_param< LinOp > result, array< char > &tmp) const
Computes the column-wise Euclidean (L^2) norm of this matrix.
std::unique_ptr< LinOp > row_permute(const array< int64 > *permutation_indices) const override
Returns a LinOp representing the row permutation of the Permutable object.
static std::unique_ptr< Dense > create_with_config_of(ptr_param< const Dense > other)
Creates a Dense matrix with the same size and stride as another Dense matrix.
Definition dense.hpp:196
std::unique_ptr< Dense > permute(ptr_param< const Permutation< int64 > > row_permutation, ptr_param< const Permutation< int64 > > column_permutation, bool invert=false) const
Dense & operator=(const Dense &)
Copy-assigns a Dense matrix.
void get_imag(ptr_param< real_type > result) const
Extracts the imaginary part of the original matrix into a given real matrix.
void row_permute(const array< int32 > *permutation_indices, ptr_param< Dense > output) const
Writes the row-permuted matrix into the given output matrix.
void get_real(ptr_param< real_type > result) const
Extracts the real part of the original matrix into a given real matrix.
std::unique_ptr< LinOp > column_permute(const array< int64 > *permutation_indices) const override
Returns a LinOp representing the column permutation of the Permutable object.
static std::unique_ptr< Dense > create_with_type_of(ptr_param< const Dense > other, std::shared_ptr< const Executor > exec, const dim< 2 > &size, const dim< 2 > &local_size, size_type stride)
Definition dense.hpp:251
void compute_dot(ptr_param< const LinOp > b, ptr_param< LinOp > result) const
Computes the column-wise dot product of this matrix and b.
void sub_scaled(ptr_param< const LinOp > alpha, ptr_param< const LinOp > b)
Subtracts b scaled by alpha from the matrix (aka: BLAS axpy).
std::unique_ptr< Dense > permute(ptr_param< const Permutation< int64 > > permutation, permute_mode mode=permute_mode::symmetric) const
std::unique_ptr< LinOp > permute(const array< int64 > *permutation_indices) const override
Returns a LinOp representing the symmetric row and column permutation of the Permutable object.
ValueType at(size_type idx) const noexcept
Returns a single element of the matrix.
Definition dense.hpp:936
std::unique_ptr< Dense > row_gather(const array< int64 > *gather_indices) const
Create a Dense matrix consisting of the given rows from this matrix.
std::unique_ptr< LinOp > inverse_permute(const array< int64 > *permutation_indices) const override
Returns a LinOp representing the symmetric inverse row and column permutation of the Permutable objec...
std::unique_ptr< Dense > permute(ptr_param< const Permutation< int32 > > row_permutation, ptr_param< const Permutation< int32 > > column_permutation, bool invert=false) const
Creates a non-symmetrically permuted copy of this matrix with the given row and column permutations...
void row_gather(const array< int32 > *gather_indices, ptr_param< LinOp > row_collection) const
Copies the given rows from this matrix into row_collection
void column_permute(const array< int32 > *permutation_indices, ptr_param< Dense > output) const
Writes the column-permuted matrix into the given output matrix.
std::unique_ptr< LinOp > inverse_row_permute(const array< int32 > *permutation_indices) const override
Returns a LinOp representing the row permutation of the inverse permuted object.
Dense(const Dense &)
Copy-constructs a Dense matrix.
std::unique_ptr< Dense > permute(ptr_param< const Permutation< int32 > > permutation, permute_mode mode=permute_mode::symmetric) const
Creates a permuted copy of this matrix with the given permutation .
void inverse_permute(const array< int64 > *permutation_indices, ptr_param< Dense > output) const
void compute_squared_norm2(ptr_param< LinOp > result, array< char > &tmp) const
Computes the square of the column-wise Euclidean (L^2) norm of this matrix.
static std::unique_ptr< Dense > create_with_type_of(ptr_param< const Dense > other, std::shared_ptr< const Executor > exec, const dim< 2 > &size=dim< 2 >{})
Creates a Dense matrix with the same type as another Dense matrix but on a different executor and wit...
Definition dense.hpp:217
void permute(const array< int64 > *permutation_indices, ptr_param< Dense > output) const
void scale(ptr_param< const LinOp > alpha)
Scales the matrix with a scalar (aka: BLAS scal).
std::unique_ptr< LinOp > inverse_column_permute(const array< int32 > *permutation_indices) const override
Returns a LinOp representing the row permutation of the inverse permuted object.
void conj_transpose(ptr_param< Dense > output) const
Writes the conjugate-transposed matrix into the given output matrix.
std::unique_ptr< Dense > create_submatrix(const span &rows, const span &columns)
Create a submatrix from the original matrix.
Definition dense.hpp:1145
void row_permute(const array< int64 > *permutation_indices, ptr_param< Dense > output) const
std::unique_ptr< LinOp > permute(const array< int32 > *permutation_indices) const override
Returns a LinOp representing the symmetric row and column permutation of the Permutable object.
std::unique_ptr< Dense > create_submatrix(const span &rows, const span &columns, const size_type stride)
Create a submatrix from the original matrix.
Definition dense.hpp:1132
void compute_squared_norm2(ptr_param< LinOp > result) const
Computes the square of the column-wise Euclidean (L^2) norm of this matrix.
std::unique_ptr< LinOp > row_permute(const array< int32 > *permutation_indices) const override
Returns a LinOp representing the row permutation of the Permutable object.
void permute(ptr_param< const Permutation< int64 > > permutation, ptr_param< Dense > output, permute_mode mode) const
void inverse_permute(const array< int32 > *permutation_indices, ptr_param< Dense > output) const
Writes the inverse symmetrically permuted matrix into the given output matrix.
std::unique_ptr< Dense > row_gather(const array< int32 > *gather_indices) const
Create a Dense matrix consisting of the given rows from this matrix.
void extract_diagonal(ptr_param< Diagonal< ValueType > > output) const
Writes the diagonal of this matrix into an existing diagonal matrix.
void make_complex(ptr_param< complex_type > result) const
Writes a complex copy of the original matrix to a given complex matrix.
std::unique_ptr< absolute_type > compute_absolute() const override
Gets the AbsoluteLinOp.
void scale_permute(ptr_param< const ScaledPermutation< value_type, int32 > > row_permutation, ptr_param< const ScaledPermutation< value_type, int32 > > column_permutation, ptr_param< Dense > output, bool invert=false) const
Overload of scale_permute(ptr_param<const ScaledPermutation<value_type,int32>>, ptr_param<const Scale...
void permute(ptr_param< const Permutation< int32 > > permutation, ptr_param< Dense > output, permute_mode mode) const
Overload of permute(ptr_param<const Permutation<int32>>, permute_mode) that writes the permuted copy ...
void row_gather(ptr_param< const LinOp > alpha, const array< int32 > *gather_indices, ptr_param< const LinOp > beta, ptr_param< LinOp > row_collection) const
Copies the given rows from this matrix into row_collection with scaling.
const value_type * get_const_values() const noexcept
Returns a pointer to the array of values of the matrix.
Definition dense.hpp:869
size_type get_num_stored_elements() const noexcept
Returns the number of elements explicitly stored in the matrix.
Definition dense.hpp:886
void compute_mean(ptr_param< LinOp > result, array< char > &tmp) const
Computes the column-wise arithmetic mean of this matrix.
ValueType & at(size_type idx) noexcept
Returns a single element of the matrix.
Definition dense.hpp:928
std::unique_ptr< Dense > scale_permute(ptr_param< const ScaledPermutation< value_type, int32 > > row_permutation, ptr_param< const ScaledPermutation< value_type, int32 > > column_permutation, bool invert=false) const
Creates a scaled and permuted copy of this matrix.
void scale_permute(ptr_param< const ScaledPermutation< value_type, int64 > > row_permutation, ptr_param< const ScaledPermutation< value_type, int64 > > column_permutation, ptr_param< Dense > output, bool invert=false) const
void compute_conj_dot(ptr_param< const LinOp > b, ptr_param< LinOp > result, array< char > &tmp) const
Computes the column-wise dot product of conj(this matrix) and b.
void compute_mean(ptr_param< LinOp > result) const
Computes the column-wise arithmetic mean of this matrix.
static std::unique_ptr< Dense > create(std::shared_ptr< const Executor > exec, const dim< 2 > &size, array< value_type > values, size_type stride)
Creates a Dense matrix from an already allocated (and initialized) array.
size_type get_stride() const noexcept
Returns the stride of the matrix.
Definition dense.hpp:879
std::unique_ptr< LinOp > inverse_permute(const array< int32 > *permutation_indices) const override
Returns a LinOp representing the symmetric inverse row and column permutation of the Permutable objec...
void permute(const array< int32 > *permutation_indices, ptr_param< Dense > output) const
Writes the symmetrically permuted matrix into the given output matrix.
void scale_permute(ptr_param< const ScaledPermutation< value_type, int64 > > permutation, ptr_param< Dense > output, permute_mode mode) const
void inverse_row_permute(const array< int32 > *permutation_indices, ptr_param< Dense > output) const
Writes the inverse row-permuted matrix into the given output matrix.
void inverse_column_permute(const array< int32 > *permutation_indices, ptr_param< Dense > output) const
Writes the inverse column-permuted matrix into the given output matrix.
void add_scaled(ptr_param< const LinOp > alpha, ptr_param< const LinOp > b)
Adds b scaled by alpha to the matrix (aka: BLAS axpy).
std::unique_ptr< LinOp > inverse_column_permute(const array< int64 > *permutation_indices) const override
Returns a LinOp representing the row permutation of the inverse permuted object.
static std::unique_ptr< Dense > create_view_of(ptr_param< Dense > other)
Creates a Dense matrix, where the underlying array is a view of another Dense matrix' array.
Definition dense.hpp:267
void permute(ptr_param< const Permutation< int32 > > row_permutation, ptr_param< const Permutation< int32 > > column_permutation, ptr_param< Dense > output, bool invert=false) const
Overload of permute(ptr_param<const Permutation<int32>>, ptr_param<constPermutation<int32>>,...
void compute_norm1(ptr_param< LinOp > result, array< char > &tmp) const
Computes the column-wise (L^1) norm of this matrix.
std::unique_ptr< LinOp > inverse_row_permute(const array< int64 > *permutation_indices) const override
Returns a LinOp representing the row permutation of the inverse permuted object.
std::unique_ptr< Dense > scale_permute(ptr_param< const ScaledPermutation< value_type, int32 > > permutation, permute_mode mode=permute_mode::symmetric) const
Creates a scaled and permuted copy of this matrix.
void transpose(ptr_param< Dense > output) const
Writes the transposed matrix into the given output matrix.
void compute_conj_dot(ptr_param< const LinOp > b, ptr_param< LinOp > result) const
Computes the column-wise dot product of conj(this matrix) and b.
std::unique_ptr< real_type > get_real() const
Creates a new real matrix and extracts the real part of the original matrix into that.
std::unique_ptr< Dense > scale_permute(ptr_param< const ScaledPermutation< value_type, int64 > > permutation, permute_mode mode=permute_mode::symmetric) const
static std::unique_ptr< const Dense > create_const_view_of(ptr_param< const Dense > other)
Creates a immutable Dense matrix, where the underlying array is a view of another Dense matrix' array...
Definition dense.hpp:279
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
std::unique_ptr< LinOp > column_permute(const array< int32 > *permutation_indices) const override
Returns a LinOp representing the column permutation of the Permutable object.
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
void scale_permute(ptr_param< const ScaledPermutation< value_type, int32 > > permutation, ptr_param< Dense > output, permute_mode mode) const
Overload of scale_permute(ptr_param<const ScaledPermutation<value_type,int32>>, permute_mode) that wr...
void compute_absolute_inplace() override
Compute absolute inplace on each element.
std::unique_ptr< complex_type > make_complex() const
Creates a complex copy of the original matrix.
std::unique_ptr< const real_type > create_real_view() const
Create a real view of the (potentially) complex original matrix.
void column_permute(const array< int64 > *permutation_indices, ptr_param< Dense > output) const
Dense(Dense &&)
Move-constructs a Dense matrix.
void inverse_row_permute(const array< int64 > *permutation_indices, ptr_param< Dense > output) const
value_type at(size_type row, size_type col) const noexcept
Returns a single element of the matrix.
Definition dense.hpp:909
static std::unique_ptr< Dense > create(std::shared_ptr< const Executor > exec, const dim< 2 > &size={}, size_type stride=0)
Creates an uninitialized Dense matrix of the specified size.
static std::unique_ptr< const Dense > create_const(std::shared_ptr< const Executor > exec, const dim< 2 > &size, gko::detail::const_array_view< ValueType > &&values, size_type stride)
Creates a constant (immutable) Dense matrix from a constant array.
void permute(ptr_param< const Permutation< int64 > > row_permutation, ptr_param< const Permutation< int64 > > column_permutation, ptr_param< Dense > output, bool invert=false) const
void inv_scale(ptr_param< const LinOp > alpha)
Scales the matrix with the inverse of a scalar.
Dense & operator=(Dense &&)
Move-assigns a Dense matrix.
value_type * get_values() noexcept
Returns a pointer to the array of values of the matrix.
Definition dense.hpp:860
void inverse_column_permute(const array< int64 > *permutation_indices, ptr_param< Dense > output) const
void compute_norm2(ptr_param< LinOp > result) const
Computes the column-wise Euclidean (L^2) norm of this matrix.
void row_gather(const array< int64 > *gather_indices, ptr_param< LinOp > row_collection) const
std::unique_ptr< real_type > get_imag() const
Creates a new real matrix and extracts the imaginary part of the original matrix into that.
static std::unique_ptr< Dense > create_with_type_of(ptr_param< const Dense > other, std::shared_ptr< const Executor > exec, const dim< 2 > &size, size_type stride)
Definition dense.hpp:233
std::unique_ptr< real_type > create_real_view()
Create a real view of the (potentially) complex original matrix.
std::unique_ptr< Diagonal< ValueType > > extract_diagonal() const override
Extracts the diagonal entries of the matrix into a vector.
void fill(const ValueType value)
Fill the dense matrix with a given value.
void compute_dot(ptr_param< const LinOp > b, ptr_param< LinOp > result, array< char > &tmp) const
Computes the column-wise dot product of this matrix and b.
void row_gather(ptr_param< const LinOp > alpha, const array< int64 > *gather_indices, ptr_param< const LinOp > beta, ptr_param< LinOp > row_collection) const
This class is a utility which efficiently implements the diagonal matrix (a linear operator which sca...
Definition diagonal.hpp:56
ELL is a matrix format where stride with explicit zeros is used such that all rows have the same numb...
Definition ell.hpp:66
Fixed-block compressed sparse row storage matrix format.
Definition fbcsr.hpp:116
HYBRID is a matrix format which splits the matrix into ELLPACK and COO format.
Definition hybrid.hpp:57
Permutation is a matrix format that represents a permutation matrix, i.e.
Definition permutation.hpp:112
ScaledPermutation is a matrix combining a permutation with scaling factors.
Definition scaled_permutation.hpp:38
SELL-P is a matrix format similar to ELL format.
Definition sellp.hpp:58
SparsityCsr is a matrix format which stores only the sparsity pattern of a sparse matrix by compressi...
Definition sparsity_csr.hpp:56
This class is used for function parameters in the place of raw pointers.
Definition utils_helper.hpp:41
A range is a multidimensional view of the memory.
Definition range.hpp:297
std::unique_ptr< Matrix > initialize(size_type stride, std::initializer_list< typename Matrix::value_type > vals, std::shared_ptr< const Executor > exec, TArgs &&... create_args)
Creates and initializes a column-vector.
Definition dense.hpp:1574
The distributed namespace.
Definition polymorphic_object.hpp:19
The matrix namespace.
Definition dense_cache.hpp:24
permute_mode
Specifies how a permutation will be applied to a matrix.
Definition permutation.hpp:42
@ columns
The columns will be permuted.
Definition permutation.hpp:48
@ rows
The rows will be permuted.
Definition permutation.hpp:46
@ symmetric
The rows and columns will be permuted.
Definition permutation.hpp:53
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:264
std::int32_t int32
32-bit signed integral type.
Definition types.hpp:107
std::unique_ptr< const matrix::Dense< typename detail::pointee< VecPtr >::value_type > > make_const_dense_view(VecPtr &&vector)
Creates a view of a given Dense vector.
Definition dense.hpp:1546
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
detail::const_array_view< ValueType > make_const_array_view(std::shared_ptr< const Executor > exec, size_type size, const ValueType *data)
Helper function to create a const array view deducing the value type.
Definition array.hpp:820
std::unique_ptr< matrix::Dense< typename detail::pointee< VecPtr >::value_type > > make_dense_view(VecPtr &&vector)
Creates a view of a given Dense vector.
Definition dense.hpp:1529
array< ValueType > make_array_view(std::shared_ptr< const Executor > exec, size_type size, ValueType *data)
Helper function to create an array view deducing the value type.
Definition array.hpp:801
void write(StreamType &&os, MatrixPtrType &&matrix, layout_type layout=detail::mtx_io_traits< std::remove_cv_t< detail::pointee< MatrixPtrType > > >::default_layout)
Writes a matrix into an output stream in matrix market format.
Definition mtx_io.hpp:295
std::int64_t int64
64-bit signed integral type.
Definition types.hpp:113
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:90
detail::cloned_type< Pointer > clone(const Pointer &p)
Creates a unique clone of the object pointed to by p.
Definition utils_helper.hpp:173
std::unique_ptr< MatrixType > read(StreamType &&is, MatrixArgs &&... args)
Reads a matrix stored in matrix market format from an input stream.
Definition mtx_io.hpp:159
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
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
A type representing the dimensions of a multidimensional object.
Definition dim.hpp:26
This structure is used as an intermediate data type to store a sparse matrix.
Definition matrix_data.hpp:126
A span is a lightweight structure used to create sub-ranges from other ranges.
Definition range.hpp:46