Skip to main content

DenseElementBudget

Struct DenseElementBudget 

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

Element-count budget for one dense materialization.

A budget is checked against the element count of a dense object (or the total of several) before the allocation. Counts equal to the limit pass; only counts above it fail.

§Examples

use tensor4all_core::{DenseElementBudget, DEFAULT_MAX_DENSE_ELEMENTS};

assert_eq!(
    DenseElementBudget::default().max_elements(),
    DEFAULT_MAX_DENSE_ELEMENTS
);
assert_eq!(DenseElementBudget::unbounded().max_elements(), usize::MAX);

Implementations§

Source§

impl DenseElementBudget

Source

pub const fn new(max_elements: usize) -> Self

Create a budget that admits at most max_elements elements.

new(0) admits only empty objects (an extent of 0 or no objects at all).

Source

pub const fn unbounded() -> Self

Create a budget that admits every object whose element count fits in usize.

Source

pub const fn max_elements(self) -> usize

The maximum element count this budget admits.

Source

pub fn check_dims( self, what: &'static str, dims: &[usize], ) -> Result<usize, DenseBudgetError>

Element count of the dense object with dims, checked against the budget.

dims is the extent of each axis; an empty slice is a scalar (1 element) and any extent of 0 is an empty object (0 elements).

§Errors

Returns DenseBudgetError::Overflow when the element count does not fit in usize, and DenseBudgetError::Exceeded when it is above Self::max_elements.

§Examples
use tensor4all_core::{DenseBudgetError, DenseElementBudget};

let budget = DenseElementBudget::new(4);
assert_eq!(budget.check_dims("density", &[2, 2]).unwrap(), 4);
assert_eq!(budget.check_dims("scalar", &[]).unwrap(), 1);
assert_eq!(budget.check_dims("empty", &[0, 9]).unwrap(), 0);
assert_eq!(
    budget.check_dims("density", &[2, 3]),
    Err(DenseBudgetError::Exceeded {
        what: "density",
        elements: 6,
        max_elements: 4,
    })
);
Source

pub fn check_total<'a>( self, what: &'static str, objects: impl IntoIterator<Item = &'a [usize]>, ) -> Result<usize, DenseBudgetError>

Total element count of several dense objects, checked against the budget once.

Use this when one operation allocates a list of dense objects whose sum, not any single object, is the cost.

§Errors

Returns DenseBudgetError::Overflow when the total does not fit in usize, and DenseBudgetError::Exceeded when it is above Self::max_elements.

§Examples
use tensor4all_core::DenseElementBudget;

let budget = DenseElementBudget::new(8);
let sites = [[1usize, 4, 1].as_slice(), [1, 4, 1].as_slice()];
assert_eq!(budget.check_total("mpo", sites).unwrap(), 8);
assert_eq!(
    budget.check_total("mpo", std::iter::once(sites[0])).unwrap(),
    4
);
assert!(DenseElementBudget::new(7).check_total("mpo", sites).is_err());

Trait Implementations§

Source§

impl Clone for DenseElementBudget

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 DenseElementBudget

Source§

impl Debug for DenseElementBudget

Source§

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

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

impl Default for DenseElementBudget

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for DenseElementBudget

Source§

impl Hash for DenseElementBudget

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for DenseElementBudget

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 DenseElementBudget

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
§

impl<U> As for U

§

fn as_<T>(self) -> T
where T: CastFrom<U>, U: Sized,

Casts self to type T. The semantics of numeric casting with the as operator are followed, so <T as As>::as_::<U> can be used in the same way as T as U for numeric conversions. Read more
§

impl<T> Boilerplate for T
where T: Copy + Send + Sync + Debug + PartialEq + 'static,

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
§

impl<T> ByRef<T> for T

§

fn by_ref(&self) -> &T

§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

§

fn simd_from(_simd: S, value: T) -> T

§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

§

fn simd_into(self, simd: S) -> T

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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V