Skip to main content

FftOptions

Struct FftOptions 

Source
#[non_exhaustive]
pub struct FftOptions { pub n: Option<usize>, pub axis: isize, pub norm: FftNorm, }
Expand description

Options of the one-axis transforms fft, ifft, rfft and irfft.

  • n: transform length along axis; the input is cropped or zero-padded to it (for irfft, the length of the real output). None keeps the input length (for irfft, 2 * (m - 1)).
  • axis: the transformed axis; negative values count from the end. The default is -1, the last axis.
  • norm: the normalization; the default is FftNorm::Backward.

The in-place transforms (fft_in_place, ifft_in_place) cannot change the length, so they reject n: Some(_) with a validation error.

§Examples

use tenferro_fft::{FftNorm, FftOptions};

let opts = FftOptions::default();
assert_eq!((opts.n, opts.axis, opts.norm), (None, -1, FftNorm::Backward));

let opts = FftOptions::default().n(Some(8)).axis(0).norm(FftNorm::Ortho);
assert_eq!((opts.n, opts.axis, opts.norm), (Some(8), 0, FftNorm::Ortho));

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§n: Option<usize>

Transform length along axis; None keeps the input length.

§axis: isize

The transformed axis; negative values count from the end.

§norm: FftNorm

The normalization.

Implementations§

Source§

impl FftOptions

Source

pub fn n(self, n: Option<usize>) -> Self

Return options with the requested transform length.

§Examples
use tenferro_fft::FftOptions;

assert_eq!(FftOptions::default().n(Some(4)).n, Some(4));
Source

pub fn axis(self, axis: isize) -> Self

Return options with the requested axis.

§Examples
use tenferro_fft::FftOptions;

assert_eq!(FftOptions::default().axis(0).axis, 0);
Source

pub fn norm(self, norm: FftNorm) -> Self

Return options with the requested normalization.

§Examples
use tenferro_fft::{FftNorm, FftOptions};

assert_eq!(FftOptions::default().norm(FftNorm::Forward).norm, FftNorm::Forward);

Trait Implementations§

Source§

impl Clone for FftOptions

Source§

fn clone(&self) -> Self

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 Copy for FftOptions

Source§

impl Debug for FftOptions

Source§

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

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

impl Default for FftOptions

Source§

fn default() -> Self

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

impl Eq for FftOptions

Source§

impl PartialEq for FftOptions

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for FftOptions

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
§

impl<T> Boilerplate for T
where T: Copy + Send + Sync + Debug + PartialEq + 'static,

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
§

impl<T> ByRef<T> for T

§

fn by_ref(&self) -> &T

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
§

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

§

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

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

§

fn simd_from(_simd: S, value: T) -> T

§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

§

fn simd_into(self, simd: S) -> T

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.