5#ifndef GKO_PUBLIC_CORE_PRECONDITIONER_JACOBI_HPP_
6#define GKO_PUBLIC_CORE_PRECONDITIONER_JACOBI_HPP_
9#include <ginkgo/core/base/array.hpp>
10#include <ginkgo/core/base/lin_op.hpp>
11#include <ginkgo/core/config/config.hpp>
12#include <ginkgo/core/config/registry.hpp>
13#include <ginkgo/core/matrix/csr.hpp>
14#include <ginkgo/core/matrix/dense.hpp>
15#include <ginkgo/core/matrix/diagonal.hpp>
36template <
typename IndexType>
37struct block_interleaved_storage_scheme {
38 block_interleaved_storage_scheme() =
default;
125 GKO_ATTRIBUTES IndexType
186template <
typename ValueType = default_precision,
typename IndexType =
int32>
199 using value_type = ValueType;
200 using index_type = IndexType;
225 return storage_scheme_;
241 return blocks_.get_const_data();
255 return conditioning_.get_const_data();
265 return blocks_.get_size();
272 void write(mat_data& data)
const override;
377 struct storage_optimization_type {
379 : is_block_wise{false}, of_all_blocks{p}
382 storage_optimization_type(
384 : is_block_wise{block_wise_opt.
get_size() > 0},
385 block_wise{block_wise_opt}
388 storage_optimization_type(
390 : is_block_wise{block_wise_opt.get_size() > 0},
391 block_wise{
std::move(block_wise_opt)}
397 precision_reduction of_all_blocks;
523 config::make_type_descriptor<ValueType, IndexType>());
531 explicit Jacobi(std::shared_ptr<const Executor> exec)
537 parameters_.block_pointers.set_executor(exec);
538 parameters_.storage_optimization.block_wise.set_executor(exec);
548 explicit Jacobi(
const Factory* factory,
549 std::shared_ptr<const LinOp> system_matrix)
552 parameters_{factory->get_parameters()},
553 storage_scheme_{this->compute_storage_scheme(
554 parameters_.max_block_size, parameters_.max_block_stride)},
555 num_blocks_{parameters_.block_pointers.
get_size() - 1},
557 storage_scheme_.compute_storage_space(
558 parameters_.block_pointers.
get_size() - 1)),
564 this->generate(system_matrix.get(), parameters_.
skip_sorting);
575 block_interleaved_storage_scheme<index_type> compute_storage_scheme(
578 uint32 default_block_stride = 32;
580 if (
auto hip_exec = std::dynamic_pointer_cast<const gko::HipExecutor>(
582 default_block_stride = hip_exec->get_warp_size();
584 uint32 max_block_stride = default_block_stride;
585 if (param_max_block_stride != 0) {
588 max_block_stride = param_max_block_stride;
590 max_block_stride != default_block_stride) {
592 GKO_NOT_SUPPORTED(
this);
595 if (parameters_.max_block_size > max_block_stride ||
596 parameters_.max_block_size < 1) {
597 GKO_NOT_SUPPORTED(
this);
599 const auto group_size =
static_cast<uint32>(
601 const auto block_offset = max_block_size;
602 const auto block_stride = group_size * block_offset;
603 const auto group_offset = max_block_size * block_stride;
604 return {
static_cast<index_type
>(block_offset),
605 static_cast<index_type
>(group_offset),
618 void generate(
const LinOp* system_matrix,
bool skip_sorting);
627 void detect_blocks(
const matrix::Csr<ValueType, IndexType>* system_matrix);
629 void apply_impl(
const LinOp* b,
LinOp* x)
const override;
632 LinOp* x)
const override;
635 block_interleaved_storage_scheme<index_type> storage_scheme_{};
637 array<value_type> blocks_;
ConvertibleTo interface is used to mark that the implementer can be converted to the object of Result...
Definition polymorphic_object.hpp:470
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:662
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
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition polymorphic_object.hpp:234
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
void set_executor(std::shared_ptr< const Executor > exec)
Changes the Executor of the array, moving the allocated data to the new Executor.
Definition array.hpp:700
pnode describes a tree of properties.
Definition property_tree.hpp:28
This class stores additional context for creating Ginkgo objects from configuration files.
Definition registry.hpp:167
This class describes the value and index types to be used when building a Ginkgo type from a configur...
Definition type_descriptor.hpp:39
Dense is a matrix format which explicitly stores all values of the matrix.
Definition dense.hpp:117
This class is used to encode storage precisions of low precision algorithms.
Definition types.hpp:238
Definition jacobi.hpp:501
A block-Jacobi preconditioner is a block-diagonal linear operator, obtained by inverting the diagonal...
Definition jacobi.hpp:190
const block_interleaved_storage_scheme< index_type > & get_storage_scheme() const noexcept
Returns the storage scheme used for storing Jacobi blocks.
Definition jacobi.hpp:222
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
Jacobi(const Jacobi &other)
Copy-constructs a Jacobi preconditioner.
const remove_complex< value_type > * get_conditioning() const noexcept
Returns an array of 1-norm condition numbers of the blocks.
Definition jacobi.hpp:253
Jacobi(Jacobi &&other)
Move-assigns a Jacobi preconditioner.
static parameters_type parse(const config::pnode &config, const config::registry &context, const config::type_descriptor &td_for_child=config::make_type_descriptor< ValueType, IndexType >())
Create the parameters from the property_tree.
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
const value_type * get_blocks() const noexcept
Returns the pointer to the memory used for storing the block data.
Definition jacobi.hpp:239
Jacobi & operator=(Jacobi &&other)
Move-assigns a Jacobi preconditioner.
Jacobi & operator=(const Jacobi &other)
Copy-assigns a Jacobi preconditioner.
size_type get_num_stored_elements() const noexcept
Returns the number of elements explicitly stored in the matrix.
Definition jacobi.hpp:263
size_type get_num_blocks() const noexcept
Returns the number of blocks of the operator.
Definition jacobi.hpp:212
#define GKO_CREATE_FACTORY_PARAMETERS(_parameters_name, _factory_name)
This Macro will generate a new type containing the parameters for the factory _factory_name.
Definition abstract_factory.hpp:280
#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)
Creates a scalar factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:445
#define GKO_ENABLE_BUILD_METHOD(_factory_name)
Defines a build method for the factory, simplifying its construction by removing the repetitive typin...
Definition abstract_factory.hpp:394
#define GKO_ENABLE_LIN_OP_FACTORY(_lin_op, _parameters_name, _factory_name)
This macro will generate a default implementation of a LinOpFactory for the LinOp subclass it is defi...
Definition lin_op.hpp:1017
#define GKO_FACTORY_PARAMETER_VECTOR(_name,...)
Creates a vector factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:461
The Preconditioner namespace.
Definition gauss_seidel.hpp:19
The Ginkgo namespace.
Definition abstract_factory.hpp:20
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:630
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
constexpr uint32 get_significant_bit(const T &n, uint32 hint=0u) noexcept
Returns the position of the most significant bit of the number.
Definition math.hpp:1009
std::uint32_t uint32
32-bit unsigned integral type.
Definition types.hpp:129
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
constexpr int64 ceildiv(int64 num, int64 den)
Performs integer division with rounding up.
Definition math.hpp:590
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:89
batch_dim< 2, DimensionType > transpose(const batch_dim< 2, DimensionType > &input)
Returns a batch_dim object with its dimensions swapped for batched operators.
Definition batch_dim.hpp:119
constexpr T get_superior_power(const T &base, const T &limit, const T &hint=T{1}) noexcept
Returns the smallest power of base not smaller than limit.
Definition math.hpp:1027
@ array
The matrix should be written as dense matrix in column-major order.
Definition mtx_io.hpp:96
This structure is used as an intermediate data type to store a sparse matrix.
Definition matrix_data.hpp:126
uint32 max_block_stride
Stride between two columns of a block (as number of elements).
Definition jacobi.hpp:325
storage_optimization_type storage_optimization
The precisions to use for the blocks of the matrix.
Definition jacobi.hpp:470
uint32 max_block_size
Maximal size of diagonal blocks.
Definition jacobi.hpp:314
remove_complex< value_type > accuracy
The relative accuracy of the adaptive Jacobi variant.
Definition jacobi.hpp:499
gko::array< index_type > block_pointers
Starting (row / column) indexes of individual blocks.
Definition jacobi.hpp:372
bool skip_sorting
true means it is known that the matrix given to this factory will be sorted first by row,...
Definition jacobi.hpp:344
Defines the parameters of the interleaved block storage scheme used by block-Jacobi blocks.
Definition jacobi.hpp:37
IndexType get_block_offset(IndexType block_id) const noexcept
Returns the offset of the block with the given ID within its group.
Definition jacobi.hpp:113
IndexType get_group_offset(IndexType block_id) const noexcept
Returns the offset of the group belonging to the block with the given ID.
Definition jacobi.hpp:101
uint32 group_power
Then base 2 power of the group.
Definition jacobi.hpp:62
IndexType get_stride() const noexcept
Returns the stride between columns of the block.
Definition jacobi.hpp:137
IndexType group_offset
The offset between two block groups.
Definition jacobi.hpp:55
IndexType get_global_block_offset(IndexType block_id) const noexcept
Returns the offset of the block with the given ID.
Definition jacobi.hpp:126
IndexType block_offset
The offset between consecutive blocks within the group.
Definition jacobi.hpp:50
size_type compute_storage_space(size_type num_blocks) const noexcept
Computes the storage space required for the requested number of blocks.
Definition jacobi.hpp:87
IndexType get_group_size() const noexcept
Returns the number of elements in the group.
Definition jacobi.hpp:69