Struct ndarray::Slice

pub struct Slice {
    pub start: isize,
    pub end: Option<isize>,
    pub step: isize,
}

A slice (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.

See also the s![] macro.

Examples

Slice::new(0, None, 1) is the full range of an axis. It can also be created with Slice::from(..). The Python equivalent is [:].

Slice::new(a, b, 2) is every second element from a until b. It can also be created with Slice::from(a..b).step_by(2). The Python equivalent is [a:b:2].

Slice::new(a, None, -1) is every element, from a until the end, in reverse order. It can also be created with Slice::from(a..).step_by(-1). The Python equivalent is [a::-1].

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.

Implementations

impl Slice

pub fn new(start: isize, end: Option<isize>, step: isize) -> Slice

Create a new Slice with the given extents.

See also the From impls, converting from ranges; for example Slice::from(i..) or Slice::from(j..k).

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

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

Create a new Slice 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 Slice

fn clone(&self) -> Slice

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Slice

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

Formats the value using the given formatter.

impl From<Range<i32>> for Slice

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

Converts to this type from the input type.

impl From<Range<isize>> for Slice

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

Converts to this type from the input type.

impl From<Range<usize>> for Slice

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

Converts to this type from the input type.

impl From<RangeFrom<i32>> for Slice

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

Converts to this type from the input type.

impl From<RangeFrom<isize>> for Slice

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

Converts to this type from the input type.

impl From<RangeFrom<usize>> for Slice

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

Converts to this type from the input type.

impl From<RangeFull> for Slice

fn from(_: RangeFull) -> Slice

Converts to this type from the input type.

impl From<RangeInclusive<i32>> for Slice

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

Converts to this type from the input type.

impl From<RangeInclusive<isize>> for Slice

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

Converts to this type from the input type.

impl From<RangeInclusive<usize>> for Slice

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

Converts to this type from the input type.

impl From<RangeTo<i32>> for Slice

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

Converts to this type from the input type.

impl From<RangeTo<isize>> for Slice

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

Converts to this type from the input type.

impl From<RangeTo<usize>> for Slice

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

Converts to this type from the input type.

impl From<RangeToInclusive<i32>> for Slice

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

Converts to this type from the input type.

impl From<RangeToInclusive<isize>> for Slice

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

Converts to this type from the input type.

impl From<RangeToInclusive<usize>> for Slice

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

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 Hash for Slice

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

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

impl Eq for Slice

impl StructuralEq for Slice

impl StructuralPartialEq for Slice