Audio Processing Framework (APF)  version 0.3.0
Public Types | Public Member Functions | List of all members
apf::Cascade< S, Container > Class Template Reference

Cascade of filter sections. More...

#include <apf/biquad.h>

Public Types

using argument_type = typename S::argument_type
 
using result_type = typename S::result_type
 
using size_type = typename Container::size_type
 

Public Member Functions

 Cascade (size_type n)
 Constructor. More...
 
template<typename I >
void set (I first, I last)
 Overwrite sections with new content. More...
 
result_type operator() (argument_type in)
 Process all sections on single sample. More...
 
template<typename In , typename Out >
void execute (In first, In last, Out result)
 Process all sections on audio block. More...
 
size_type number_of_sections () const
 

Detailed Description

template<typename S, typename Container = std::vector<S>>
class apf::Cascade< S, Container >

Cascade of filter sections.

Template Parameters
Ssection type, e.g. BiQuad

Definition at line 185 of file biquad.h.

Constructor & Destructor Documentation

template<typename S , typename Container = std::vector<S>>
apf::Cascade< S, Container >::Cascade ( size_type  n)
inlineexplicit

Constructor.

Definition at line 193 of file biquad.h.

Member Function Documentation

template<typename S , typename Container = std::vector<S>>
template<typename I >
void apf::Cascade< S, Container >::set ( first,
last 
)
inline

Overwrite sections with new content.

Template Parameters
IIterator type for arguments
Parameters
firstBegin iterator
lastEnd iterator

Definition at line 200 of file biquad.h.

template<typename S , typename Container = std::vector<S>>
result_type apf::Cascade< S, Container >::operator() ( argument_type  in)
inline

Process all sections on single sample.

Parameters
inInput sample
Returns
Output sample

Definition at line 210 of file biquad.h.

template<typename S , typename Container = std::vector<S>>
template<typename In , typename Out >
void apf::Cascade< S, Container >::execute ( In  first,
In  last,
Out  result 
)
inline

Process all sections on audio block.

Template Parameters
InIterator type for input samples
OutIterator type for output samples
Parameters
firstIterator to first input sample
lastIterator to (one past) last input sample
resultIterator to first output sample

Definition at line 226 of file biquad.h.


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