Changeset 486 for trunk/psLib/src/collections/psArray.h

Timestamp:

Apr 20, 2004, 2:40:32 PM (22 years ago)

Author:

harman

Message:

Added double array

File:

• trunk/psLib/src/collections/psArray.h (modified) (6 diffs)

trunk/psLib/src/collections/psArray.h

@@ -8 +8 @@
  *  @author Ross Harman, MHPCC
  *   
- *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2004-04-21 00:18:05 $
+ *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-04-21 00:40:32 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -96 +96 @@
 typedef struct
 {
-    psType type; ///< Type of data. THIS STRUCT ELEMENT MUST BE FIRST IN THE STRUCT!
-    int nalloc;  ///< Total number of elements available.
-    int n;   ///< Number of elements in use.
-    float *arr;  ///< Array data.
+    psType type;    ///< Type of data. THIS STRUCT ELEMENT MUST BE FIRST IN THE STRUCT!
+    int nalloc;     ///< Total number of elements available.
+    int n;          ///< Number of elements in use.
+    float *arr;     ///< Array data.
 }
 psFloatArray;
+
+/** An array of doubles.
+ *
+ * Struct for maintaining an array of double precision floating point numbers.
+ *
+ */
+typedef struct
+{
+    psType type;    ///< Type of data.  THIS STRUCT ELEMENT MUST BE FIRST IN THE STRUCT!
+    int nalloc;     ///< Total number of elements available.
+    int n;          ///< Number of elements in use.
+    double *arr;    ///< Array data.
+}
+psDoubleArray;
 
 /*****************************************************************************/
@@ -107 +121 @@
 /*****************************************************************************/
 
-/** Allocate an integer array */
+/** Allocate an integer array.
+ *
+ * Uses psLib memory allocation functions to create an array of integers as defined by the psIntArray struct. 
+ *
+ */
 psIntArray *psIntArrayAlloc(
     int nalloc  ///< Total number of elements to make available
 );
 
-/** Reallocate an integer array */
+/** Reallocate an integer array.
+ *
+ * Uses psLib memory allocation functions to reallocate an array of integers as defined by the psIntArray 
+ * struct. 
+ *
+ */
 psIntArray *psIntArrayRealloc(
     psIntArray *myArray,    ///< Array to reallocate.
@@ -119 +142 @@
 
 
-/** Deallocate an integer array */
+/** Deallocate an integer array
+ *
+ * Uses psLib memory allocation functions to deallocate an array of integers as defined by the psIntArray 
+ * struct. 
+ *
+ */
 void psIntArrayFree(
     psIntArray *restrict myArray    ///< Array to free
@@ -153 +181 @@
     psFloatArray *restrict myArray  ///< Array to free
 );
+
+/** Allocate a Double array.
+ *
+ * Uses psLib memory allocation functions to create an array of doubles as defined by the psDoubleArray 
+ * struct. 
+ *
+ */
+psDoubleArray *psDoubleArrayAlloc(
+    int nalloc  ///< Total number of elements to make available.
+);
+
+/** Reallocate a Double array.
+ *
+ * Uses psLib memory allocation functions to reallocate an array of Doubles as defined by the psDoubleArray 
+ * struct. 
+ *
+ */
+psDoubleArray *psDoubleArrayRealloc(
+    psDoubleArray *myArray, ///< Array to reallocate.
+    int nalloc              ///< Total number of elements to make available.
+);
+
+/** Deallocate a Double array
+ *
+ * Uses psLib memory allocation functions to deallocate an array of doubles as defined by the psDoubleArray 
+ * struct. 
+ *
+ */
+void psDoubleArrayFree(
+    psDoubleArray *restrict myArray  ///< Array to free
+);
+
+
+
+
+
+
+
 
 /** An array of complex numbers.
@@ -182 +248 @@
 
 
-/************************************************************************************************************/
-
-/** An array of double-precision real numbers */
-typedef struct
-{
-    psType type;  ///< Type of data.  THIS STRUCT ELEMENT MUST BE FIRST IN THE STRUCT!
-    int nalloc;   ///< Total number of elements available
-    int n;    ///< Number of elements in use
-    double *arr;  ///< The array data
-}
-psDoubleArray;
-
-/** Constructor \ingroup DataGroup */
-psDoubleArray *psDoubleArrayAlloc(int nalloc) ///< Total number of elements to make available
-;
-
-/** Reallocator \ingroup DataGroup */
-psDoubleArray *psDoubleArrayRealloc(psDoubleArray *myArray, ///< Array to reallocate
-                                    int nalloc) ///< Total number of elements to make available
-;
-
-/** Destructor \ingroup DataGroup */
-void psDoubleArrayFree(psDoubleArray *restrict myArray) ///< Array to free
-;
+
 
 /** Array of pointers to void.