Aleph-w 3.0
A C++ Library for Data Structures and Algorithms
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
Aleph::FFT< Real >::OverlapAdd Class Reference

Reusable overlap-add convolver for long real sequences. More...

#include <fft.H>

Collaboration diagram for Aleph::FFT< Real >::OverlapAdd:
[legend]

Public Member Functions

 OverlapAdd (const Array< Real > &kernel, const size_t block_size=0)
 
size_t block_size () const noexcept
 
size_t fft_size () const noexcept
 
const Array< Real > & kernel () const noexcept
 
size_t overlap_size () const noexcept
 
void reset ()
 
Array< Real > convolve (const Array< Real > &signal) const
 
Array< Real > pconvolve (ThreadPool &pool, const Array< Real > &signal, const size_t chunk_size=0) const
 
Array< Real > process_block (const Array< Real > &block)
 
Array< Real > pprocess_block (ThreadPool &pool, const Array< Real > &block, const size_t chunk_size=0)
 
Array< Real > flush ()
 
template<typename Container >
requires Is_Real_Container<Container>
Array< Real > convolve (const Container &signal) const
 
template<typename Container >
requires Is_Real_Container<Container>
Array< Real > pconvolve (ThreadPool &pool, const Container &signal, const size_t chunk_size=0) const
 
template<typename Container >
requires Is_Real_Container<Container>
Array< Real > process_block (const Container &block)
 
template<typename Container >
requires Is_Real_Container<Container>
Array< Real > pprocess_block (ThreadPool &pool, const Container &block, const size_t chunk_size=0)
 

Private Member Functions

Array< Complex > build_signal_block (const Array< Real > &signal, const size_t offset, const size_t length) const
 Rationale: Prepares a chunk of signal for FFT by zero-padding it to the internal fft_size().
 
void pointwise_multiply (Array< Complex > &spectrum, ThreadPool *pool, const size_t chunk_size) const
 Rationale: Applies the precomputed FIR kernel in the frequency domain via element-wise multiplication.
 
void clear_overlap ()
 Rationale: Resets the overlap buffer between independent convolution runs.
 
Array< Real > process_chunk_impl (const Array< Real > &block, ThreadPool *pool, const size_t chunk_size)
 Rationale: Implements the core Overlap-Add logic for a single block:
 
Array< Real > convolve_impl (const Array< Real > &signal, ThreadPool *pool, const size_t chunk_size) const
 implementation of one-shot linear convolution.
 

Static Private Member Functions

static size_t default_block_size (const size_t kernel_size)
 

Private Attributes

Array< Real > kernel_
 
size_t block_size_ = 0
 
size_t fft_size_ = 0
 
Plan plan_
 
Array< Complex > kernel_spectrum_
 
Array< Real > overlap_
 
bool has_pending_tail_ = false
 

Detailed Description

template<std::floating_point Real = double>
class Aleph::FFT< Real >::OverlapAdd

Reusable overlap-add convolver for long real sequences.

The kernel spectrum is precomputed once. Input signals are processed in blocks of size block_size(), each block transformed with an FFT of size fft_size() and accumulated in the output via overlap-add.

Definition at line 13741 of file fft.H.

Constructor & Destructor Documentation

◆ OverlapAdd()

template<std::floating_point Real = double>
Aleph::FFT< Real >::OverlapAdd::OverlapAdd ( const Array< Real > &  kernel,
const size_t  block_size = 0 
)
inlineexplicit

Definition at line 13905 of file fft.H.

References ah_invalid_argument_if, Aleph::FFT< Real >::OverlapAdd::block_size(), Aleph::FFT< Real >::OverlapAdd::block_size_, Aleph::FFT< Real >::OverlapAdd::clear_overlap(), Aleph::Array< T >::create(), Aleph::FFT< Real >::OverlapAdd::default_block_size(), Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::OverlapAdd::fft_size_, Aleph::Array< T >::is_empty(), Aleph::FFT< Real >::OverlapAdd::kernel_, Aleph::FFT< Real >::OverlapAdd::kernel_spectrum_, Aleph::FFT< Real >::next_power_of_two(), Aleph::FFT< Real >::OverlapAdd::overlap_, Aleph::FFT< Real >::OverlapAdd::plan_, Aleph::Array< T >::size(), and Aleph::FFT< Real >::Plan::transform().

Member Function Documentation

◆ block_size()

template<std::floating_point Real = double>
size_t Aleph::FFT< Real >::OverlapAdd::block_size ( ) const
inlinenoexcept

Definition at line 13936 of file fft.H.

References Aleph::FFT< Real >::OverlapAdd::block_size_.

Referenced by Aleph::FFT< Real >::OverlapAdd::OverlapAdd().

◆ build_signal_block()

