From a13f90495111590b7174c341e81831824ee1bf75 Mon Sep 17 00:00:00 2001
From: brinn <brinn>
Date: Mon, 9 Aug 2010 07:12:19 +0000
Subject: [PATCH] add: some documentation regarding the layout of native tagged
 arrays

SVN: 17362
---
 base/doc/tagged_array_def.txt | 43 +++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 base/doc/tagged_array_def.txt

diff --git a/base/doc/tagged_array_def.txt b/base/doc/tagged_array_def.txt
new file mode 100644
index 00000000000..4fe98e2a0e1
--- /dev/null
+++ b/base/doc/tagged_array_def.txt
@@ -0,0 +1,43 @@
+Tagged Array Definition:
+
+All indices and lengths are given in bytes.
+
+ID: number_type
+START INDEX: 0
+LENGTH: 1
+DESCRIPTION:
+    'F' : IEEE floating point numbers
+    'I' : Integer numbers
+ 
+ID: endiness
+START INDEX: 1
+LENGTH: 1
+DESCRIPTION:
+    'L' : Little Endian
+    'B' : Big Endian
+
+ID: element_size
+START INDEX: 2
+LENGTH: 1
+DESCRIPTION:
+    Size in Bytes (e.g. 4 for a 32bit number, or 8 for a 64bit number)
+    
+ID: rank
+START INDEX: 3
+LENGTH: 1
+DESCRIPTION:
+    Rank of the array (e.g. 2 for a matrix or 3 for a cube)
+
+ID: dimensions
+START INDEX: 4
+LENGTH: 4 * rank
+DESCRIPTION:
+    Dimensions of the array along each axis; each entry is a 32bit (4 byte) integer number in the specified endiness
+
+ID: data
+START INDEX: 4 + 4 * rank
+LENGTH: prod(dimensions)
+DESCRIPTION:
+    Number array with prod(dimensions) elements in C row-major order; 
+    each element is a number of the specified number_type, endiness and element_size
+    
\ No newline at end of file
-- 
GitLab