Skip to main content

TransferFunctionBlock

Struct TransferFunctionBlock 

Source
pub struct TransferFunctionBlock<const NUM_SIZE: usize, const DEN_SIZE: usize, F: Float, I>
where I: Default,
{ pub data: BlockData, /* private fields */ }
Expand description

Implements a transfer function H(z) = Y(z) / X(z) over the input signal.

The parameters for the block require an array of numerator and denominator coefficients used to compute the output of the block: y[n] = b[0] * x[n] + b[1] * x[n-1] + ... + b[n] * x[n-n] - a[1] * y[n-1] - a[2] * y[n-2] + ...

A transfer function that represents an decay of 1/2 each sample can be represented as: H(z) = Y(z) / X(z) = z / (z - 0.5)

The numerator would be [1] and the denominator would be [1, -0.5].

The numerator and denominator must have dimensions of at least 1 and the 0th value of the denominator will be skipped (but must still be present), as it represents the coefficient for y[n], the current output.

Fields§

§data: BlockData

Trait Implementations§

Source§

impl<const NUM_SIZE: usize, const DEN_SIZE: usize, F, I> Default for TransferFunctionBlock<NUM_SIZE, DEN_SIZE, F, I>
where F: Float, I: Pass + Default, BlockData: FromPass<I>,

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<const NUM_SIZE: usize, const DEN_SIZE: usize, const ROWS: usize, const COLS: usize> ProcessBlock for TransferFunctionBlock<NUM_SIZE, DEN_SIZE, f32, Matrix<ROWS, COLS, f32>>
where f32: Float, OldBlockData: FromPass<Matrix<ROWS, COLS, f32>>,

Source§

type Inputs = Matrix<ROWS, COLS, f32>

Source§

type Output = Matrix<ROWS, COLS, f32>

Source§

type Parameters = Parameters<f32, NUM_SIZE, DEN_SIZE>

Source§

fn process( &mut self, parameters: &Self::Parameters, _context: &dyn Context, input: PassBy<'_, Self::Inputs>, ) -> PassBy<'_, Self::Output>

Source§

impl<const NUM_SIZE: usize, const DEN_SIZE: usize> ProcessBlock for TransferFunctionBlock<NUM_SIZE, DEN_SIZE, f32, f32>

Source§

type Inputs = f32

Source§

type Output = f32

Source§

type Parameters = Parameters<f32, NUM_SIZE, DEN_SIZE>

Source§

fn process( &mut self, parameters: &Self::Parameters, _context: &dyn Context, input: PassBy<'_, Self::Inputs>, ) -> PassBy<'_, Self::Output>

Source§

impl<const NUM_SIZE: usize, const DEN_SIZE: usize, const ROWS: usize, const COLS: usize> ProcessBlock for TransferFunctionBlock<NUM_SIZE, DEN_SIZE, f64, Matrix<ROWS, COLS, f64>>
where f64: Float, OldBlockData: FromPass<Matrix<ROWS, COLS, f64>>,

Source§

type Inputs = Matrix<ROWS, COLS, f64>

Source§

type Output = Matrix<ROWS, COLS, f64>

Source§

type Parameters = Parameters<f64, NUM_SIZE, DEN_SIZE>

Source§

fn process( &mut self, parameters: &Self::Parameters, _context: &dyn Context, input: PassBy<'_, Self::Inputs>, ) -> PassBy<'_, Self::Output>

Source§

impl<const NUM_SIZE: usize, const DEN_SIZE: usize> ProcessBlock for TransferFunctionBlock<NUM_SIZE, DEN_SIZE, f64, f64>

Source§

type Inputs = f64

Source§

type Output = f64

Source§

type Parameters = Parameters<f64, NUM_SIZE, DEN_SIZE>

Source§

fn process( &mut self, parameters: &Self::Parameters, _context: &dyn Context, input: PassBy<'_, Self::Inputs>, ) -> PassBy<'_, Self::Output>

Auto Trait Implementations§

§

impl<const NUM_SIZE: usize, const DEN_SIZE: usize, F, I> Freeze for TransferFunctionBlock<NUM_SIZE, DEN_SIZE, F, I>
where I: Freeze,

§

impl<const NUM_SIZE: usize, const DEN_SIZE: usize, F, I> RefUnwindSafe for TransferFunctionBlock<NUM_SIZE, DEN_SIZE, F, I>

§

impl<const NUM_SIZE: usize, const DEN_SIZE: usize, F, I> Send for TransferFunctionBlock<NUM_SIZE, DEN_SIZE, F, I>
where I: Send,

§

impl<const NUM_SIZE: usize, const DEN_SIZE: usize, F, I> Sync for TransferFunctionBlock<NUM_SIZE, DEN_SIZE, F, I>
where I: Sync,

§

impl<const NUM_SIZE: usize, const DEN_SIZE: usize, F, I> Unpin for TransferFunctionBlock<NUM_SIZE, DEN_SIZE, F, I>
where I: Unpin, F: Unpin,

§

impl<const NUM_SIZE: usize, const DEN_SIZE: usize, F, I> UnsafeUnpin for TransferFunctionBlock<NUM_SIZE, DEN_SIZE, F, I>
where I: UnsafeUnpin,

§

impl<const NUM_SIZE: usize, const DEN_SIZE: usize, F, I> UnwindSafe for TransferFunctionBlock<NUM_SIZE, DEN_SIZE, F, I>
where I: UnwindSafe, F: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.