Struct ndarray::Si

pub struct Si(pub Ixs, pub Option<Ixs>, pub Ixs);

A slice, a description of a range of an array axis.

Fields are begin, end and stride, where negative begin or end indexes are counted from the back of the axis.

If end is None, the slice extends to the end of the axis.

See also the s![] macro, a convenient way to specify an array of Si.

Examples

Si(0, None, 1) is the full range of an axis. Python equivalent is [:]. Macro equivalent is s![..].

Si(a, Some(b), 2) is every second element from a until b. Python equivalent is [a:b:2]. Macro equivalent is s![a..b;2].

Si(a, None, -1) is every element, from a until the end, in reverse order. Python equivalent is [a::-1]. Macro equivalent is s![a..;-1].

The constant S is a shorthand for the full range of an axis.

Implementations

impl Si

pub fn step(self, step: Ixs) -> Self

Trait Implementations

impl Clone for Si

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Si

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

Formats the value using the given formatter.

impl From<Range<isize>> for Si

fn from(r: Range<Ixs>) -> Si

Performs the conversion.

impl From<RangeFrom<isize>> for Si

fn from(r: RangeFrom<Ixs>) -> Si

Performs the conversion.

impl From<RangeFull> for Si

fn from(_: RangeFull) -> Si

Performs the conversion.

impl From<RangeTo<isize>> for Si

fn from(r: RangeTo<Ixs>) -> Si

Performs the conversion.

impl Hash for Si

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Si> for Si

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

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

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

This method tests for !=.

impl Copy for Si

impl Eq for Si

impl StructuralEq for Si

impl StructuralPartialEq for Si