This LinOp implements a 1D Fourier matrix using the FFT algorithm. More...
#include <ginkgo/core/matrix/fft.hpp>
Public Types | |
| using | value_type = std::complex<double> |
| using | index_type = int64 |
| using | transposed_type = Fft |
Public Types inherited from gko::EnablePolymorphicAssignment< Fft > | |
| using | result_type |
Public Types inherited from gko::ConvertibleTo< Fft > | |
| using | result_type |
Public Member Functions | |
| std::unique_ptr< LinOp > | transpose () const override |
| Returns a LinOp representing the transpose of the Transposable object. | |
| std::unique_ptr< LinOp > | conj_transpose () const override |
| Returns a LinOp representing the conjugate transpose of the Transposable object. | |
| 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< 1 > | get_fft_size () const |
| bool | is_inverse () const |
Public Member Functions inherited from gko::EnableLinOp< Fft > | |
| const Fft * | apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const |
| Fft * | apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) |
| const Fft * | apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) const |
| Fft * | 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< Fft, LinOp > | |
| std::unique_ptr< Fft > | create_default (std::shared_ptr< const Executor > exec) const |
| std::unique_ptr< Fft > | create_default () const |
| std::unique_ptr< Fft > | clone (std::shared_ptr< const Executor > exec) const |
| std::unique_ptr< Fft > | clone () const |
| Fft * | copy_from (const PolymorphicObject *other) |
| std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, Fft > * | copy_from (std::unique_ptr< Derived > &&other) |
| std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, Fft > * | copy_from (const std::unique_ptr< Derived > &other) |
| Fft * | copy_from (const std::shared_ptr< const PolymorphicObject > &other) |
| Fft * | move_from (ptr_param< PolymorphicObject > other) |
| Fft * | clear () |
Public Member Functions inherited from gko::LinOp | |
| LinOp * | apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) |
| Applies a linear operator to a vector (or a sequence of vectors). | |
| const LinOp * | apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const |
| LinOp * | apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) |
| Performs the operation x = alpha * op(b) + beta * x. | |
| const LinOp * | apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) const |
| const dim< 2 > & | get_size () const noexcept |
| Returns the size of the operator. | |
| virtual bool | apply_uses_initial_guess () const |
| Returns true if the linear operator uses the data given in x as an initial guess. | |
| LinOp & | operator= (const LinOp &)=default |
| Copy-assigns a LinOp. | |
| LinOp & | operator= (LinOp &&other) |
| Move-assigns a LinOp. | |
| LinOp (const LinOp &)=default | |
| Copy-constructs a LinOp. | |
| LinOp (LinOp &&other) | |
| Move-constructs a LinOp. | |
Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< LinOp > | |
| std::unique_ptr< LinOp > | create_default (std::shared_ptr< const Executor > exec) const |
| std::unique_ptr< LinOp > | create_default () const |
| std::unique_ptr< LinOp > | clone (std::shared_ptr< const Executor > exec) const |
| std::unique_ptr< LinOp > | clone () const |
| LinOp * | copy_from (const PolymorphicObject *other) |
| std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, LinOp > * | copy_from (std::unique_ptr< Derived > &&other) |
| std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, LinOp > * | copy_from (const std::unique_ptr< Derived > &other) |
| LinOp * | copy_from (const std::shared_ptr< const PolymorphicObject > &other) |
| LinOp * | move_from (ptr_param< PolymorphicObject > other) |
| LinOp * | 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 |
| Creates a new "default" object of the same dynamic type as this object. | |
| std::unique_ptr< PolymorphicObject > | create_default () const |
| Creates a new "default" object of the same dynamic type as this object. | |
| std::unique_ptr< PolymorphicObject > | clone (std::shared_ptr< const Executor > exec) const |
| Creates a clone of the object. | |
| std::unique_ptr< PolymorphicObject > | clone () const |
| Creates a clone of the object. | |
| PolymorphicObject * | copy_from (const PolymorphicObject *other) |
| Copies another object into this object. | |
| 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) |
| Moves another object into this object. | |
| 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) |
| Copies another object into this object. | |
| PolymorphicObject * | copy_from (const std::shared_ptr< const PolymorphicObject > &other) |
| Copies another object into this object. | |
| PolymorphicObject * | move_from (ptr_param< PolymorphicObject > other) |
| Moves another object into this object. | |
| PolymorphicObject * | clear () |
| Transforms the object into its default state. | |
| std::shared_ptr< const Executor > | get_executor () const noexcept |
| Returns the Executor of the object. | |
Public Member Functions inherited from gko::log::EnableLogging< PolymorphicObject > | |
| void | add_logger (std::shared_ptr< const Logger > logger) override |
| Adds a new logger to the list of subscribed loggers. | |
| void | remove_logger (const Logger *logger) override |
| Removes a logger from the list of subscribed loggers. | |
| void | remove_logger (ptr_param< const Logger > logger) |
| const std::vector< std::shared_ptr< const Logger > > & | get_loggers () const override |
| Returns the vector containing all loggers registered at this object. | |
| void | clear_loggers () override |
| Remove all loggers registered at this object. | |
Public Member Functions inherited from gko::log::Loggable | |
| void | remove_logger (ptr_param< const Logger > logger) |
Public Member Functions inherited from gko::EnablePolymorphicAssignment< Fft > | |
| void | convert_to (result_type *result) const override |
| void | move_to (result_type *result) override |
Public Member Functions inherited from gko::ConvertibleTo< Fft > | |
| 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< Fft > | create (std::shared_ptr< const Executor > exec) |
| Creates an empty Fourier matrix. | |
| static std::unique_ptr< Fft > | create (std::shared_ptr< const Executor > exec, size_type size=0, bool inverse=false) |
| Creates an Fourier matrix with the given dimensions. | |
Friends | |
| class | EnablePolymorphicObject< Fft, LinOp > |
This LinOp implements a 1D Fourier matrix using the FFT algorithm.
It implements forward and inverse DFT.
For a power-of-two size n with corresponding root of unity 

![\[ x_k = \sum_{j=0}^{n-1} \omega^{jk} b_j
\]](form_76.png)
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.
|
overridevirtual |
Returns a LinOp representing the conjugate transpose of the Transposable object.
Implements gko::Transposable.
|
static |
Creates an empty Fourier matrix.
| exec | Executor associated to the matrix |
|
static |
Creates an Fourier matrix with the given dimensions.
| size | size of the matrix |
| inverse | true to compute an inverse DFT instead of a normal DFT |
References gko::matrix::inverse.
|
overridevirtual |
Returns a LinOp representing the transpose of the Transposable object.
Implements gko::Transposable.