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 >::OverlapAddBank Class Reference

Multichannel overlap-add convolver with one shared kernel FFT. More...

#include <fft.H>

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

Public Member Functions

 OverlapAddBank (const size_t num_channels, const Array< Real > &kernel, const size_t block_size=0)
 
size_t num_channels () const noexcept
 
size_t block_size () const noexcept
 
size_t fft_size () const noexcept
 
size_t overlap_size () const noexcept
 
const Array< Real > & kernel () const noexcept
 
void reset ()
 
Array< Array< Real > > convolve (const Array< Array< Real > > &signals) const
 
Array< Array< Real > > pconvolve (ThreadPool &pool, const Array< Array< Real > > &signals, const size_t chunk_size=0) const
 
Array< Array< Real > > process_block (const Array< Array< Real > > &block)
 
Array< Array< Real > > pprocess_block (ThreadPool &pool, const Array< Array< Real > > &block, const size_t chunk_size=0)
 
Array< Array< Real > > flush ()
 
Array< Array< Real > > pflush (ThreadPool &pool, const size_t chunk_size=0)
 

Private Member Functions

void validate_channel_count (const size_t count, const char *ctx) const
 Rationale: Internal safety guard.
 
Array< Complex > build_signal_block (const Array< Real > &signal, const size_t offset=0, const size_t length=std::numeric_limits< size_t >::max()) const
 implementation helper for preparing a signal block for FFT.
 
Array< Array< Complex > > build_signal_batch (const Array< Array< Real > > &block) const
 implementation helper for preparing a batch of signal blocks.
 
Array< Array< Complex > > build_signal_batch (const Array< Array< Real > > &source, const Array< size_t > &channels, const Array< size_t > &lengths, const size_t offset=0) const
 implementation helper for preparing a subset of signal blocks.
 
void pointwise_multiply_batch (Array< Array< Complex > > &spectra, ThreadPool *pool, const size_t chunk_size) const
 Rationale: Parallel pointwise multiplication of multiple signal spectra with the shared kernel spectrum.
 
void clear_channel_overlap (const size_t channel)
 Rationale: Resets the overlap buffer for a single channel.
 
void clear_overlaps ()
 
Array< Array< Real > > process_chunk_batch_impl (const Array< Array< Real > > &block, ThreadPool *pool, const size_t chunk_size)
 
Array< Array< Real > > convolve_impl (const Array< Array< Real > > &signals, ThreadPool *pool, const size_t chunk_size) const
 

Static Private Member Functions

static size_t default_block_size (const size_t kernel_size)
 Rationale: Selects a block size that is at least as large as the kernel to ensure efficient FFT processing (defaults to power of two).
 
static size_t max_batch_length (const Array< Array< Real > > &signals) noexcept
 Returns the maximum signal length in a batch.
 
static Array< Real > slice_chunk (const Array< Real > &input, const size_t offset, const size_t length)
 Returns a contiguous slice of input.
 

Private Attributes

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

Detailed Description

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

Multichannel overlap-add convolver with one shared kernel FFT.

All channels reuse the same transform plan and kernel spectrum. This avoids recomputing the kernel FFT per channel and enables batched FFT execution when many channels share the same FIR kernel.

Definition at line 14063 of file fft.H.

Constructor & Destructor Documentation

◆ OverlapAddBank()

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

Definition at line 14341 of file fft.H.

References ah_invalid_argument_if, Aleph::Array< T >::append(), Aleph::FFT< Real >::OverlapAddBank::block_size(), Aleph::FFT< Real >::OverlapAddBank::block_size_, Aleph::FFT< Real >::OverlapAddBank::clear_overlaps(), Aleph::Array< T >::create(), Aleph::FFT< Real >::OverlapAddBank::default_block_size(), Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::OverlapAddBank::fft_size_, Aleph::FFT< Real >::OverlapAddBank::has_pending_tail_, Aleph::Array< T >::is_empty(), Aleph::FFT< Real >::OverlapAddBank::kernel_, Aleph::FFT< Real >::OverlapAddBank::kernel_spectrum_, Aleph::FFT< Real >::next_power_of_two(), Aleph::FFT< Real >::OverlapAddBank::num_channels(), Aleph::FFT< Real >::OverlapAddBank::overlaps_, Aleph::FFT< Real >::OverlapAddBank::plan_, Aleph::Array< T >::reserve(), 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 >::OverlapAddBank::block_size ( ) const
inlinenoexcept

