Difference between revisions of "Ttclass/ttort.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(→‎See also)
(sync with Spinach main f053e432: direct argument is mandatory, no default; the two direction lines separated)
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
{{DISPLAYTITLE:ttclass/ttclass_ort.m}}
+
{{DISPLAYTITLE:ttclass/ttort.m}} __NOTOC__
−
Performs TT-orthogonalisation for a tensor train (or for each tensor train in a buffered sum).
+
Performs TT-orthogonalisation for a tensor train (or for each tensor
 +
train in a buffered sum).
  
 
==Syntax==
 
==Syntax==
  
−
     [tt,lognrm]=ttclass_ort(tt,direct)
+
     [tt,lognrm]=ttort(tt,direct)
  
−
==Arguments==
+
==Parameters==
  
−
    direct=+1 - {default} gives you left-to-right orthogonality,
+
    direct=+1 - gives left-to-right orthogonality,
−
    direct=-1 - gives right-to-left orthogonality
+
    direct=-1 - gives right-to-left orthogonality
 
   
 
   
−
    tt     - tensor train object, possibly with buffered sums
+
    tt       - tensor train object, possibly with buffered sums
  
 
==Outputs==
 
==Outputs==
  
−
    tt    - tensor train object with all terms in the buffe-
+
    tt    - tensor train object with all terms in the buffe-
−
            red sum has all of them orthogonalised in the  
+
              red sum has all of them orthogonalised in the
−
            direction requested
+
              direction requested
 
   
 
   
−
    lognrm - if this output is present, all buffered trains  
+
    lognrm - if this output is present, all buffered trains
−
            are also normalized, and natural logs of their
+
              are also normalized, and natural logs of their
−
            norms returned in the vector lognrm. Use this
+
              norms returned in the vector lognrm. Use this
−
            option if the tensor norm is likely to exceed
+
              option if the tensor norm is likely to exceed
−
            realmax()=1.7977e+308.
+
              realmax()=1.7977e+308.
  
 
==Notes==
 
==Notes==
−
Normally you should not call this subroutine directly.
+
normally you should not call this subroutine directly.
  
 
==See also==
 
==See also==
−
[[ttclass.m]]
+
[[ttclass.m]], [[ttclass/amensolve.m]], [[ttclass/amensum.m]], [[ttclass/clearcoeff.m]], [[ttclass/conj.m]], [[ttclass/ctranspose.m]], [[ttclass/diag.m]], [[ttclass/dot.m]], [[ttclass/full.m]], [[ttclass/hdot.m]], [[ttclass/ismatrix.m]], [[ttclass/isnumeric.m]], [[ttclass/isreal.m]], [[ttclass/kron.m]], [[ttclass/mean.m]], [[ttclass/minus.m]], [[ttclass/mldivide.m]], [[ttclass/mrdivide.m]], [[ttclass/mtimes.m]], [[ttclass/nnz.m]], [[ttclass/norm.m]], [[ttclass/numel.m]], [[ttclass/pack.m]], [[ttclass/plus.m]], [[ttclass/rand.m]], [[ttclass/ranks.m]], [[ttclass/rdivide.m]], [[ttclass/revert.m]], [[ttclass/shrink.m]], [[ttclass/size.m]], [[ttclass/sizes.m]], [[ttclass/subsref.m]], [[ttclass/sum.m]], [[ttclass/trace.m]], [[ttclass/transpose.m]], [[ttclass/truncate.m]], [[ttclass/unit_like.m]], [[ttclass/vec.m]], [[Tensor_train_module]]
−
 
 
  
 
''Version 2.1, authors: [[Ilya Kuprov]], [[Dmitry Savostyanov]]''
 
''Version 2.1, authors: [[Ilya Kuprov]], [[Dmitry Savostyanov]]''

Latest revision as of 08:47, 30 August 2026

Performs TT-orthogonalisation for a tensor train (or for each tensor train in a buffered sum).

Syntax

    [tt,lognrm]=ttort(tt,direct)

Parameters

    direct=+1 - gives left-to-right orthogonality,
    direct=-1 - gives right-to-left orthogonality

    tt        - tensor train object, possibly with buffered sums

Outputs

    tt     - tensor train object with all terms in the buffe-
             red sum has all of them orthogonalised in the
             direction requested

    lognrm - if this output is present, all buffered trains
             are also normalized, and natural logs of their
             norms returned in the vector lognrm. Use this
             option if the tensor norm is likely to exceed
             realmax()=1.7977e+308.

Notes

normally you should not call this subroutine directly.

See also

ttclass.m, ttclass/amensolve.m, ttclass/amensum.m, ttclass/clearcoeff.m, ttclass/conj.m, ttclass/ctranspose.m, ttclass/diag.m, ttclass/dot.m, ttclass/full.m, ttclass/hdot.m, ttclass/ismatrix.m, ttclass/isnumeric.m, ttclass/isreal.m, ttclass/kron.m, ttclass/mean.m, ttclass/minus.m, ttclass/mldivide.m, ttclass/mrdivide.m, ttclass/mtimes.m, ttclass/nnz.m, ttclass/norm.m, ttclass/numel.m, ttclass/pack.m, ttclass/plus.m, ttclass/rand.m, ttclass/ranks.m, ttclass/rdivide.m, ttclass/revert.m, ttclass/shrink.m, ttclass/size.m, ttclass/sizes.m, ttclass/subsref.m, ttclass/sum.m, ttclass/trace.m, ttclass/transpose.m, ttclass/truncate.m, ttclass/unit_like.m, ttclass/vec.m, Tensor_train_module

Version 2.1, authors: Ilya Kuprov, Dmitry Savostyanov