5#ifndef GKO_PUBLIC_CORE_MATRIX_PERMUTATION_HPP_
6#define GKO_PUBLIC_CORE_MATRIX_PERMUTATION_HPP_
15#include <ginkgo/core/base/array.hpp>
16#include <ginkgo/core/base/exception.hpp>
17#include <ginkgo/core/base/exception_helpers.hpp>
18#include <ginkgo/core/base/executor.hpp>
19#include <ginkgo/core/base/lin_op.hpp>
20#include <ginkgo/core/base/types.hpp>
21#include <ginkgo/core/base/utils.hpp>
93static constexpr mask_type row_permute = mask_type{1};
94GKO_DEPRECATED(
"permute mask is no longer supported")
95static constexpr mask_type column_permute = mask_type{1 << 2};
96GKO_DEPRECATED(
"permute mask is no longer supported")
97static constexpr mask_type inverse_permute = mask_type{1 << 3};
111template <
typename IndexType =
int32>
119 using index_type = IndexType;
147 GKO_DEPRECATED(
"use get_size()[0] instead")
150 GKO_DEPRECATED("permute mask is no longer supported")
151 mask_type get_permute_mask() const;
153 GKO_DEPRECATED("permute mask is no longer supported")
154 void set_permute_mask(mask_type permute_mask);
178 void write(
gko::
matrix_data<value_type, index_type>& data) const override;
206 std::shared_ptr<const
Executor> exec,
207 array<IndexType> permutation_indices);
210 "
dim<2> is no longer supported
as a dimension parameter, use
size_type "
213 std::shared_ptr<const
Executor> exec, const
dim<2>& size);
215 GKO_DEPRECATED("permute mask is no longer supported")
217 std::shared_ptr<const
Executor> exec, const
dim<2>& size,
218 const mask_type& enabled_permute);
220 GKO_DEPRECATED("use the overload without dimensions")
222 std::shared_ptr<const
Executor> exec, const
dim<2>& size,
223 array<IndexType> permutation_indices);
225 GKO_DEPRECATED("permute mask is no longer supported")
227 std::shared_ptr<const
Executor> exec, const
dim<2>& size,
228 array<index_type> permutation_indices,
229 const mask_type& enabled_permute);
242 GKO_DEPRECATED("use
create_const without size and permute mask")
245 gko::detail::const_array_view<IndexType>&& perm_idxs,
246 mask_type enabled_permute = row_permute);
259 std::shared_ptr<const
Executor> exec,
260 gko::detail::const_array_view<IndexType>&& perm_idxs);
266 array<IndexType> permutation_indices);
268 void apply_impl(const
LinOp* in,
LinOp* out) const override;
271 LinOp* out) const override;
274 array<index_type> permutation_;
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition lin_op.hpp:880
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:663
The first step in using the Ginkgo library consists of creating an executor.
Definition executor.hpp:616
Definition lin_op.hpp:118
A LinOp implementing this interface can write its data to a matrix_data structure.
Definition lin_op.hpp:661
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:674
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:683
Permutation is a matrix format that represents a permutation matrix, i.e.
Definition permutation.hpp:113
static std::unique_ptr< Permutation > create(std::shared_ptr< const Executor > exec, size_type size=0)
Creates an uninitialized Permutation arrays on the specified executor.
size_type get_permutation_size() const noexcept
Returns the number of elements explicitly stored in the permutation array.
std::unique_ptr< Permutation > compose(ptr_param< const Permutation > other) const
Composes this permutation with another permutation.
index_type * get_permutation() noexcept
Returns a pointer to the array of permutation.
Definition permutation.hpp:126
static std::unique_ptr< const Permutation > create_const(std::shared_ptr< const Executor > exec, size_type size, gko::detail::const_array_view< IndexType > &&perm_idxs, mask_type enabled_permute=row_permute)
Creates a constant (immutable) Permutation matrix from a constant array.
const index_type * get_const_permutation() const noexcept
Returns a pointer to the array of permutation.
Definition permutation.hpp:135
std::unique_ptr< Permutation > compute_inverse() const
Returns the inverse permutation.
This class is used for function parameters in the place of raw pointers.
Definition utils_helper.hpp:43
permute_mode operator|(permute_mode a, permute_mode b)
Combines two permutation modes.
permute_mode operator&(permute_mode a, permute_mode b)
Computes the intersection of two permutation modes.
permute_mode operator^(permute_mode a, permute_mode b)
Computes the symmetric difference of two permutation modes.
std::ostream & operator<<(std::ostream &stream, permute_mode mode)
Prints a permutation mode.
permute_mode
Specifies how a permutation will be applied to a matrix.
Definition permutation.hpp:43
@ none
Neither rows nor columns will be permuted.
@ columns
The columns will be permuted.
@ inverse
The permutation will be inverted before being applied.
@ inverse_columns
The columns will be permuted using the inverse permutation.
@ inverse_symmetric
The rows and columns will be permuted using the inverse permutation.
@ rows
The rows will be permuted.
@ inverse_rows
The rows will be permuted using the inverse permutation.
@ symmetric
The rows and columns will be permuted.
The Ginkgo namespace.
Definition abstract_factory.hpp:20
std::uint64_t uint64
64-bit unsigned integral type.
Definition types.hpp:132
double default_precision
Precision used if no precision is explicitly specified.
Definition types.hpp:171
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:86
std::decay_t< T > * as(U *obj)
Performs polymorphic type conversion.
Definition utils_helper.hpp:309
A type representing the dimensions of a multidimensional object.
Definition dim.hpp:27
This structure is used as an intermediate data type to store a sparse matrix.
Definition matrix_data.hpp:127