Deploying to github.io from @ 23d3d32 🚀

docs/unstable/array_8hpp_source.html

@@ -111,7 +111,7 @@
   <div class="headertitle"><div class="title">array.hpp</div></div>
 </div><!--header-->
 <div class="contents">
-<a href="array_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">// Copyright (c) 2020-2022 Simons Foundation</span></div>
+<a href="array_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">// Copyright (c) 2020-2024 Simons Foundation</span></div>
 <div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment">//</span></div>
 <div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
 <div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment">// you may not use this file except in compliance with the License.</span></div>
@@ -125,7 +125,7 @@
 <div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment">// See the License for the specific language governing permissions and</span></div>
 <div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment">// limitations under the License.</span></div>
 <div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment">//</span></div>
-<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment">// Authors: Nils Wentzell</span></div>
+<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment">// Authors: Thomas Hahn, Nils Wentzell</span></div>
 <div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span> </div>
 <div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment">/**</span></div>
 <div class="line"><span class="lineno">   18</span><span class="comment"> * @file</span></div>

docs/unstable/array__interface_8cpp_source.html

@@ -111,7 +111,7 @@
   <div class="headertitle"><div class="title">array_interface.cpp</div></div>
 </div><!--header-->
 <div class="contents">
-<a href="array__interface_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">// Copyright (c) 2019-2021 Simons Foundation</span></div>
+<a href="array__interface_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">// Copyright (c) 2019-2024 Simons Foundation</span></div>
 <div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment">//</span></div>
 <div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
 <div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment">// you may not use this file except in compliance with the License.</span></div>
@@ -125,7 +125,7 @@
 <div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment">// See the License for the specific language governing permissions and</span></div>
 <div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment">// limitations under the License.</span></div>
 <div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment">//</span></div>
-<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment">// Authors: Olivier Parcollet, Nils Wentzell</span></div>
+<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment">// Authors: Thomas Hahn, Olivier Parcollet, Nils Wentzell</span></div>
 <div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span> </div>
 <div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment">/**</span></div>
 <div class="line"><span class="lineno">   18</span><span class="comment"> * @file</span></div>

docs/unstable/array__interface_8hpp_source.html

@@ -111,7 +111,7 @@
   <div class="headertitle"><div class="title">array_interface.hpp</div></div>
 </div><!--header-->
 <div class="contents">
-<a href="array__interface_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">// Copyright (c) 2019-2020 Simons Foundation</span></div>
+<a href="array__interface_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">// Copyright (c) 2019-2024 Simons Foundation</span></div>
 <div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment">//</span></div>
 <div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
 <div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment">// you may not use this file except in compliance with the License.</span></div>
@@ -125,7 +125,7 @@
 <div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment">// See the License for the specific language governing permissions and</span></div>
 <div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment">// limitations under the License.</span></div>
 <div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment">//</span></div>
-<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment">// Authors: Olivier Parcollet, Nils Wentzell</span></div>
+<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment">// Authors: Thomas Hahn, Olivier Parcollet, Nils Wentzell</span></div>
 <div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span> </div>
 <div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment">/**</span></div>
 <div class="line"><span class="lineno">   18</span><span class="comment"> * @file</span></div>

docs/unstable/changelog.html

@@ -112,11 +112,48 @@
 </div><!--header-->
 <div class="contents">
 <div class="textblock"><h2><a class="anchor" id="autotoc_md0"></a>
