Struct PlanKey 

pub struct PlanKey {
    pub rank: u32,
    pub dims: [i32; 3],
    pub kind: FftKind,
    pub dtype: DType,
    pub batch: i32,
    pub many_layout: Option<u64>,
}

Plan-cache key. Captures everything cuFFT cares about for both the simple cufftPlan{1,2,3}d constructors and the advanced cufftPlanMany builder. dims[i] == 0 for i >= rank (unused dimensions are zeroed for hashability).

Fields

rank: u32

dims: [i32; 3]

kind: FftKind

dtype: DType

batch: i32

many_layout: Option<u64>

Some(seed) ⇒ this is a plan_many plan; the seed is a hash of the embed/stride/dist tuples so two plan_manys with different layouts hash distinctly. None ⇒ simple cufftPlan{1,2,3}d.

Implementations

impl PlanKey

pub fn plan_1d(n: i32, kind: FftKind, batch: i32) -> Self

Convenience constructor for a simple 1D plan.

pub fn plan_2d(nx: i32, ny: i32, kind: FftKind) -> Self

Convenience constructor for a simple 2D plan.

pub fn plan_3d(nx: i32, ny: i32, nz: i32, kind: FftKind) -> Self

Convenience constructor for a simple 3D plan.

Trait Implementations

impl Clone for PlanKey

fn clone(&self) -> PlanKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PlanKey

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

Formats the value using the given formatter.

impl Hash for PlanKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for PlanKey

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for PlanKey

impl Eq for PlanKey

impl StructuralPartialEq for PlanKey