Skip to main content

SolverChoice

oxifft::kernel

Enum SolverChoice 

Source 
#[non_exhaustive]
pub enum SolverChoice {

Show 14 variants    Nop,
    Direct,
    CooleyTukeyDit,
    CooleyTukeyDif,
    CooleyTukeyRadix4,
    CooleyTukeyRadix8,
    CooleyTukeySplitRadix,
    Stockham,
    Composite,
    Generic,
    Bluestein,
    Rader,
    CacheOblivious,
    MixedRadix {
        factors: Vec<u16>,
    },

}
Expand description

Solver selection strategy.

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

Nop

No-op for size 0 or 1

§

Direct

Direct O(n²) computation

§

CooleyTukeyDit

Cooley-Tukey radix-2 DIT

§

CooleyTukeyDif

Cooley-Tukey radix-2 DIF

§

CooleyTukeyRadix4

Cooley-Tukey radix-4

§

CooleyTukeyRadix8

Cooley-Tukey radix-8

§

CooleyTukeySplitRadix

Cooley-Tukey split-radix

§

Stockham

Stockham auto-sort (avoids bit-reversal, optimal for large sizes)

§

Composite

Specialized composite codelets (12, 24, 36, 48, 60, 72, 96, 100)

§

Generic

Generic mixed-radix for composite sizes

§

Bluestein

Bluestein’s algorithm for arbitrary sizes

§

Rader

Rader’s algorithm for prime sizes

§

CacheOblivious

Cache-oblivious four-step FFT for large power-of-2 sizes

§

MixedRadix

Mixed-radix DIT FFT for smooth-7 composite sizes.

factors is ordered innermost-first; the product equals the transform size.

Fields

§factors: Vec<u16>

Implementations§

Source§

impl SolverChoice

Source

pub fn name(&self) -> &'static str

Short, static solver identifier (used for display and non-wisdom purposes).

For MixedRadix, returns the generic tag "mixed-radix". Use SolverChoice::wisdom_name when encoding to wisdom strings, since that method includes the factor sequence.

Source

pub fn wisdom_name(&self) -> String

Wisdom-safe solver name that encodes all solver parameters.

For MixedRadix { factors: [3, 2] } this returns "mixed-radix-3-2". For all other variants, identical to Self::name.

Trait Implementations§

Source§

impl Clone for SolverChoice

Source§

fn clone(&self) -> SolverChoice

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SolverChoice

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for SolverChoice

Source§

fn eq(&self, other: &SolverChoice) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for SolverChoice

Source§

impl StructuralPartialEq for SolverChoice

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.