+Version 1.3.0</h2>
+<p>This is version 1.3.0 of h5, a high-level C++ interface to the hdf5 library.</p>
+<p>We thank all contributors: Thomas Hahn, Alexander Hampel, Henri Menke, Olivier Parcollet, Nils Wentzell</p>
+<p>Find below an itemized list of changes in this release.</p>
+<h3><a class="anchor" id="autotoc_md1"></a>
+General</h3>
+<ul>
+<li>Clean up detail namespace to consistently contain implementation details</li>
+<li>Improve test coverage and clean up tests</li>
+<li>Bug fix in h5::array_interface</li>
+<li>Allow arbitrary block sizes in h5::array_interface</li>
+<li>Clean up in h5::array_interface</li>
+<li>Bug fix in <a class="el" href="classh5_1_1file.html" title="A handle to an HDF5 file.">h5::file</a> ctor</li>
+<li>Split <a class="el" href="object_8hpp.html" title="Provides a generic handle for HDF5 objects.">object.hpp</a> into multiple header files</li>
+<li>Remove default copy constructor in group</li>
+<li>Allow additional arguments in generic <a class="el" href="group__rw__generic.html#gabf688ff83a3b4c62d1bfea507d30b077" title="Generic implementation for reading from an HDF5 dataset/subgroup.">h5::read</a> and <a class="el" href="group__rw__generic.html#gad2a999fc4d4c07de13abfa2e508e4939" title="Generic implementation for writing a variable to an HDF5 dataset/subgroup.">h5::write</a> functions</li>
+<li>Allow reading of all integer types into Python long without warning</li>
+<li>Correct installation of _h5py.wrap.hxx</li>
+<li>Add hxx clair include</li>
+<li>Add missing include in <a class="el" href="macros_8hpp.html" title="Macros used in the h5 library.">h5/macros.hpp</a></li>
+<li>Add missing cstdint include in <a class="el" href="object_8hpp.html" title="Provides a generic handle for HDF5 objects.">h5/object.hpp</a>, see issue #915</li>
+</ul>
+<h3><a class="anchor" id="autotoc_md2"></a>
+doc</h3>
+<ul>
+<li>Add documentation to the C++ source code files</li>
+<li>Remove any sphinx related files and switch to doxygen to generate documentation</li>
+<li>Build and deploy documentation with GitHub Actions</li>
+</ul>
+<h3><a class="anchor" id="autotoc_md3"></a>
+cmake</h3>
+<ul>
+<li>Use GNUInstallDirs in install commands</li>
+<li>Set policy CMP0144 to new</li>
+<li>Use CPP2PY_PYTHON_xxx variables instead of PYTHON_xxx</li>
+</ul>
+<h2><a class="anchor" id="autotoc_md4"></a>
 Version 1.2.0</h2>
 <p>This is version 1.2.0 of h5, a high-level C++ interface to the hdf5 library.</p>
 <p>We thank all contributors: Thomas Hahn, Alexander Hampel, Olivier Parcollet, Dylan Simon, Nils Wentzell</p>
 <p>Find below an itemized list of changes in this release.</p>
-<h3><a class="anchor" id="autotoc_md1"></a>
+<h3><a class="anchor" id="autotoc_md5"></a>
 General</h3>
 <ul>
 <li>Remove redundant std_addons/complex.hpp header</li>
@@ -131,7 +168,7 @@ <h3><a class="anchor" id="autotoc_md1"></a>
 <li>Remove warnings</li>
 <li>General cleanup</li>
 </ul>
-<h3><a class="anchor" id="autotoc_md2"></a>
+<h3><a class="anchor" id="autotoc_md6"></a>
 cmake</h3>
 <ul>
 <li>Add compiler warnings for IntelLLVM</li>
@@ -140,12 +177,12 @@ <h3><a class="anchor" id="autotoc_md2"></a>
 <li>Fix FindHDF5 logic for cmake versions &gt;=3.23</li>
 <li>Fix h5::hdf5 interface target for cmake versions 3.20+</li>
 </ul>
-<h3><a class="anchor" id="autotoc_md3"></a>
+<h3><a class="anchor" id="autotoc_md7"></a>
 jenkins</h3>
 <ul>
 <li>Update packaging Dockerfiles</li>
 </ul>
-<h3><a class="anchor" id="autotoc_md4"></a>
+<h3><a class="anchor" id="autotoc_md8"></a>
 fixes</h3>
 <ul>
 <li>Fix hsize_t for hdf5 versions &gt;=1.13</li>
@@ -155,12 +192,12 @@ <h3><a class="anchor" id="autotoc_md4"></a>
 <li>Allow reading vector&lt;string&gt; when stored as subgroup with numbered keys</li>
 <li>np.int / np.float / np.complex removed</li>
 </ul>
-<h2><a class="anchor" id="autotoc_md5"></a>
+<h2><a class="anchor" id="autotoc_md9"></a>
 Version 1.1.0</h2>
 <p>This is version 1.1.0 of h5, a high-level C++ interface to the hdf5 library.</p>
 <p>We thank all contributors: Daniel Bauernfeind, Alexander Hampel, Henri Menke, Dylan Simon, Nils Wentzell</p>
 <p>Find below an itemized list of changes in this release.</p>