template<std::floating_point Real = double>
Array< Complex > Aleph::FFT< Real >::OverlapAdd::build_signal_block ( const Array< Real > &  signal,
const size_t  offset,
const size_t  length 
) const
inlineprivate

Rationale: Prepares a chunk of signal for FFT by zero-padding it to the internal fft_size().

Definition at line 13763 of file fft.H.

References Aleph::Array< T >::create(), Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::OverlapAdd::fft_size_, and offset.

Referenced by Aleph::FFT< Real >::OverlapAdd::convolve_impl(), and Aleph::FFT< Real >::OverlapAdd::process_chunk_impl().

◆ clear_overlap()

template<std::floating_point Real = double>
void Aleph::FFT< Real >::OverlapAdd::clear_overlap ( )
inlineprivate

Rationale: Resets the overlap buffer between independent convolution runs.

Definition at line 13799 of file fft.H.

References Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::OverlapAdd::has_pending_tail_, Aleph::FFT< Real >::OverlapAdd::overlap_, and Aleph::Array< T >::size().

Referenced by Aleph::FFT< Real >::OverlapAdd::OverlapAdd(), Aleph::FFT< Real >::OverlapAdd::flush(), and Aleph::FFT< Real >::OverlapAdd::reset().

◆ convolve() [1/2]

template<std::floating_point Real = double>
Array< Real > Aleph::FFT< Real >::OverlapAdd::convolve ( const Array< Real > &  signal) const
inline

Definition at line 13947 of file fft.H.

References Aleph::FFT< Real >::OverlapAdd::convolve_impl().

Referenced by Aleph::FFT< Real >::OverlapAdd::convolve(), and Aleph::FFT< Real >::overlap_add_convolution().

◆ convolve() [2/2]

template<std::floating_point Real = double>
template<typename Container >
requires Is_Real_Container<Container>
Array< Real > Aleph::FFT< Real >::OverlapAdd::convolve ( const Container &  signal) const
inline

Definition at line 14025 of file fft.H.

References Aleph::FFT< Real >::build_real_input(), and Aleph::FFT< Real >::OverlapAdd::convolve().

◆ convolve_impl()

template<std::floating_point Real = double>
Array< Real > Aleph::FFT< Real >::OverlapAdd::convolve_impl ( const Array< Real > &  signal,
ThreadPool *  pool,
const size_t  chunk_size 
) const
inlineprivate

implementation of one-shot linear convolution.

Definition at line 13864 of file fft.H.

References ah_invalid_argument_if, Aleph::FFT< Real >::OverlapAdd::block_size_, Aleph::FFT< Real >::OverlapAdd::build_signal_block(), Aleph::Array< T >::create(), Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::Plan::inverse_transform_real(), Aleph::Array< T >::is_empty(), Aleph::FFT< Real >::OverlapAdd::kernel_, offset, output, Aleph::FFT< Real >::Plan::pinverse_transform_real(), Aleph::FFT< Real >::OverlapAdd::plan_, Aleph::FFT< Real >::OverlapAdd::pointwise_multiply(), Aleph::FFT< Real >::Plan::ptransform(), Aleph::Array< T >::size(), Aleph::FFT< Real >::spectrum(), and Aleph::FFT< Real >::Plan::transform().

Referenced by Aleph::FFT< Real >::OverlapAdd::convolve(), and Aleph::FFT< Real >::OverlapAdd::pconvolve().

◆ default_block_size()

template<std::floating_point Real = double>
static size_t Aleph::FFT< Real >::OverlapAdd::default_block_size ( const size_t  kernel_size)
inlinestaticprivate

Definition at line 13752 of file fft.H.

References ah_invalid_argument_if, Aleph::divide_and_conquer_partition_dp(), and Aleph::FFT< Real >::next_power_of_two().

Referenced by Aleph::FFT< Real >::OverlapAdd::OverlapAdd().

◆ fft_size()

template<std::floating_point Real = double>
size_t Aleph::FFT< Real >::OverlapAdd::fft_size ( ) const
inlinenoexcept

Definition at line 13937 of file fft.H.

References Aleph::FFT< Real >::OverlapAdd::fft_size_.

◆ flush()

template<std::floating_point Real = double>
Array< Real > Aleph::FFT< Real >::OverlapAdd::flush ( )
inline

Definition at line 14009 of file fft.H.

References Aleph::FFT< Real >::OverlapAdd::clear_overlap(), Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::OverlapAdd::has_pending_tail_, Aleph::Array< T >::is_empty(), and Aleph::FFT< Real >::OverlapAdd::overlap_.

◆ kernel()

template<std::floating_point Real = double>
const Array< Real > & Aleph::FFT< Real >::OverlapAdd::kernel ( ) const
inlinenoexcept

Definition at line 13938 of file fft.H.

References Aleph::FFT< Real >::OverlapAdd::kernel_.

◆ overlap_size()

