Skip to main content

DynamicConvolver

Struct DynamicConvolver 

Source
pub struct DynamicConvolver { /* private fields */ }

Implementations§

Source§

impl DynamicConvolver

Source

pub fn new(l: Laplacian) -> Result<Self, GspError>

Creates a dynamic convolver with branch-update support.

§Errors

Returns an error when l is not square.

Source

pub fn with_poles(l: Laplacian, poles: &[f64]) -> Result<Self, GspError>

Creates a dynamic convolver and pre-initializes pole states.

§Errors

Returns an error for invalid poles or failed factorizations.

Source

pub fn with_kernel(l: Laplacian, k: &VfKernel) -> Result<Self, GspError>

Creates a dynamic convolver using poles from an existing kernel.

§Errors

Returns an error when kernel validation or pole setup fails.

Source

pub fn convolve( &mut self, b: ArrayView2<'_, f64>, k: &VfKernel, ) -> Result<Array3<f64>, GspError>

Convolves a real-valued signal matrix with a VF kernel on the updated graph.

§Errors

Returns an error when kernel validation or solves fail.

Source

pub fn convolve_1d( &mut self, b: ArrayView1<'_, f64>, k: &VfKernel, ) -> Result<Array2<f64>, GspError>

1D wrapper around DynamicConvolver::convolve.

§Errors

Returns an error when dimensions are invalid or solves fail.

Source

pub fn convolve_complex( &mut self, b: ArrayView2<'_, Complex64>, k: &VfKernel, ) -> Result<Array3<Complex64>, GspError>

Convolves a complex-valued signal matrix by splitting real/imaginary parts.

§Errors

Returns an error when dimensions are invalid or solves fail.

Source

pub fn convolve_complex_1d( &mut self, b: ArrayView1<'_, Complex64>, k: &VfKernel, ) -> Result<Array2<Complex64>, GspError>

1D wrapper around DynamicConvolver::convolve_complex.

§Errors

Returns an error when dimensions are invalid or solves fail.

Source

pub fn lowpass( &mut self, b: ArrayView2<'_, f64>, scales: &[f64], order: usize, ) -> Result<Vec<Array2<f64>>, GspError>

Applies the analytical low-pass filter over multiple scales.

§Errors

Returns an error when dimensions/scales are invalid or solves fail.

Source

pub fn lowpass_complex( &mut self, b: ArrayView2<'_, Complex64>, scales: &[f64], order: usize, ) -> Result<Vec<Array2<Complex64>>, GspError>

Applies analytical low-pass filtering to complex signals.

§Errors

Returns an error when dimensions/scales are invalid or solves fail.

Source

pub fn lowpass_complex_one( &mut self, b: ArrayView2<'_, Complex64>, scale: f64, order: usize, ) -> Result<Array2<Complex64>, GspError>

Applies one complex low-pass solve at a single scale.

§Errors

Returns an error when dimensions/scales are invalid or solves fail.

Source

pub fn lowpass_one( &mut self, b: ArrayView2<'_, f64>, scale: f64, order: usize, ) -> Result<Array2<f64>, GspError>

Applies one real low-pass solve at a single scale.

§Errors

Returns an error when dimensions/scales are invalid or solves fail.

Source

pub fn bandpass( &mut self, b: ArrayView2<'_, f64>, scales: &[f64], order: usize, ) -> Result<Vec<Array2<f64>>, GspError>

Applies the analytical band-pass filter over multiple scales.

§Errors

Returns an error when dimensions/scales are invalid or solves fail.

Source

pub fn bandpass_one( &mut self, b: ArrayView2<'_, f64>, scale: f64, order: usize, ) -> Result<Array2<f64>, GspError>

Applies one real band-pass solve at a single scale.

§Errors

Returns an error when dimensions/scales are invalid or solves fail.

Source

pub fn bandpass_complex( &mut self, b: ArrayView2<'_, Complex64>, scales: &[f64], order: usize, ) -> Result<Vec<Array2<Complex64>>, GspError>

Applies analytical band-pass filtering to complex signals.

§Errors

Returns an error when dimensions/scales are invalid or solves fail.

Source

pub fn bandpass_complex_one( &mut self, b: ArrayView2<'_, Complex64>, scale: f64, order: usize, ) -> Result<Array2<Complex64>, GspError>

Applies one complex band-pass solve at a single scale.

§Errors

Returns an error when dimensions/scales are invalid or solves fail.

Source

pub fn highpass( &mut self, b: ArrayView2<'_, f64>, scales: &[f64], ) -> Result<Vec<Array2<f64>>, GspError>

Applies the analytical high-pass filter over multiple scales.

§Errors

Returns an error when dimensions/scales are invalid or solves fail.

Source

pub fn highpass_one( &mut self, b: ArrayView2<'_, f64>, scale: f64, ) -> Result<Array2<f64>, GspError>

Applies one real high-pass solve at a single scale.

§Errors

Returns an error when dimensions/scales are invalid or solves fail.

Source

pub fn highpass_complex( &mut self, b: ArrayView2<'_, Complex64>, scales: &[f64], ) -> Result<Vec<Array2<Complex64>>, GspError>

Applies analytical high-pass filtering to complex signals.

§Errors

Returns an error when dimensions/scales are invalid or solves fail.

Source

pub fn highpass_complex_one( &mut self, b: ArrayView2<'_, Complex64>, scale: f64, ) -> Result<Array2<Complex64>, GspError>

Applies one complex high-pass solve at a single scale.

§Errors

Returns an error when dimensions/scales are invalid or solves fail.

Source

pub fn add_branch( &mut self, i: usize, j: usize, w: f64, ) -> Result<bool, GspError>

Adds a weighted branch (i, j) to the dynamic topology.

§Errors

Returns an error on negative weights or near-singular Woodbury updates.

Auto Trait Implementations§

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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§

unsafe 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<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.