Aimt is an array index mapping tool used to interconvert between index and subscripts. This open-source project is written in C language and performs multidimensional conversions. As we see in Matlab and Octave Forge, there are two functions to mapping array indexes: the sub2ind and ind2sub.
In the sub2ind and ind2sub functions, the array index traverses rows, then columns, and then higher dimensions. The index starts from 1, and the subscripts start from (1, ..., 1). Right below are basic examples of how these functions work.
sub2ind
Let's use the sub2ind function to get a linear index form of a (4, 3) subscripts in a 5x4 matrix. So, we code:
int myMatrixDimensions[] = {5, 4};
int mySubscripts[] = {4, 3}; // index = 14
int arraySize = sizeof(myMatrixDimensions)/sizeof(myMatrixDimensions[0]);
int linearIndex = sub2ind(myMatrixDimensions, mySubscripts, arraySize);ind2sub
On the other hand, we can use the ind2sub function to move in the opposite way. For example, in a 5x4 matrix, one linear index is 14, and we can get these subscripts form coding like this:
int myMatrixDimensions[] = {5, 4};
int myIndex = 14; // subscripts = (4, 3)
int arraySize = sizeof(myMatrixDimensions)/sizeof(myMatrixDimensions[0]);
int mySubscripts[arraySize];
ind2sub(myMatrixDimensions, arraySize, myIndex, mySubscripts);See the demos folder for complete examples. The Makefile shows how to link and compile all files.
Keep in mind this tool is under development and was tested only in the Unix environment for the GCC 9.3.0 compiler. If you want to use it, go ahead and copy the src folder into your project and add the aimt.h file by the include directive.
#include "../src/aimt.h"
int main (int argc, char *argv[]){
// stuff to do...
return 0;
}I'm so glad when I see improvements done by other people. Feel free to contribute by opening pull requests with improvements, fixing bugs or typing mistakes, or even open an issue to report errors. See some useful stuff in Contributing guide.
Aimt is a MIT licensed, as found in the LICENSE file.