Difference between revisions of "Serpentine.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(Normalise sequential blank lines)
m (Rename Arguments section heading to Parameters)
Line 6: Line 6:
 
                   S=serpentine(nlevels,idx_base)
 
                   S=serpentine(nlevels,idx_base)
  
==Arguments==
+
==Parameters==
  
 
         nlevels  - dimension of the matrix, a
 
         nlevels  - dimension of the matrix, a

Revision as of 18:52, 5 June 2026

Serpentine index matrix used in Spinach for single-index numbering of matrix elements.

Syntax

                 S=serpentine(nlevels,idx_base)

Parameters

       nlevels  - dimension of the matrix, a
                  positive real integer
       idx_base - indexing base, 0 or 1

Outputs

       S        - serpentine matrix, for example (base 1):
                           (1 )(3 )(6 )(10)
                           (2 )(5 )(9 )(13)
                           (4 )(8 )(12)(15)
                           (7 )(11)(14)(16)
                  or (with indexing set to base 0):
                           (0 )(2 )(5 )(9 )
                           (1 )(4 )(8 )(12)
                           (3 )(7 )(11)(14)
                           (6 )(10)(13)(15)

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