template<std::floating_point Real = double>
size_t Aleph::FFT< Real >::OverlapAdd::overlap_size ( ) const
inlinenoexcept

Definition at line 13939 of file fft.H.

References Aleph::FFT< Real >::OverlapAdd::overlap_, and Aleph::Array< T >::size().

◆ pconvolve() [1/2]

template<std::floating_point Real = double>
Array< Real > Aleph::FFT< Real >::OverlapAdd::pconvolve ( ThreadPool &  pool,
const Array< Real > &  signal,
const size_t  chunk_size = 0 
) const
inline

Definition at line 13953 of file fft.H.

References Aleph::FFT< Real >::OverlapAdd::convolve_impl().

Referenced by Aleph::FFT< Real >::OverlapAdd::pconvolve(), and Aleph::FFT< Real >::poverlap_add_convolution().

◆ pconvolve() [2/2]

template<std::floating_point Real = double>
template<typename Container >
requires Is_Real_Container<Container>
Array< Real > Aleph::FFT< Real >::OverlapAdd::pconvolve ( ThreadPool &  pool,
const Container &  signal,
const size_t  chunk_size = 0 
) const
inline

Definition at line 14033 of file fft.H.

References Aleph::FFT< Real >::build_real_input(), and Aleph::FFT< Real >::OverlapAdd::pconvolve().

◆ pointwise_multiply()

template<std::floating_point Real = double>
void Aleph::FFT< Real >::OverlapAdd::pointwise_multiply ( Array< Complex > &  spectrum,
ThreadPool *  pool,
const size_t  chunk_size 
) const
inlineprivate

Rationale: Applies the precomputed FIR kernel in the frequency domain via element-wise multiplication.

Definition at line 13781 of file fft.H.

References Aleph::and, Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::OverlapAdd::fft_size_, Aleph::FFT< Real >::OverlapAdd::kernel_spectrum_, Aleph::ThreadPool::num_threads(), Aleph::parallel_for_index(), and Aleph::FFT< Real >::spectrum().

Referenced by Aleph::FFT< Real >::OverlapAdd::convolve_impl(), and Aleph::FFT< Real >::OverlapAdd::process_chunk_impl().

◆ pprocess_block() [1/2]

template<std::floating_point Real = double>
Array< Real > Aleph::FFT< Real >::OverlapAdd::pprocess_block ( ThreadPool &  pool,
const Array< Real > &  block,
const size_t  chunk_size = 0 
)
inline

Definition at line 13984 of file fft.H.

References Aleph::Array< T >::append(), Aleph::FFT< Real >::OverlapAdd::block_size_, Aleph::divide_and_conquer_partition_dp(), Aleph::Array< T >::is_empty(), offset, Aleph::FFT< Real >::OverlapAdd::process_chunk_impl(), Aleph::Array< T >::reserve(), and Aleph::Array< T >::size().

Referenced by Aleph::FFT< Real >::OverlapAdd::pprocess_block().

◆ pprocess_block() [2/2]

template<std::floating_point Real = double>
template<typename Container >
requires Is_Real_Container<Container>
Array< Real > Aleph::FFT< Real >::OverlapAdd::pprocess_block ( ThreadPool &  pool,
const Container &  block,
const size_t  chunk_size = 0 
)
inline

Definition at line 14050 of file fft.H.

References Aleph::FFT< Real >::build_real_input(), and Aleph::FFT< Real >::OverlapAdd::pprocess_block().

◆ process_block() [1/2]

template<std::floating_point Real = double>
Array< Real > Aleph::FFT< Real >::OverlapAdd::process_block ( const Array< Real > &  block)
inline

Definition at line 13960 of file fft.H.

References Aleph::Array< T >::append(), Aleph::FFT< Real >::OverlapAdd::block_size_, Aleph::divide_and_conquer_partition_dp(), Aleph::Array< T >::is_empty(), offset, Aleph::FFT< Real >::OverlapAdd::process_chunk_impl(), Aleph::Array< T >::reserve(), and Aleph::Array< T >::size().

Referenced by Aleph::FFT< Real >::OverlapAdd::process_block().

◆ process_block() [2/2]

template<std::floating_point Real = double>
template<typename Container >
requires Is_Real_Container<Container>
Array< Real > Aleph::FFT< Real >::OverlapAdd::process_block ( const Container &  block)
inline

Definition at line 14042 of file fft.H.

References Aleph::FFT< Real >::build_real_input(), and Aleph::FFT< Real >::OverlapAdd::process_block().

◆ process_chunk_impl()

template<std::floating_point Real = double>
Array< Real > Aleph::FFT< Real >::OverlapAdd::process_chunk_impl ( const Array< Real > &  block,
ThreadPool *  pool,
const size_t  chunk_size 
)
inlineprivate

