Next: , Previous: bpipe_matrix_override_new, Up: Internal Functions


A.5.28 bpipe_matrix_verify

determine if a matrix specification is valid.

Synopsis

     #include <bpipe/bpipe.h>
     
     
     
int bpipe_matrix_verify(BPMatrix *matrix);

Parameters

BPMatrix *matrix
the matrix specification to validate.

Description

The number of dimensions and the extent of the dimensions of a matrix specification are checked to determine if they are positive. the number of elements in the matrix are recalculated. If the passed pointer is NULL, the routine simply returns.

Returns

If the specification is valid it returns zero, else non-zero.