get_matrix - Retrieves a matrix from the labeled table (LT)

SYNTAX

#include "ltable.h"

FUNCTION get_matrix (vec,odtype,matrix)

     struct VECTOR          *vec;
     long                    odtype;
     unsigned char          *matrix;

PARAMETERS

vec (Input/Output, struct VECTOR)

Pointer to a structure defining a field within an LT logical record. Note that a field is required to be a numerical matrix. Note that vec is an element of the the linked list defining the LT record.

odtype (Input, long)

Specifies the data type of parameter matrix. If the matrix is stored in the LT as a different data type, the matrix is converted to the specified data type. Note that data type conversion may lead to unexpected results when converting from a large data type (e.g., R*4) to a small data type (e.g., I*1). Valid data type values are:

          = I1: unsigned byte data
          = I2: signed two byte data
          = I4: signed four byte data
          = R4: four byte floating point data
          = R8: eight byte floating point data

matrix (Output, 'odtype', length(*))

The matrix read from the LT. If required, the matrix is converted to the desired data type specified by parameter odtype dimension array.

DESCRIPTION

The get_matrix() routine retrieves a matrix from the LT. Returns an I*1, I*2, I*4, R*4, or R*8 matrix read from the LT into parameter vec dimension array in row major. The data type of the returned matrix is determined by parameter odtype

If null values are encountered within the matrix, the structure field null is set to represent the size of the matrix where the first null value was detected.

It is required that an application program to call get_vector() and get_record() prior to calling get_matrix().

RETURN VALUE

get_matrix() has no return values.

SPECIAL CONSIDERATIONS:

The get_matrix() call is for C only.