Jamoma API  0.6.0.a19
TTMatrixBase.h File Reference

2-dimensional matrix of compound values with N elements each. More...

#include "TTFoundation.h"
#include "TTDataObjectBase.h"
#include "TTLimits.h"
+ Include dependency graph for TTMatrixBase.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  TTMatrixBase
 2-dimensional matrix of compound values with N elements each. More...
 

Macros

#define INDEX_OF_COMPONENT_FIRSTBYTE(i, j)
 [doxygenAppendixC_macroExample] More...
 
#define INDEX_OF_ELEMENT_FIRSTBYTE(i, j, e)
 [doxygenAppendixC_macroExample] More...
 

Detailed Description

2-dimensional matrix of compound values with N elements each.

Each compound value stored in the matrix is known as a component. The number of elements in each component is variable, enabling the storage of things like complex numbers or RGBA colors. However, this element count for each component and their datatype is uniform across the entire matrix.

Locations for individual components in the matrix are identified by (row, column) pairs. These coordinates are translated internally into linear memory using column-major order.

All dimension indices begin counting at zero. This means that index values greater than or equal to the respective mRowCount, mColumnCount or mElementCount will be out of bounds.

Please note that previous support for N dimensions has been deprecated and the TTMatrixBase class is now fixed at 2 dimensions. Throughout this documentation, dimension 1 is referred to as the "row" and dimension 2 is referred to as the "column".

Author
Timothy Place & Nathan Wolek

Definition in file TTMatrixBase.h.