Struct Plan 

pub struct Plan<'h> { /* private fields */ }

A compiled operation plan. Dispatch to the matching execute method based on the op kind that built it.

Implementations

impl<'h> Plan<'h>

pub fn new( op: &OperationDescriptor<'h>, pref: &PlanPreference<'h>, workspace_size_limit: u64, ) -> Result<Self>

Compile an operation descriptor into a plan. workspace_size_limit bytes — pass the estimate.

pub fn as_raw(&self) -> cutensorPlan_t

Raw cutensorPlan_t. Use with care.

pub unsafe fn contract( &self, alpha: *const c_void, a: *const c_void, b: *const c_void, beta: *const c_void, c: *const c_void, d: *mut c_void, workspace: *mut c_void, workspace_bytes: u64, stream: *mut c_void, ) -> Result<()>

Execute a contraction plan. Aborts if self wasn’t built from a Contraction descriptor.

Safety

All device pointers must be live, tensor-descriptor-conforming, and aligned. workspace must be at least the estimated size.

pub unsafe fn reduce( &self, alpha: *const c_void, a: *const c_void, beta: *const c_void, c: *const c_void, d: *mut c_void, workspace: *mut c_void, workspace_bytes: u64, stream: *mut c_void, ) -> Result<()>

Execute a reduction plan.

Safety

Same as Self::contract.

pub unsafe fn elementwise_binary( &self, alpha: *const c_void, a: *const c_void, gamma: *const c_void, c: *const c_void, d: *mut c_void, stream: *mut c_void, ) -> Result<()>

Execute an elementwise-binary plan.

Safety

Same as Self::contract.

pub unsafe fn elementwise_trinary( &self, alpha: *const c_void, a: *const c_void, beta: *const c_void, b: *const c_void, gamma: *const c_void, c: *const c_void, d: *mut c_void, stream: *mut c_void, ) -> Result<()>

Execute an elementwise-trinary plan.

Safety

Same as Self::contract.

pub unsafe fn permute( &self, alpha: *const c_void, a: *const c_void, b: *mut c_void, stream: *mut c_void, ) -> Result<()>

Execute a permutation plan.

Safety

Same as Self::contract.

pub unsafe fn contract_block_sparse( &self, alpha: *const c_void, a: *const c_void, b: *const c_void, beta: *const c_void, c: *const c_void, d: *mut c_void, workspace: *mut c_void, workspace_bytes: u64, stream: *mut c_void, ) -> Result<()>

Execute a block-sparse contraction plan.

Safety

Same as Self::contract; a must be a block-sparse device buffer matching the BlockSparseTensorDescriptor passed to BlockSparseContraction::new.

pub unsafe fn contract_trinary( &self, alpha: *const c_void, a: *const c_void, b: *const c_void, c: *const c_void, beta: *const c_void, d: *const c_void, e: *mut c_void, workspace: *mut c_void, workspace_bytes: u64, stream: *mut c_void, ) -> Result<()>

Execute a trinary-contraction plan: E = α·op_a(A)·op_b(B)·op_c(C) + β·op_d(D).

Safety

Same as Self::contract.

Trait Implementations

impl<'h> Debug for Plan<'h>

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

Formats the value using the given formatter.

impl Drop for Plan<'_>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.