Changeset 4595

Timestamp:

Jul 22, 2005, 12:09:32 PM (21 years ago)

Author:

Paul Price

Message:

Added the psCompare functions (bug 440).

File:

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

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.318 2005-07-22 21:04:16 price Exp $
+%%% $Id: psLibSDRS.tex,v 1.319 2005-07-22 22:09:32 price Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -1752 +1752 @@
 sorted in-place.
 
+\subsubsection{Comparison functions}
+
+We specify several comparison functions as a convenience to the user.
+The \code{psCompareTypePtr} functions are intended for sorting where
+the container has a pointer to the value (e.g., \code{psList}).  The
+functions return an integer less than, equal to, or greater than zero
+if \code{a} is is less than, equal to, or greater than \code{b},
+respectively (\code{qsort} man page).
+
+\begin{prototype}
+int psCompareS8Ptr(const void **a, const void **b);
+int psCompareS16Ptr(const void **a, const void **b);
+int psCompareS32Ptr(const void **a, const void **b);
+int psCompareS64Ptr(const void **a, const void **b);
+int psCompareU8Ptr(const void **a, const void **b);
+int psCompareU16Ptr(const void **a, const void **b);
+int psCompareU32Ptr(const void **a, const void **b);
+int psCompareU64Ptr(const void **a, const void **b);
+int psCompareF32Ptr(const void **a, const void **b);
+int psCompareF64Ptr(const void **a, const void **b);
+int psCompareDescendingS8Ptr(const void **a, const void **b);
+int psCompareDescendingS16Ptr(const void **a, const void **b);
+int psCompareDescendingS32Ptr(const void **a, const void **b);
+int psCompareDescendingS64Ptr(const void **a, const void **b);
+int psCompareDescendingU8Ptr(const void **a, const void **b);
+int psCompareDescendingU16Ptr(const void **a, const void **b);
+int psCompareDescendingU32Ptr(const void **a, const void **b);
+int psCompareDescendingU64Ptr(const void **a, const void **b);
+int psCompareDescendingF32Ptr(const void **a, const void **b);
+int psCompareDescendingF64Ptr(const void **a, const void **b);
+int psCompareS8(const void *a, const void *b);
+int psCompareS16(const void *a, const void *b);
+int psCompareS32(const void *a, const void *b);
+int psCompareS64(const void *a, const void *b);
+int psCompareU8(const void *a, const void *b);
+int psCompareU16(const void *a, const void *b);
+int psCompareU32(const void *a, const void *b);
+int psCompareU64(const void *a, const void *b);
+int psCompareF32(const void *a, const void *b);
+int psCompareF64(const void *a, const void *b);
+int psCompareDescendingS8(const void *a, const void *b);
+int psCompareDescendingS16(const void *a, const void *b);
+int psCompareDescendingS32(const void *a, const void *b);
+int psCompareDescendingS64(const void *a, const void *b);
+int psCompareDescendingU8(const void *a, const void *b);
+int psCompareDescendingU16(const void *a, const void *b);
+int psCompareDescendingU32(const void *a, const void *b);
+int psCompareDescendingU64(const void *a, const void *b);
+int psCompareDescendingF32(const void *a, const void *b);
+int psCompareDescendingF64(const void *a, const void *b);
+\end{prototype}
+
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%