NAME

cxPyrSet - replaces the base lattice in a pyramid

C SPECIFICATION

#include <cx/DataAccess.h>

cxErrorCode cxPyrSet(cxPyramid *src, cxLattice *baseLat)

FORTRAN SPECIFICATION

integer function cxPyrSet(src, baselat)
integer src
integer baselat

PARAMETERS

src
Input pyramid data structure.
baseLat
Input replacement base lattice for the pyramid.

FUNCTION RETURN VALUE

The return value for this function is an integer error code enumeration.

DESCRIPTION

cxPyrSet replaces the base lattice in a pyramid data structure. In doing so, it decrements the shared memory reference count of the old base lattice and increments the reference count of baseLat. The base lattice resides at the lowest level in the pyramid. Each lattice-connection layer stores higher-dimensional data and its relation to data of dimension one lower. Another routine, cxPyrNew, sets the number of layers in the pyramid. cxPyrLayerSet assigns a lattice and connection to a single layer in the pyramid. A return value of cx_err_none indicates success, while another value indicates a NULL input pyramid.

SEE ALSO

cxPyrGet(3E), cxPyrLayerGet(3E), cxPyrLayerSet(3E), cxDataRefInc(3E), cxDataRefDec(3E)
Last modified: Mon Nov 18 13:52:55 GMT 1996
[ Documentation Home ]
© The Numerical Algorithms Group Ltd, Oxford UK. 1996