Man page - mat_vargetstructslinear(3)

Packages contains this manual

Manual

MAT_VARGETSTRUCTSLINEAR (3) Library Functions Manual MAT_VARGETSTRUCTSLINEAR (3)

NAME

Mat_VarGetStructsLinear ā€” Linearly index a structure variable

SYNOPSIS

#include <matio.h>

matvar_t *

Mat_VarGetStructsLinear ( constĀ matvar_tĀ *matvar , intĀ start , intĀ stride , intĀ edge , intĀ copy_fields );

DESCRIPTION

The Mat_VarGetStructsLinear () function selects a subarray from a structure array matvar. Each of the elements in the subarray contains all of the fields of the structure. The indexing starts at the start element in the array (0 being the first element), and reads every stride values (1 being every element, 2 every other element, etc.). The total number of elements in the subarray is specified as edge. The original array must have at least start+(stride-1)*edge+1 elements. The copy_fields option specifies whether the fields of the original structure are copied for the new subarray. If set to 0, the returned structure arrayā€™s fields have the same pointer as the original array, and the data field of the subarray structure. The subarray is marked with the conserve memory flag indicating that the fields should not be freeā€™d. They are freeā€™d when the original structure is freeā€™d.

RETURN VALUES

A subarray of the original structure array, or NULL if there is an error.

SEE ALSO

Mat_VarGetStructs (3) Debian March 14, 2012 MAT_VARGETSTRUCTSLINEAR (3)