Difference between revisions of "Keep rank.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(Sync syntax/arguments/outputs with current Spinach source)
(Restore pre-bulk-edit wiki content)
Line 1: Line 1:
 
{{DISPLAYTITLE:keep_rank.m}} __NOTOC__
 
{{DISPLAYTITLE:keep_rank.m}} __NOTOC__
−
 
 
Truncates the singular value decomposition at the specified rank and reassembles the matrix.
 
Truncates the singular value decomposition at the specified rank and reassembles the matrix.
  
 
==Syntax==
 
==Syntax==
  
−
A=keep_rank(A,nsvk)
+
    A=keep_rank(A,rank)
  
 
==Arguments==
 
==Arguments==
  
−
A    -  real or complex matrix, will be
+
        A    -  real or complex matrix, will be  
 
                   converted to full if a sparse
 
                   converted to full if a sparse
 
                   matrix is received
 
                   matrix is received
−
 
+
−
         nsvk -  number of singular values to keep
+
         rank -  number of singular values to keep
  
 
==Outputs==
 
==Outputs==
  
−
A    -  filtered matrix, returned as full
+
        A    -  filtered matrix, returned as full
  
 
==See also==
 
==See also==
−
 
 
[[Kernel_utilities#Numerical_infrastructure|Numerical infrastructure]], [[frob_chop.m]], [[ttclass/shrink.m]]
 
[[Kernel_utilities#Numerical_infrastructure|Numerical infrastructure]], [[frob_chop.m]], [[ttclass/shrink.m]]
  
  
 
''Version 2.5, authors: [[Ilya Kuprov]]''
 
''Version 2.5, authors: [[Ilya Kuprov]]''

Revision as of 15:49, 5 April 2026

Truncates the singular value decomposition at the specified rank and reassembles the matrix.

Syntax

    A=keep_rank(A,rank)

Arguments

        A     -  real or complex matrix, will be 
                 converted to full if a sparse
                 matrix is received

        rank  -  number of singular values to keep

Outputs

        A     -  filtered matrix, returned as full

See also

Numerical infrastructure, frob_chop.m, ttclass/shrink.m


Version 2.5, authors: Ilya Kuprov