-<h3><a class="anchor" id="autotoc_md6"></a>
+<h3><a class="anchor" id="autotoc_md10"></a>
 General</h3>
 <ul>
 <li>Allow creation of softlinks</li>
@@ -177,21 +214,21 @@ <h3><a class="anchor" id="autotoc_md6"></a>
 <li>Minor correction in h5_read doc for array and vector</li>
 <li>Consistently use header guards over pragma once</li>
 </ul>
-<h3><a class="anchor" id="autotoc_md7"></a>
+<h3><a class="anchor" id="autotoc_md11"></a>
 doc</h3>
 <ul>
 <li>Add link to reference doc to README.md</li>
 <li>Minor doc cleanups for doxygen generation, add Doxyfile and update .gitignore</li>
 </ul>
-<h3><a class="anchor" id="autotoc_md8"></a>
+<h3><a class="anchor" id="autotoc_md12"></a>
 cmake</h3>
 <ul>
 <li>Bump Version number to 1.1.0</li>
 <li>Set CXX standard using target_compile_features</li>
 <li>Bump version requirement to 3.13.5</li>
 <li>Provide a namespaced alias for the python modules</li>
 </ul>
-<h2><a class="anchor" id="autotoc_md9"></a>
+<h2><a class="anchor" id="autotoc_md13"></a>
 Version 1.0.0</h2>
 <p>h5 is a high-level C++ interface to the hdf5 library, which</p><ul>
 <li>Provides write and read functions for various STL container types</li>

docs/unstable/complex_8hpp_source.html

@@ -111,7 +111,7 @@
   <div class="headertitle"><div class="title">complex.hpp</div></div>
 </div><!--header-->
 <div class="contents">
-<a href="complex_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">// Copyright (c) 2019-2022 Simons Foundation</span></div>
+<a href="complex_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">// Copyright (c) 2024 Simons Foundation</span></div>
 <div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment">//</span></div>
 <div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
 <div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment">// you may not use this file except in compliance with the License.</span></div>
@@ -125,7 +125,7 @@
 <div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment">// See the License for the specific language governing permissions and</span></div>
 <div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment">// limitations under the License.</span></div>
 <div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment">//</span></div>
-<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment">// Authors: Olivier Parcollet, Nils Wentzell</span></div>
+<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment">// Authors: Thomas Hahn, Olivier Parcollet, Nils Wentzell</span></div>
 <div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span> </div>
 <div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment">/**</span></div>
 <div class="line"><span class="lineno">   18</span><span class="comment"> * @file</span></div>

docs/unstable/documentation.html

@@ -112,18 +112,18 @@
 </div><!--header-->
 <div class="contents">
 <div class="toc"><h3>Table of Contents</h3>
-<ul><ul><li class="level2"><a href="#autotoc_md10">h5 data model</a></li>
-<li class="level2"><a href="#autotoc_md11">h5 types</a></li>
-<li class="level2"><a href="#autotoc_md12">Read and write from/to HDF5</a></li>
-<li class="level2"><a href="#autotoc_md13">Serialize/Deserialize</a></li>
-<li class="level2"><a href="#autotoc_md14">Utilities</a></li>
+<ul><ul><li class="level2"><a href="#autotoc_md14">h5 data model</a></li>
+<li class="level2"><a href="#autotoc_md15">h5 types</a></li>
+<li class="level2"><a href="#autotoc_md16">Read and write from/to HDF5</a></li>
+<li class="level2"><a href="#autotoc_md17">Serialize/Deserialize</a></li>
+<li class="level2"><a href="#autotoc_md18">Utilities</a></li>
 </ul>
 </ul>
 </div>
 <div class="textblock"><p>The <b>h5</b> library implements various high-level C++ wrappers around their low-level C counterparts. It is not intended as a full replacement for the HDF5 C implementation. Instead it tries to help the user with the most common tasks like opening/closing files, creating groups/datasets and writing/reading data to/from HDF5 files.</p>
 <p>The following provides a detailed reference documentation grouped into logical units.</p>
 <p>If you are looking for a specific function, class, etc., try using the search bar in the top left corner.</p>
