[svn-r12134] Purpose:

bug fix

Description:
1) added a more explainative usage message
2) the percent relative error for the integer type (division) was being done using integer arythmetic; use floating point arythmetic instead
3) added a new test for integer percent

Solution:

Platforms tested:
linux (32,64)
AIX
solaris

Misc. update:

3 files changed, 281 insertions, 271 deletions

diff --git a/tools/h5diff/h5diff_common.c b/tools/h5diff/h5diff_common.c
index 441f291..3ba45c3 100644
--- a/tools/h5diff/h5diff_common.c
+++ b/tools/h5diff/h5diff_common.c
@@ -25,151 +25,152 @@
  *-------------------------------------------------------------------------
  */
 
-void parse_input(int argc, const char* argv[], const char** fname1, const char** fname2, const char** objname1, const char** objname2, diff_opt_t* options)
+void parse_input(int argc, const char* argv[], const char** fname1, const char** fname2, 
+                 const char** objname1, const char** objname2, diff_opt_t* options)
 {
-    int        i;
-    const char *s = NULL;
-
-    /* process the command-line */
-    memset(options, 0, sizeof (diff_opt_t));
-
-    /*-------------------------------------------------------------------------
-     * initial check of command line options
-     *-------------------------------------------------------------------------
-     */
-
-    if ( argc==2 && (strcmp("-h",argv[1])==0) )
- usage();
-
-    if ( argc<3 )
-    {
- printf("Number of arguments is only %d\n", argc );
- usage();
-    }
-
-    /*-------------------------------------------------------------------------
-     * file names are first
-     *-------------------------------------------------------------------------
-     */
-    if ( argc>=3 )
-    {
- *fname1 = argv[1];
- *fname2 = argv[2];
-    }
-    /*-------------------------------------------------------------------------
-     * parse command line options
-     *-------------------------------------------------------------------------
-     */
-    for (i=3; i<argc ; i++)
-    {
- /* get the single-letter switches */
- if ( '-'==argv[i][0] )
+ int        i;
+ const char *s = NULL;
+ 
+ /* process the command-line */
+ memset(options, 0, sizeof (diff_opt_t));
+ 
+/*-------------------------------------------------------------------------
+ * initial check of command line options
+ *-------------------------------------------------------------------------
+ */
+ 
+ if ( argc==2 && (strcmp("-h",argv[1])==0) )
+  usage();
+ 
+ if ( argc<3 )
  {
-     for (s=argv[i]+1; *s; s++)
-     {
-  switch (*s) {
-      default:
-   printf("-%s is an invalid option\n", s );
-   usage();
-   break;
-      case 'h':
-   usage();
-   break;
-      case 'v':
-   options->m_verbose = 1;
-   break;
-      case 'q':
-   /* use quiet mode; supress the message "0 differences found" */
-   options->m_quiet = 1;
-   break;
-      case 'r':
-   options->m_report = 1;
-   break;
-      case 'd':
-   /* if it is not another option */
-   if ( i<argc-1 &&'-' != argv[i+1][0] )
-   {
-       options->d=1;
-       if ( check_f_input(argv[i+1])==-1)
-       {
-    printf("<-d %s> is not a valid option\n", argv[i+1] );
-    usage();
-       }
-       options->delta = atof(argv[i+1]);
-       i++; /* go to next */
-   }
-   else
+  printf("Number of arguments is only %d\n", argc );
+  usage();
+ }
+ 
+/*-------------------------------------------------------------------------
+ * file names are first
+ *-------------------------------------------------------------------------
+ */
+ if ( argc>=3 )
+ {
+  *fname1 = argv[1];
+  *fname2 = argv[2];
+ }
+/*-------------------------------------------------------------------------
+ * parse command line options
+ *-------------------------------------------------------------------------
+ */
+ for (i=3; i<argc ; i++)
+ {
+  /* get the single-letter switches */
+  if ( '-'==argv[i][0] )
+  {
+   for (s=argv[i]+1; *s; s++)
    {
-       printf("Not a valid -d option\n");
+    switch (*s) {
+    default:
+     printf("-%s is an invalid option\n", s );
+     usage();
+     break;
+    case 'h':
+     usage();
+     break;
+    case 'v':
+     options->m_verbose = 1;
+     break;
+    case 'q':
+     /* use quiet mode; supress the message "0 differences found" */
+     options->m_quiet = 1;
+     break;
+    case 'r':
+     options->m_report = 1;
+     break;
+    case 'd':
+     /* if it is not another option */
+     if ( i<argc-1 &&'-' != argv[i+1][0] )
+     {
+      options->d=1;
+      if ( check_f_input(argv[i+1])==-1)
+      {
+       printf("<-d %s> is not a valid option\n", argv[i+1] );
        usage();
-   }
-   break;
-      case 'p':
-   if ( i<argc-1 &&'-' !=argv[i+1][0] )
-   {
-       options->p=1;
-       if ( check_f_input(argv[i+1])==-1)
-       {
-    printf("<-p %s> is not a valid option\n", argv[i+1] );
-    usage();
-       }
-       options->percent = atof(argv[i+1]);
-       i++; /* go to next */
-   }
-   else
-   {
-       printf("Not a valid -p option\n");
+      }
+      options->delta = atof(argv[i+1]);
+      i++; /* go to next */
+     }
+     else
+     {
+      printf("Not a valid -d option\n");
+      usage();
+     }
+     break;
+    case 'p':
+     if ( i<argc-1 &&'-' !=argv[i+1][0] )
+     {
+      options->p=1;
+      if ( check_f_input(argv[i+1])==-1)
+      {
+       printf("<-p %s> is not a valid option\n", argv[i+1] );
        usage();
-   }
-   break;
-      case 'n':
-   if ( i<argc-1 && '-' !=argv[i+1][0] )
-   {
-       options->n=1;
-       if ( check_n_input(argv[i+1])==-1)
-       {
-    printf("<-n %s> is not a valid option\n", argv[i+1] );
-    usage();
-       }
-       options->count = atol(argv[i+1]);
-       i++; /* go to next */
-   }
-   else
-   {
-       printf("Not a valid -n option\n");
+      }
+      options->percent = atof(argv[i+1]);
+      i++; /* go to next */
+     }
+     else
+     {
+      printf("Not a valid -p option\n");
+      usage();
+     }
+     break;
+    case 'n':
+     if ( i<argc-1 && '-' !=argv[i+1][0] )
+     {
+      options->n=1;
+      if ( check_n_input(argv[i+1])==-1)
+      {
+       printf("<-n %s> is not a valid option\n", argv[i+1] );
        usage();
-   }
-   break;
-  } /*switch*/
-     } /*for*/
- } /*if*/
-
- else /* not single-letter switches */
-
- {
-     /* check if it is not a -d, -p parameter */
-     if ( '-'==argv[i-1][0] && ('d'==argv[i-1][1] ||'p'==argv[i-1][1] ))
-  continue;
+      }
+      options->count = atol(argv[i+1]);
+      i++; /* go to next */
+     }
      else
      {
-  if ( *objname1==NULL )
-      *objname1 = argv[i];
-  if ( *objname2==NULL )
+      printf("Not a valid -n option\n");
+      usage();
+     }
+     break;
+    } /*switch*/
+   } /*for*/
+  } /*if*/
+  
+  else /* not single-letter switches */
+   
   {
-      /* check if we have a second object name */
-      if ( i+1<argc && '-' !=argv[i+1][0] ) {
-   /* yes */
-   *objname2 = argv[i+1];
-   i++; /* go to next */
-      }
-      else
-   /* no */
-   *objname2 = *objname1;
-  } /*objname2*/
-     } /*else*/
- } /*else*/
-
-    }/*for*/
+   /* check if it is not a -d, -p parameter */
+   if ( '-'==argv[i-1][0] && ('d'==argv[i-1][1] ||'p'==argv[i-1][1] ))
+    continue;
+   else
+   {
+    if ( *objname1==NULL )
+     *objname1 = argv[i];
+    if ( *objname2==NULL )
+    {
+     /* check if we have a second object name */
+     if ( i+1<argc && '-' !=argv[i+1][0] ) {
+      /* yes */
+      *objname2 = argv[i+1];
+      i++; /* go to next */
+     }
+     else
+      /* no */
+      *objname2 = *objname1;
+    } /*objname2*/
+   } /*else*/
+  } /*else*/
+  
+ }/*for*/
 }
 
 /*-------------------------------------------------------------------------
@@ -180,28 +181,28 @@ void parse_input(int argc, const char* argv[], const char** fname1, const char**
  *-------------------------------------------------------------------------
  */
 
