Skip to main content

FftExecutor

Struct FftExecutor 

Source
pub struct FftExecutor { /* private fields */ }
Expand description

Reusable concrete FFT executor with an explicitly owned backend-neutral cache.

Use this executor for repeated concrete FFT calls that should reuse backend plans. The immediate TensorFftExt and TensorReadFftExt methods stay one-shot and do not retain hidden process-global, thread-local, or backend-owned plan state between calls.

Implementations§

Source§

impl FftExecutor

Source

pub fn new(plans: FftPlanCache) -> Self

Create an executor from a caller-configured FFT execution cache.

Source

pub const fn plan_cache(&self) -> &FftPlanCache

Inspect the owned backend-neutral FFT cache.

Source

pub fn plan_cache_mut(&mut self) -> &mut FftPlanCache

Mutably inspect or configure the owned backend-neutral FFT cache.

Source

pub fn cache_stats(&self) -> CacheStats

Snapshot aggregate statistics for every backend cache namespace.

Source

pub fn clear_cache(&mut self)

Remove every retained backend plan or workspace from this executor.

Source

pub fn fft<B: FftBackend>( &mut self, input: &Tensor, n: Option<usize>, axis: isize, norm: FftNorm, backend: &mut B, ) -> Result<Tensor>

Execute a complex or full-spectrum real FFT while reusing owned plans.

§Errors

Returns tenferro_tensor::Error::Validation with AxisOutOfBounds or InvalidArgument for invalid axis/n, tenferro_tensor::Error::Extension with ErrorKind::Unsupported for unsupported dtypes, or a typed backend source for execution.

Source

pub fn ifft<B: FftBackend>( &mut self, input: &Tensor, n: Option<usize>, axis: isize, norm: FftNorm, backend: &mut B, ) -> Result<Tensor>

Execute an inverse complex FFT while reusing owned plans.

§Errors

Returns tenferro_tensor::Error::Validation with AxisOutOfBounds or InvalidArgument for invalid axis/n, tenferro_tensor::Error::Extension with ErrorKind::Unsupported for a non-complex input, or a typed backend source for execution.

Source

pub fn rfft<B: FftBackend>( &mut self, input: &Tensor, n: Option<usize>, axis: isize, norm: FftNorm, backend: &mut B, ) -> Result<Tensor>

Execute a real FFT while reusing owned plans.

§Errors

Returns tenferro_tensor::Error::Validation with AxisOutOfBounds or InvalidArgument for invalid axis/n, tenferro_tensor::Error::Extension with ErrorKind::Unsupported for a non-real input, or a typed backend source for execution.

Source

pub fn irfft<B: FftBackend>( &mut self, input: &Tensor, n: Option<usize>, axis: isize, norm: FftNorm, backend: &mut B, ) -> Result<Tensor>

Execute an inverse real FFT while reusing owned plans.

§Errors

Returns tenferro_tensor::Error::Validation with AxisOutOfBounds, InvalidArgument, or spectrum-length details, tenferro_tensor::Error::Extension with ErrorKind::Unsupported for a non-complex input, or a typed backend source for execution.

Trait Implementations§

Source§

impl Default for FftExecutor

Source§

fn default() -> FftExecutor

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

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
§

impl<T> ByRef<T> for T

§

fn by_ref(&self) -> &T

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
§

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

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

§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSendSync for T
where T: Send + Sync,

§

impl<T> MaybeSync for T
where T: Sync,