Struct ndarray::Slice

source ·
pub struct Slice {
    pub start: isize,
    pub end: Option<isize>,
    pub step: isize,
}
Expand description

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§

source§

impl Slice

source

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.)

source

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§

source§

impl Clone for Slice

source§

fn clone(&self) -> Slice

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Slice

source§

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

Formats the value using the given formatter. Read more
source§

impl From<Range<i32>> for Slice

source§

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

Converts to this type from the input type.
source§

impl From<Range<isize>> for Slice

source§

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

Converts to this type from the input type.
source§

impl From<Range<usize>> for Slice

source§

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

Converts to this type from the input type.
source§

impl From<RangeFrom<i32>> for Slice

source§

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

Converts to this type from the input type.
source§

impl From<RangeFrom<isize>> for Slice

source§

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

Converts to this type from the input type.
source§

impl From<RangeFrom<usize>> for Slice

source§

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

Converts to this type from the input type.
source§

impl From<RangeFull> for Slice

source§

fn from(_: RangeFull) -> Slice

Converts to this type from the input type.
source§

impl From<RangeInclusive<i32>> for Slice

source§

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

Converts to this type from the input type.
source§

impl From<RangeInclusive<isize>> for Slice

source§

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

Converts to this type from the input type.
source§

impl From<RangeInclusive<usize>> for Slice

source§

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

Converts to this type from the input type.
source§

impl From<RangeTo<i32>> for Slice

source§

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

Converts to this type from the input type.
source§

impl From<RangeTo<isize>> for Slice

source§

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

Converts to this type from the input type.
source§

impl From<RangeTo<usize>> for Slice

source§

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

Converts to this type from the input type.
source§

impl From<RangeToInclusive<i32>> for Slice

source§

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

Converts to this type from the input type.
source§

impl From<RangeToInclusive<isize>> for Slice

source§

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

Converts to this type from the input type.
source§

impl From<RangeToInclusive<usize>> for Slice

source§

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

Converts to this type from the input type.
source§

impl From<Slice> for SliceInfoElem

source§

fn from(s: Slice) -> SliceInfoElem

Converts to this type from the input type.
source§

impl Hash for Slice

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl PartialEq<Slice> for Slice

source§

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

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

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.
source§

impl Copy for Slice

source§

impl Eq for Slice

source§

impl StructuralEq for Slice

source§

impl StructuralPartialEq for Slice

Auto Trait Implementations§

§

impl RefUnwindSafe for Slice

§

impl Send for Slice

§

impl Sync for Slice

§

impl Unpin for Slice

§

impl UnwindSafe for Slice

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.