Skip to main content

StridedSliceSpec

Struct StridedSliceSpec 

Source
pub struct StridedSliceSpec { /* private fields */ }
Expand description

One-axis slice specification for typed view slicing.

start and end always name the ascending half-open interval [start, end) on the axis, with negative bounds counting from the end of the axis; a negative step then walks that interval in reverse. The endpoint roles therefore do not depend on the sign of step, and this is not ndarray’s range-with-step model, where a negative step makes start the high endpoint and end the low one. Full-axis reversal is StridedSliceSpec::reverse (new(0, None, -1)); under the ndarray model that spelling would select only the first element.

§Examples

use tenferro_tensor::{StridedSliceSpec, TypedTensorView};

let data = [0_i32, 1, 2, 3, 4, 5];
let view = TypedTensorView::from_slice(vec![6], vec![1], 0, &data)?;

// Ascending selection `[0, 3)` walked backwards with step -2: 2, 0.
let reversed = view.slice_view(&[StridedSliceSpec::new(0, Some(3), -2)])?;
assert_eq!(reversed.shape(), &[2]);
assert_eq!(reversed.get(&[0]), Some(&2));
assert_eq!(reversed.get(&[1]), Some(&0));

// `start` is the low endpoint even for a negative step, so a range that
// looks descending under ndarray's model is empty here.
let empty = view.slice_view(&[StridedSliceSpec::new(4, Some(1), -1)])?;
assert_eq!(empty.shape(), &[0]);

Implementations§

Source§

impl StridedSliceSpec

Source

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

Create a slice from a signed start, optional exclusive end, and step.

start and end are the low and high endpoints of the ascending half-open interval [start, end); a negative step reverses that interval instead of re-reading the endpoints as high and low. See the type documentation for the full model.

§Examples
use tenferro_tensor::StridedSliceSpec;

let slice = StridedSliceSpec::new(1, Some(-1), 1);
assert_eq!(slice.start(), 1);
assert_eq!(slice.end(), Some(-1));
Source

pub fn all() -> Self

Select the full axis.

§Examples
use tenferro_tensor::StridedSliceSpec;

assert_eq!(StridedSliceSpec::all(), StridedSliceSpec::new(0, None, 1));
Source

pub fn reverse() -> Self

Select the full axis in reverse order.

§Examples
use tenferro_tensor::StridedSliceSpec;

assert_eq!(StridedSliceSpec::reverse(), StridedSliceSpec::new(0, None, -1));
Source

pub fn start(&self) -> isize

Return the signed start bound.

§Examples
use tenferro_tensor::StridedSliceSpec;

assert_eq!(StridedSliceSpec::new(-3, None, 1).start(), -3);
Source

pub fn end(&self) -> Option<isize>

Return the optional signed exclusive end bound.

§Examples
use tenferro_tensor::StridedSliceSpec;

assert_eq!(StridedSliceSpec::new(0, Some(2), 1).end(), Some(2));
Source

pub fn step(&self) -> isize

Return the signed step.

§Examples
use tenferro_tensor::StridedSliceSpec;

assert_eq!(StridedSliceSpec::reverse().step(), -1);

Trait Implementations§

Source§

impl Clone for StridedSliceSpec

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for StridedSliceSpec

Source§

impl Debug for StridedSliceSpec

Source§

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

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

impl Eq for StridedSliceSpec

Source§

impl PartialEq for StridedSliceSpec

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for StridedSliceSpec

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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 T
where 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 T
where T: Clone,

Source§

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 T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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.