Enum ndarray::SliceOrIndex

pub enum SliceOrIndex {
    Slice {
        start: isize,
        end: Option<isize>,
        step: isize,
    },
    Index(isize),
}

A slice (range with step) or an index.

See also the s![] macro for a convenient way to create a &SliceInfo<[SliceOrIndex; n], D>.

Examples

SliceOrIndex::Index(a) is the index a. It can also be created with SliceOrIndex::from(a). The Python equivalent is [a]. The macro equivalent is s![a].

SliceOrIndex::Slice { start: 0, end: None, step: 1 } is the full range of an axis. It can also be created with SliceOrIndex::from(..). The Python equivalent is [:]. The macro equivalent is s![..].

SliceOrIndex::Slice { start: a, end: Some(b), step: 2 } is every second element from a until b. It can also be created with SliceOrIndex::from(a..b).step_by(2). The Python equivalent is [a:b:2]. The macro equivalent is s![a..b;2].

SliceOrIndex::Slice { start: a, end: None, step: -1 } is every element, from a until the end, in reverse order. It can also be created with SliceOrIndex::from(a..).step_by(-1). The Python equivalent is [a::-1]. The macro equivalent is s![a..;-1].

Variants

Slice

Fields

start: isize

end: Option<isize>

step: isize

A range with step size. end is an exclusive index. 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.

Index(isize)

A single index.

Implementations

impl SliceOrIndex

pub fn is_slice(&self) -> bool

Returns true if self is a Slice value.

pub fn is_index(&self) -> bool

Returns true if self is an Index value.

pub fn step_by(self, step: isize) -> Self

Returns a new SliceOrIndex with the given step size (multiplied with the previous step size).

step must be nonzero. (This method checks with a debug assertion that step is not zero.)

Trait Implementations

impl Clone for SliceOrIndex

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 SliceOrIndex

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

Formats the value using the given formatter.

impl Display for SliceOrIndex

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

Formats the value using the given formatter.

impl From<Range<i32>> for SliceOrIndex

fn from(r: Range<i32>) -> SliceOrIndex

Converts to this type from the input type.

impl From<Range<isize>> for SliceOrIndex

fn from(r: Range<isize>) -> SliceOrIndex

Converts to this type from the input type.

impl From<Range<usize>> for SliceOrIndex

fn from(r: Range<usize>) -> SliceOrIndex

Converts to this type from the input type.

impl From<RangeFrom<i32>> for SliceOrIndex

fn from(r: RangeFrom<i32>) -> SliceOrIndex

Converts to this type from the input type.

impl From<RangeFrom<isize>> for SliceOrIndex

fn from(r: RangeFrom<isize>) -> SliceOrIndex

Converts to this type from the input type.

impl From<RangeFrom<usize>> for SliceOrIndex

fn from(r: RangeFrom<usize>) -> SliceOrIndex

Converts to this type from the input type.

impl From<RangeFull> for SliceOrIndex

fn from(_: RangeFull) -> SliceOrIndex

Converts to this type from the input type.

impl From<RangeInclusive<i32>> for SliceOrIndex

fn from(r: RangeInclusive<i32>) -> SliceOrIndex

Converts to this type from the input type.

impl From<RangeInclusive<isize>> for SliceOrIndex

fn from(r: RangeInclusive<isize>) -> SliceOrIndex

Converts to this type from the input type.

impl From<RangeInclusive<usize>> for SliceOrIndex

fn from(r: RangeInclusive<usize>) -> SliceOrIndex

Converts to this type from the input type.

impl From<RangeTo<i32>> for SliceOrIndex

fn from(r: RangeTo<i32>) -> SliceOrIndex

Converts to this type from the input type.

impl From<RangeTo<isize>> for SliceOrIndex

fn from(r: RangeTo<isize>) -> SliceOrIndex

Converts to this type from the input type.

impl From<RangeTo<usize>> for SliceOrIndex

fn from(r: RangeTo<usize>) -> SliceOrIndex

Converts to this type from the input type.

impl From<RangeToInclusive<i32>> for SliceOrIndex

fn from(r: RangeToInclusive<i32>) -> SliceOrIndex

Converts to this type from the input type.

impl From<RangeToInclusive<isize>> for SliceOrIndex

fn from(r: RangeToInclusive<isize>) -> SliceOrIndex

Converts to this type from the input type.

impl From<RangeToInclusive<usize>> for SliceOrIndex

fn from(r: RangeToInclusive<usize>) -> SliceOrIndex

Converts to this type from the input type.

impl From<Slice> for SliceOrIndex

fn from(s: Slice) -> SliceOrIndex

Converts to this type from the input type.

impl From<i32> for SliceOrIndex

fn from(r: i32) -> SliceOrIndex

Converts to this type from the input type.

impl From<isize> for SliceOrIndex

fn from(r: isize) -> SliceOrIndex

Converts to this type from the input type.

impl From<usize> for SliceOrIndex

fn from(r: usize) -> SliceOrIndex

Converts to this type from the input type.

impl Hash for SliceOrIndex

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,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<SliceOrIndex> for SliceOrIndex

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for SliceOrIndex

impl Eq for SliceOrIndex

impl StructuralEq for SliceOrIndex

impl StructuralPartialEq for SliceOrIndex