IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Mar 15, 2004, 3:20:03 PM (22 years ago)
Author:
eugene
Message:

added Doxygen \file and \defgroup entries
some basic reorganization

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/archive/pslib/include/psMath.h

    r238 r247  
    22#define PS_MATH_H
    33
    4 /** in this method, the data types (psImage, psVector) include embedded information about their data type in
    5  * the structure.  The constant value is then handled by calling the psScalar function which returns a private
    6  * scalar data type which is always freed by the code.  This forces the layout of the data structures to be
    7  * consistent, with the type information as the first entry.  We can then define a data type which is
    8  * completely flat and can be used to check on the data type of the data.
     4/** \file psMath.h
     5 *  \brief math operators between PSLib data types
     6 *  \ingroup MathGroup
    97 */
     8
     9/** private structure used to pass constant values into the math operators. */
     10typedef struct {
     11    psType type;                        ///< data type information
     12    union {                           
     13        int i;                          ///< integer value entry
     14        float f;                        ///< float value entry
     15        double d;                       ///< double value entry
     16        complex float c;                ///< complex value entry
     17    }
     18} p_psScalar;
    1019
    1120/** Perform a binary operation on two data items (psImage, psVector, psScalar). */
    … …  
    2433);
    2534
    26 /** create a psType-ed structure from a constant value. */
     35/** create a psType-ed structure from a constant double value. */
    2736p_ps_Scalar *
    2837psScalar (double value);
    … …  
    3443);
    3544
    36 typedef struct {
    37     psType type;
    38     union {
    39         int i;
    40         float f;
    41         double d;
    42         complex float c;
    43     }
    44 } p_psScalar;
     45/** the functions defined here can operate on the basic PSLib data types: psImage, psVector, XXX.  These data
     46 *  types include embedded information about their type in the structure.  Constant values are handled by
     47 *  wrapping the value in the psScalar function, which returns a private scalar data type, p_ps_Scalar, which
     48 *  is always freed by the function.  The return value type can be determined by casting the return to psType
     49 *  and checking the type entry. 
     50 */
    4551
    4652/* examples of usage:
    … …  
    6672
    6773*/
    68 
    6974
    7075#endif
Note: See TracChangeset for help on using the changeset viewer.