Enum BiquadRepr

pub enum BiquadRepr<T, C>
where
    C: Coefficient,
    T: Float + FloatConst,
{
    Ba(Ba<T>),
    Raw(Biquad<C>),
    Pid(Pid<T>),
    Filter(FilterRepr<T>),
}

Representation of Biquad

miniconf::Tree can be used like this:

use miniconf::{Tree, str_leaf};
#[derive(Tree)]
struct Foo {
    #[tree(typ="&str", with=str_leaf, defer=self.repr)]
    typ: (),
    repr: idsp::iir::BiquadRepr<f32, f32>,
}

Variants

Ba(Ba<T>)

Normalized SI unit coefficients

Raw(Biquad<C>)

Raw, unscaled, possibly fixed point machine unit coefficients

Pid(Pid<T>)

A PID

Filter(FilterRepr<T>)

Standard biquad filters: Notch, Lowpass, Highpass, Shelf etc

Implementations

impl<T, C> BiquadRepr<T, C>

where C: Coefficient, T: Float + FloatConst,

pub fn from_repr(discriminant: usize) -> Option<BiquadRepr<T, C>>

Try to create Self from the raw representation

impl<T, C> BiquadRepr<T, C>

where C: Coefficient + AsPrimitive<C> + AsPrimitive<T>, T: AsPrimitive<C> + Float + FloatConst,

pub fn build<I>(&self, period: T, b_scale: T, y_scale: T) -> Biquad<C>

where T: AsPrimitive<I>, I: Float + AsPrimitive<C>, C: AsPrimitive<I>, f32: AsPrimitive<T>,

Build a biquad

Args:

• period: The sample period in desired units (e.g. SI seconds)
• b_scale: The feed forward (b coefficient) conversion scale from desired units to machine units. An identity (gain=1) filter a x input in machine units will lead to a y=b_scale*x filter output in machine units.
• y_scale: The y output scale from desired units to machine units. E.g. a max setting will lead to a y=y_scale*max upper limit of the filter in machine units.

Trait Implementations

impl<T, C> AsRef<str> for BiquadRepr<T, C>

where C: Coefficient, T: Float + FloatConst,

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl<T, C> Clone for BiquadRepr<T, C>

where C: Coefficient + Clone, T: Float + FloatConst + Clone,

fn clone(&self) -> BiquadRepr<T, C>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T, C> Debug for BiquadRepr<T, C>

where C: Coefficient + Debug, T: Float + FloatConst + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T, C> Default for BiquadRepr<T, C>

where C: Coefficient, T: Float + FloatConst,

fn default() -> Self

Returns the “default value” for a type.

impl<'_derivative_strum, T, C> From<&'_derivative_strum BiquadRepr<T, C>> for &'static str

where C: Coefficient, T: Float + FloatConst,

fn from(x: &'_derivative_strum BiquadRepr<T, C>) -> &'static str

Converts to this type from the input type.

impl<'_enum, T, C> From<&'_enum BiquadRepr<T, C>> for BiquadReprDiscriminants

where C: Coefficient, T: Float + FloatConst,

fn from(val: &'_enum BiquadRepr<T, C>) -> BiquadReprDiscriminants

Converts to this type from the input type.

impl<T, C> From<BiquadRepr<T, C>> for &'static str

where C: Coefficient, T: Float + FloatConst,

fn from(x: BiquadRepr<T, C>) -> &'static str

Converts to this type from the input type.

impl<T, C> From<BiquadRepr<T, C>> for BiquadReprDiscriminants

where C: Coefficient, T: Float + FloatConst,

fn from(val: BiquadRepr<T, C>) -> BiquadReprDiscriminants

Converts to this type from the input type.

impl<T, C> FromStr for BiquadRepr<T, C>

where C: Coefficient, T: Float + FloatConst,

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<BiquadRepr<T, C>, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl<T, C> IntoDiscriminant for BiquadRepr<T, C>

where C: Coefficient, T: Float + FloatConst,

type Discriminant = BiquadReprDiscriminants

Enum listing the same variants as this enum but without any data fields

fn discriminant(&self) -> Self::Discriminant

impl<T, C> TreeAny for BiquadRepr<T, C>

where C: Coefficient + Any, T: Float + FloatConst, Ba<T>: TreeAny, Pid<T>: TreeAny, FilterRepr<T>: TreeAny,

fn ref_any_by_key(&self, keys: impl Keys) -> Result<&dyn Any, ValueError>

Obtain a reference to a dyn Any trait object for a leaf node.

fn mut_any_by_key( &mut self, keys: impl Keys, ) -> Result<&mut dyn Any, ValueError>

Obtain a mutable reference to a dyn Any trait object for a leaf node.

fn ref_by_key<T>(&self, keys: impl IntoKeys) -> Result<&T, ValueError>

where T: Any,

Obtain a reference to a leaf of known type by key.

fn mut_by_key<T>(&mut self, keys: impl IntoKeys) -> Result<&mut T, ValueError>

where T: Any,

Obtain a mutable reference to a leaf of known type by key.

impl<'de, T, C> TreeDeserialize<'de> for BiquadRepr<T, C>

where C: Coefficient + Deserialize<'de>, T: Float + FloatConst, Ba<T>: TreeDeserialize<'de>, Pid<T>: TreeDeserialize<'de>, FilterRepr<T>: TreeDeserialize<'de>,

fn deserialize_by_key<D: Deserializer<'de>>( &mut self, keys: impl Keys, de: D, ) -> Result<(), SerdeError<D::Error>>

Deserialize a leaf node by its keys.

fn probe_by_key<D: Deserializer<'de>>( keys: impl Keys, de: D, ) -> Result<(), SerdeError<D::Error>>

Blind deserialize a leaf node by its keys.

impl<T, C> TreeSchema for BiquadRepr<T, C>

where C: Coefficient, T: Float + FloatConst, Ba<T>: TreeSchema, Pid<T>: TreeSchema, FilterRepr<T>: TreeSchema,

const SCHEMA: &'static Schema

Schema for this tree level

impl<T, C> TreeSerialize for BiquadRepr<T, C>

where C: Coefficient + Serialize, T: Float + FloatConst, Ba<T>: TreeSerialize, Pid<T>: TreeSerialize, FilterRepr<T>: TreeSerialize,

fn serialize_by_key<S: Serializer>( &self, keys: impl Keys, ser: S, ) -> Result<S::Ok, SerdeError<S::Error>>

Serialize a node by keys.

impl<T, C> TryFrom<&str> for BiquadRepr<T, C>

where C: Coefficient, T: Float + FloatConst,

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<BiquadRepr<T, C>, <Self as TryFrom<&str>>::Error>

Performs the conversion.