Skip to main content

SegmentSumPlan

Struct SegmentSumPlan 

Source
pub struct SegmentSumPlan<T: Element> { /* private fields */ }
Expand description

segment_sum plan (sorted).

out[s, d] = Σ_{n : segment_ids[n] == s} input[n, d] (TF / JAX segment_sum). Requires segment_ids to be monotonically non-decreasing.

When to use: forward sorted segment-sum. For unsorted IDs use UnsortedSegmentSumPlan. Pair with SegmentSumBackwardPlan for autograd.

Dtypes: {f32, f64} (matches the family — kernels rely on FP atomic primitives even in the sorted variant for some paths).

Shape limits: input is [N, D], segment_ids is [N] with values in [0, num_segments); output is [num_segments, D]. All extents non-negative.

Workspace: none.

Precision guarantee: deterministic, bit-stable — single thread per output cell sweeps the segment’s row range in order.

Index policy: out-of-range segment IDs (< 0 or ≥ num_segments) are silently dropped (TF / JAX semantic). Output buffer is fully overwritten (no accumulation into prior state).

Implementations§

Source§

impl<T: Element> SegmentSumPlan<T>

Source

pub fn select( _stream: &Stream, desc: &SegmentSumDescriptor, _pref: PlanPreference, ) -> Result<Self>

Pick a kernel for desc.

Source

pub fn can_implement(&self, args: &SegmentSumArgs<'_, T>) -> Result<()>

Validate args.

Source

pub fn workspace_size(&self) -> usize

Workspace size in bytes.

Source

pub fn sku(&self) -> KernelSku

Identity of the kernel this plan picked.

Source

pub fn precision_guarantee(&self) -> PrecisionGuarantee

Numerical guarantees for this plan’s kernel.

Source

pub fn run( &self, stream: &Stream, _workspace: Workspace<'_>, args: SegmentSumArgs<'_, T>, ) -> Result<()>

Launch.

Auto Trait Implementations§

§

impl<T> Freeze for SegmentSumPlan<T>

§

impl<T> RefUnwindSafe for SegmentSumPlan<T>
where T: RefUnwindSafe,

§

impl<T> Send for SegmentSumPlan<T>
where T: Send,

§

impl<T> Sync for SegmentSumPlan<T>
where T: Sync,

§

impl<T> Unpin for SegmentSumPlan<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for SegmentSumPlan<T>

§

impl<T> UnwindSafe for SegmentSumPlan<T>
where 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, 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.