Enum ciphercore_base::graphs::SliceElement

pub enum SliceElement {
    SingleIndex(i64),
    SubArray(Option<i64>, Option<i64>, Option<i64>),
    Ellipsis,
}

This enum represents different types of slice elements that are used to create indexing slices (see Slice and Graph::get_slice).

The semantics is similar to the NumPy slice indexing.

Variants

SingleIndex(i64)

Single index of a given array dimension.

The index is given by a signed integer. If negative, the index is interpreted as in NumPy.

For example, to choose all the elements of an array with the last index in the first dimension and the first index in the second dimension, one can use a slice vec![SingleIndex(-1), SingleIndex(0)].

SubArray(Option<i64>, Option<i64>, Option<i64>)

Sub-array denotes a range of indices of a given array dimension.

It follows the description of the NumPy basic slice, which is defined by 3 signed integers: start, stop, step. step can’t be equal to zero.

For example, to choose all the elements of an array with even indices in the first dimension, one can use a slice `vec![SubArray(Some(0), None, Some(2))].

Ellipsis

Ellipsis denotes several dimensions where indices are not restricted.

For example, to choose all the elements of an array with index 0 in the first dimension and index 2 in the last dimension, one can use a slice vec![SingleIndex(0), Ellipsis, SingleIndex(2)].

Trait Implementations

impl Clone for SliceElement

fn clone(&self) -> SliceElement

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SliceElement

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SliceElement

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<SliceElement> for SliceElement

fn eq(&self, other: &SliceElement) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SliceElement) -> bool

This method tests for !=.

impl Serialize for SliceElement

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Eq for SliceElement

impl StructuralEq for SliceElement

impl StructuralPartialEq for SliceElement