Difference between revisions of "Rcv/rcv.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(Sync syntax/arguments/outputs with current Spinach source)
(Update function See also links and function index membership)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:rcv/rcv.m}} __NOTOC__
 
{{DISPLAYTITLE:rcv/rcv.m}} __NOTOC__
 
 
Creates an RCV (row-column-value storage) sparse matrix.
 
Creates an RCV (row-column-value storage) sparse matrix.
  
 
==Syntax==
 
==Syntax==
  
obj=rcv(varargin)
+
                          obj=rcv(M)
 +
                          obj=rcv(dim1,dim2)
 +
                          obj=rcv(R,C,V,dim1,dim2)
  
==Arguments==
+
==Parameters==
  
M      - a Matlab matrix
+
        M      - a Matlab matrix
 
         dim1  - number of rows
 
         dim1  - number of rows
 
         dim2  - number of columns
 
         dim2  - number of columns
Line 18: Line 19:
 
==Outputs==
 
==Outputs==
  
obj    - an RCV sparse matrix object
+
        obj    - an RCV sparse matrix object
  
 
==Examples==
 
==Examples==
 
 
See examples in the Spinach distribution relevant to this function.
 
See examples in the Spinach distribution relevant to this function.
  
 
==Notes==
 
==Notes==
 
 
This page was generated from the function header in the Spinach repository.
 
This page was generated from the function header in the Spinach repository.
  
 
==See also==
 
==See also==
 
+
[[rcv/mtimes.m]], [[rcv/plus.m]], [[rcv/minus.m]], [[rcv/times.m]], [[rcv/rdivide.m]], [[rcv/sparse.m]], [[rcv/full.m]], [[rcv/transpose.m]], [[rcv/ctranspose.m]], [[rcv/gather.m]], [[rcv/gpuArray.m]], [[rcv/horzcat.m]], [[rcv/kron.m]], [[rcv/nnz.m]], [[rcv/size.m]], [[rcv/spy.m]], [[rcv/vertcat.m]], [[Appendix_H:_Matlab_object_overloads]], [[Kernel_utilities]], [[Main_Page]]
* [[rcv/mtimes.m]]
 
* [[rcv/plus.m]]
 
* [[rcv/minus.m]]
 
* [[rcv/times.m]]
 
* [[rcv/rdivide.m]]
 
* [[rcv/sparse.m]]
 
* [[rcv/full.m]]
 
* [[rcv/transpose.m]]
 
* [[Kernel_utilities]]
 
* [[Main_Page]]
 
 
 
 
 
  
 
''Version 2.11, authors: M Keitel''
 
''Version 2.11, authors: M Keitel''

Latest revision as of 19:40, 6 June 2026

Creates an RCV (row-column-value storage) sparse matrix.

Syntax

                          obj=rcv(M)
                          obj=rcv(dim1,dim2)
                          obj=rcv(R,C,V,dim1,dim2)

Parameters

       M      - a Matlab matrix
       dim1   - number of rows
       dim2   - number of columns
       R      - row indices of non-zero entries
       C      - column indices of non-zero entries
       V      - values corresponding to entries in R and C

Outputs

       obj    - an RCV sparse matrix object

Examples

See examples in the Spinach distribution relevant to this function.

Notes

This page was generated from the function header in the Spinach repository.

See also

rcv/mtimes.m, rcv/plus.m, rcv/minus.m, rcv/times.m, rcv/rdivide.m, rcv/sparse.m, rcv/full.m, rcv/transpose.m, rcv/ctranspose.m, rcv/gather.m, rcv/gpuArray.m, rcv/horzcat.m, rcv/kron.m, rcv/nnz.m, rcv/size.m, rcv/spy.m, rcv/vertcat.m, Appendix_H:_Matlab_object_overloads, Kernel_utilities, Main_Page

Version 2.11, authors: M Keitel