Skip to main content

SiteTensorTrain

Struct SiteTensorTrain 

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

Site Tensor Train with center canonical form

A tensor train where:

  • Tensors at indices < center are left-orthogonal
  • Tensors at indices > center are right-orthogonal
  • The tensor at the center index is the “center” tensor

§Examples

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

// Build a constant tensor train and convert to center-canonical form.
let tt = TensorTrain::<f64>::constant(&[2, 3, 4], 1.0);
let stt = SiteTensorTrain::from_tensor_train(&tt, 1).unwrap();

// The center is at site 1.
assert_eq!(stt.center(), 1);
assert_eq!(stt.len(), 3);

// Converting back preserves tensor train values.
let tt2 = stt.to_tensor_train();
let val = tt2.evaluate(&[0, 1, 2]).unwrap();
assert!((val - 1.0).abs() < 1e-12);

Implementations§

Source§

impl<T: TTScalar + Scalar + Default> SiteTensorTrain<T>

Source

pub fn new(tensors: Vec<Tensor3<T>>, center: usize) -> Result<Self>

Create a new SiteTensorTrain from tensors with specified center

Source

pub fn from_tensor_train(tt: &TensorTrain<T>, center: usize) -> Result<Self>

Create from TensorTrain with specified center

Source

pub fn center(&self) -> usize

Get the center index

Source

pub fn partition(&self) -> &Range<usize>

Get the partition range

Source

pub fn site_tensors_mut(&mut self) -> &mut [Tensor3<T>]

Get mutable access to site tensors

Source

pub fn move_center_right(&mut self) -> Result<()>

Move the center one position to the right

Source

pub fn move_center_left(&mut self) -> Result<()>

Move the center one position to the left

Source

pub fn set_center(&mut self, new_center: usize) -> Result<()>

Move the center to a specific position

Source

pub fn to_tensor_train(&self) -> TensorTrain<T>

Convert to a regular TensorTrain

Source

pub fn set_site_tensor(&mut self, i: usize, tensor: Tensor3<T>)

Set the tensor at a specific site

Note: This may invalidate the canonical form. Use with caution.

Source

pub fn set_two_site_tensors( &mut self, i: usize, tensor1: Tensor3<T>, tensor2: Tensor3<T>, ) -> Result<()>

Set two adjacent site tensors (useful for TEBD-like algorithms)

Trait Implementations§

Source§

impl<T: TTScalar + Scalar + Default> AbstractTensorTrain<T> for SiteTensorTrain<T>

Source§

fn len(&self) -> usize

Number of sites (core tensors) in the tensor train.
Source§

fn site_tensor(&self, i: usize) -> &Tensor3<T>

Borrow the rank-3 core tensor at site i.
Source§

fn site_tensors(&self) -> &[Tensor3<T>]

Borrow all core tensors as a slice.
Source§

fn is_empty(&self) -> bool

Returns true if the tensor train has zero sites.
Bond dimensions at every link (length = len() - 1).
Bond dimension at the link between site i and site i+1.
Source§

fn site_dims(&self) -> Vec<usize>

Physical (site) dimensions for every site.
Source§

fn site_dim(&self, i: usize) -> usize

Physical (site) dimension at site i.
Source§

fn rank(&self) -> usize

Maximum bond dimension across all links.
Source§

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

Evaluate the tensor train at a given index set Read more
Source§

fn sum(&self) -> T

Sum over all indices of the tensor train Read more
Source§

fn norm2(&self) -> f64

Squared Frobenius norm: sum_i |T[i]|^2. Read more
Source§

fn norm(&self) -> f64

Frobenius norm: sqrt(sum_i |T[i]|^2). Read more
Source§

fn log_norm(&self) -> f64

Logarithm of the Frobenius norm: ln(norm()). Read more
Source§

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

Source§

fn clone(&self) -> SiteTensorTrain<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 SiteTensorTrain<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 SiteTensorTrain<T>

§

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

§

impl<T> Send for SiteTensorTrain<T>

§

impl<T> Sync for SiteTensorTrain<T>

§

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

§

impl<T> UnsafeUnpin for SiteTensorTrain<T>

§

impl<T> UnwindSafe for SiteTensorTrain<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