Changeset 247 for trunk/archive/pslib/include/psStdArrays.h

Timestamp:

Mar 15, 2004, 3:20:03 PM (22 years ago)

Author:

eugene

Message:

added Doxygen \file and \defgroup entries
some basic reorganization

File:

• trunk/archive/pslib/include/psStdArrays.h (modified) (2 diffs)

trunk/archive/pslib/include/psStdArrays.h

@@ -2 +2 @@
 #define PS_TYPES_H
 
-#include <complex.h>
-#include <stdint.h>
-#include "psArray.h"
-
+/** \file psStdArrays.h
+ *  \brief Support for basic flat arrays
+ *  \ingroup DataGroup
+ */
 
 /** Types of the elements of vectors, matrices, etc. */
@@ -189 +189 @@
 /************************************************************************************************************/
 
+/*****************************************************************************/
+/** Array of pointers to void.
+ *  psVoidPtrArray is special, as it needs to have a destructor that
+ *  accepts a destructor for the array elements
+ */
+typedef struct {
+    int n;                              //!< Number of elements in use 
+    int size;                           //!< Number of total elements
+    void **arr;                         //!< The elements
+} psVoidPtrArray;
+
+/** Constructor */
+psVoidPtrArray *psVoidPtrArrayAlloc(int n, //!< Number of elements to use
+                                    int s //!< Total number of elements
+                                    );
+/** Reallocate */
+psVoidPtrArray *psVoidPtrArrayRealloc(psVoidPtrArray *arr, //!< Array to reallocate
+                                      int n //!< Number of elements
+                                      );
+/** Destructor */
+void psVoidPtrArrayFree(psVoidPtrArray *arr, //!< array to destroy
+                        void (*elemFree)(void *) //!< destructor for array data
+                        );
+
+
 #endif