manpagez: man pages & more
man Mat_VarGetStructsLinear(3)
Home | html | info | man

MAT_VARGETSTRUCTSLINE... BSD Library Functions Manual MAT_VARGETSTRUCTSLINE...


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 struc-
     ture 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 indicat-
     ing that the fields should not be free'd. They are free'd when the origi-
     nal 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),

BSD                             March 14, 2012                             BSD

matio 1.5.9 - Generated Sat Nov 5 07:30:54 CDT 2016
© manpagez.com 2000-2024
Individual documents may contain additional copyright information.