Skip to main content

TTCache

Struct TTCache 

Source
pub struct TTCache<T: TTScalar> { /* private fields */ }
Expand description

Cached tensor train evaluator.

Wraps a tensor train and caches left and right partial contractions so that repeated evaluations sharing common prefixes or suffixes reuse previously computed results. This is particularly effective for batch evaluation via evaluate_many.

§Examples

use tensor4all_simplett::{TensorTrain, AbstractTensorTrain, TTCache};

let tt = TensorTrain::<f64>::constant(&[2, 3, 4], 5.0);
let mut cache = TTCache::new(&tt);

// Single evaluation (caches intermediate contractions)
let val = cache.evaluate(&[1, 2, 3]).unwrap();
assert!((val - 5.0).abs() < 1e-12);

// Batch evaluation reuses cached partial contractions
let indices = vec![vec![0, 0, 0], vec![1, 2, 3], vec![0, 1, 2]];
let vals = cache.evaluate_many(&indices, None).unwrap();
assert!(vals.iter().all(|&v| (v - 5.0).abs() < 1e-12));

Implementations§

Source§

impl<T: TTScalar + EinsumScalar> TTCache<T>

Source

pub fn new<TT: AbstractTensorTrain<T>>(tt: &TT) -> Self

Create a new TTCache from a tensor train

Source

pub fn with_site_dims<TT: AbstractTensorTrain<T>>( tt: &TT, site_dims: Vec<Vec<usize>>, ) -> Result<Self>

Create a new TTCache with custom site dimensions

This allows treating a single tensor site as multiple logical indices.

Source

pub fn len(&self) -> usize

Number of sites

Source

pub fn is_empty(&self) -> bool

Check if empty

Source

pub fn site_dims(&self) -> &[Vec<usize>]

Get site dimensions

Get link dimensions

Get link dimension at position i (between site i and i+1)

Source

pub fn clear_cache(&mut self)

Clear all cached values

Source

pub fn evaluate_left(&mut self, indices: &[LocalIndex]) -> Vec<T>

Evaluate from the left up to (but not including) site end

Returns a vector of size link_dim(end-1) (or 1 if end == 0)

Source

pub fn evaluate_right(&mut self, indices: &[LocalIndex]) -> Vec<T>

Evaluate from the right starting at site start

indices contains indices for sites start to n-1 Returns a vector of size link_dim(start-1) (or 1 if start == n)

Source

pub fn evaluate(&mut self, indices: &[LocalIndex]) -> Result<T>

Evaluate the tensor train at a given index set using cache

Source

pub fn evaluate_many( &mut self, indices: &[MultiIndex], split: Option<usize>, ) -> Result<Vec<T>>

Batch evaluate at multiple index sets

This method efficiently evaluates the tensor train at multiple indices by splitting at a given position and computing unique left/right environments.

§Arguments
  • indices - The indices to evaluate
  • split - Optional split position. If None, uses a simple heuristic (checks 1/4, 1/2, 3/4 positions and picks the best). If you know the optimal split position (e.g., from TCI), pass Some(split) to avoid the search overhead.

Trait Implementations§

Source§

impl<T: Clone + TTScalar> Clone for TTCache<T>

Source§

fn clone(&self) -> TTCache<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + TTScalar> Debug for TTCache<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for TTCache<T>

§

impl<T> RefUnwindSafe for TTCache<T>
where T: RefUnwindSafe,

§

impl<T> Send for TTCache<T>

§

impl<T> Sync for TTCache<T>

§

impl<T> Unpin for TTCache<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for TTCache<T>

§

impl<T> UnwindSafe for TTCache<T>
where T: UnwindSafe,

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>,

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

§

fn by_ref(&self) -> &T

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<T> DistributionExt for T
where T: ?Sized,

§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

§

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

§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

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> 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
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

§

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

§

impl<T> MaybeSend for T

§

impl<T> MaybeSendSync for T

§

impl<T> MaybeSync for T