- void  print_results(diff_opt_t* options)
+void  print_results(diff_opt_t* options)
+{
+ if (options->m_quiet || options->err_stat)
+  return;
+ 
+ if (options->cmn_objs==0)
  {
-  if (options->m_quiet || options->err_stat)
-   return;
-
-  if (options->cmn_objs==0)
-  {
-   printf("No common objects found. Files are not comparable.\n");
-   if (!options->m_verbose)
-    printf("Use -v for a list of objects.\n");
-  }
-
-  if (options->not_cmp==1)
-  {
-			printf("--------------------------------\n");
-   printf("Some objects are not comparable\n");
-			printf("--------------------------------\n");
-   if (!options->m_verbose)
-    printf("Use -v for a list of objects.\n");
-  }
-
+  printf("No common objects found. Files are not comparable.\n");
+  if (!options->m_verbose)
+   printf("Use -v for a list of objects.\n");
+ }
+ 
+ if (options->not_cmp==1)
+ {
+  printf("--------------------------------\n");
+  printf("Some objects are not comparable\n");
+  printf("--------------------------------\n");
+  if (!options->m_verbose)
+   printf("Use -v for a list of objects.\n");
  }
+ 
+}
 
 /*-------------------------------------------------------------------------
  * Function: check_n_input
@@ -222,22 +223,22 @@ void parse_input(int argc, const char* argv[], const char** fname1, const char**
  */
 int check_n_input( const char *str )
 {
-    unsigned i;
-    char c;
-
-    for ( i = 0; i < strlen(str); i++)
-    {
- c = str[i];
- if ( i==0 )
+ unsigned i;
+ char c;
+ 
+ for ( i = 0; i < strlen(str); i++)
  {
-     if ( c < 49 || c > 57  ) /* ascii values between 1 and 9 */
-  return -1;
+  c = str[i];
+  if ( i==0 )
+  {
+   if ( c < 49 || c > 57  ) /* ascii values between 1 and 9 */
+    return -1;
+  }
+  else
+   if ( c < 48 || c > 57  ) /* 0 also */
+    return -1;
  }
- else
-     if ( c < 48 || c > 57  ) /* 0 also */
-  return -1;
-    }
-    return 1;
+ return 1;
 }
 
 /*-------------------------------------------------------------------------
@@ -257,20 +258,20 @@ int check_n_input( const char *str )
  */
 int check_f_input( const char *str )
 {
-    double x;
-
-    /*
-       the atof return value on a hexadecimal input is different
-       on some systems; we do a character check for this
-     */
-    if (strlen(str)>2 && str[0]=='0' && str[1]=='x')
- return -1;
-
-    x=atof(str);
-    if (x==0)
- return -1;
-
-    return 1;
+ double x;
+ 
+ /*
+ the atof return value on a hexadecimal input is different
+ on some systems; we do a character check for this
+ */
+ if (strlen(str)>2 && str[0]=='0' && str[1]=='x')
+  return -1;
+ 
+ x=atof(str);
+ if (x==0)
+  return -1;
+ 
+ return 1;
 }
 
 /*-------------------------------------------------------------------------
@@ -284,59 +285,64 @@ int check_f_input( const char *str )
  */
 void usage(void)
 {
-    printf("Usage: h5diff file1 file2 [OPTIONS] [obj1[obj2]] \n");
-    printf("\n");
-    printf("file1             File name of the first HDF5 file\n");
-    printf("file2             File name of the second HDF5 file\n");
-    printf("[obj1]            Name of an HDF5 object, in absolute path\n");
-    printf("[obj2]            Name of an HDF5 object, in absolute path\n");
-    printf("[OPTIONS] are:\n");
-    printf("[-h]              Print out this information\n");
-    printf("[-r]              Report mode. Print the differences\n");
-    printf("[-v]              Verbose mode. Print the differences, list of objects, warnings\n");
-    printf("[-q]              Quiet mode. Do not do output\n");
-    printf("[-n count]        Print difference up to count number\n");
-    printf("[-d delta]        Print difference when it is greater than limit delta\n");
-    printf("[-p relative]     Print difference when it is greater than a relative limit\n");
-    printf("\n");
-    printf("Items in [] are optional\n");
-    printf("[obj1] and [obj2] are HDF5 objects (datasets, groups or datatypes)\n");
-    printf("The 'count' value must be a positive integer\n");
-    printf("The 'delta' and 'relative' values must be positive numbers\n");
-    printf("The -d compare criteria is |a - b| > delta\n");
-    printf("The -p compare criteria is |1 - b/a| > relative\n");
-    printf("\n");
-    printf("h5diff has four modes of output:\n");
-    printf(" Normal mode: print the number of differences found and where they occured\n");
-    printf(" Report mode: print the above plus the differences\n");
-    printf(" Verbose mode: print the above plus a list of objects and warnings\n");
-    printf(" Quiet mode: do not print output (h5diff always returns an exit code of 1 when differences are found)\n");
-    printf("\n");
-    printf("Examples of use:\n");
-    printf("\n");
-    printf("1) h5diff file1 file2 /g1/dset1 /g1/dset2\n");
-    printf("\n");
-    printf("   Compares object '/g1/dset1' in file1 with '/g1/dset2' in file2\n");
-    printf("\n");
-    printf("2) h5diff file1 file2 /g1/dset1\n");
-    printf("\n");
-    printf("   Compares object '/g1/dset1' in both files\n");
-    printf("\n");
-    printf("3) h5diff file1 file2\n");
-    printf("\n");
-    printf("   Compares all objects in both files\n");
-    printf("\n");
-    printf("Note)  file1 and file2 can be the same file. Use\n");
-    printf("\n");
-    printf("   h5diff file1 file1 /g1/dset1 /g1/dset2\n");
-    printf("\n");
-    printf("   to compare '/g1/dset1' and '/g1/dset2' in the same file\n");
+ printf("Usage: h5diff file1 file2 [OPTIONS] [obj1[obj2]] \n");
+ printf("\n");
+ printf("file1             File name of the first HDF5 file\n");
+ printf("file2             File name of the second HDF5 file\n");
+ printf("[obj1]            Name of an HDF5 object, in absolute path\n");
+ printf("[obj2]            Name of an HDF5 object, in absolute path\n");
+ printf("[OPTIONS] are:\n");
+ printf("[-h]              Print out this information\n");
+ printf("[-r]              Report mode. Print the differences\n");
+ printf("[-v]              Verbose mode. Print the differences, list of objects, warnings\n");
+ printf("[-q]              Quiet mode. Do not do output\n");
+ printf("[-n count]        Print difference up to count number\n");
+ printf("[-d delta]        Print difference when it is greater than limit delta\n");
+ printf("[-p relative]     Print difference when it is greater than a relative limit\n");
+ printf("\n");
+ printf("Items in [] are optional\n");
+ printf("[obj1] and [obj2] are HDF5 objects (datasets, groups, datatypes or links)\n");
+ printf("The 'count' value must be a positive integer\n");
+ printf("The 'delta' and 'relative' values must be positive numbers\n");
+ printf("The -d compare criteria is |a - b| > delta\n");
+ printf("The -p compare criteria is |1 - b/a| > relative\n");
+ printf("\n");
+ printf("h5diff has four modes of output:\n");
+ printf(" Normal mode: print the number of differences found and where they occured\n");
+ printf(" Report mode: print the above plus the differences\n");
+ printf(" Verbose mode: print the above plus a list of objects and warnings\n");
+ printf(" Quiet mode: do not print output (h5diff always returns an exit code of 1 when differences are found)\n");
+ printf("\n");
+ printf("Examples of use:\n");
+ printf("\n");
+ printf("1) h5diff file1 file2 /g1/dset1 /g1/dset2\n");
+ printf("\n");
+ printf("   Compares object '/g1/dset1' in file1 with '/g1/dset2' in file2\n");
+ printf("\n");
+ printf("2) h5diff file1 file2 /g1/dset1\n");
+ printf("\n");
+ printf("   Compares object '/g1/dset1' in both files\n");
+ printf("\n");
+ printf("3) h5diff file1 file2\n");
+ printf("\n");
+ printf("   Compares all objects in both files\n");
+ printf("\n");
+ printf("Note)  file1 and file2 can be the same file. Use\n");
+ printf("\n");
+ printf("   h5diff file1 file1 /g1/dset1 /g1/dset2\n");
+ printf("\n");
+ printf("   to compare '/g1/dset1' and '/g1/dset2' in the same file\n");
+ printf("\n");
+ printf("If no objects are specified, h5diff only compares objects with the same ");
+ printf("absolute path in both files. The compare criteria is: ");
+ printf("1) datasets: numerical array differences 2) groups: name string difference ");
+ printf("3) datatypes: the return value of H5Tequal 2) links: name string difference of the linked value\n");
 #ifdef H5_HAVE_PARALLEL
-    if(g_Parallel)
- h5diff_exit(0);
-    else
+ if(g_Parallel)
+  h5diff_exit(0);
+ else
 #endif
-    exit(0);
+  exit(0);
 }
 
 /*-------------------------------------------------------------------------
@@ -358,14 +364,14 @@ void usage(void)
 void h5diff_exit(int status)
 {
 #ifdef H5_HAVE_PARALLEL
-    /* if in parallel mode, dismiss workers, close down MPI, then exit */
-    if((g_nTasks > 1) && g_Parallel) {
- phdiff_dismiss_workers();
- MPI_Barrier(MPI_COMM_WORLD);
-    }
-    if(g_Parallel)
- MPI_Finalize();
+ /* if in parallel mode, dismiss workers, close down MPI, then exit */
+ if((g_nTasks > 1) && g_Parallel) {
+  phdiff_dismiss_workers();
+  MPI_Barrier(MPI_COMM_WORLD);
+ }
+ if(g_Parallel)
+  MPI_Finalize();
 #endif
-    exit(status);
+ exit(status);
 }
 
diff --git a/tools/h5diff/h5diff_main.c b/tools/h5diff/h5diff_main.c
index cd23d4b..836a335 100644
--- a/tools/h5diff/h5diff_main.c
+++ b/tools/h5diff/h5diff_main.c
@@ -39,41 +39,41 @@
  *   Quiet mode: do not print output
  *
  * November 2004: Leon Arber (larber@uiuc.edu)
- * 		  Additions that allow h5diff to be run in parallel
+ *     Additions that allow h5diff to be run in parallel
  *
  * February 2005: Leon Arber (larber@uiuc.edu)
- * 		h5diff and ph5diff split into two files, one that is used
- * 		to build a serial h5diff and one used to build a parallel h5diff
- * 		Common functions have been moved to h5diff_common.c
+ *   h5diff and ph5diff split into two files, one that is used
+ *   to build a serial h5diff and one used to build a parallel h5diff
+ *   Common functions have been moved to h5diff_common.c
  *-------------------------------------------------------------------------
  */
 
 
 int main(int argc, const char *argv[])
 {
-    int        ret;
-    const char *fname1 = NULL;
-    const char *fname2 = NULL;
-    const char *objname1  = NULL;
-    const char *objname2  = NULL;
-    hsize_t    nfound=0;
-    diff_opt_t options;
-
-    parse_input(argc, argv, &fname1, &fname2, &objname1, &objname2, &options);
-
-    nfound = h5diff(fname1,fname2,objname1,objname2,&options);
-
-    print_results(&options);
-
-    /*-------------------------------------------------------------------------
-     * exit code
-     *   >0 if differences, 0 if no differences, <0 if error
-     *-------------------------------------------------------------------------
-     */
-
-    ret= (nfound==0 ? 0 : 1 );
-    if (options.err_stat)
-	ret=-1;
-    return ret;
+ int        ret;
+ const char *fname1 = NULL;
+ const char *fname2 = NULL;
+ const char *objname1  = NULL;
+ const char *objname2  = NULL;
+ hsize_t    nfound=0;
+ diff_opt_t options;
+ 
+ parse_input(argc, argv, &fname1, &fname2, &objname1, &objname2, &options);
+ 
+ nfound = h5diff(fname1,fname2,objname1,objname2,&options);
+ 
+ print_results(&options);
+ 
+/*-------------------------------------------------------------------------
+ * exit code
+ *   >0 if differences, 0 if no differences, <0 if error
+ *-------------------------------------------------------------------------
+ */
+ 
+ ret= (nfound==0 ? 0 : 1 );
+ if (options.err_stat)
+  ret=-1;
+ return ret;
 }
 
diff --git a/tools/h5diff/testh5diff.sh b/tools/h5diff/testh5diff.sh
index 49ca6e9..20b0f9b 100755
--- a/tools/h5diff/testh5diff.sh
+++ b/tools/h5diff/testh5diff.sh
@@ -276,6 +276,10 @@ TOOLTEST h5diff_17.txt file1.h5 file2.h5 -v
 # 1.8 quiet mode 
 TOOLTEST h5diff_18.txt file1.h5 file2.h5 -q
 
+# 1.9 with -p (int)
+TOOLTEST h5diff_191.txt file1.h5 file1.h5 -v -p 0.02 g1/dset5 g1/dset6
+
+
 # ##############################################################################
 # # not comparable types
 # ##############################################################################