Definition at line 14386 of file fft.H.

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

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

◆ build_signal_batch() [1/2]

template<std::floating_point Real = double>
Array< Array< Complex > > Aleph::FFT< Real >::OverlapAddBank::build_signal_batch ( const Array< Array< Real > > &  block) const
inlineprivate

implementation helper for preparing a batch of signal blocks.

Definition at line 14141 of file fft.H.

References Aleph::FFT< Real >::OverlapAddBank::build_signal_block(), and Aleph::divide_and_conquer_partition_dp().

Referenced by Aleph::FFT< Real >::OverlapAddBank::convolve_impl(), and Aleph::FFT< Real >::OverlapAddBank::process_chunk_batch_impl().

◆ build_signal_batch() [2/2]

template<std::floating_point Real = double>
Array< Array< Complex > > Aleph::FFT< Real >::OverlapAddBank::build_signal_batch ( const Array< Array< Real > > &  source,
const Array< size_t > &  channels,
const Array< size_t > &  lengths,
const size_t  offset = 0 
) const
inlineprivate

implementation helper for preparing a subset of signal blocks.

Definition at line 14151 of file fft.H.

References Aleph::FFT< Real >::OverlapAddBank::build_signal_block(), Aleph::divide_and_conquer_partition_dp(), and offset.

◆ build_signal_block()

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

implementation helper for preparing a signal block for FFT.

Definition at line 14118 of file fft.H.

References ah_invalid_argument_if, Aleph::FFT< Real >::OverlapAddBank::block_size_, Aleph::Array< T >::create(), Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::OverlapAddBank::fft_size_, offset, and Aleph::Array< T >::size().

Referenced by Aleph::FFT< Real >::OverlapAddBank::build_signal_batch(), and Aleph::FFT< Real >::OverlapAddBank::build_signal_batch().

◆ clear_channel_overlap()

template<std::floating_point Real = double>
void Aleph::FFT< Real >::OverlapAddBank::clear_channel_overlap ( const size_t  channel)
inlineprivate

Rationale: Resets the overlap buffer for a single channel.

Definition at line 14187 of file fft.H.

References Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::OverlapAddBank::has_pending_tail_, and Aleph::FFT< Real >::OverlapAddBank::overlaps_.

Referenced by Aleph::FFT< Real >::OverlapAddBank::clear_overlaps(), Aleph::FFT< Real >::OverlapAddBank::flush(), and Aleph::FFT< Real >::OverlapAddBank::pflush().

◆ clear_overlaps()

template<std::floating_point Real = double>
void Aleph::FFT< Real >::OverlapAddBank::clear_overlaps ( )
inlineprivate

Definition at line 14195 of file fft.H.

References Aleph::FFT< Real >::OverlapAddBank::clear_channel_overlap(), and Aleph::FFT< Real >::OverlapAddBank::overlaps_.

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

◆ convolve()

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

Definition at line 14397 of file fft.H.

References Aleph::FFT< Real >::OverlapAddBank::convolve_impl(), Aleph::divide_and_conquer_partition_dp(), and Aleph::FFT< Real >::OverlapAddBank::validate_channel_count().

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

◆ convolve_impl()

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

Definition at line 14270 of file fft.H.

References Aleph::FFT< Real >::OverlapAddBank::block_size_, Aleph::FFT< Real >::OverlapAddBank::build_signal_batch(), Aleph::Array< T >::create(), Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::OverlapAddBank::fft_size_, Aleph::FFT< Real >::Plan::inverse_transform_real_batch(), Aleph::FFT< Real >::OverlapAddBank::kernel_, Aleph::FFT< Real >::OverlapAddBank::max_batch_length(), offset, output, Aleph::FFT< Real >::Plan::pinverse_transform_real_batch(), Aleph::FFT< Real >::OverlapAddBank::plan_, Aleph::FFT< Real >::OverlapAddBank::pointwise_multiply_batch(), Aleph::FFT< Real >::Plan::ptransform_batch(), Aleph::Array< T >::reserve(), Aleph::FFT< Real >::should_parallelize_batch_work(), Aleph::Array< T >::size(), Aleph::size(), and Aleph::FFT< Real >::Plan::transform_batch().

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

◆ default_block_size()

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

