#include <ginkgo/core/matrix/fft.hpp>

Inheritance diagram for gko::matrix::Fft3:

Public Types
using	value_type = std::complex< double >

using	index_type = int64

using	transposed_type = Fft3

Public Types inherited from gko::EnablePolymorphicAssignment< ConcreteType, ResultType >
using	result_type = ResultType

Public Types inherited from gko::ConvertibleTo< ResultType >
using	result_type = ResultType

Public Member Functions
std::unique_ptr< LinOp >	transpose () const override

std::unique_ptr< LinOp >	conj_transpose () const override

void	write (matrix_data< std::complex< float >, int32 > &data) const override

void	write (matrix_data< std::complex< float >, int64 > &data) const override

void	write (matrix_data< std::complex< double >, int32 > &data) const override

void	write (matrix_data< std::complex< double >, int64 > &data) const override

dim< 3 >	get_fft_size () const

bool	is_inverse () const

Public Member Functions inherited from gko::EnableLinOp< Fft3 >
const Fft3 *	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const

Fft3 *	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x)

const Fft3 *	apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) const

Fft3 *	apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x)

Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< AbstractObject, PolymorphicBase >
std::unique_ptr< AbstractObject >	create_default (std::shared_ptr< const Executor > exec) const

std::unique_ptr< AbstractObject >	create_default () const

std::unique_ptr< AbstractObject >	clone (std::shared_ptr< const Executor > exec) const

std::unique_ptr< AbstractObject >	clone () const

AbstractObject *	copy_from (const PolymorphicObject *other)

template<typename Derived >
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, AbstractObject > *	copy_from (std::unique_ptr< Derived > &&other)

template<typename Derived >
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, AbstractObject > *	copy_from (const std::unique_ptr< Derived > &other)

AbstractObject *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)

AbstractObject *	move_from (ptr_param< PolymorphicObject > other)

AbstractObject *	clear ()

Public Member Functions inherited from gko::PolymorphicObject
PolymorphicObject &	operator= (const PolymorphicObject &)

std::unique_ptr< PolymorphicObject >	create_default (std::shared_ptr< const Executor > exec) const

std::unique_ptr< PolymorphicObject >	create_default () const

std::unique_ptr< PolymorphicObject >	clone (std::shared_ptr< const Executor > exec) const

std::unique_ptr< PolymorphicObject >	clone () const

PolymorphicObject *	copy_from (const PolymorphicObject *other)

template<typename Derived , typename Deleter >
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, PolymorphicObject > *	copy_from (std::unique_ptr< Derived, Deleter > &&other)

template<typename Derived , typename Deleter >
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, PolymorphicObject > *	copy_from (const std::unique_ptr< Derived, Deleter > &other)

PolymorphicObject *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)

PolymorphicObject *	move_from (ptr_param< PolymorphicObject > other)

PolymorphicObject *	clear ()

std::shared_ptr< const Executor >	get_executor () const noexcept

Public Member Functions inherited from gko::log::EnableLogging< PolymorphicObject >
void	add_logger (std::shared_ptr< const Logger > logger) override

void	remove_logger (const Logger *logger) override

void	remove_logger (ptr_param< const Logger > logger)

const std::vector< std::shared_ptr< const Logger > > &	get_loggers () const override

void	clear_loggers () override

Public Member Functions inherited from gko::log::Loggable
void	remove_logger (ptr_param< const Logger > logger)

Public Member Functions inherited from gko::EnablePolymorphicAssignment< ConcreteType, ResultType >
void	convert_to (result_type *result) const override

void	move_to (result_type *result) override

Public Member Functions inherited from gko::ConvertibleTo< ResultType >
void	convert_to (ptr_param< result_type > result) const

void	move_to (ptr_param< result_type > result)

Static Public Member Functions
static std::unique_ptr< Fft3 >	create (std::shared_ptr< const Executor > exec)

static std::unique_ptr< Fft3 >	create (std::shared_ptr< const Executor > exec, size_type size)

static std::unique_ptr< Fft3 >	create (std::shared_ptr< const Executor > exec, size_type size1, size_type size2, size_type size3, bool inverse=false)

Protected Member Functions
	Fft3 (std::shared_ptr< const Executor > exec, size_type size1=0, size_type size2=0, size_type size3=0, bool inverse=false)

void	apply_impl (const LinOp b, LinOp x) const override

void	apply_impl (const LinOp alpha, const LinOp b, const LinOp beta, LinOp x) const override

Protected Member Functions inherited from gko::EnableLinOp< Fft3 >
Fft3 *	self () noexcept

