Enum ndarray::SliceOrIndex [−][src]
A slice (range with step) or an index.
See also the s![]
macro for a convenient way to create a
&SliceInfo<[SliceOrIndex; n], D>
.
Examples
SliceOrIndex::Index(a)
is the index a
. It can also be created with
SliceOrIndex::from(a)
. The Python equivalent is [a]
. The macro
equivalent is s![a]
.
SliceOrIndex::Slice { start: 0, end: None, step: 1 }
is the full range of
an axis. It can also be created with SliceOrIndex::from(..)
. The Python
equivalent is [:]
. The macro equivalent is s![..]
.
SliceOrIndex::Slice { start: a, end: Some(b), step: 2 }
is every second
element from a
until b
. It can also be created with
SliceOrIndex::from(a..b).step_by(2)
. The Python equivalent is [a:b:2]
.
The macro equivalent is s![a..b;2]
.
SliceOrIndex::Slice { start: a, end: None, step: -1 }
is every element,
from a
until the end, in reverse order. It can also be created with
SliceOrIndex::from(a..).step_by(-1)
. The Python equivalent is [a::-1]
.
The macro equivalent is s![a..;-1]
.
Variants
Slice
A range with step size. end
is an exclusive index. Negative begin
or end
indexes are counted from the back of the axis. If end
is
None
, the slice extends to the end of the axis.
Fields of Slice
start: isize | |
end: Option<isize> | |
step: isize |
Index(isize)
A single index.
Methods
impl SliceOrIndex
[src]
impl SliceOrIndex
pub fn is_slice(&self) -> bool
[src]
pub fn is_slice(&self) -> bool
Returns true
if self
is a Slice
value.
pub fn is_index(&self) -> bool
[src]
pub fn is_index(&self) -> bool
Returns true
if self
is an Index
value.
pub fn step_by(self, step: isize) -> Self
[src]
pub fn step_by(self, step: isize) -> Self
Returns a new SliceOrIndex
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 Debug for SliceOrIndex
[src]
impl Debug for SliceOrIndex
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl PartialEq for SliceOrIndex
[src]
impl PartialEq for SliceOrIndex
fn eq(&self, other: &SliceOrIndex) -> bool
[src]
fn eq(&self, other: &SliceOrIndex) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &SliceOrIndex) -> bool
[src]
fn ne(&self, other: &SliceOrIndex) -> bool
This method tests for !=
.
impl Eq for SliceOrIndex
[src]
impl Eq for SliceOrIndex
impl Hash for SliceOrIndex
[src]
impl Hash for SliceOrIndex
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
fn hash<__H: Hasher>(&self, state: &mut __H)
Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl Copy for SliceOrIndex
[src]
impl Copy for SliceOrIndex
impl Clone for SliceOrIndex
[src]
impl Clone for SliceOrIndex
fn clone(&self) -> Self
[src]
fn clone(&self) -> Self
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Display for SliceOrIndex
[src]
impl Display for SliceOrIndex
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl From<Range<isize>> for SliceOrIndex
[src]
impl From<Range<isize>> for SliceOrIndex
fn from(r: Range<isize>) -> SliceOrIndex
[src]
fn from(r: Range<isize>) -> SliceOrIndex
Performs the conversion.
impl From<RangeInclusive<isize>> for SliceOrIndex
[src]
impl From<RangeInclusive<isize>> for SliceOrIndex
fn from(r: RangeInclusive<isize>) -> SliceOrIndex
[src]
fn from(r: RangeInclusive<isize>) -> SliceOrIndex
Performs the conversion.
impl From<RangeFrom<isize>> for SliceOrIndex
[src]
impl From<RangeFrom<isize>> for SliceOrIndex
fn from(r: RangeFrom<isize>) -> SliceOrIndex
[src]
fn from(r: RangeFrom<isize>) -> SliceOrIndex
Performs the conversion.
impl From<RangeTo<isize>> for SliceOrIndex
[src]
impl From<RangeTo<isize>> for SliceOrIndex
fn from(r: RangeTo<isize>) -> SliceOrIndex
[src]
fn from(r: RangeTo<isize>) -> SliceOrIndex
Performs the conversion.
impl From<RangeToInclusive<isize>> for SliceOrIndex
[src]
impl From<RangeToInclusive<isize>> for SliceOrIndex
fn from(r: RangeToInclusive<isize>) -> SliceOrIndex
[src]
fn from(r: RangeToInclusive<isize>) -> SliceOrIndex
Performs the conversion.
impl From<Range<usize>> for SliceOrIndex
[src]
impl From<Range<usize>> for SliceOrIndex
fn from(r: Range<usize>) -> SliceOrIndex
[src]
fn from(r: Range<usize>) -> SliceOrIndex
Performs the conversion.
impl From<RangeInclusive<usize>> for SliceOrIndex
[src]
impl From<RangeInclusive<usize>> for SliceOrIndex
fn from(r: RangeInclusive<usize>) -> SliceOrIndex
[src]
fn from(r: RangeInclusive<usize>) -> SliceOrIndex
Performs the conversion.
impl From<RangeFrom<usize>> for SliceOrIndex
[src]
impl From<RangeFrom<usize>> for SliceOrIndex
fn from(r: RangeFrom<usize>) -> SliceOrIndex
[src]
fn from(r: RangeFrom<usize>) -> SliceOrIndex
Performs the conversion.
impl From<RangeTo<usize>> for SliceOrIndex
[src]
impl From<RangeTo<usize>> for SliceOrIndex
fn from(r: RangeTo<usize>) -> SliceOrIndex
[src]
fn from(r: RangeTo<usize>) -> SliceOrIndex
Performs the conversion.
impl From<RangeToInclusive<usize>> for SliceOrIndex
[src]
impl From<RangeToInclusive<usize>> for SliceOrIndex
fn from(r: RangeToInclusive<usize>) -> SliceOrIndex
[src]
fn from(r: RangeToInclusive<usize>) -> SliceOrIndex
Performs the conversion.
impl From<Range<i32>> for SliceOrIndex
[src]
impl From<Range<i32>> for SliceOrIndex
fn from(r: Range<i32>) -> SliceOrIndex
[src]
fn from(r: Range<i32>) -> SliceOrIndex
Performs the conversion.
impl From<RangeInclusive<i32>> for SliceOrIndex
[src]
impl From<RangeInclusive<i32>> for SliceOrIndex
fn from(r: RangeInclusive<i32>) -> SliceOrIndex
[src]
fn from(r: RangeInclusive<i32>) -> SliceOrIndex
Performs the conversion.
impl From<RangeFrom<i32>> for SliceOrIndex
[src]
impl From<RangeFrom<i32>> for SliceOrIndex
fn from(r: RangeFrom<i32>) -> SliceOrIndex
[src]
fn from(r: RangeFrom<i32>) -> SliceOrIndex
Performs the conversion.
impl From<RangeTo<i32>> for SliceOrIndex
[src]
impl From<RangeTo<i32>> for SliceOrIndex
fn from(r: RangeTo<i32>) -> SliceOrIndex
[src]
fn from(r: RangeTo<i32>) -> SliceOrIndex
Performs the conversion.
impl From<RangeToInclusive<i32>> for SliceOrIndex
[src]
impl From<RangeToInclusive<i32>> for SliceOrIndex
fn from(r: RangeToInclusive<i32>) -> SliceOrIndex
[src]
fn from(r: RangeToInclusive<i32>) -> SliceOrIndex
Performs the conversion.
impl From<RangeFull> for SliceOrIndex
[src]
impl From<RangeFull> for SliceOrIndex
fn from(_: RangeFull) -> SliceOrIndex
[src]
fn from(_: RangeFull) -> SliceOrIndex
Performs the conversion.
impl From<Slice> for SliceOrIndex
[src]
impl From<Slice> for SliceOrIndex
fn from(s: Slice) -> SliceOrIndex
[src]
fn from(s: Slice) -> SliceOrIndex
Performs the conversion.
impl From<isize> for SliceOrIndex
[src]
impl From<isize> for SliceOrIndex
fn from(r: isize) -> SliceOrIndex
[src]
fn from(r: isize) -> SliceOrIndex
Performs the conversion.
impl From<usize> for SliceOrIndex
[src]
impl From<usize> for SliceOrIndex
fn from(r: usize) -> SliceOrIndex
[src]
fn from(r: usize) -> SliceOrIndex
Performs the conversion.
impl From<i32> for SliceOrIndex
[src]
impl From<i32> for SliceOrIndex
fn from(r: i32) -> SliceOrIndex
[src]
fn from(r: i32) -> SliceOrIndex
Performs the conversion.
Auto Trait Implementations
impl Send for SliceOrIndex
impl Send for SliceOrIndex
impl Sync for SliceOrIndex
impl Sync for SliceOrIndex