Rationale: Selects a block size that is at least as large as the kernel to ensure efficient FFT processing (defaults to power of two).

Definition at line 14077 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 >::OverlapAddBank::OverlapAddBank().

◆ fft_size()

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

Definition at line 14387 of file fft.H.

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

◆ flush()

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

Definition at line 14485 of file fft.H.

References Aleph::and, Aleph::FFT< Real >::OverlapAddBank::clear_channel_overlap(), Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::OverlapAddBank::has_pending_tail_, and Aleph::FFT< Real >::OverlapAddBank::overlaps_.

◆ kernel()

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

Definition at line 14389 of file fft.H.

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

◆ max_batch_length()

template<std::floating_point Real = double>
static size_t Aleph::FFT< Real >::OverlapAddBank::max_batch_length ( const Array< Array< Real > > &  signals)
inlinestaticprivatenoexcept

Returns the maximum signal length in a batch.

Definition at line 14095 of file fft.H.

References Aleph::divide_and_conquer_partition_dp(), and Aleph::size().

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

◆ num_channels()

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

Definition at line 14381 of file fft.H.

References Aleph::FFT< Real >::OverlapAddBank::overlaps_.

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

◆ overlap_size()

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

Definition at line 14388 of file fft.H.

References Aleph::FFT< Real >::OverlapAddBank::kernel_, and Aleph::Array< T >::size().

◆ pconvolve()

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

Definition at line 14404 of file fft.H.

References Aleph::FFT< Real >::OverlapAddBank::convolve_impl(), Aleph::divide_and_conquer_partition_dp(), and Aleph::FFT< Real >::OverlapAddBank::validate_channel_count().

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

◆ pflush()

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

Definition at line 14498 of file fft.H.

References Aleph::and, Aleph::FFT< Real >::OverlapAddBank::clear_channel_overlap(), Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::OverlapAddBank::has_pending_tail_, Aleph::ThreadPool::num_threads(), Aleph::FFT< Real >::OverlapAddBank::overlaps_, and Aleph::parallel_for_index().

◆ pointwise_multiply_batch()

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

Rationale: Parallel pointwise multiplication of multiple signal spectra with the shared kernel spectrum.

Definition at line 14168 of file fft.H.

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

Referenced by Aleph::FFT< Real >::OverlapAddBank::convolve_impl(), and Aleph::FFT< Real >::OverlapAddBank::process_chunk_batch_impl().

◆ pprocess_block()

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

Definition at line 14448 of file fft.H.

References Aleph::FFT< Real >::OverlapAddBank::block_size_, Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::OverlapAddBank::max_batch_length(), offset, Aleph::FFT< Real >::OverlapAddBank::process_chunk_batch_impl(), Aleph::Array< T >::size(), Aleph::size(), Aleph::FFT< Real >::OverlapAddBank::slice_chunk(), and Aleph::FFT< Real >::OverlapAddBank::validate_channel_count().

◆ process_block()

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

Definition at line 14413 of file fft.H.

References Aleph::FFT< Real >::OverlapAddBank::block_size_, Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::OverlapAddBank::max_batch_length(), offset, Aleph::FFT< Real >::OverlapAddBank::process_chunk_batch_impl(), Aleph::Array< T >::size(), Aleph::size(), Aleph::FFT< Real >::OverlapAddBank::slice_chunk(), and Aleph::FFT< Real >::OverlapAddBank::validate_channel_count().

◆ process_chunk_batch_impl()

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

Definition at line 14202 of file fft.H.

References Aleph::FFT< Real >::OverlapAddBank::build_signal_batch(), Aleph::FFT< Real >::count_non_empty_real_batch(), Aleph::Array< T >::create(), Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::OverlapAddBank::fft_size_, Aleph::FFT< Real >::OverlapAddBank::has_pending_tail_, Aleph::FFT< Real >::Plan::inverse_transform_real_batch(), Aleph::FFT< Real >::OverlapAddBank::overlaps_, Aleph::FFT< Real >::Plan::pinverse_transform_real_batch(), Aleph::FFT< Real >::OverlapAddBank::plan_, Aleph::FFT< Real >::OverlapAddBank::pointwise_multiply_batch(), Aleph::FFT< Real >::Plan::ptransform_batch(), Aleph::Array< T >::reserve(), Aleph::FFT< Real >::should_parallelize_batch_work(), Aleph::size(), Aleph::FFT< Real >::Plan::transform_batch(), and Aleph::FFT< Real >::OverlapAddBank::validate_channel_count().

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

