Struct tc_tensor::Bounds

pub struct Bounds {
    pub axes: Vec<AxisBounds>,
}

Tensor bounds

Fields

axes: Vec<AxisBounds>

Implementations

impl Bounds

pub fn all(shape: &Shape) -> Bounds

The bounds of the entire Tensor with the given Shape

pub fn affected(&self) -> MultiProduct<AxisIter>

Return an iterator over all the Coords within these Bounds.

pub fn contains_coord(&self, coord: &[u64]) -> bool

Return true if these bounds contain the given coordinate.

pub fn as_coord(&self) -> Option<Coord>

Return Some(Coord) if these bounds match a single Coord, otherwise None

pub fn normalize(&mut self, shape: &Shape)

Expand these Bounds to the entire given Shape.

Example:

let mut bounds = Bounds::from(&[0u64][..]);
assert_eq!(bounds.to_shape(&Shape::from(vec![2, 3, 4])).unwrap(), Shape::from(vec![3, 4]));

pub fn to_shape(&self, source_shape: &Shape) -> TCResult<Shape>

Return the Shape of the Tensor slice with these Bounds.

pub fn size(&self) -> u64

Return the size of the slice with these Bounds, assuming they are of the same length as the source shape.

Trait Implementations

impl Clone for Bounds

fn clone(&self) -> Bounds

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bounds

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

Formats the value using the given formatter.

impl Default for Bounds

fn default() -> Self

Returns the “default value” for a type.

impl Deref for Bounds

type Target = Vec<AxisBounds>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Bounds

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for Bounds

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

Formats the value using the given formatter.

impl From<&'_ [u64]> for Bounds

fn from(coord: &[u64]) -> Bounds

Performs the conversion.

impl From<(AxisBounds, Vec<u64, Global>)> for Bounds

fn from(tuple: (AxisBounds, Vec<u64>)) -> Bounds

Performs the conversion.

impl From<(Vec<u64, Global>, Vec<u64, Global>)> for Bounds

fn from(bounds: (Vec<u64>, Vec<u64>)) -> Bounds

Performs the conversion.

impl From<Vec<AxisBounds, Global>> for Bounds

fn from(axes: Vec<AxisBounds>) -> Bounds

Performs the conversion.

impl From<Vec<u64, Global>> for Bounds

fn from(coord: Vec<u64>) -> Bounds

Performs the conversion.

impl PartialEq<Bounds> for Bounds

fn eq(&self, other: &Self) -> 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 !=.

impl TryCastFrom<Value> for Bounds

fn can_cast_from(value: &Value) -> bool

Test if value can be cast into Self.

fn opt_cast_from(value: Value) -> Option<Bounds>

Returns Some(Self) if the source value can be cast into Self, otherwise None.

fn try_cast_from<Err, OnErr>(value: T, on_err: OnErr) -> Result<Self, Err> where
    OnErr: FnOnce(&T) -> Err, 

Returns Ok(Self) if the source value can be cast into Self, otherwise calls on_err.