Changeset 10587

Timestamp:

Dec 8, 2006, 2:31:16 PM (20 years ago)

Author:

eugene

Message:

updates to psStats

Location:

trunk/doc/pslib

Files:

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

trunk/doc/pslib/ChangeLogSDRS.tex

@@ -1 @@
-%%% $Id: ChangeLogSDRS.tex,v 1.212 2006-09-12 03:49:25 jhoblitt Exp $
+%%% $Id: ChangeLogSDRS.tex,v 1.213 2006-12-09 00:31:16 eugene Exp $
 
 \subsection{Changes from version 00 to version 01}
@@ -923 +923 @@
 \item add \code{psMetadataConfigPrint()}
 \end{itemize}
+
+\subsection{Changes from Revision 21 (24 July 2006) to present}
+
+\begin{itemize}
+\item dropped requirement for \code{psTimerStop} to return max elapsed time.
+\item clarified return values for \code{psTimerMark} and \code{psTimerClear} in case of errors.
+\item changed \code{psVectorStats} to return a bool
+\item added \code{psStats->result}
+\end{itemize}

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.438 2006-10-30 21:54:44 eugene Exp $
+%%% $Id: psLibSDRS.tex,v 1.439 2006-12-09 00:31:16 eugene Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -4847 +4847 @@
 
 \begin{prototype}
-psStats *psVectorStats(psStats *stats, const psVector *in, const psVector *errors,
-                       const psVector *mask, psMaskType maskVal);
+bool psVectorStats(psStats *stats, const psVector *in, const psVector *errors,
+                   const psVector *mask, psMaskType maskVal);
 \end{prototype}
 %
@@ -4909 +4909 @@
     double binsize;                     ///< binsize for robust fit (input/output)
     long   nSubsample;                  ///< maximum number of measuremenst (input)
-    psStatsOptions options;             ///< bitmask of calculated values
+    psStatsOptions options;             ///< bitmask of desired values
+    psStatsOptions results;             ///< bitmask of calculated values
 } psStats;
 \end{datatype}
@@ -7111 +7112 @@
 psF64 psTimerMark(char *name);
 psF64 psTimerClear(char *name);
-psF64 psTimerStop(void);
+bool psTimerStop(void);
 \end{prototype}
 
@@ -7117 +7118 @@
 timers, under the supplied \code{name}.  \code{psTimerMark} shall
 return the elapsed time, in seconds, for the timer specified by
-\code{name}.  \code{psTimerClear} resets the named timer.
-\code{psTimerStop} shall free all memory associated with all timers,
-so that no memory is leaked, and return the maximum time expended.
+\code{name}, or NAN if the timer does not exist.  \code{psTimerClear}
+resets the named timer, return the elapsed time on that timer so far,
+or NAN if not currently defined.  \code{psTimerStop} shall free all
+memory associated with all timers, so that no memory is leaked.
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%