Skip to main content

ScatterPlan

Struct ScatterPlan 

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

A compiled additive scatter traversal.

Execution first copies operand into dest, then applies additive updates in deterministic column-major order. Boolean values are intentionally not supported because additive scatter has no bool semantics.

Implementations§

Source§

impl ScatterPlan

Source

pub fn compile( operand_dims: &[usize], operand_strides: &[isize], index_dims: &[usize], index_strides: &[isize], update_dims: &[usize], update_strides: &[isize], dest_dims: &[usize], dest_strides: &[isize], spec: ScatterSpec, ) -> Result<Self>

Compile an additive scatter traversal.

§Errors

Returns StridedError::StrideLengthMismatch when a stride list does not match its dimension list, StridedError::OffsetOverflow when an element count or layout span does not fit usize/isize, StridedError::ShapeMismatch when dest_dims differs from operand_dims or an update batch extent differs from the index batch shape, and StridedError::NonInjectiveOutputLayout when the destination layout cannot be proven injective (aliasing elements, or a span the check cannot represent). StridedError::InvalidAxis reports inserted_window_dims, scatter_dims_to_operand_dims, or update_window_dims that repeat or exceed their rank, index_vector_dim beyond the index rank, or an update window extent beyond its operand extent; and StridedError::RankMismatch reports an index vector that does not match scatter_dims_to_operand_dims, a wrong-length update_window_dims, or an update batch rank that disagrees with the index batch shape.

Source

pub fn execute<T, I>( &self, dest: &mut RawStridedMut<'_, T>, operand: &RawStridedRef<'_, T>, scatter_indices: &RawStridedRef<'_, I>, updates: &RawStridedRef<'_, T>, exec: Exec<'_>, ) -> Result<()>
where T: Copy + Add<Output = T> + Send + Sync, I: GatherIndex,

Execute the prepared additive scatter traversal.

§Errors

Returns StridedError::PlanLayoutMismatch when the operand, index, update, or destination view does not carry its compiled extents and strides, before the operand copy runs. Start values are clamped into the operand window, so an out-of-range scatter index is not an error.

Trait Implementations§

Source§

impl Clone for ScatterPlan

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 Debug for ScatterPlan

Source§

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

Formats the value using the given formatter. 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
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
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> 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.