diff options
Diffstat (limited to 'develop/group___a_t_o_m.html')
| -rw-r--r-- | develop/group___a_t_o_m.html | 44 |
1 files changed, 22 insertions, 22 deletions
diff --git a/develop/group___a_t_o_m.html b/develop/group___a_t_o_m.html index 09fa0ae..7b1bf69 100644 --- a/develop/group___a_t_o_m.html +++ b/develop/group___a_t_o_m.html @@ -37,7 +37,7 @@ <td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname"><a href="https://www.hdfgroup.org">HDF5</a> -  <span id="projectnumber">1.15.0.184445f</span> +  <span id="projectnumber">1.15.0.5f5f5f0</span> </div> <div id="projectbrief">API Reference</div> </td> @@ -221,7 +221,7 @@ Functions</h2></td></tr> <tr> <td><a class="el" href="_h5_tpublic_8h.html#a03755b8370672668ddc7063add28e71aa41685667f69bf81eb7de5dd5f452e658">H5T_CSET_UTF8</a></td><td>UTF-8 Unicode encoding</td></tr> </table> -<dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> +<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl> </div> </div> @@ -250,7 +250,7 @@ Functions</h2></td></tr> </dl> <dl class="section return"><dt>Returns</dt><dd>Returns the bias if successful and 0, otherwise.</dd></dl> <p><a class="el" href="group___a_t_o_m.html#ga302b1c22cc6007ca69724a9e387e3888" title="Retrieves the exponent bias of a floating-point type.">H5Tget_ebias()</a> retrieves the exponent bias of a floating-point type.</p> -<dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> +<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl> </div> </div> @@ -318,7 +318,7 @@ Functions</h2></td></tr> </dl> <dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> <p><a class="el" href="group___a_t_o_m.html#ga42e62cb497fdec8f08cb9ac3c6de0e14" title="Retrieves floating point datatype bit field information.">H5Tget_fields()</a> retrieves information about the locations of the various bit fields of a floating point datatype. The field positions are bit positions in the significant region of the datatype. Bits are numbered with the least significant bit number zero. Any (or even all) of the arguments can be null pointers.</p> -<dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> +<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl> </div> </div> @@ -359,7 +359,7 @@ Functions</h2></td></tr> <div class="ttc" id="a_h5_tpublic_8h_html_a361ad902a75bcf442c17bf3d0bc103aaa27e402d21763ab46b5e170bed5676af4"><div class="ttname"><a href="_h5_tpublic_8h.html#a361ad902a75bcf442c17bf3d0bc103aaa27e402d21763ab46b5e170bed5676af4">H5T_PAD_ERROR</a></div><div class="ttdeci">@ H5T_PAD_ERROR</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:144</div></div> <div class="ttc" id="a_h5_tpublic_8h_html_a361ad902a75bcf442c17bf3d0bc103aaac2ca8836f78fc3e7f524098857c42e64"><div class="ttname"><a href="_h5_tpublic_8h.html#a361ad902a75bcf442c17bf3d0bc103aaac2ca8836f78fc3e7f524098857c42e64">H5T_PAD_BACKGROUND</a></div><div class="ttdeci">@ H5T_PAD_BACKGROUND</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:147</div></div> <div class="ttc" id="a_h5_tpublic_8h_html_a361ad902a75bcf442c17bf3d0bc103aaaed1384c65a60f4d623fe6bc852b72823"><div class="ttname"><a href="_h5_tpublic_8h.html#a361ad902a75bcf442c17bf3d0bc103aaaed1384c65a60f4d623fe6bc852b72823">H5T_PAD_ZERO</a></div><div class="ttdeci">@ H5T_PAD_ZERO</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:145</div></div> -</div><!-- fragment --> <dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> +</div><!-- fragment --> <dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl> </div> </div> @@ -400,7 +400,7 @@ Functions</h2></td></tr> <div class="ttc" id="a_h5_tpublic_8h_html_a609b101af0343a4a76d8c3e182cdda80a969bb16893e9aa2fb7b260596370d64e"><div class="ttname"><a href="_h5_tpublic_8h.html#a609b101af0343a4a76d8c3e182cdda80a969bb16893e9aa2fb7b260596370d64e">H5T_NORM_ERROR</a></div><div class="ttdeci">@ H5T_NORM_ERROR</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:81</div></div> <div class="ttc" id="a_h5_tpublic_8h_html_a609b101af0343a4a76d8c3e182cdda80a9dc5e01d17abf41c619e154150de8dde"><div class="ttname"><a href="_h5_tpublic_8h.html#a609b101af0343a4a76d8c3e182cdda80a9dc5e01d17abf41c619e154150de8dde">H5T_NORM_MSBSET</a></div><div class="ttdeci">@ H5T_NORM_MSBSET</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:83</div></div> <div class="ttc" id="a_h5_tpublic_8h_html_a609b101af0343a4a76d8c3e182cdda80ab1a219215c45144cf317f2ea846a861c"><div class="ttname"><a href="_h5_tpublic_8h.html#a609b101af0343a4a76d8c3e182cdda80ab1a219215c45144cf317f2ea846a861c">H5T_NORM_NONE</a></div><div class="ttdeci">@ H5T_NORM_NONE</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:84</div></div> -</div><!-- fragment --> <dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> +</div><!-- fragment --> <dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl> </div> </div> @@ -432,7 +432,7 @@ Functions</h2></td></tr> <div class="line">1: [ pad] [0x22] [0x11] [ pad]</div> <div class="line">2: [0x11] [ pad] [ pad] [0x22]</div> <div class="line">3: [0x22] [ pad] [ pad] [0x11]</div> -</div><!-- fragment --><dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> +</div><!-- fragment --><dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl> </div> </div> @@ -477,7 +477,7 @@ Functions</h2></td></tr> <div class="ttc" id="a_h5_tpublic_8h_html_a2a6a8eb856a0829fecaac60f803c9fd0ae5668f73f6c28feddb7af175ac53012d"><div class="ttname"><a href="_h5_tpublic_8h.html#a2a6a8eb856a0829fecaac60f803c9fd0ae5668f73f6c28feddb7af175ac53012d">H5T_ORDER_LE</a></div><div class="ttdeci">@ H5T_ORDER_LE</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:54</div></div> <div class="ttc" id="a_h5_tpublic_8h_html_a2a6a8eb856a0829fecaac60f803c9fd0af0f0bd9ff22f9566ba71233a8ec55ac7"><div class="ttname"><a href="_h5_tpublic_8h.html#a2a6a8eb856a0829fecaac60f803c9fd0af0f0bd9ff22f9566ba71233a8ec55ac7">H5T_ORDER_VAX</a></div><div class="ttdeci">@ H5T_ORDER_VAX</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:56</div></div> </div><!-- fragment --><p> Members of a compound datatype need not have the same byte order. If members of a compound datatype have more than one of little endian, big endian, or VAX byte order, <a class="el" href="group___a_t_o_m.html#gaeb5bd7ec46787a4b6d33947dc73c2a5f" title="Returns the byte order of an atomic datatype.">H5Tget_order()</a> will return <a class="el" href="_h5_tpublic_8h.html#a2a6a8eb856a0829fecaac60f803c9fd0a40929cbd19d8cd5422d17a2bc1bc289f">H5T_ORDER_MIXED</a> for the compound datatype. A byte order of <a class="el" href="_h5_tpublic_8h.html#a2a6a8eb856a0829fecaac60f803c9fd0a179aeb861afc806d2b739233972279f6">H5T_ORDER_NONE</a> will, however, be ignored; for example, if one or more members of a compound datatype have byte order <a class="el" href="_h5_tpublic_8h.html#a2a6a8eb856a0829fecaac60f803c9fd0a179aeb861afc806d2b739233972279f6">H5T_ORDER_NONE</a> but all other members have byte order <a class="el" href="_h5_tpublic_8h.html#a2a6a8eb856a0829fecaac60f803c9fd0ae5668f73f6c28feddb7af175ac53012d">H5T_ORDER_LE</a>, <a class="el" href="group___a_t_o_m.html#gaeb5bd7ec46787a4b6d33947dc73c2a5f" title="Returns the byte order of an atomic datatype.">H5Tget_order()</a> will return <a class="el" href="_h5_tpublic_8h.html#a2a6a8eb856a0829fecaac60f803c9fd0ae5668f73f6c28feddb7af175ac53012d">H5T_ORDER_LE</a> for the compound datatype.</p> -<dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> +<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl> </div> </div> @@ -530,7 +530,7 @@ Functions</h2></td></tr> <div class="line"> <a class="code" href="_h5_tpublic_8h.html#a361ad902a75bcf442c17bf3d0bc103aaac2ca8836f78fc3e7f524098857c42e64">H5T_PAD_BACKGROUND</a> = 2, </div> <div class="line"> <a class="code" href="_h5_tpublic_8h.html#a361ad902a75bcf442c17bf3d0bc103aaa221fdf3aa76b0784a3cc95c3f5d623b5">H5T_NPAD</a> = 3 </div> <div class="line">} <a class="code" href="_h5_tpublic_8h.html#a361ad902a75bcf442c17bf3d0bc103aa">H5T_pad_t</a>;</div> -</div><!-- fragment --> <dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> +</div><!-- fragment --> <dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl> </div> </div> @@ -559,7 +559,7 @@ Functions</h2></td></tr> </dl> <dl class="section return"><dt>Returns</dt><dd>Returns the number of significant bits if successful; otherwise 0</dd></dl> <p><a class="el" href="group___a_t_o_m.html#gaac9f5410c8cf456f048011030b7f90f9" title="Returns the precision of an atomic datatype.">H5Tget_precision()</a> returns the precision of an atomic datatype (for example, integer or float) or a datatype whose base (parent) type is an atomic type (for example, array, enum and variable length). The precision is the number of significant bits which, unless padding is present, is 8 times larger than the value returned by <a class="el" href="group___h5_t.html#ga1b971589cd7a86f3e84affdee455564e" title="Returns the size of a datatype.">H5Tget_size()</a>.</p> -<dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> +<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl> </div> </div> @@ -598,7 +598,7 @@ Functions</h2></td></tr> <div class="ttc" id="a_h5_tpublic_8h_html_af7bfee2db210a12b9290eba85d730a71a41c7133982bb30730a695b94957ba3b4"><div class="ttname"><a href="_h5_tpublic_8h.html#af7bfee2db210a12b9290eba85d730a71a41c7133982bb30730a695b94957ba3b4">H5T_NSGN</a></div><div class="ttdeci">@ H5T_NSGN</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:72</div></div> <div class="ttc" id="a_h5_tpublic_8h_html_af7bfee2db210a12b9290eba85d730a71a42dcabf08602c222e3e0084ee816be34"><div class="ttname"><a href="_h5_tpublic_8h.html#af7bfee2db210a12b9290eba85d730a71a42dcabf08602c222e3e0084ee816be34">H5T_SGN_ERROR</a></div><div class="ttdeci">@ H5T_SGN_ERROR</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:68</div></div> <div class="ttc" id="a_h5_tpublic_8h_html_af7bfee2db210a12b9290eba85d730a71aca59fce1697506dd3cbc7955eca77a12"><div class="ttname"><a href="_h5_tpublic_8h.html#af7bfee2db210a12b9290eba85d730a71aca59fce1697506dd3cbc7955eca77a12">H5T_SGN_NONE</a></div><div class="ttdeci">@ H5T_SGN_NONE</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:69</div></div> -</div><!-- fragment --> <dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> +</div><!-- fragment --> <dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl> </div> </div> @@ -635,7 +635,7 @@ Functions</h2></td></tr> <tr> <td><a class="el" href="_h5_tpublic_8h.html#ad2ab726f3bd28222a2ffb91c6bbc3514a3f73f8dae99444798f5efd7d2d2a5e5c">H5T_STR_SPACEPAD</a></td><td>2</td><td>Pad with spaces (as FORTRAN does)</td></tr> </table> -<dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> +<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl> </div> </div> @@ -718,7 +718,7 @@ Functions</h2></td></tr> <p>For example, if the character set for the datatype <code>type_id</code> is set to <a class="el" href="_h5_tpublic_8h.html#a03755b8370672668ddc7063add28e71aa41685667f69bf81eb7de5dd5f452e658">H5T_CSET_UTF8</a>, string or character data of datatype dtype_id will be encoded using the UTF-8 Unicode character set.</p> <p>ASCII and UTF-8 Unicode are the only currently supported character encodings. Extended ASCII encodings (for example, ISO 8859) are not supported. This encoding policy is not enforced by the HDF5 library. Using encodings other than ASCII and UTF-8 can lead to compatibility and usability problems.</p> <p>Note that <a class="el" href="group___a_t_o_m.html#ga4909c0c3d97c3d212fee032cc8dc031a" title="Sets character set to be used in a string or character datatype.">H5Tset_cset()</a> sets the character set for a character or string datatype while <a class="el" href="group___a_c_p_l.html#gad4fa8e2d17236786f770cf17eef908cc" title="Sets the character encoding used to encode link and attribute names.">H5Pset_char_encoding()</a> sets the character set used for an HDF5 link or attribute name.</p> -<dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> +<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl> </div> </div> @@ -758,7 +758,7 @@ Functions</h2></td></tr> </dl> <dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> <p><a class="el" href="group___a_t_o_m.html#gad2c4a8f09672f4166f39efe83d44dba2" title="Sets the exponent bias of a floating-point type.">H5Tset_ebias()</a> sets the exponent bias of a floating-point type.</p> -<dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> +<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl> </div> </div> @@ -827,7 +827,7 @@ Functions</h2></td></tr> <dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl> <p><a class="el" href="group___a_t_o_m.html#gafbdc98b45749e5cfbaf1a8689f3c403d" title="Sets locations and sizes of floating point bit fields.">H5Tset_fields()</a> sets the locations and sizes of the various floating-point bit fields. The field positions are bit positions in the significant region of the datatype. Bits are numbered with the least significant bit number zero.</p> <p>Fields are not allowed to extend beyond the number of bits of precision, nor are they allowed to overlap with one another.</p> -<dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> +<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl> </div> </div> @@ -873,7 +873,7 @@ Functions</h2></td></tr> <div class="line"> <a class="code" href="_h5_tpublic_8h.html#a361ad902a75bcf442c17bf3d0bc103aaac2ca8836f78fc3e7f524098857c42e64">H5T_PAD_BACKGROUND</a> = 2, </div> <div class="line"> <a class="code" href="_h5_tpublic_8h.html#a361ad902a75bcf442c17bf3d0bc103aaa221fdf3aa76b0784a3cc95c3f5d623b5">H5T_NPAD</a> = 3 </div> <div class="line">} <a class="code" href="_h5_tpublic_8h.html#a361ad902a75bcf442c17bf3d0bc103aa">H5T_pad_t</a>;</div> -</div><!-- fragment --> <dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> +</div><!-- fragment --> <dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl> </div> </div> @@ -919,7 +919,7 @@ Functions</h2></td></tr> <div class="line"> <a class="code" href="_h5_tpublic_8h.html#a609b101af0343a4a76d8c3e182cdda80ab1a219215c45144cf317f2ea846a861c">H5T_NORM_NONE</a> = 2 </div> <div class="line"> <span class="comment">/*H5T_NORM_NONE must be last */</span></div> <div class="line">} <a class="code" href="_h5_tpublic_8h.html#a609b101af0343a4a76d8c3e182cdda80">H5T_norm_t</a>;</div> -</div><!-- fragment --> <dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> +</div><!-- fragment --> <dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl> </div> </div> @@ -964,7 +964,7 @@ Functions</h2></td></tr> <div class="line">3: [0x22] [ pad] [ pad] [0x11]</div> </div><!-- fragment --><p> If the offset is incremented then the total size is incremented also if necessary to prevent significant bits of the value from hanging over the edge of the datatype.</p> <p>The offset of an <a class="el" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a2de5d7919fe54466b7cf6a6c0b4265fa">H5T_STRING</a> cannot be set to anything but zero.</p> -<dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> +<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl> </div> </div> @@ -1023,7 +1023,7 @@ Functions</h2></td></tr> <li>Opaque datatypes: Byte order can be set but has no effect.</li> </ul> </dd></dl> -<dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> +<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl> </div> </div> @@ -1120,7 +1120,7 @@ Functions</h2></td></tr> <p>If the precision is increased then the offset is decreased and then the size is increased to insure that significant bits do not "hang over" the edge of the datatype.</p> <p>Changing the precision of an <a class="el" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a2de5d7919fe54466b7cf6a6c0b4265fa">H5T_STRING</a> automatically changes the size as well. The precision must be a multiple of 8.</p> <p>When decreasing the precision of a floating point type, set the locations and sizes of the sign, mantissa, and exponent fields first.</p> -<dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> +<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl> </div> </div> @@ -1165,7 +1165,7 @@ Functions</h2></td></tr> <tr> <td><a class="el" href="_h5_tpublic_8h.html#af7bfee2db210a12b9290eba85d730a71a1152d5238ff7af5c9d50edfea1ed1357">H5T_SGN_2</a></td><td>1</td><td>Two's complement signed integer type</td></tr> </table> -<dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> +<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl> </div> </div> @@ -1216,7 +1216,7 @@ Functions</h2></td></tr> </table> <p>When converting from a longer string to a shorter string, the behavior is as follows. If the shorter string is <a class="el" href="_h5_tpublic_8h.html#ad2ab726f3bd28222a2ffb91c6bbc3514a128d51156e51b7a2c9db0fe8787b4547">H5T_STR_NULLPAD</a> or <a class="el" href="_h5_tpublic_8h.html#ad2ab726f3bd28222a2ffb91c6bbc3514a3f73f8dae99444798f5efd7d2d2a5e5c">H5T_STR_SPACEPAD</a>, then the string is simply truncated. If the short string is <a class="el" href="_h5_tpublic_8h.html#ad2ab726f3bd28222a2ffb91c6bbc3514a23c685afc240bbac4da23b36d8fd7e13">H5T_STR_NULLTERM</a>, it is truncated and a null terminator is appended.</p> <p>When converting from a shorter string to a longer string, the longer string is padded on the end by appending nulls or spaces.</p> -<dl class="section since"><dt>Since</dt><dd>1.2.0 </dd></dl> +<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl> </div> </div> |