Changeset 2211 for trunk/psLib/src/dataManip/psConstants.h

Timestamp:

Oct 27, 2004, 9:58:54 AM (22 years ago)

Author:

gusciora

Message:

I've been unifying the naming conventions for various macros that check
functions parameters for type, size, non-NULL ...

File:

• trunk/psLib/src/dataManip/psConstants.h (modified) (7 diffs)

trunk/psLib/src/dataManip/psConstants.h

@@ -6 +6 @@
  *  @author GLG, MHPCC
  *
- *  @version $Revision: 1.18 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2004-10-27 01:23:24 $
+ *  @version $Revision: 1.19 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-10-27 19:58:54 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
  */
 
+/*****************************************************************************
+These constants are used by various functions in the psLib.
+ *****************************************************************************/
 #define DETERMINE_BRACKET_STEP_SIZE 0.10
 #define MAX_LMM_ITERATIONS 100
@@ -17 +20 @@
 #define LEFT_SPLINE_DERIV 0.0
 #define RIGHT_SPLINE_DERIV 0.0
-
+/*****************************************************************************
+These are common mathimatical constants used by various functions in the psLib.
+ *****************************************************************************/
+
+
+
+/*****************************************************************************
+ 
+ *****************************************************************************/
 #define CONVERT_VECTOR_F64_TO_F32(OLD, NEW_PTR32, NEW_STATIC32) \
 if (OLD->type.type == PS_TYPE_F32) { \
@@ -44 +55 @@
 } \
 
-#define VECTOR_CHECK_TYPE_F32_OR_F64_RETURN_NULL(VEC) \
-if ((VEC->type.type != PS_TYPE_F32) && (VEC->type.type != PS_TYPE_F64)) { \
-    psAbort(__func__, "Bad type for VEC (%d)", VEC->type.type); \
-    return(NULL); \
-} \
-
 #define GEN_PERSIST_YERR_VEC_F32(VEC, N) \
 VEC = psVectorRecycle(VEC, N, PS_TYPE_F32); \
@@ -89 +94 @@
 
 
-
-
-
+/*****************************************************************************
+ 
+*****************************************************************************/
+#define PS_CHECK_NULL_PTR(NAME, RVAL) \
+if (NAME == NULL) { \
+    psError(__func__,"Unallowable operation: %s is NULL.", #NAME); \
+    return(RVAL); \
+}
+
+/*****************************************************************************
+ 
+ *****************************************************************************/
+#define VECTOR_CHECK_TYPE_F32_OR_F64(VEC, RVAL) \
+if ((VEC->type.type != PS_TYPE_F32) && (VEC->type.type != PS_TYPE_F64)) { \
+    psAbort(__func__, "Bad type for VEC (%d)", VEC->type.type); \
+    return(RVAL); \
+} \
 
 /** Preprocessor macro to generate error on an incorrect type */
@@ -107 +126 @@
 } \
 
-/** Preprocessor macro to generate error on a NULL poniter */
-#define PS_CHECK_NULL_PTR(NAME, RVAL) \
-if (NAME == NULL) { \
-    psError(__func__,"Unallowable operation: %s is NULL.", #NAME); \
-    return(RVAL); \
-}
-
 /** Preprocessor macro to generate error for zero length vector */
 #define PS_CHECK_EMPTY_VECTOR(NAME, RVAL) \
@@ -128 +140 @@
 }
 
-
-
-
-
-/** Preprocessor macro to generate error on a NULL image */
-#define PS_CHECK_NULL_IMAGE_RETURN_NULL(NAME) \
-if (NAME == NULL || NAME->data.V == NULL) {                                                         \
-    psError(__func__,"Unallowable operation: %s or its data is NULL.", #NAME);                          \
-    return(NULL); \
-}
-
-/** Preprocessor macro to generate error for zero length rows or columns */
-#define PS_CHECK_EMPTY_IMAGE_RETURN_NULL(NAME) \
-if (NAME->numCols < 1 || NAME->numRows < 1) {                                                       \
-    psError(__func__,"Unallowable operation: %s has zero rows or columns (%dx%d).", #NAME,              \
-            NAME->numCols, NAME->numRows);                                                          \
-    return(NULL); \
-}
-
-#define PS_CHECK_IMAGE_TYPE_RETURN_NULL(NAME, TYPE) \
-if (NAME->type.type != TYPE) { \
-    psError(__func__,"Unallowable operation: %s has incorrect type.", #NAME); \
-    return(NULL); \
-}
-
-/** Preprocessor macro to generate error on a NULL image */
-#define PS_CHECK_NULL_IMAGE_READOUT_NULL(NAME) \
-if (NAME == NULL || NAME->image == NULL) {                                                         \
-    psError(__func__,"Unallowable operation: %s or its data is NULL.", #NAME);                          \
-    return(NULL); \
-}
-
-#define PS_CHECK_NULL_1DPOLY_RETURN_NULL(NAME)                                                          \
-if (NAME == NULL || NAME->coeff == NULL) {                                                         \
-    psError(__func__,"Unallowable operation: %s or its coeffs is NULL.", #NAME);                          \
-    return(NULL); \
-} \
-
-
-
-
-
 #define PS_PRINT_VECTOR(NAME) \
 for (int my_i=0;my_i<NAME->n;my_i++) { \
@@ -189 +159 @@
 
 
+
+/*****************************************************************************
+ 
+*****************************************************************************/
+#define PS_CHECK_NULL_POLY(NAME, NULL) \
+if (NAME == NULL || NAME->coeff == NULL) { \
+    psError(__func__,"Unallowable operation: polynomial %s or its coeffs is NULL.", #NAME); \
+    return(NULL); \
+} \
+
+
+
+
+
+/*****************************************************************************
+ 
+*****************************************************************************/
+/** Preprocessor macro to generate error on a NULL image */
+#define PS_CHECK_NULL_IMAGE(NAME, RVAL) \
+if (NAME == NULL || NAME->data.V == NULL) { \
+    psError(__func__,"Unallowable operation: psImage %s or its data is NULL.", #NAME); \
+    return(RVAL); \
+}
+
+/** Preprocessor macro to generate error for zero length rows or columns */
+#define PS_CHECK_EMPTY_IMAGE(NAME, RVAL) \
+if (NAME->numCols < 1 || NAME->numRows < 1) { \
+    psError(__func__,"Unallowable operation: psImage %s has zero rows or columns (%dx%d).", #NAME, \
+            NAME->numCols, NAME->numRows); \
+    return(RVAL); \
+}
+
+#define PS_CHECK_IMAGE_TYPE(NAME, TYPE, RVAL) \
+if (NAME->type.type != TYPE) { \
+    psError(__func__,"Unallowable operation: psImage %s has incorrect type.", #NAME); \
+    return(RVAL); \
+}
+
+/*****************************************************************************
+ 
+ *****************************************************************************/
+/** Preprocessor macro to generate error on a NULL image */
+#define PS_CHECK_NULL_IMAGE_READOUT(NAME, RVAL) \
+if (NAME == NULL || NAME->image == NULL) {                                                         \
+    psError(__func__,"Unallowable operation: psReadout %s or its data is NULL.", #NAME); \
+    return(RVAL); \
+}
+
+
+
+
+
+/*****************************************************************************
+ 
+ *****************************************************************************/
 #define PS_MAX(A, B) \
 (((A) > (B)) ? (A) : (B)) \