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

S	section type, e.g. BiQuad

Definition at line 185 of file biquad.h.

Member Typedef Documentation

argument_type

template<typename S , typename Container = std::vector<S>>

using apf::Cascade< S, Container >::argument_type = typename S::argument_type

Definition at line 188 of file biquad.h.

result_type

template<typename S , typename Container = std::vector<S>>

using apf::Cascade< S, Container >::result_type = typename S::result_type

Definition at line 189 of file biquad.h.

size_type

template<typename S , typename Container = std::vector<S>>

using apf::Cascade< S, Container >::size_type = typename Container::size_type

Definition at line 190 of file biquad.h.

Constructor & Destructor Documentation

Cascade()

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

set()

template<typename S , typename Container = std::vector<S>>

template<typename I >

void apf::Cascade< S, Container >::set ( I  first, I  last  )

inline

Overwrite sections with new content.

Template Parameters

I	Iterator type for arguments

Parameters

first	Begin iterator
last	End iterator

Definition at line 200 of file biquad.h.

operator()()

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

in	Input sample

Returns

Output sample

Definition at line 210 of file biquad.h.

Referenced by apf::Cascade< S, Container >::execute().

execute()

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

In	Iterator type for input samples
Out	Iterator type for output samples

Parameters

first	Iterator to first input sample
last	Iterator to (one past) last input sample
result	Iterator to first output sample

Definition at line 226 of file biquad.h.

References apf::Cascade< S, Container >::operator()().

number_of_sections()

template<typename S , typename Container = std::vector<S>>

size_type apf::Cascade< S, Container >::number_of_sections ( ) const

inline

Definition at line 237 of file biquad.h.

---

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

• apf/biquad.h