Difference between revisions of "Kq2lin.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(Fix lead description from MATLAB header (folding/hyphenation pass))
(Normalise sequential blank lines)
Line 33: Line 33:
 
* [[oper2bm.m]]
 
* [[oper2bm.m]]
 
* [[enlev2bm.m]]
 
* [[enlev2bm.m]]
 
 
  
 
''Version 2.11, authors: [[Ilya Kuprov]]''
 
''Version 2.11, authors: [[Ilya Kuprov]]''

Revision as of 12:27, 25 April 2026

Converts k,q indexing of matrices into their linear serpentine indexing. In base 1 indexing convention: (1,1)(1,2)(1,3) (1)(3)(6) (2,1)(2,2)(2,3) <=> (2)(5)(8) (3,1)(3,2)(3,3) (4)(7)(9) and in base 0 indexing convention: (0,0)(0,1)(0,2) (0)(2)(5) (1,0)(1,1)(1,2) <=> (1)(4)(7) (2,0)(2,1)(2,2) (3)(6)(8).

Syntax

                     I=kq2lin(N,K,Q,idx_base)

Arguments

            N   - matrix dimension, a scalar
            K   - first index, positive integer
                  array of any size
            Q   - second index, positive integer
                  array of the same size as K
       idx_base - indexing base, 0 or 1

Outputs

            I   - linear serpentine index, an ar-
                  ray of the same size as inputs

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

Version 2.11, authors: Ilya Kuprov