Struct ICumulativeLayer 

pub struct ICumulativeLayer { /* private fields */ }

ICumulativeLayer

Layer that represents a cumulative operation across a tensor.

It computes successive reductions across an axis of a tensor. The output always has the same shape as the input.

If the reduction operation is summation, then this is also known as prefix-sum or cumulative sum.

The operation has forward vs. reverse variants, and inclusive vs. exclusive variants.

For example, let the input be a vector x of length n and the output be vector y. Then y[j] = sum(x[…]) where … denotes a sequence of indices from this table:

| forward | reverse –––––|———–| ——— inclusive | 0..j | j..n-1 exclusive | 0..j-1 | j+1..n-1

For multidimensional tensors, the reductions apply across a specified axis. For example, given a 2D input, a forward inclusive cumulative operation across axis 0 generates cumulative sums within each column.

Do not inherit from this class, as doing so will break forward-compatibility of the API and ABI.

Implementations

impl ICumulativeLayer

pub fn setOperation( self: Pin<&mut ICumulativeLayer>, op: CumulativeOperation, ) -> bool

Set the cumulative operation for the layer.

• op The reduction operation to be performed

Whether op is valid and the operation successfully set

See [getOperation()], CumulativeOperation

pub fn getOperation(self: &ICumulativeLayer) -> CumulativeOperation

Get the cumulative operation for the layer.

The reduction operation to be performed

See [setOperation()], CumulativeOperation

pub fn setExclusive(self: Pin<&mut ICumulativeLayer>, exclusive: bool)

Set whether it is an exclusive accumulation or inclusive accumulation.

• exclusive Whether the operation will exclude the element at the current index

See [getExclusive]

pub fn getExclusive(self: &ICumulativeLayer) -> bool

Get whether it is exclusive accumulation or inclusive accumulation.

Whether the operation will exclude the element at the current index

See [setExclusive]

pub fn setReverse(self: Pin<&mut ICumulativeLayer>, reverse: bool)

Specify whether the cumulative operation should be applied backward.

• reverse Whether the cumulative will run in the reverse direction from the last element

See [getReverse]

pub fn getReverse(self: &ICumulativeLayer) -> bool

Get the boolean that specifies whether the cumulative operation should be applied backward.

Whether the cumulative will run in the reverse direction from the last element

See [setReverse]

Trait Implementations

impl AsLayer for ICumulativeLayer

fn as_layer(&self) -> &ILayer

fn as_layer_pin_mut(&mut self) -> Pin<&mut ILayer>

impl AsLayerTyped for ICumulativeLayer

const TYPE: LayerType = LayerType::kCUMULATIVE

impl AsRef<ILayer> for ICumulativeLayer

fn as_ref(self: &ICumulativeLayer) -> &ILayer

Converts this type into a shared reference of the (usually inferred) input type.

impl ExternType for ICumulativeLayer

type Id = (n, v, i, n, f, e, r, _1, (), I, C, u, m, u, l, a, t, i, v, e, L, a, y, e, r)

A type-level representation of the type’s C++ namespace and type name.

type Kind = Opaque

Either cxx::kind::Opaque or cxx::kind::Trivial.

impl MakeCppStorage for ICumulativeLayer

unsafe fn allocate_uninitialized_cpp_storage() -> *mut ICumulativeLayer

Allocates heap space for this type in C++ and return a pointer to that space, but do not initialize that space (i.e. do not yet call a constructor).

unsafe fn free_uninitialized_cpp_storage(arg0: *mut ICumulativeLayer)

Frees a C++ allocation which has not yet had a constructor called.