#[non_exhaustive]pub enum WaveletFamily {
Haar,
Daubechies(usize),
}Expand description
A wavelet family: Haar (db1) or Daubechies of a given vanishing-moment order.
Daubechies(N) carries the vanishing-moment order N ∈ 2..=10 (db2..db10);
db1 is spelled WaveletFamily::Haar. Construct from a plain dbN order via
WaveletFamily::from_db_order.
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
Haar
The Haar wavelet (equivalently db1): filter length 2.
Daubechies(usize)
Daubechies wavelet with N vanishing moments (N ∈ 2..=10, filter length 2N).
Implementations§
Source§impl WaveletFamily
impl WaveletFamily
Sourcepub fn from_db_order(order: usize) -> Result<Self, FdarError>
pub fn from_db_order(order: usize) -> Result<Self, FdarError>
Map a plain Daubechies order to a WaveletFamily.
1 maps to WaveletFamily::Haar (db1 == Haar); 2..=10 map to
WaveletFamily::Daubechies.
§Errors
Returns FdarError::InvalidParameter for an order of 0 or > 10.
Trait Implementations§
Source§impl Clone for WaveletFamily
impl Clone for WaveletFamily
Source§fn clone(&self) -> WaveletFamily
fn clone(&self) -> WaveletFamily
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for WaveletFamily
impl Debug for WaveletFamily
Source§impl PartialEq for WaveletFamily
impl PartialEq for WaveletFamily
impl StructuralPartialEq for WaveletFamily
Auto Trait Implementations§
impl Freeze for WaveletFamily
impl RefUnwindSafe for WaveletFamily
impl Send for WaveletFamily
impl Sync for WaveletFamily
impl Unpin for WaveletFamily
impl UnsafeUnpin for WaveletFamily
impl UnwindSafe for WaveletFamily
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
impl<T> Scalar for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
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
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
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.