Changeset 670 for trunk/psLib/src/collections/psVector.h

Timestamp:

May 13, 2004, 12:47:52 PM (22 years ago)

Author:

desonia

Message:

Major refactoring of the Vector alloc/free functions.

File:

• trunk/psLib/src/collections/psVector.h (modified) (5 diffs)

trunk/psLib/src/collections/psVector.h

@@ -19 +19 @@
  *  @author Ross Harman, MHPCC
  *   
- *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2004-05-13 19:54:26 $
+ *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-05-13 22:47:52 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -60 +60 @@
     PS_TYPE_COMPLEX_FLOAT = 0x84,     ///< Complex numbers consisting of single-precision floating point.
     PS_TYPE_COMPLEX_DOUBLE = 0x88,    ///< Complex numbers consisting of double-precision floating point.
-    PS_TYPE_OTHER,                    ///< Something else that's not supported for arithmetic.} psElemType;
+    PS_TYPE_PTR = 0x00,               ///< Something else that's not supported for arithmetic.}
 } psElemType;
 
@@ -118 +118 @@
         double *d;                      ///< Pointers to double precision data.
         complex float *cf;              ///< Pointers to complex floating point data.
+        void *v;                        ///< Pointers to generic void data
         void **vp;                      ///< Void pointer vector.
     }vec;                               ///< Union for data types.
@@ -135 +136 @@
  */
 psVector *psVectorAlloc(
-    psElemType dataType,    ///< Type of data to be held by vector.
-    int nalloc              ///< Total number of elements to make available.
+    psElemType dataType,                ///< Type of data to be held by vector.
+    unsigned int nalloc                 ///< Total number of elements to make available.
 );
 
@@ -164 +165 @@
 );
 
-/** Allocate a void pointer vector.
+
+/** Deallocate/Dereference elements of a void pointer vector.
  *
- * Uses psLib memory allocation functions to create a vector of void pointers as defined by the psVoidPtrVector
- * struct.
- *
- * @return psVector*: Pointer to psVector.
- *
- */
-psVector *psVoidPtrVectorAlloc(
-    unsigned int nalloc                 ///< Number of elements to use.
-);
-
-/** Reallocate a void pointer vector.
- *
- * Uses psLib memory allocation functions to reallocate a vector of void pointers as defined by the
- * psVoidPtrVector struct. If the vector size is increased or decreased, this function does not allocate or
- * deallocate the contents of individual vector elements. The user must do this after calling this function.
- *
- * @return psVector*: Pointer to psVector.
- *
- */
-psVector *psVoidPtrVectorRealloc(
-    psVector *restrict psVec,           ///< Void pointer vector to destroy.
-    unsigned int nalloc                 ///< Number of elements.
-);
-
-/** Deallocate a void pointer vector.
- *
- * Uses psLib memory allocation functions to deallocate a vector of void pointers as defined by the
- * psVoidPtrVector struct. This function does not free the vector elements unless the user provides a callback
- * function. NULL may be passed as an alternative to supplying a callback, but the user must remember to
- * delete the vector elements afterwards. The user must not delete or deallocate the vector elements prior to
- * calling this function, as it requires valid elements for memory reference decrementation operations.
- *
- * @return: void
+ * Uses psLib memory allocation functions to deallocate/dereference elements of a vector of void pointers.
+ * This function does not free the vector elements unless the user provides a elemFree function
+ * pointer. If the elemFree function pointer is NULL, the reference cound of the elements are decremented
+ * without being freed.  The vector psVec is not freed, and its elements will all be set to NULL.
  *
  */