Skip to main content

ParallelPlanND

Struct ParallelPlanND 

Source
pub struct ParallelPlanND<T: Float, P: ThreadPool> { /* private fields */ }
Expand description

A parallel plan for executing N-dimensional FFT transforms.

Uses a thread pool to parallelize fiber transforms along each dimension.

Implementations§

Source§

impl<T: Float, P: ThreadPool> ParallelPlanND<T, P>

Source

pub fn new( dims: &[usize], direction: Direction, flags: Flags, pool: P, ) -> Option<Self>

Create a parallel N-dimensional complex-to-complex DFT plan.

§Arguments
  • dims - Array of dimension sizes in row-major order (slowest varying first)
  • direction - Forward or Backward transform
  • flags - Planning flags
  • pool - Thread pool for parallel execution
§Returns

A plan for row-major N-dimensional data.

Source

pub fn rank(&self) -> usize

Get the number of dimensions.

Source

pub fn dims(&self) -> &[usize]

Get the dimensions.

Source

pub fn size(&self) -> usize

Get the total size (product of all dimensions).

Source

pub fn direction(&self) -> Direction

Get the transform direction.

Source

pub fn pool(&self) -> &P

Get a reference to the thread pool.

Source

pub fn execute(&self, input: &[Complex<T>], output: &mut [Complex<T>])

Execute the N-dimensional FFT in parallel on the given input/output buffers.

Data is in row-major order (last dimension varies fastest).

§Panics

Panics if buffer sizes don’t match the total size.

Source

pub fn execute_inplace(&self, data: &mut [Complex<T>])

Execute the N-dimensional FFT in-place in parallel.

§Panics

Panics if buffer size doesn’t match the total size.

Auto Trait Implementations§

§

impl<T, P> Freeze for ParallelPlanND<T, P>
where P: Freeze,

§

impl<T, P> RefUnwindSafe for ParallelPlanND<T, P>

§

impl<T, P> Send for ParallelPlanND<T, P>

§

impl<T, P> Sync for ParallelPlanND<T, P>

§

impl<T, P> Unpin for ParallelPlanND<T, P>
where P: Unpin,

§

impl<T, P> UnsafeUnpin for ParallelPlanND<T, P>
where P: UnsafeUnpin,

§

impl<T, P> UnwindSafe for ParallelPlanND<T, P>
where P: UnwindSafe, T: UnwindSafe,

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