NAME
cxPyrExpand
- makes an uncompressed pyramid structure
C SPECIFICATION
#include <cx/Pyramid.h>
cxPyramid *cxPyrExpand(cxPyramid *src)
FORTRAN SPECIFICATION
integer function cxPyrExpand(src)
integer src
PARAMETERS
-
src
-
Input pyramid data structure.
FUNCTION RETURN VALUE
The returned value for this function is a pointer to the newly expanded
pyramid.
DESCRIPTION
cxPyrExpand returns an uncompressed version of the input pyramid.
If the input is not compressed, the returned pyramid will be a pointer
to the input. If the input is compressed, the returned pyramid will be
newly allocated and expanded from the input.
cxPyrExpand can be used to handle compressed pyramids by fully
expanding them, manipulating and then freeing the expanded version.
cxPyrExpand is slightly less expensive than
cxPyrDupExpand, in that it does not duplicate already
uncompressed pyramids. This approach of duplicating pyramids can be
very expensive in terms of computer memory and time, as the expanded
pyramid may be many times the size of the compressed input. Another
routine, cxPyrEleDupExpand, exists to expand a single pyramid
element, rather than the entire pyramid.
cxPyrExpand 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; it may be identical to the input.
SEE ALSO
cxPyrDup(3E),
cxPyrDupExpand(3E),
cxPyrEleDupExpand(3E),
cxPyrCompress(3E),
Last modified: Mon Nov 18 13:52:43 GMT 1996
[ Documentation Home ]
© The Numerical Algorithms Group Ltd, Oxford UK. 1996