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

Stateful bank of SOS cascades, one per channel. More...

#include <fft.H>

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

Public Member Functions

 SOSFilterBank (const size_t num_channels, const Array< BiquadSection > &sections)
 
template<typename SectionsContainer >
requires Is_Biquad_Container<SectionsContainer>
 SOSFilterBank (const size_t num_channels, const SectionsContainer &sections)
 
size_t num_channels () const noexcept
 
SOSFilter & channel (const size_t index)
 
const SOSFilter & channel (const size_t index) const
 
void reset ()
 
Array< Real > filter_channel (const size_t index, const Array< Real > &signal)
 
template<typename Container >
requires Is_Real_Container<Container>
Array< Real > filter_channel (const size_t index, const Container &signal)
 
Array< Array< Real > > filter (const Array< Array< Real > > &signals)
 
Array< Array< Real > > pfilter (ThreadPool &pool, const Array< Array< Real > > &signals, 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.
 

Private Attributes

Array< SOSFilter > filters_
 

Detailed Description

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

Stateful bank of SOS cascades, one per channel.

Definition at line 11837 of file fft.H.

Constructor & Destructor Documentation

◆ SOSFilterBank() [1/2]

template<std::floating_point Real = double>
Aleph::FFT< Real >::SOSFilterBank::SOSFilterBank ( const size_t  num_channels,
const Array< BiquadSection > &  sections 
)
inlineexplicit

Definition at line 11851 of file fft.H.

References ah_invalid_argument_if, Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::SOSFilterBank::filters_, and Aleph::FFT< Real >::SOSFilterBank::num_channels().

◆ SOSFilterBank() [2/2]

template<std::floating_point Real = double>
template<typename SectionsContainer >
requires Is_Biquad_Container<SectionsContainer>
Aleph::FFT< Real >::SOSFilterBank::SOSFilterBank ( const size_t  num_channels,
const SectionsContainer &  sections 
)
inlineexplicit

Definition at line 11863 of file fft.H.

Member Function Documentation

◆ channel() [1/2]

template<std::floating_point Real = double>
SOSFilter & Aleph::FFT< Real >::SOSFilterBank::channel ( const size_t  index)
inline

Definition at line 11874 of file fft.H.

References ah_out_of_range_error_if, and Aleph::FFT< Real >::SOSFilterBank::filters_.

Referenced by Aleph::FFT< Real >::SOSFilterBank::filter_channel(), and Aleph::FFT< Real >::SOSFilterBank::filter_channel().

◆ channel() [2/2]

template<std::floating_point Real = double>
const SOSFilter & Aleph::FFT< Real >::SOSFilterBank::channel ( const size_t  index) const
inline

Definition at line 11883 of file fft.H.

References ah_out_of_range_error_if, and Aleph::FFT< Real >::SOSFilterBank::filters_.

◆ filter()

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

Definition at line 11914 of file fft.H.

References Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::SOSFilterBank::filters_, output, and Aleph::FFT< Real >::SOSFilterBank::validate_channel_count().

◆ filter_channel() [1/2]

template<std::floating_point Real = double>
Array< Real > Aleph::FFT< Real >::SOSFilterBank::filter_channel ( const size_t  index,
const Array< Real > &  signal 
)
inline

Definition at line 11898 of file fft.H.

References Aleph::FFT< Real >::SOSFilterBank::channel(), and Aleph::FFT< Real >::SOSFilter::filter().

◆ filter_channel() [2/2]

template<std::floating_point Real = double>
template<typename Container >
requires Is_Real_Container<Container>
Array< Real > Aleph::FFT< Real >::SOSFilterBank::filter_channel ( const size_t  index,
const Container &  signal 
)
inline

Definition at line 11907 of file fft.H.

References Aleph::FFT< Real >::SOSFilterBank::channel(), and Aleph::FFT< Real >::SOSFilter::filter().

◆ num_channels()

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

Definition at line 11868 of file fft.H.

References Aleph::FFT< Real >::SOSFilterBank::filters_.

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

◆ pfilter()

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

Definition at line 11924 of file fft.H.

References Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::SOSFilterBank::filters_, output, Aleph::parallel_for_index(), and Aleph::FFT< Real >::SOSFilterBank::validate_channel_count().

◆ reset()

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

Definition at line 11891 of file fft.H.

References Aleph::FFT< Real >::SOSFilterBank::filters_.

◆ validate_channel_count()

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

Rationale: Internal safety guard.

Definition at line 11843 of file fft.H.

References ah_invalid_argument_if, Aleph::count(), and Aleph::FFT< Real >::SOSFilterBank::filters_.

Referenced by Aleph::FFT< Real >::SOSFilterBank::filter(), and Aleph::FFT< Real >::SOSFilterBank::pfilter().

Member Data Documentation

◆ filters_

template<std::floating_point Real = double>
Array<SOSFilter> Aleph::FFT< Real >::SOSFilterBank::filters_
private

Definition at line 11839 of file fft.H.

Referenced by Aleph::FFT< Real >::SOSFilterBank::SOSFilterBank(), Aleph::FFT< Real >::SOSFilterBank::channel(), Aleph::FFT< Real >::SOSFilterBank::channel(), Aleph::FFT< Real >::SOSFilterBank::filter(), Aleph::FFT< Real >::SOSFilterBank::num_channels(), Aleph::FFT< Real >::SOSFilterBank::pfilter(), Aleph::FFT< Real >::SOSFilterBank::reset(), and Aleph::FFT< Real >::SOSFilterBank::validate_channel_count().

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