Next: , Previous: bpipe_matrix_new, Up: Utility Functions   [Contents]


A.4.15 bpipe_matrix_new_va

create a binary pipe matrix specification

Synopsis

#include <bpipe/bpipe.h>

BPMatrix *bpipe_matrix_new_va(
  size_t nd,
  ...
);

Parameters

size_t nd

the number of dimensions in the matrix

...

the extents of the dimensions. there must be as many extents as there are dimensions

Description

This routine creates a binary pipe matrix specification of a given dimensionality. It allocates memory for the matrix structure and its associated data. To ease filling in the associated extents array, the extents are passed as a variable argument list.

Returns

Upon successful completion a pointer to the new matrix is returned. Upon error bpipe_errno is set and NULL is returned.

Errors

Upon error bpipe_errno is set to one of the following errors:

BPEBADARG

the passed argument is bogus or the matrix specification was illegal

BPENOMEM

a memory allocation failed