Changeset 2700

Timestamp:

Dec 10, 2004, 4:30:23 PM (22 years ago)

Author:

Paul Price

Message:

Altered psList and psListIterator to match that in bug 249.

Location:

trunk/doc/pslib

Files:

• ChangeLogSDRS.tex (modified) (2 diffs)
• psLibSDRS.tex (modified) (4 diffs)

trunk/doc/pslib/ChangeLogSDRS.tex

@@ -1 @@
-%%% $Id: ChangeLogSDRS.tex,v 1.49 2004-12-02 02:49:35 price Exp $
+%%% $Id: ChangeLogSDRS.tex,v 1.50 2004-12-11 02:30:17 price Exp $
 
 \subsection{Changes from version 00 to version 01}
@@ -394 +394 @@
 \begin{itemize}
 \item Changed names of \code{psSphereTransform} structure members to conform with ADD.
-\end{itemize}
+\item Altered \code{psList} and \code{psListIterator} to match that in bug 249.
+\end{itemize}

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.157 2004-12-02 02:49:43 price Exp $
+%%% $Id: psLibSDRS.tex,v 1.158 2004-12-11 02:30:23 price Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -1500 +1500 @@
    psListElem *head;                   ///< first element on list (may be NULL)
    psListElem *tail;                   ///< last element on list (may be NULL)
-   unsigned int nIter;                 ///< number of iterators
-   psArray *iter;                      ///< array of psListIterator: iteration cursors
+   psArray *iterators;                 ///< array of psListIterator: iteration cursors
    pthread_mutex_t lock;               ///< mutex to lock a node during changes
 } psList;
@@ -1508 +1507 @@
 The type \code{psList} represents the container of the list.  It has a
 pointer to the first element in the linked list (\code{head}), a
-pointer to the last element in the list (\code{tail}), an entry for
-the current cursor location (\code{iter}), and an entry to define the
-number of elements in the list (\code{size}).  Iteration on the list
-is achieved by means of an array of \code{nIter} iteration cursors,
-\code{iter}.  The \code{lock} should be applied during changes to the
-list to maintain thread safety.
+pointer to the last element in the list (\code{tail}), an array of
+iteration cursors, (\code{iterators}), and an entry to define the
+number of elements in the list (\code{size}).  The \code{lock} should
+be applied during changes to the list to maintain thread safety.
 
 The elements of the list are defined by the type \code{psListElem}:
@@ -1556 +1553 @@
 typedef struct {
     psList *list;                      ///< List iterator works on
-    unsigned int num;                  ///< Iterator number
     psListElem *cursor;                ///< The current iterator cursor
     bool offEnd;                       ///< Is the iterator off the end?
+    int index;                         ///< Index of iterator, to assist performance
 } psListIterator;
 \end{verbatim}
 The \code{psListIterator} keeps track of which list element the
-iterator \code{cursor} is currently pointing at.  \code{num} is the
-number of the list iterator in the parent \code{list}'s array of
-iterators, so \code{list->iter[num]} points to the list iterator.  The
-boolean member, \code{offEnd}, indicates whether the iterator has
-progressed off the end of the list (i.e., beyond the last item).
+iterator \code{cursor} is currently pointing at.  \code{index} is the
+index of the list iterator, which is used to assist performance when
+using numerical locations.  The boolean member, \code{offEnd},
+indicates whether the iterator has progressed off the end of the list
+(i.e., beyond the last item).
 
 The corresponding constructor shall be: