From 4ac7b7aeef8a4a8f8e3b9bf37be883479919a662 Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Fri, 30 Oct 2009 15:51:26 -0500 Subject: [svn-r17796] Description: Added --use-system-epsilon option and necessary discussion. -- Fixes Bugzilla entry 1677. Formatting and HTML adjustments for readability and to conform with template. Tested: Safari --- doc/html/Tools.html | 2 +- doc/html/Tools/h5diff.htm | 78 ++++++++++++++++++++++++++++++++++------------- 2 files changed, 57 insertions(+), 23 deletions(-) diff --git a/doc/html/Tools.html b/doc/html/Tools.html index e5f96dc..7cb6fb6 100644 --- a/doc/html/Tools.html +++ b/doc/html/Tools.html @@ -271,7 +271,7 @@ Describes HDF5 Release 1.6.10, November 2009  
diff --git a/doc/html/Tools/h5diff.htm b/doc/html/Tools/h5diff.htm index 936e80d..591b004 100644 --- a/doc/html/Tools/h5diff.htm +++ b/doc/html/Tools/h5diff.htm @@ -3,7 +3,7 @@
- Last modified: 29 April 2009 + Last modified: 30 October 2009
Tool Name: h5diff     @@ -11,8 +11,10 @@
h5diff file1 file2 [OPTIONS] [object1 [object2 ] ] +

Purpose:
Compares two HDF5 files and reports the differences. +

Description:
h5diff is a command line tool that compares two HDF5 files, file1 and file2, and @@ -29,19 +31,21 @@ object1 in file1 with object2 in file2. These objects must be HDF5 datasets. -

object1 and object2 must be expressed as absolute paths from the respective file's root group. -

- h5diff has the following four modes of output:
- Normal mode: print the number of differences found and where they occurred
- Report mode (-r): print the above plus the differences
- Verbose mode (-v): print the above plus a list of objects and warnings
- Quiet mode (-q): do not print output (h5diff always returns an exit code of - 1 when differences are found). -

+ h5diff has the following four modes of output: +
+ Normal mode: Print the number of differences found and where + they occurred. +
+ Report mode (-r): Print the above plus the differences. +
+ Verbose mode (-v): Print the above plus a list of objects and warnings. +
+ Quiet mode (-q): Do not print output + (h5diff always returns an exit code of 1 when differences are found).

Additional information, with several sample cases, can be found in the document @@ -68,6 +72,7 @@ whether any of the differences are associated with NaN values. +

Options and Parameters:
file1 @@ -109,11 +114,27 @@ (e.g., |1–(b/a)| > relative where a is a value in file1 and b is a value in file2). +
--use-system-epsilon +
Return a difference if and only if the difference + between two data values exceeds the system value for epsilon. + That is, if a is a data value in one dataset, + b is the corresponding data value in the + dataset with which the first dataset is being compared, and + epsilon is the system epsilon, + return a difference if and only if + |a-b| > epsilon. +
+ Default: Without this option, + h5diff checks for strict equality. +
+ This option has no single-letter short form. +
object1
object2
Specific object(s) within the files to be compared.
+

Exit Status:
@@ -130,39 +151,52 @@
+

Examples:
The following h5diff call compares the object /a/b in file1 with the object /a/c in file2:
    h5diff file1 file2 /a/b /a/c -
This h5diff call compares +

+ This h5diff call compares the object /a/b in file1 with the same object in file2:
    h5diff file1 file2 /a/b -

And this h5diff call compares +

+ And this h5diff call compares all objects in both files:
    h5diff file1 file2 -  
- file1 and file2 can be the same file. Use:
+

+ file1 and file2 can be the same file. + Use:
    h5diff file1 file1 /g1/dset1 /g1/dset2 
- to compare /g1/dset1  and /g1/dset2 in the same file +

History: -
    +
    - + + Command Line Tool + + + - + -
    - Release     + Release     - Command Line Tool
    1.6.0 + Tool introduced in this release.
    1.6.01.6.10 - Tool introduced in this release.
+ --use-system-epsilon + option added in this release. +
-- cgit v0.12