Enum ndarray::SliceInfoElem

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

A slice (range with step), an index, or a new axis token.

See also the s![] macro for a convenient way to create a SliceInfo<[SliceInfoElem; n], Din, Dout>.

Examples

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

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

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

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

SliceInfoElem::NewAxis is a new axis of length 1. It can also be created with SliceInfoElem::from(NewAxis). The Python equivalent is [np.newaxis]. The macro equivalent is s![NewAxis].

Variants

Slice

Fields

start: isize

start index; negative are counted from the back of the axis

end: Option<isize>

end index; negative are counted from the back of the axis; when not present the default is the full length of the axis.

step: isize

step size in elements; the default is 1, for every element.

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

NewAxis

A new axis of length 1.

Implementations

impl SliceInfoElem

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 is_new_axis(&self) -> bool

Returns true if self is a NewAxis value.

Trait Implementations

impl Clone for SliceInfoElem

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 SliceInfoElem

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

Formats the value using the given formatter.

impl Display for SliceInfoElem

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

Formats the value using the given formatter.

impl From<NewAxis> for SliceInfoElem

fn from(_: NewAxis) -> SliceInfoElem

Converts to this type from the input type.

impl From<Range<i32>> for SliceInfoElem

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

Converts to this type from the input type.

impl From<Range<isize>> for SliceInfoElem

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

Converts to this type from the input type.

impl From<Range<usize>> for SliceInfoElem

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

Converts to this type from the input type.

impl From<RangeFrom<i32>> for SliceInfoElem

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

Converts to this type from the input type.

impl From<RangeFrom<isize>> for SliceInfoElem

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

Converts to this type from the input type.

impl From<RangeFrom<usize>> for SliceInfoElem

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

Converts to this type from the input type.

impl From<RangeFull> for SliceInfoElem

fn from(_: RangeFull) -> SliceInfoElem

Converts to this type from the input type.

impl From<RangeInclusive<i32>> for SliceInfoElem

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

Converts to this type from the input type.

impl From<RangeInclusive<isize>> for SliceInfoElem

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

Converts to this type from the input type.

impl From<RangeInclusive<usize>> for SliceInfoElem

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

Converts to this type from the input type.

impl From<RangeTo<i32>> for SliceInfoElem

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

Converts to this type from the input type.

impl From<RangeTo<isize>> for SliceInfoElem

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

Converts to this type from the input type.

impl From<RangeTo<usize>> for SliceInfoElem

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

Converts to this type from the input type.

impl From<RangeToInclusive<i32>> for SliceInfoElem

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

Converts to this type from the input type.

impl From<RangeToInclusive<isize>> for SliceInfoElem

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

Converts to this type from the input type.

impl From<RangeToInclusive<usize>> for SliceInfoElem

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

Converts to this type from the input type.

impl From<Slice> for SliceInfoElem

fn from(s: Slice) -> SliceInfoElem

Converts to this type from the input type.

impl From<i32> for SliceInfoElem

fn from(r: i32) -> SliceInfoElem

Converts to this type from the input type.

impl From<isize> for SliceInfoElem

fn from(r: isize) -> SliceInfoElem

Converts to this type from the input type.

impl From<usize> for SliceInfoElem

fn from(r: usize) -> SliceInfoElem

Converts to this type from the input type.

impl Hash for SliceInfoElem

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<SliceInfoElem> for SliceInfoElem

fn eq(&self, other: &SliceInfoElem) -> 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 SliceInfoElem

impl Eq for SliceInfoElem

impl StructuralEq for SliceInfoElem

impl StructuralPartialEq for SliceInfoElem