RTcmix Documentation

load_array/get_array/put_array/get_size/get_sum

scorefile commands -- access and manipulate Minc arrays

MInc has 32 internal arrays of up to 256 elements available for use within scorefiles (these limits may be increased by changing the ARRAY_SIZE and NUM_ARRAYS values at the beginning of the "RTcmix/sys/minc_functions.c" file). These arrays can be used to store and retrieve data (double/floating-point) throughout a scorefile.

USAGE:

size = load_array(array#, p1, p2, p3, p4, ...)
val = get_array(array#, element)
val = put_array(array#, element, value)
size = get_size(array#)
val = get_sum(array#, upperbound)

load_array will load array number array# with the double (floating-point) values of p1, p2, p3, ... etc. It returns the size of the array thus filled. If the number of values requested exceeds the defined limit of ARRAY_SIZE, it will only load ARRAY_SIZE elements into the array.

get_array returns the value of the number stored at location element in array number array#. If the requested element is at a location larger than the stored size of the array, then it returns the last number stored in the array.

put_array stores value at the location element in array number array#. It will reset the array size if the element location requested is larger than the currently stored size of the array (up to ARRAY_SIZE, of course). It returns the value stored, or -1 if it element exceeds ARRAY_SIZE.

get_size returns the current size of the array number array#.

get_sum returns the summation of the value of all elements in array array# up to and including location element. It will return 0 if element is larger than the stored size of the array.