33#ifndef GKO_PUBLIC_CORE_MATRIX_DIAGONAL_HPP_
34#define GKO_PUBLIC_CORE_MATRIX_DIAGONAL_HPP_
37#include <ginkgo/core/base/array.hpp>
38#include <ginkgo/core/base/lin_op.hpp>
45template <
typename ValueType,
typename IndexType>
48template <
typename ValueType>
67template <
typename ValueType = default_precision>
96 using value_type = ValueType;
97 using index_type =
int64;
154 GKO_ASSERT_REVERSE_CONFORMANT(
this, b);
155 GKO_ASSERT_EQUAL_ROWS(b, x);
156 GKO_ASSERT_EQUAL_COLS(
this, x);
158 this->rapply_impl(b.
get(), x.
get());
172 GKO_ASSERT_CONFORMANT(
this, b);
173 GKO_ASSERT_EQUAL_ROWS(b, x);
174 GKO_ASSERT_EQUAL_ROWS(
this, x);
176 this->inverse_apply_impl(b.
get(), x.
get());
179 void read(
const mat_data& data)
override;
181 void read(
const mat_data32& data)
override;
183 void read(
const device_mat_data& data)
override;
185 void read(
const device_mat_data32& data)
override;
187 void read(device_mat_data&& data)
override;
189 void read(device_mat_data32&& data)
override;
191 void write(mat_data& data)
const override;
193 void write(mat_data32& data)
const override;
206 std::shared_ptr<const Executor> exec,
size_type size,
207 gko::detail::const_array_view<ValueType>&& values)
211 return std::unique_ptr<const Diagonal>(
new Diagonal{
212 exec, size, gko::detail::array_const_cast(std::move(values))});
221 explicit Diagonal(std::shared_ptr<const Executor> exec)
231 Diagonal(std::shared_ptr<const Executor> exec,
size_type size)
249 template <
typename ValuesArray>
250 Diagonal(std::shared_ptr<const Executor> exec,
const size_type size,
252 : EnableLinOp<Diagonal>(exec, dim<2>(size)),
258 void apply_impl(
const LinOp* b, LinOp* x)
const override;
260 void apply_impl(
const LinOp* alpha,
const LinOp* b,
const LinOp* beta,
261 LinOp* x)
const override;
263 void rapply_impl(
const LinOp* b, LinOp* x)
const;
265 void inverse_apply_impl(
const LinOp* b, LinOp* x)
const;
268 array<value_type> values_;
ConvertibleTo interface is used to mark that the implementer can be converted to the object of Result...
Definition polymorphic_object.hpp:499
The EnableAbsoluteComputation mixin provides the default implementations of compute_absolute_linop an...
Definition lin_op.hpp:823
This mixin implements a static create() method on ConcreteType that dynamically allocates the memory,...
Definition polymorphic_object.hpp:776
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition lin_op.hpp:908
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:691
Definition lin_op.hpp:146
A LinOp implementing this interface can read its data from a matrix_data structure.
Definition lin_op.hpp:634
Linear operators which support transposition should implement the Transposable interface.
Definition lin_op.hpp:462
A LinOp implementing this interface can write its data to a matrix_data structure.
Definition lin_op.hpp:689
value_type * get_data() noexcept
Returns a pointer to the block of memory used to store the elements of the array.
Definition array.hpp:646
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:655
size_type get_num_elems() const noexcept
Returns the number of elements in the array.
Definition array.hpp:637
This type is a device-side equivalent to matrix_data.
Definition device_matrix_data.hpp:63
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition csr.hpp:146
This class is a utility which efficiently implements the diagonal matrix (a linear operator which sca...
Definition diagonal.hpp:79
static std::unique_ptr< const Diagonal > create_const(std::shared_ptr< const Executor > exec, size_type size, gko::detail::const_array_view< ValueType > &&values)
Creates a constant (immutable) Diagonal matrix from a constant array.
Definition diagonal.hpp:205
void rapply(ptr_param< const LinOp > b, ptr_param< LinOp > x) const
Applies the diagonal matrix from the right side to a matrix b, which means scales the columns of b wi...
Definition diagonal.hpp:152
void inverse_apply(ptr_param< const LinOp > b, ptr_param< LinOp > x) const
Applies the inverse of the diagonal matrix to a matrix b, which means scales the columns of b with th...
Definition diagonal.hpp:170
value_type * get_values() noexcept
Returns a pointer to the array of values of the matrix.
Definition diagonal.hpp:131
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
std::unique_ptr< absolute_type > compute_absolute() const override
Gets the AbsoluteLinOp.
const value_type * get_const_values() const noexcept
Returns a pointer to the array of values of the matrix.
Definition diagonal.hpp:140
void compute_absolute_inplace() override
Compute absolute inplace on each element.
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
This class is used for function parameters in the place of raw pointers.
Definition utils_helper.hpp:71
T * get() const
Definition utils_helper.hpp:105
The Ginkgo namespace.
Definition abstract_factory.hpp:48
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:803
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:354
std::int32_t int32
32-bit signed integral type.
Definition types.hpp:137
typename detail::next_precision_impl< T >::type next_precision
Obtains the next type in the singly-linked precision list.
Definition math.hpp:490
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:373
std::int64_t int64
64-bit signed integral type.
Definition types.hpp:143
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:120
A type representing the dimensions of a multidimensional object.
Definition dim.hpp:55
This structure is used as an intermediate data type to store a sparse matrix.
Definition matrix_data.hpp:155