◆ reset()

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

Definition at line 14391 of file fft.H.

References Aleph::FFT< Real >::OverlapAddBank::clear_overlaps().

◆ slice_chunk()

template<std::floating_point Real = double>
static Array< Real > Aleph::FFT< Real >::OverlapAddBank::slice_chunk ( const Array< Real > &  input,
const size_t  offset,
const size_t  length 
)
inlinestaticprivate

Returns a contiguous slice of input.

Definition at line 14105 of file fft.H.

References Aleph::Array< T >::append(), Aleph::divide_and_conquer_partition_dp(), offset, and Aleph::Array< T >::reserve().

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

◆ validate_channel_count()

template<std::floating_point Real = double>
void Aleph::FFT< Real >::OverlapAddBank::validate_channel_count ( const size_t  count,
const char *  ctx 
) const
inlineprivate

Rationale: Internal safety guard.

Definition at line 14086 of file fft.H.

References ah_invalid_argument_if, Aleph::count(), and Aleph::FFT< Real >::OverlapAddBank::overlaps_.

Referenced by Aleph::FFT< Real >::OverlapAddBank::convolve(), Aleph::FFT< Real >::OverlapAddBank::pconvolve(), Aleph::FFT< Real >::OverlapAddBank::pprocess_block(), Aleph::FFT< Real >::OverlapAddBank::process_block(), and Aleph::FFT< Real >::OverlapAddBank::process_chunk_batch_impl().

Member Data Documentation

◆ block_size_

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

Definition at line 14066 of file fft.H.

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

◆ fft_size_

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

Definition at line 14067 of file fft.H.

Referenced by Aleph::FFT< Real >::OverlapAddBank::OverlapAddBank(), Aleph::FFT< Real >::OverlapAddBank::build_signal_block(), Aleph::FFT< Real >::OverlapAddBank::convolve_impl(), Aleph::FFT< Real >::OverlapAddBank::fft_size(), Aleph::FFT< Real >::OverlapAddBank::pointwise_multiply_batch(), and Aleph::FFT< Real >::OverlapAddBank::process_chunk_batch_impl().

◆ has_pending_tail_

template<std::floating_point Real = double>
Array<bool> Aleph::FFT< Real >::OverlapAddBank::has_pending_tail_
private

Definition at line 14071 of file fft.H.

Referenced by Aleph::FFT< Real >::OverlapAddBank::OverlapAddBank(), Aleph::FFT< Real >::OverlapAddBank::clear_channel_overlap(), Aleph::FFT< Real >::OverlapAddBank::flush(), Aleph::FFT< Real >::OverlapAddBank::pflush(), and Aleph::FFT< Real >::OverlapAddBank::process_chunk_batch_impl().

◆ kernel_

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

Definition at line 14065 of file fft.H.

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

◆ kernel_spectrum_

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

Definition at line 14069 of file fft.H.

Referenced by Aleph::FFT< Real >::OverlapAddBank::OverlapAddBank(), and Aleph::FFT< Real >::OverlapAddBank::pointwise_multiply_batch().

◆ overlaps_

template<std::floating_point Real = double>
Array<Array<Real> > Aleph::FFT< Real >::OverlapAddBank::overlaps_
private

Definition at line 14070 of file fft.H.

Referenced by Aleph::FFT< Real >::OverlapAddBank::OverlapAddBank(), Aleph::FFT< Real >::OverlapAddBank::clear_channel_overlap(), Aleph::FFT< Real >::OverlapAddBank::clear_overlaps(), Aleph::FFT< Real >::OverlapAddBank::flush(), Aleph::FFT< Real >::OverlapAddBank::num_channels(), Aleph::FFT< Real >::OverlapAddBank::pflush(), Aleph::FFT< Real >::OverlapAddBank::process_chunk_batch_impl(), and Aleph::FFT< Real >::OverlapAddBank::validate_channel_count().

◆ plan_

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

Definition at line 14068 of file fft.H.

Referenced by Aleph::FFT< Real >::OverlapAddBank::OverlapAddBank(), Aleph::FFT< Real >::OverlapAddBank::convolve_impl(), and Aleph::FFT< Real >::OverlapAddBank::process_chunk_batch_impl().

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