Difference between revisions of "Clean up.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(Created page with "Array clean-up utility. Drops non-zero elements with magnitude below the user-specified tolerance and converts between sparse and dense represen- tations depending on the dens...")
 
Line 1: Line 1:
−
Array clean-up utility. Drops non-zero elements with magnitude below the
+
{{DISPLAYTITLE:clean_up.m}} __NOTOC__
−
user-specified tolerance and converts between sparse and dense represen-
+
Array clean-up utility. Drops non-zero elements with magnitude below the user-specified tolerance and converts between sparse and full storage de pending on the density of non-zeroes in the array.
−
tations depending on the density of non-zeros in the array. Syntax:
 
  
−
                  A=clean_up(spin_system,A,nonzero_tol)
+
==Syntax==
 +
 
 +
    A=clean_up(spin_system,A,nonzero_tol)
 +
 
 +
==Arguments==
 +
 
 +
    A  - a numerical array or a cell array thereof
 +
 +
    nonzero_tol - nonzero tolerance
 +
 
 +
==Outputs==
 +
 
 +
    A  - cleaned-up array
 +
 
 +
==See also==
 +
[[tolerances.m]], [[mprealloc.m]]
 +
 
 +
 
 +
''Version 2.3, authors: [[Ilya Kuprov]], [[Alex Nevzorov]]''

Revision as of 18:57, 29 December 2018

Array clean-up utility. Drops non-zero elements with magnitude below the user-specified tolerance and converts between sparse and full storage de pending on the density of non-zeroes in the array.

Syntax

    A=clean_up(spin_system,A,nonzero_tol)

Arguments

    A  - a numerical array or a cell array thereof

    nonzero_tol - nonzero tolerance

Outputs

    A  - cleaned-up array

See also

tolerances.m, mprealloc.m


Version 2.3, authors: Ilya Kuprov, Alex Nevzorov