5#ifndef GKO_PUBLIC_CORE_MATRIX_PERMUTATION_HPP_
6#define GKO_PUBLIC_CORE_MATRIX_PERMUTATION_HPP_
14#include <ginkgo/core/base/array.hpp>
15#include <ginkgo/core/base/exception.hpp>
16#include <ginkgo/core/base/exception_helpers.hpp>
17#include <ginkgo/core/base/executor.hpp>
18#include <ginkgo/core/base/lin_op.hpp>
19#include <ginkgo/core/base/types.hpp>
20#include <ginkgo/core/base/utils.hpp>
92static constexpr mask_type row_permute = mask_type{1};
93GKO_DEPRECATED(
"permute mask is no longer supported")
94static constexpr mask_type column_permute = mask_type{1 << 2};
95GKO_DEPRECATED(
"permute mask is no longer supported")
96static constexpr mask_type inverse_permute = mask_type{1 << 3};
110template <
typename IndexType =
int32>
118 using index_type = IndexType;
136 return permutation_.get_const_data();
146 GKO_DEPRECATED(
"use get_size()[0] instead")
149 GKO_DEPRECATED(
"permute mask is no longer supported")
150 mask_type get_permute_mask() const;
152 GKO_DEPRECATED(
"permute mask is no longer supported")
153 void set_permute_mask(mask_type permute_mask);
175 ptr_param<const Permutation> other) const;
177 void write(
gko::
matrix_data<value_type, index_type>& data) const override;
206 array<IndexType> permutation_indices);
209 "dim<2> is no longer supported as a dimension parameter, use size_type "
211 static
std::unique_ptr<Permutation>
create(
214 GKO_DEPRECATED(
"permute mask is no longer supported")
215 static
std::unique_ptr<Permutation>
create(
217 const mask_type& enabled_permute);
219 GKO_DEPRECATED(
"use the overload without dimensions")
220 static
std::unique_ptr<Permutation>
create(
222 array<IndexType> permutation_indices);
224 GKO_DEPRECATED(
"permute mask is no longer supported")
225 static
std::unique_ptr<Permutation>
create(
227 array<index_type> permutation_indices,
228 const mask_type& enabled_permute);
241 GKO_DEPRECATED(
"use create_const without size and permute mask")
244 gko::detail::const_array_view<IndexType>&& perm_idxs,
245 mask_type enabled_permute = row_permute);
259 gko::detail::const_array_view<IndexType>&& perm_idxs);
265 array<IndexType> permutation_indices);
267 void apply_impl(const
LinOp* in,
LinOp* out) const override;
270 LinOp* out) const override;
273 array<index_type> permutation_;
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
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
static std::unique_ptr< Permutation > create(std::shared_ptr< const Executor > exec, size_type size=0)
size_type get_permutation_size() const noexcept
std::unique_ptr< Permutation > compose(ptr_param< const Permutation > other) const
index_type * get_permutation() noexcept
Returns a pointer to the array of permutation.
Definition permutation.hpp:125
static std::unique_ptr< const Permutation > create_const(std::shared_ptr< const Executor > exec, size_type size, gko::detail::const_array_view< index_type > &&perm_idxs, mask_type enabled_permute=row_permute)
const index_type * get_const_permutation() const noexcept
Returns a pointer to the array of permutation.
Definition permutation.hpp:134
std::unique_ptr< Permutation > compute_inverse() const
This class is used for function parameters in the place of raw pointers.
Definition utils_helper.hpp:41
The matrix namespace.
Definition dense_cache.hpp:24
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:42
@ none
Neither rows nor columns will be permuted.
Definition permutation.hpp:44
@ columns
The columns will be permuted.
Definition permutation.hpp:48
@ inverse
The permutation will be inverted before being applied.
Definition permutation.hpp:55
@ inverse_columns
The columns will be permuted using the inverse permutation.
Definition permutation.hpp:65
@ inverse_symmetric
The rows and columns will be permuted using the inverse permutation.
Definition permutation.hpp:70
@ rows
The rows will be permuted.
Definition permutation.hpp:46
@ inverse_rows
The rows will be permuted using the inverse permutation.
Definition permutation.hpp:60
@ symmetric
The rows and columns will be permuted.
Definition permutation.hpp:53
The Ginkgo namespace.
Definition abstract_factory.hpp:20
std::uint64_t uint64
64-bit unsigned integral type.
Definition types.hpp:136
double default_precision
Precision used if no precision is explicitly specified.
Definition types.hpp:172
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:90
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