Rationale: Implements the core Overlap-Add logic for a single block:

  1. FFT of current signal block.
  2. Pointwise multiplication with kernel spectrum.
  3. Inverse FFT to time domain.
  4. Add previous overlap and emit result.
  5. Update overlap buffer with the new tail.

Definition at line 13814 of file fft.H.

References ah_invalid_argument_if, Aleph::FFT< Real >::OverlapAdd::block_size_, Aleph::FFT< Real >::OverlapAdd::build_signal_block(), Aleph::Array< T >::create(), Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::OverlapAdd::has_pending_tail_, Aleph::FFT< Real >::Plan::inverse_transform_real(), Aleph::Array< T >::is_empty(), Aleph::FFT< Real >::OverlapAdd::overlap_, Aleph::FFT< Real >::Plan::pinverse_transform_real(), Aleph::FFT< Real >::OverlapAdd::plan_, Aleph::FFT< Real >::OverlapAdd::pointwise_multiply(), Aleph::FFT< Real >::Plan::ptransform(), Aleph::Array< T >::size(), Aleph::FFT< Real >::spectrum(), and Aleph::FFT< Real >::Plan::transform().

Referenced by Aleph::FFT< Real >::OverlapAdd::pprocess_block(), and Aleph::FFT< Real >::OverlapAdd::process_block().

◆ reset()

template<std::floating_point Real = double>
void Aleph::FFT< Real >::OverlapAdd::reset ( )
inline

Definition at line 13941 of file fft.H.

References Aleph::FFT< Real >::OverlapAdd::clear_overlap().

Member Data Documentation

◆ block_size_

template<std::floating_point Real = double>
size_t Aleph::FFT< Real >::OverlapAdd::block_size_ = 0
private

Definition at line 13744 of file fft.H.

Referenced by Aleph::FFT< Real >::OverlapAdd::OverlapAdd(), Aleph::FFT< Real >::OverlapAdd::block_size(), Aleph::FFT< Real >::OverlapAdd::convolve_impl(), Aleph::FFT< Real >::OverlapAdd::pprocess_block(), Aleph::FFT< Real >::OverlapAdd::process_block(), and Aleph::FFT< Real >::OverlapAdd::process_chunk_impl().

◆ fft_size_

template<std::floating_point Real = double>
size_t Aleph::FFT< Real >::OverlapAdd::fft_size_ = 0
private

Definition at line 13745 of file fft.H.

Referenced by Aleph::FFT< Real >::OverlapAdd::OverlapAdd(), Aleph::FFT< Real >::OverlapAdd::build_signal_block(), Aleph::FFT< Real >::OverlapAdd::fft_size(), and Aleph::FFT< Real >::OverlapAdd::pointwise_multiply().

◆ has_pending_tail_

template<std::floating_point Real = double>
bool Aleph::FFT< Real >::OverlapAdd::has_pending_tail_ = false
private

Definition at line 13749 of file fft.H.

Referenced by Aleph::FFT< Real >::OverlapAdd::clear_overlap(), Aleph::FFT< Real >::OverlapAdd::flush(), and Aleph::FFT< Real >::OverlapAdd::process_chunk_impl().

◆ kernel_

template<std::floating_point Real = double>
Array<Real> Aleph::FFT< Real >::OverlapAdd::kernel_
private

Definition at line 13743 of file fft.H.

Referenced by Aleph::FFT< Real >::OverlapAdd::OverlapAdd(), Aleph::FFT< Real >::OverlapAdd::convolve_impl(), and Aleph::FFT< Real >::OverlapAdd::kernel().

◆ kernel_spectrum_

template<std::floating_point Real = double>
Array<Complex> Aleph::FFT< Real >::OverlapAdd::kernel_spectrum_
private

Definition at line 13747 of file fft.H.

Referenced by Aleph::FFT< Real >::OverlapAdd::OverlapAdd(), and Aleph::FFT< Real >::OverlapAdd::pointwise_multiply().

◆ overlap_

template<std::floating_point Real = double>
Array<Real> Aleph::FFT< Real >::OverlapAdd::overlap_
private

Definition at line 13748 of file fft.H.

Referenced by Aleph::FFT< Real >::OverlapAdd::OverlapAdd(), Aleph::FFT< Real >::OverlapAdd::clear_overlap(), Aleph::FFT< Real >::OverlapAdd::flush(), Aleph::FFT< Real >::OverlapAdd::overlap_size(), and Aleph::FFT< Real >::OverlapAdd::process_chunk_impl().

◆ plan_

template<std::floating_point Real = double>
Plan Aleph::FFT< Real >::OverlapAdd::plan_
private

Definition at line 13746 of file fft.H.

Referenced by Aleph::FFT< Real >::OverlapAdd::OverlapAdd(), Aleph::FFT< Real >::OverlapAdd::convolve_impl(), and Aleph::FFT< Real >::OverlapAdd::process_chunk_impl().

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