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
impl ScatterPlan
Sourcepub 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>
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.
Sourcepub fn execute<T, I>(
&self,
dest: &mut RawStridedMut<'_, T>,
operand: &RawStridedRef<'_, T>,
scatter_indices: &RawStridedRef<'_, I>,
updates: &RawStridedRef<'_, T>,
exec: Exec<'_>,
) -> Result<()>
pub fn execute<T, I>( &self, dest: &mut RawStridedMut<'_, T>, operand: &RawStridedRef<'_, T>, scatter_indices: &RawStridedRef<'_, I>, updates: &RawStridedRef<'_, T>, exec: Exec<'_>, ) -> Result<()>
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.