summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFrank Baker <fbaker@hdfgroup.org>2009-04-30 21:33:02 (GMT)
committerFrank Baker <fbaker@hdfgroup.org>2009-04-30 21:33:02 (GMT)
commit4413072ae4b3e7007b01c48b454ac4850467b953 (patch)
tree67941188f8113539413a67914e031acfa1cdbdf1
parent78ec5b0403d7fdbb15cba8e12fd4a4953ce7e8fe (diff)
downloadhdf5-4413072ae4b3e7007b01c48b454ac4850467b953.zip
hdf5-4413072ae4b3e7007b01c48b454ac4850467b953.tar.gz
hdf5-4413072ae4b3e7007b01c48b454ac4850467b953.tar.bz2
[svn-r16898] Description:
Added '-n, --NaN' option. Added explanatory performance-related notes to "h5diff and NaNs" discussion.
-rw-r--r--doc/html/Tools/h5diff.htm18
1 files changed, 17 insertions, 1 deletions
diff --git a/doc/html/Tools/h5diff.htm b/doc/html/Tools/h5diff.htm
index e6221e7..6da3809 100644
--- a/doc/html/Tools/h5diff.htm
+++ b/doc/html/Tools/h5diff.htm
@@ -2,6 +2,10 @@
<!-- HEADER RIGHT "h5diff" -->
<hr>
<dl>
+<dt><div align=right><font color=999999 size=-1><i>
+ Last modified: 29 April 2009
+ </i></font></div>
+
<dt><strong>Tool Name:</strong> <a name="Tools-Diff">h5diff</a> &nbsp;&nbsp;&nbsp;
<dt><strong>Syntax:</strong>
<dd><code>h5diff </code> <em>file1</em> <em>file2</em>
@@ -54,6 +58,14 @@
Thus, when one NaN is compared with another NaN, <code>h5diff</code>
treats them as equal; when a NaN is compared with a valid number,
<code>h5diff</code> treats them as not equal.
+ <p>
+ Note that NaN detection is computationally expensive and slows
+ <code>h5diff</code> performance dramatically.
+ If you do not have NaNs in your files, or do not care about NaNs,
+ use the <code>-N</code> option below to turn off NaN detection.
+ Similarly, if <code>h5diff -N</code> produces unexpected differences,
+ running <code>h5diff</code> without <code>-N</code> should reveal
+ whether any of the differences are associated with NaN values.
<dt><strong>Options and Parameters:</strong>
@@ -65,8 +77,12 @@
<dd>help message.
<dt><code>-r</code>
<dd>Report mode. Print the differences.<dt><code>-v</code>
- <dd>Verbose mode. Print the differences, list of objects, warnings.<dt><code>-q</code>
+ <dd>Verbose mode. Print the differences, list of objects, warnings.
+ <dt><code>-q</code>
<dd>Quiet mode. Do not print output.
+ <dt><code>-N</code>
+ <dd>Disables NaN detection;
+ see &ldquo;<code>h5diff</code> and NaNs&rdquo; above.
<dt><code>-n</code> <em>count</em>
<dd>Print difference up to <em>count</em> differences,
then stop.