Enum ndarray::SliceOrIndex

[−] Show declaration

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

[−] Expand description

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

[−] Expand description

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.

[−] Show fields

Fields of Slice

start: isizeend: Option<isize>step: isize

Index(isize)

[−] Expand description

A single index.

Methods

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[+]

[+] Show hidden undocumented items

fn clone(&self) -> Self[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Copy for SliceOrIndex

impl Debug for SliceOrIndex[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl Display for SliceOrIndex[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl Eq for SliceOrIndex

impl From<Range<i32>> for SliceOrIndex[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl From<Range<isize>> for SliceOrIndex[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl From<Range<usize>> for SliceOrIndex[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl From<RangeFrom<i32>> for SliceOrIndex[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl From<RangeFrom<isize>> for SliceOrIndex[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl From<RangeFrom<usize>> for SliceOrIndex[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl From<RangeFull> for SliceOrIndex[+]

[+] Show hidden undocumented items

fn from(_: RangeFull) -> SliceOrIndex[−]

Performs the conversion.

impl From<RangeInclusive<i32>> for SliceOrIndex[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl From<RangeInclusive<isize>> for SliceOrIndex[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl From<RangeInclusive<usize>> for SliceOrIndex[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl From<RangeTo<i32>> for SliceOrIndex[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl From<RangeTo<isize>> for SliceOrIndex[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl From<RangeTo<usize>> for SliceOrIndex[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl From<RangeToInclusive<i32>> for SliceOrIndex[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl From<RangeToInclusive<isize>> for SliceOrIndex[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl From<RangeToInclusive<usize>> for SliceOrIndex[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl From<Slice> for SliceOrIndex[+]

[+] Show hidden undocumented items

fn from(s: Slice) -> SliceOrIndex[−]

Performs the conversion.

impl From<i32> for SliceOrIndex[+]

[+] Show hidden undocumented items

fn from(r: i32) -> SliceOrIndex[−]

Performs the conversion.

impl From<isize> for SliceOrIndex[+]

[+] Show hidden undocumented items

fn from(r: isize) -> SliceOrIndex[−]

Performs the conversion.

impl From<usize> for SliceOrIndex[+]

[+] Show hidden undocumented items

fn from(r: usize) -> SliceOrIndex[−]

Performs the conversion.

impl Hash for SliceOrIndex[+]

[+] Show hidden undocumented items

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<SliceOrIndex> for SliceOrIndex[+]

[+] Show hidden undocumented items

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: &SliceOrIndex) -> bool[−]

This method tests for !=.

impl StructuralEq for SliceOrIndex

impl StructuralPartialEq for SliceOrIndex