Difference between revisions of "Lin2kq.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(Normalise sequential blank lines)
m (Rename Arguments section heading to Parameters)
Line 6: Line 6:
 
                     [K,Q]=lin2kq(N,I,idx_base)
 
                     [K,Q]=lin2kq(N,I,idx_base)
  
==Arguments==
+
==Parameters==
  
 
             N  - matrix dimension
 
             N  - matrix dimension

Revision as of 18:50, 5 June 2026

Converts linear serpentine indexing of matrices into their k,q 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

                   [K,Q]=lin2kq(N,I,idx_base)

Parameters

            N   - matrix dimension
            I   - linear serpentine indices, an
                  array of integers
       idx_base - indexing base, 0 or 1

Outputs

            K   - row indices, an array of the
                  same size as I
            Q   - col indices, an array of the
                  same size as I

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