const Fft3 *	self () const noexcept

Protected Member Functions inherited from gko::EnablePolymorphicObject< ConcreteObject, PolymorphicBase >
std::unique_ptr< PolymorphicObject >	create_default_impl (std::shared_ptr< const Executor > exec) const override

PolymorphicObject *	copy_from_impl (const PolymorphicObject *other) override

PolymorphicObject *	copy_from_impl (std::unique_ptr< PolymorphicObject > other) override

PolymorphicObject *	move_from_impl (PolymorphicObject *other) override

PolymorphicObject *	move_from_impl (std::unique_ptr< PolymorphicObject > other) override

PolymorphicObject *	clear_impl () override

Protected Member Functions inherited from gko::PolymorphicObject
	PolymorphicObject (std::shared_ptr< const Executor > exec)

	PolymorphicObject (const PolymorphicObject &other)

Protected Member Functions inherited from gko::log::EnableLogging< PolymorphicObject >
void	log (Params &&... params) const

Friends
class	EnablePolymorphicObject< Fft3, LinOp >

Additional Inherited Members
Protected Attributes inherited from gko::log::EnableLogging< PolymorphicObject >
std::vector< std::shared_ptr< const Logger > >	loggers_

Detailed Description

This LinOp implements a 3D Fourier matrix using the FFT algorithm. For indexing purposes, the first dimension is the major axis.

It implements complex-to-complex forward and inverse FFT.

For a power-of-two sizes \(n_1, n_2, n_3\) with corresponding root of unity \(\omega = e^{-2\pi i / (n_1 n_2 n_3)}\) for forward DFT and \(\omega = e^{2 \pi i / (n_1 n_2 n_3)}\) for inverse DFT it computes

\[ x_{k_1 n_2 n_3 + k_2 n_3 + k_3} = \sum_{i_1=0}^{n_1-1} \sum_{i_2=0}^{n_2-1} \sum_{i_3=0}^{n_3-1} \omega^{i_1 k_1 + i_2 k_2 + i_3 k_3} b_{i_1 n_2 n_3 + i_2 n_3 + i_3} \]

without normalization factors.

The Reference and OpenMP implementations support only power-of-two input sizes, as they use the Radix-2 algorithm by J. W. Cooley and J. W. Tukey, "An Algorithm for the Machine Calculation of Complex Fourier Series," Mathematics of Computation, vol. 19, no. 90, pp. 297–301, 1965, doi: 10.2307/2003354. The CUDA and HIP implementations use cuSPARSE/hipSPARSE with full support for non-power-of-two input sizes and special optimizations for products of small prime powers.

Member Function Documentation

◆ conj_transpose()

std::unique_ptr< LinOp > gko::matrix::Fft3::conj_transpose ( ) const

overridevirtual

Returns a LinOp representing the conjugate transpose of the Transposable object.

Returns: a pointer to the new conjugate transposed object

Implements gko::Transposable.

◆ create() [1/3]

static std::unique_ptr< Fft3 > gko::matrix::Fft3::create ( std::shared_ptr< const Executor > exec )

static

Creates an empty Fourier matrix.

Parameters

exec	Executor associated to the matrix

Returns: A smart pointer to the newly created matrix.

◆ create() [2/3]

static std::unique_ptr< Fft3 > gko::matrix::Fft3::create	(	std::shared_ptr< const Executor >	exec,
		size_type	size
	)

static

Creates an Fourier matrix with the given dimensions.

Parameters

size	size of all FFT dimensions

Returns: A smart pointer to the newly created matrix.

◆ create() [3/3]

static std::unique_ptr< Fft3 > gko::matrix::Fft3::create	(	std::shared_ptr< const Executor >	exec,
		size_type	size1,
		size_type	size2,
		size_type	size3,
		bool	inverse = `false`
	)

static

Creates an Fourier matrix with the given dimensions.

Parameters

size1	size of the first FFT dimension
size2	size of the second FFT dimension
size3	size of the third FFT dimension
inverse	true to compute an inverse DFT instead of a normal DFT

Returns: A smart pointer to the newly created matrix.

◆ transpose()

std::unique_ptr< LinOp > gko::matrix::Fft3::transpose ( ) const

overridevirtual

Returns a LinOp representing the transpose of the Transposable object.

Returns: a pointer to the new transposed object

Implements gko::Transposable.

The documentation for this class was generated from the following file:

ginkgo/core/matrix/fft.hpp

Fft3 Class Reference

Fft3 Class Reference#

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ conj_transpose()

◆ create() [1/3]

◆ create() [2/3]

◆ create() [3/3]

◆ transpose()