Enum ShapeExtent 

pub enum ShapeExtent<D> {
    Exact(D),
    UpperBound(D),
    Unknown,
}

A dimension expression plus the guarantee it provides.

Exact means the expression is the runtime size. UpperBound means the runtime size is no larger than the expression. Unknown preserves rank when no useful bound is available.

Examples

use tenferro_ops::shape_extent::ShapeExtent;

let extent = ShapeExtent::exact(4usize);
assert_eq!(extent.as_exact(), Some(&4));

Variants

Exact(D)

The dimension expression is exact.

UpperBound(D)

The dimension expression is an upper bound.

Unknown

The dimension is rank-known but otherwise unknown.

Implementations

impl<D> ShapeExtent<D>

pub fn exact(dim: D) -> Self

Construct an exact extent.

Examples

use tenferro_ops::shape_extent::ShapeExtent;

let extent = ShapeExtent::exact(3usize);
assert!(extent.is_exact());

pub fn upper_bound(dim: D) -> Self

Construct an upper-bound extent.

Examples

use tenferro_ops::shape_extent::ShapeExtent;

let extent = ShapeExtent::upper_bound(3usize);
assert!(!extent.is_exact());

pub fn unknown() -> Self

Construct an unknown extent.

Examples

use tenferro_ops::shape_extent::ShapeExtent;

let extent: ShapeExtent<usize> = ShapeExtent::unknown();
assert_eq!(extent.bound_expr(), None);

pub fn is_exact(&self) -> bool

Return true when this extent is exact.

Examples

use tenferro_ops::shape_extent::ShapeExtent;

assert!(ShapeExtent::exact(2usize).is_exact());
assert!(!ShapeExtent::upper_bound(2usize).is_exact());

pub fn as_exact(&self) -> Option<&D>

Return the exact dimension expression, if this extent is exact.

Examples

use tenferro_ops::shape_extent::ShapeExtent;

assert_eq!(ShapeExtent::exact(5usize).as_exact(), Some(&5));
assert_eq!(ShapeExtent::upper_bound(5usize).as_exact(), None);

pub fn bound_expr(&self) -> Option<&D>

Return the known bound expression, if any.

Examples

use tenferro_ops::shape_extent::ShapeExtent;

assert_eq!(ShapeExtent::upper_bound(5usize).bound_expr(), Some(&5));

pub fn map<E>(self, f: impl FnOnce(D) -> E) -> ShapeExtent<E>

Map the contained dimension expression while preserving exactness.

Examples

use tenferro_ops::shape_extent::ShapeExtent;

let extent = ShapeExtent::upper_bound(5usize).map(|dim| dim + 1);
assert_eq!(extent.bound_expr(), Some(&6));

Trait Implementations

impl<D: Clone> Clone for ShapeExtent<D>

fn clone(&self) -> ShapeExtent<D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D: Debug> Debug for ShapeExtent<D>

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

Formats the value using the given formatter.

impl<D: Hash> Hash for ShapeExtent<D>

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<D: PartialEq> PartialEq for ShapeExtent<D>

fn eq(&self, other: &ShapeExtent<D>) -> 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<D: Eq> Eq for ShapeExtent<D>

impl<D> StructuralPartialEq for ShapeExtent<D>