IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Changeset 4122


Ignore:
Timestamp:
Jun 6, 2005, 1:40:53 PM (21 years ago)
Author:
jhoblitt
Message:

s/long int(?=[ ,]/long/g + formatting fixes

Location:
trunk/doc/pslib
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/pslib/ChangeLogSDRS.tex

    r4111 r4122  
    1 %%% $Id: ChangeLogSDRS.tex,v 1.128 2005-06-04 02:38:09 jhoblitt Exp $
     1%%% $Id: ChangeLogSDRS.tex,v 1.129 2005-06-06 23:40:52 jhoblitt Exp $
    22
    33\subsection{Changes from version 00 to version 01}
     
    629629  \item change \code{int} $\rightarrow$ \code{size_t} where appropriate
    630630  \item change \code{psBool} $\rightarrow$ \code{bool}
    631   \item change \code{psU64} $\rightarrow$ \code{unsigned long int} where appropriate
     631  \item change \code{psU64} $\rightarrow$ \code{unsigned long} where appropriate
    632632  \item add \code{const} to parameters where appropriate
    633633  \item remove \code{const} from parameters passed by value
     
    656656  \item change blurb about ``Threads'' to clarify requirements
    657657  \item remove \code{lock} from \code{psList}
    658   \item change \code{psVector} to store it's number of elements as an \code{long int}
    659   \item change \code{psArray} to store it's number of elements as an \code{long int}
    660   \item change \code{psList} to store it's number of elements as an \code{long int}
    661   \item change \code{psListIterator} to store the number of elements on the list as an \code{long int}
    662   \item change \code{psListIterator} to store it's index as an \code{long int}
    663   \item change \code{psHash} to store it's number of elements as an \code{long int}
    664   \item change \code{psLookupTable} to store it's index as an \code{long int}
    665   \item change \code{psBitSet} to store it's size as an \code{long int}
     658  \item change \code{psVector} to store it's number of elements as an \code{long}
     659  \item change \code{psArray} to store it's number of elements as an \code{long}
     660  \item change \code{psList} to store it's number of elements as an \code{long}
     661  \item change \code{psListIterator} to store the number of elements on the list as an \code{long}
     662  \item change \code{psListIterator} to store it's index as an \code{long}
     663  \item change \code{psHash} to store it's number of elements as an \code{long}
     664  \item change \code{psLookupTable} to store it's index as an \code{long}
     665  \item change \code{psBitSet} to store it's size as an \code{long}
    666666  \item remove \code{psXMLDocFree()}
    667667  \item add \code{psXMLDocAlloc()}
  • trunk/doc/pslib/psLibSDRS.tex

    r4110 r4122  
    1 %%% $Id: psLibSDRS.tex,v 1.263 2005-06-04 02:37:24 jhoblitt Exp $
     1%%% $Id: psLibSDRS.tex,v 1.264 2005-06-06 23:40:53 jhoblitt Exp $
    22\documentclass[panstarrs,spec]{panstarrs}
    33
     
    14201420typedef struct {
    14211421    psType type;                        ///< vector data type and dimension
    1422     long int n;                         ///< size of vector
    1423     const long int nalloc;              ///< allocated data block
     1422    long n;                             ///< size of vector
     1423    const long nalloc;                  ///< allocated data block
    14241424    union {
    14251425        psS8  *S8;                      ///< Pointers to byte data
     
    14501450%
    14511451\begin{prototype}
    1452 psVector *psVectorAlloc(long int nalloc, psElemType type);
    1453 psVector *psVectorRealloc(psVector *vector, long int nalloc);
    1454 psVector *psVectorRecycle(psVector *vector, long int nalloc, psElemType type);
     1452psVector *psVectorAlloc(long nalloc, psElemType type);
     1453psVector *psVectorRealloc(psVector *vector, long nalloc);
     1454psVector *psVectorRecycle(psVector *vector, long nalloc, psElemType type);
    14551455\end{prototype}
    14561456%
     
    14741474
    14751475\begin{prototype}
    1476 psVector *psVectorExtend(psVector *vector, long int delta, long int nExtend);
     1476psVector *psVectorExtend(psVector *vector, long delta, long nExtend);
    14771477\end{prototype}
    14781478
     
    16061606\begin{datatype}
    16071607typedef struct {
    1608     const long int n;                   ///< size of array
    1609     const long int nalloc;              ///< allocated data block
     1608    const long n;                       ///< size of array
     1609    const long nalloc;                  ///< allocated data block
    16101610    void **data;                        ///< pointer to data block
    16111611} psArray;
     
    16191619%
    16201620\begin{prototype}
    1621 psArray *psArrayAlloc(long int nalloc);
    1622 psArray *psArrayRealloc(psArray *array, long int nalloc);
     1621psArray *psArrayAlloc(long nalloc);
     1622psArray *psArrayRealloc(psArray *array, long nalloc);
    16231623\end{prototype}
    16241624%
     
    16371637
    16381638\begin{prototype}
    1639 psArray *psArrayAdd(psArray *array, long int delta, psPtr data);
     1639psArray *psArrayAdd(psArray *array, long delta, psPtr data);
    16401640\end{prototype}
    16411641
     
    16571657
    16581658\begin{prototype}
    1659 bool psArraySet(psArray *array, long int position, psPtr data);
    1660 psPtr psArrayGet(const psArray *array, long int position);
     1659bool psArraySet(psArray *array, long position, psPtr data);
     1660psPtr psArrayGet(const psArray *array, long position);
    16611661\end{prototype}
    16621662
     
    16901690\begin{datatype}
    16911691typedef struct {
    1692    long int n;                         ///< number of elements on list
    1693    psListElem *head;                   ///< first element on list (may be NULL)
    1694    psListElem *tail;                   ///< last element on list (may be NULL)
    1695    psArray *iterators;                 ///< array of psListIterator: iteration cursors
     1692   long n;                              ///< number of elements on list
     1693   psListElem *head;                    ///< first element on list (may be NULL)
     1694   psListElem *tail;                    ///< last element on list (may be NULL)
     1695   psArray *iterators;                  ///< array of psListIterator: iteration cursors
    16961696} psList;
    16971697\end{datatype}
     
    17421742\begin{datatype}
    17431743typedef struct {
    1744     psList *list;                      ///< List iterator works on
    1745     psListElem *cursor;                ///< The current iterator cursor
    1746     bool offEnd;                       ///< Is the iterator off the end?
    1747     long int index;                    ///< Index of iterator, to assist performance
    1748     bool mutable;                      ///< Is it permissible to modify the list?
     1744    psList *list;                       ///< List iterator works on
     1745    psListElem *cursor;                 ///< The current iterator cursor
     1746    bool offEnd;                        ///< Is the iterator off the end?
     1747    long index;                         ///< Index of iterator, to assist performance
     1748    bool mutable;                       ///< Is it permissible to modify the list?
    17491749} psListIterator;
    17501750\end{datatype}
     
    17631763The corresponding constructor shall be:
    17641764\begin{prototype}
    1765 psListIterator *psListIteratorAlloc(const psList *list, long int location, bool mutable);
     1765psListIterator *psListIteratorAlloc(const psList *list, long location, bool mutable);
    17661766\end{prototype}
    17671767Here, \code{list} is the \code{psList} on which the iterator will
     
    17911791
    17921792\begin{prototype}
    1793 bool psListAdd(psList *list, long int location, psPtr data);
     1793bool psListAdd(psList *list, long location, psPtr data);
    17941794bool psListAddAfter(psListIterator *iterator, psPtr data);
    17951795bool psListAddBefore(psListIterator *iterator, psPtr data);
     
    18091809
    18101810\begin{prototype}
    1811 psPtr psListGet(psList *list, long int location);
     1811psPtr psListGet(psList *list, long location);
    18121812psPtr psListGetAndIncrement(psListIterator *iterator);
    18131813psPtr psListGetAndDecrement(psListIterator *iterator);
     
    18391839
    18401840\begin{prototype}
    1841 bool psListRemove(psList *list, long int location)
     1841bool psListRemove(psList *list, long location)
    18421842bool psListRemoveData(psList *list, psPtr data);
    18431843\end{prototype}
     
    19001900\begin{datatype}
    19011901typedef struct {
    1902     long int n;                         ///< number of buckets
     1902    long n;                             ///< number of buckets
    19031903    psHashBucket **buckets;             ///< the buckets themselves
    19041904} psHash;
     
    19221922A hash table is created with the following function:
    19231923\begin{prototype}
    1924 psHash *psHashAlloc(long int nalloc);
     1924psHash *psHashAlloc(long nalloc);
    19251925\end{prototype}
    19261926which allocates the space for the hash table, creating and
     
    19991999    const char *filename;               ///< File from which data is to be read
    20002000    const char *format;                 ///< scanf-like format string for file
    2001     long int indexCol;                  ///< Column of the index vector (starting at zero)
     2001    long indexCol;                      ///< Column of the index vector (starting at zero)
    20022002    psVector *index;                    ///< Index values
    20032003    psArray *values;                    ///< Corresponding values: an array of vectors
     
    20232023\begin{prototype}
    20242024psLookupTable *psLookupTableAlloc(const char *filename, ///< File from which to read
    2025                                   const char *format, ///< scanf-like format string
    2026                                   long int indexCol ///< Column of the index vector (starting at zero)
     2025                                  const char *format,   ///< scanf-like format string
     2026                                  long indexCol        ///< Column of the index vector (starting at zero)
    20272027                                  );
    20282028\end{prototype}
     
    20352035
    20362036\begin{prototype}
    2037 psLookupTable *psLookupTableImport(psLookupTable *table, ///< Lookup table into which to import
    2038                                    const psArray *vectors, ///< Array of vectors
    2039                                    long int indexCol ///< Index of the index vector in the array of vectors
     2037psLookupTable *psLookupTableImport(psLookupTable *table,    ///< Lookup table into which to import
     2038                                   const psArray *vectors,  ///< Array of vectors
     2039                                   long indexCol            ///< Index of the index vector in the array of vectors
    20402040                                   );
    20412041\end{prototype}
     
    20552055
    20562056\begin{prototype}
    2057 long int psLookupTableRead(psLookupTable *table);
     2057long psLookupTableRead(psLookupTable *table);
    20582058\end{prototype}
    20592059\code{psLookupTableRead} combines \code{psVectorsReadFromFile} and
     
    20672067functions:
    20682068\begin{prototype}
    2069 double psLookupTableInterpolate(const psLookupTable *table, double index, long int column, psLookupStatusType *status);
     2069double psLookupTableInterpolate(const psLookupTable *table, double index, long column, psLookupStatusType *status);
    20702070psVector *psLookupTableInterpolateAll(const psLookupTable *table, double index, psVector *stats);
    20712071\end{prototype}
     
    21142114\begin{datatype}
    21152115typedef struct {
    2116     long int n;                         ///< Number of chars that form the bitset
     2116    long n;                             ///< Number of chars that form the bitset
    21172117    char *bits;                         ///< The bits
    21182118} psBitSet;
     
    21212121We also require the corresponding constructor and destructor:
    21222122\begin{prototype}
    2123 psBitSet *psBitSetAlloc(long int nalloc);
     2123psBitSet *psBitSetAlloc(long nalloc);
    21242124\end{prototype}
    21252125where \code{n} is the requested number of bits.
     
    21352135
    21362136\begin{prototype}
    2137 psBitSet *psBitSetSet(psBitSet *bitSet, long int bit);
    2138 psBitSet* psBitSetClear(psBitSet *bitSet, long int bit);
     2137psBitSet *psBitSetSet(psBitSet *bitSet, long bit);
     2138psBitSet* psBitSetClear(psBitSet *bitSet, long bit);
    21392139psBitSet *psBitSetOp(psBitSet *outBitSet, const psBitSet *inBitSet1, const char *operator, const psBitSet *inBitSet2);
    21402140psBitSet *psBitSetNot(psBitSet *outBitSet, const psBitSet *inBitSet);
    2141 bool psBitSetTest(const psBitSet *bitSet, long int bit);
     2141bool psBitSetTest(const psBitSet *bitSet, long bit);
    21422142char *psBitSetToString(const psBitSet* bitSet);
    21432143\end{prototype}
     
    47264726
    47274727\begin{prototype}
    4728     psArray *psDBSelectColumn(psDB *dbh, const char *tableName, const char *col, unsigned long int limit);
    4729     psVector *psDBSelectColumnNum(psDB *dbh, const char *tableName, const char *col, psElemType type, unsigned long int limit);
     4728    psArray *psDBSelectColumn(psDB *dbh, const char *tableName, const char *col, unsigned long limit);
     4729    psVector *psDBSelectColumnNum(psDB *dbh, const char *tableName, const char *col, psElemType type, unsigned long limit);
    47304730\end{prototype}
    47314731
     
    47384738
    47394739\begin{prototype}
    4740     psArray *psDBSelectRows(psDB *dbh, const char *tableName, psMetadata *where, unsigned long int limit);
     4740    psArray *psDBSelectRows(psDB *dbh, const char *tableName, psMetadata *where, unsigned long limit);
    47414741\end{prototype}
    47424742
Note: See TracChangeset for help on using the changeset viewer.