Changeset 9725 for trunk/doc/pslib/psLibSDRS.tex

Timestamp:

Oct 24, 2006, 11:24:08 AM (20 years ago)

Author:

Paul Price

Message:

Changing spec for psVectorAlloc, adding psVectorAllocEmpty.

File:

• trunk/doc/pslib/psLibSDRS.tex (modified) (3 diffs)

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.435 2006-10-21 01:35:07 price Exp $
+%%% $Id: psLibSDRS.tex,v 1.436 2006-10-24 21:24:08 price Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -3684 +3684 @@
 \begin{prototype}
 psVector *psVectorAlloc(long nalloc, psElemType type);
+psVector *psVectorAllocEmpty(long nalloc, psElemType type);
 psVector *psVectorRealloc(psVector *vector, long nalloc);
 psVector *psVectorRecycle(psVector *vector, long nalloc, psElemType type);
@@ -3690 +3691 @@
 In these functions, \code{nalloc} is the number of elements to
 allocate.  For \code{psVectorAlloc}, the value of \code{psVector.n} is
-initially set to zero.  Users may choose to restrict the data range
-after the \code{psVectorAlloc} function is called.  For
-\code{psVectorRealloc}, if the value of \code{nalloc} is smaller than
-the current value of \code{psVector.n}, then \code{psVector.n} is set
-to \code{nalloc}, the array is adjusted down to match \code{nalloc},
-and the extra elements are lost.  If \code{nalloc} is larger than the
-current value of \code{psVector.n}, \code{psVector.n} is left intact.
-If the value of \code{vector} is \code{NULL}, then
-\code{psVectorRealloc} must generate an error.
+initially set to the number of allocated values; for
+\code{psVectorAllocEmpty}, the value of \code{psVector.n} is initially
+set to zero.  For \code{psVectorRealloc}, if the value of
+\code{nalloc} is smaller than the current value of \code{psVector.n},
+then \code{psVector.n} is set to \code{nalloc}, the array is adjusted
+down to match \code{nalloc}, and the extra elements are lost.  If
+\code{nalloc} is larger than the current value of \code{psVector.n},
+\code{psVector.n} is left intact.  If the value of \code{vector} is
+\code{NULL}, then \code{psVectorRealloc} must generate an error.
 
 \code{psVectorRecycle} shall recycle the input \code{vector}, such