NAME

cxPyrEleDupExpand - makes an uncompressed copy of an element in a pyramid structure

C SPECIFICATION

#include <cx/Pyramid.h>

cxPyramid *cxPyrEleDupExpand(cxPyramid *src, long layer, long elem)

FORTRAN SPECIFICATION

integer function cxPyrEleDupExpand(src, layer, elem)
integer src
integer layer
integer elem

PARAMETERS

src: Input pyramid data structure.
layer: Input layer from which to duplicate and expand.
elem: Input element index from which to duplicate and expand.

FUNCTION RETURN VALUE

The returned value for this function is a pointer to the newly created pyramid.

DESCRIPTION

cxPyrEleDupExpand makes a copy of an element in its input pyramid for return to the caller. The element to be copied is specified by the layer and elem inputs, which give the pyramid layer number and element index, respectively. The value of layer is one-based, so that a layer of two corresponds to the two-dimensional contents of the pyramid. The element index is zero-based, so that the first element is numbered zero. The duplication extends to all pyramid contents subordinate to the chosen element, so that parts of constituent cxLattice and cxConnection structures are duplicated as well. The output may not be an exact copy of the input, in that any compression of the input pyramid is expanded in place in creating the output. cxPyrEleDupExpand can be used to handle compressed pyramids without fully expanding them, by expanding each compressed element, manipulating and then freeing the expanded version. cxPyrEleDupExpand returns a NULL if its input is malformed or if an allocation error occurs. The returned pyramid is a reference counted structure owned by the caller.

NAME

C SPECIFICATION

FORTRAN SPECIFICATION

PARAMETERS

FUNCTION RETURN VALUE

DESCRIPTION

SEE ALSO