Struct SliceRange 

pub struct SliceRange {
    pub start: isize,
    pub end: Option<isize>,
    /* private fields */
}

A range for slicing a Tensor or NdTensor.

This has two main differences from Range.

• A non-zero step between indices can be specified. The step can be negative, which means that the dimension should be traversed in reverse order.
• The start and end indexes can also be negative, in which case they count backwards from the end of the array.

This system for specifying slicing and indexing follows NumPy, which in turn strongly influenced slicing in ONNX.

Fields

start: isize

First index in range.

end: Option<isize>

Last index (exclusive) in range, or None if the range extends to the end of a dimension.

Implementations

impl SliceRange

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

Create a new range from start to end. The start index is inclusive and the end value is exclusive. If end is None, the range spans to the end of the dimension.

Panics if the step size is 0.

pub fn steps(&self, dim_size: usize) -> usize

Return the number of elements that would be retained if using this range to slice a dimension of size dim_size.

pub fn clamp(&self, dim_size: usize) -> SliceRange

Return a copy of this range with indexes adjusted so that they are valid for a tensor dimension of size dim_size.

Valid indexes depend on direction that the dimension is traversed (forwards if self.step is positive or backwards if negative). They start at the first element going in that direction and end after the last element.

pub fn step(&self) -> isize

pub fn resolve_clamped(&self, dim_size: usize) -> Range<usize>

Clamp this range so that it is valid for a dimension of size dim_size and resolve it to a positive range.

This method is useful for implementing Python/NumPy-style slicing where range endpoints can be out of bounds.

pub fn resolve(&self, dim_size: usize) -> Option<Range<usize>>

Resolve the range endpoints to a positive range in [0, dim_size).

Returns the range if resolved or None if out of bounds.

If self.step is positive, the returned range counts forwards from the first index of the dimension, otherwise it counts backwards from the last index.

Trait Implementations

impl Clone for SliceRange

fn clone(&self) -> SliceRange

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SliceRange

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

Formats the value using the given formatter.

impl<T> From<Range<T>> for SliceRange

where T: TryInto<isize>, <T as TryInto<isize>>::Error: Debug,

fn from(r: Range<T>) -> SliceRange

Converts to this type from the input type.

impl<T> From<RangeFrom<T>> for SliceRange

where T: TryInto<isize>, <T as TryInto<isize>>::Error: Debug,

fn from(r: RangeFrom<T>) -> SliceRange

Converts to this type from the input type.

impl From<RangeFull> for SliceRange

fn from(_: RangeFull) -> SliceRange

Converts to this type from the input type.

impl<T> From<RangeTo<T>> for SliceRange

where T: TryInto<isize>, <T as TryInto<isize>>::Error: Debug,

fn from(r: RangeTo<T>) -> SliceRange

Converts to this type from the input type.

impl IndexCount for SliceRange

type Count = U0

Type representing the count value.

fn index_count(&self) -> Option<usize>

Returns Count as a numeric value.

impl IsIndex for SliceRange

type IsIndex = U0

Associated type that is either U0 or U1 indicating whether this type is an index.

impl PartialEq for SliceRange

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for SliceRange

impl StructuralPartialEq for SliceRange