-<h2><a class="anchor" id="autotoc_md10"></a>
+<h2><a class="anchor" id="autotoc_md14"></a>
 h5 data model</h2>
 <p>The <a class="el" href="group__data__model.html">h5 data model</a> forms the backbone of the <b>h5</b> library by implementing some of the key concepts from the <a href="https://docs.hdfgroup.org/hdf5/develop/_h5_d_m__u_g.html#subsec_data_model_abstract">abstract HDF5 data model</a>. It provides concrete types for HDF5 files, groups, datasets, dataspaces and so on.</p>
 <p>The most fundamental type in <b>h5</b> is the <a class="el" href="classh5_1_1object.html" title="A generic handle for HDF5 objects.">h5::object</a>. It serves either as a base class for</p>
@@ -140,10 +140,10 @@ <h2><a class="anchor" id="autotoc_md10"></a>
 <li><a class="el" href="group__data__model.html#ga2160229edfcb9c21a9aa5332a1fd155b">h5::attribute</a></li>
 </ul>
 <p>For the average user, the two important types are the <a class="el" href="classh5_1_1file.html" title="A handle to an HDF5 file.">h5::file</a> and <a class="el" href="classh5_1_1group.html" title="A handle to an HDF5 group.">h5::group</a>. They simplify basic tasks like creating, opening and manipulating HDF5 files, groups, subgroups, datasets and links.</p>
-<h2><a class="anchor" id="autotoc_md11"></a>
+<h2><a class="anchor" id="autotoc_md15"></a>
 h5 types</h2>
 <p><a class="el" href="group__h5__types.html">h5 types</a> offers various functionality related to HDF5 datatypes, e.g. mapping C++ types to their corresponding HDF5 datatypes (see <a class="el" href="group__h5__types.html#ga92724d6ad97c1cbab14a73477693620d" title="Map a given C++ type to an HDF5 datatype.">h5::hdf5_type</a>) or getting the type stored in an HDF5 dataset (see <a class="el" href="group__h5__types.html#ga9663a6cefb9589bafc7185f7c45563fc" title="Get the HDF5 type stored in a given h5::dataset.">h5::get_hdf5_type</a>).</p>
-<h2><a class="anchor" id="autotoc_md12"></a>
+<h2><a class="anchor" id="autotoc_md16"></a>
 Read and write from/to HDF5</h2>
 <p><a class="el" href="group__readwrite.html">Read and write from/to HDF5</a> contains all the tools to actually read or write HDF5 files.</p>
 <p>At the highest level it provides a <a class="el" href="group__rw__generic.html">generic interface</a> for reading/writing from/to HDF5. Internally, the generic functions call more specialized implementations depending on what types are being passed to the interface.</p>
@@ -160,14 +160,14 @@ <h2><a class="anchor" id="autotoc_md12"></a>
 </ul>
 <p>The <a class="el" href="group__rw__arrayinterface.html">array interface</a> helps with loading and storing n-dimensional arrays.</p>
 <p>Furthermore, the generic design of the read/write functionality makes it easily extendible to support custom user types as well. <a class="el" href="ex2.html">Example 2: Write/Read a custom C++ type</a> shows how to make a user defined type HDF5 serializable.</p>
-<h2><a class="anchor" id="autotoc_md13"></a>
+<h2><a class="anchor" id="autotoc_md17"></a>
 Serialize/Deserialize</h2>
 <p><b>h5</b> can also be used to <a class="el" href="group__serialize.html">Serialize/Deserialize</a> an object to/from a byte buffer using the two generic functions:</p>
 <ul>
 <li><a class="el" href="group__serialize.html#gad2bcd8f6dac5f1b4d3726c5ba86b0ee6" title="Serialize an object to a byte buffer.">h5::serialize</a>: Store a given object in a byte buffer.</li>
 <li><a class="el" href="group__serialize.html#gaaaf280034cc7cb7233216238d956a0ad" title="Deserialize an object from a byte buffer.">h5::deserialize</a>: Restore an object from a given byte buffer.</li>
 </ul>
-<h2><a class="anchor" id="autotoc_md14"></a>
+<h2><a class="anchor" id="autotoc_md18"></a>
 Utilities</h2>
 <p><a class="el" href="group__utilities.html">Utilities</a> is a collection of convenience functions, definitions and various other tools which do not fit into any other category above but are used throughout the <b>h5</b> library. </p>
 </div></div><!-- contents -->