Skip to main content

TruncateUpdater

Struct TruncateUpdater 

Source
pub struct TruncateUpdater {
    pub max_rank: Option<usize>,
    pub svd_policy: Option<SvdTruncationPolicy>,
}
Expand description

Truncation updater for nsite=2 sweeps.

This updater performs SVD-based truncation on two-site subtrees, compressing bond dimensions while preserving the tensor train structure.

§Algorithm

For each step with nodes [A, B] where B is the new center:

  1. Contract tensors A and B into a single tensor AB
  2. Factorize AB using SVD with truncation (left indices = A’s external + bond to A’s other neighbors)
  3. The left tensor becomes the new A, the right tensor becomes the new B
  4. B is the orthogonality center (isometry pointing towards B)

§Usage

use tensor4all_core::{DynIndex, TensorDynLen};
use tensor4all_treetn::{apply_local_update_sweep, LocalUpdateSweepPlan, TreeTN, TruncateUpdater};

let s0 = DynIndex::new_dyn(2);
let bond = DynIndex::new_dyn(1);
let s1 = DynIndex::new_dyn(2);
let t0 = TensorDynLen::from_dense(vec![s0, bond.clone()], vec![1.0, 0.0])?;
let t1 = TensorDynLen::from_dense(vec![bond, s1], vec![1.0, 0.0])?;
let mut treetn = TreeTN::<TensorDynLen, usize>::from_tensors(vec![t0, t1], vec![0, 1])?;
treetn.canonicalize_mut(std::iter::once(0usize), Default::default())?;

let plan = LocalUpdateSweepPlan::from_treetn(&treetn, &0usize, 2).unwrap();
let mut updater = TruncateUpdater::new(
    Some(4),
    Some(tensor4all_core::SvdTruncationPolicy::new(1e-10)),
);
apply_local_update_sweep(&mut treetn, &plan, &mut updater)?;

assert_eq!(treetn.node_count(), 2);

Fields§

§max_rank: Option<usize>

Maximum bond dimension after truncation.

§svd_policy: Option<SvdTruncationPolicy>

Explicit SVD truncation policy.

Implementations§

Source§

impl TruncateUpdater

Source

pub fn new( max_rank: Option<usize>, svd_policy: Option<SvdTruncationPolicy>, ) -> Self

Create a new truncation updater.

§Arguments
  • max_rank - Maximum bond dimension (None for no limit)
  • svd_policy - SVD truncation policy override (None uses the global default)

Trait Implementations§

Source§

impl Clone for TruncateUpdater

Source§

fn clone(&self) -> TruncateUpdater

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 Debug for TruncateUpdater

Source§

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

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

impl<T, V> LocalUpdater<T, V> for TruncateUpdater
where T: TensorLike, <T::Index as IndexLike>::Id: Clone + Hash + Eq + Ord + Debug + Send + Sync, V: Clone + Hash + Eq + Ord + Send + Sync + Debug,

Source§

fn update( &mut self, subtree: TreeTN<T, V>, step: &LocalUpdateStep<V>, _full_treetn: &TreeTN<T, V>, ) -> Result<TreeTN<T, V>>

Update a local subtree. Read more
Source§

fn before_step( &mut self, _step: &LocalUpdateStep<V>, _full_treetn_before: &TreeTN<T, V>, ) -> Result<()>

Optional hook called before performing an update step. Read more
Source§

fn after_step( &mut self, _step: &LocalUpdateStep<V>, _full_treetn_after: &TreeTN<T, V>, ) -> Result<()>

Optional hook called after an update step has been applied to the full TreeTN. Read more

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

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

§

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

§

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