Skip to content

Commit

Permalink
Deploying to gh-pages from @ 8b973b1 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
LTLA committed Jan 3, 2024
1 parent e5ee211 commit 3c146cc
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 16 deletions.
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ <h2>Quick start</h2>
<div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="uzuki2_8hpp.html">uzuki2/uzuki2.hpp</a>&quot;</span></div>
<div class="line"><a class="code hl_function" href="namespaceuzuki2_1_1hdf5.html#a6a49fe20086ded1bd5e95fc78472523c">uzuki2::hdf5::validate</a>(h5_file_path, h5_group_name);</div>
<div class="line"><a class="code hl_function" href="namespaceuzuki2_1_1json.html#abff6ef0d77d222cd9b3daae7185d07f8">uzuki2::json::validate</a>(json_file_path);</div>
<div class="ttc" id="anamespaceuzuki2_1_1hdf5_html_a6a49fe20086ded1bd5e95fc78472523c"><div class="ttname"><a href="namespaceuzuki2_1_1hdf5.html#a6a49fe20086ded1bd5e95fc78472523c">uzuki2::hdf5::validate</a></div><div class="ttdeci">void validate(const H5::Group &amp;handle, int num_external=0, Options options=Options())</div><div class="ttdef"><b>Definition:</b> parse_hdf5.hpp:540</div></div>
<div class="ttc" id="anamespaceuzuki2_1_1hdf5_html_a6a49fe20086ded1bd5e95fc78472523c"><div class="ttname"><a href="namespaceuzuki2_1_1hdf5.html#a6a49fe20086ded1bd5e95fc78472523c">uzuki2::hdf5::validate</a></div><div class="ttdeci">void validate(const H5::Group &amp;handle, int num_external=0, Options options=Options())</div><div class="ttdef"><b>Definition:</b> parse_hdf5.hpp:538</div></div>
<div class="ttc" id="anamespaceuzuki2_1_1json_html_abff6ef0d77d222cd9b3daae7185d07f8"><div class="ttname"><a href="namespaceuzuki2_1_1json.html#abff6ef0d77d222cd9b3daae7185d07f8">uzuki2::json::validate</a></div><div class="ttdeci">void validate(byteme::Reader &amp;reader, int num_external=0, Options options=Options())</div><div class="ttdef"><b>Definition:</b> parse_json.hpp:576</div></div>
<div class="ttc" id="auzuki2_8hpp_html"><div class="ttname"><a href="uzuki2_8hpp.html">uzuki2.hpp</a></div><div class="ttdoc">Umbrella header for the uzuki2 library.</div></div>
</div><!-- fragment --><p >This will raise an error if any violations of the specification are observed. If a non-zero expected number of external objects is present:</p>
Expand Down
1 change: 0 additions & 1 deletion docs/namespaceuzuki2_1_1hdf5.html
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,6 @@ <h2 class="memtitle"><span class="permalink"><a href="#a6a49fe20086ded1bd5e95fc7
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>Handle for a HDF5 group corresponding to the list. </td></tr>
<tr><td class="paramname">name</td><td>Name of the HDF5 group corresponding to <code>handle</code>. Only used for error messages. </td></tr>
<tr><td class="paramname">num_external</td><td>Expected number of external references. </td></tr>
<tr><td class="paramname">options</td><td>Optional parameters. </td></tr>
</table>
Expand Down
28 changes: 14 additions & 14 deletions docs/parse__hdf5_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -488,26 +488,26 @@
<div class="line"><a id="l00527" name="l00527"></a><span class="lineno"> 527</span> <span class="keywordflow">return</span> parse&lt;Provisioner&gt;(ritsuko::hdf5::open_group(handle, name.c_str()), uzuki2::DummyExternals(0), std::move(options));</div>
<div class="line"><a id="l00528" name="l00528"></a><span class="lineno"> 528</span>}</div>
<div class="line"><a id="l00529" name="l00529"></a><span class="lineno"> 529</span> </div>
<div class="line"><a id="l00540" name="l00540"></a><span class="lineno"><a class="line" href="namespaceuzuki2_1_1hdf5.html#a6a49fe20086ded1bd5e95fc78472523c"> 540</a></span><span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="namespaceuzuki2_1_1hdf5.html#a6a49fe20086ded1bd5e95fc78472523c">validate</a>(<span class="keyword">const</span> H5::Group&amp; handle, <span class="keywordtype">int</span> num_external = 0, <a class="code hl_struct" href="structuzuki2_1_1hdf5_1_1Options.html">Options</a> options = <a class="code hl_struct" href="structuzuki2_1_1hdf5_1_1Options.html">Options</a>()) {</div>
<div class="line"><a id="l00541" name="l00541"></a><span class="lineno"> 541</span> DummyExternals ext(num_external);</div>
<div class="line"><a id="l00542" name="l00542"></a><span class="lineno"> 542</span> parse&lt;DummyProvisioner&gt;(handle, ext, std::move(options));</div>
<div class="line"><a id="l00543" name="l00543"></a><span class="lineno"> 543</span> <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00544" name="l00544"></a><span class="lineno"> 544</span>}</div>
<div class="line"><a id="l00545" name="l00545"></a><span class="lineno"> 545</span> </div>
<div class="line"><a id="l00555" name="l00555"></a><span class="lineno"><a class="line" href="namespaceuzuki2_1_1hdf5.html#ae561d669817325cd22dbed82897866b0"> 555</a></span><span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="namespaceuzuki2_1_1hdf5.html#a6a49fe20086ded1bd5e95fc78472523c">validate</a>(<span class="keyword">const</span> std::string&amp; file, <span class="keyword">const</span> std::string&amp; name, <span class="keywordtype">int</span> num_external = 0, <a class="code hl_struct" href="structuzuki2_1_1hdf5_1_1Options.html">Options</a> options = <a class="code hl_struct" href="structuzuki2_1_1hdf5_1_1Options.html">Options</a>()) {</div>
<div class="line"><a id="l00556" name="l00556"></a><span class="lineno"> 556</span> DummyExternals ext(num_external);</div>
<div class="line"><a id="l00557" name="l00557"></a><span class="lineno"> 557</span> parse&lt;DummyProvisioner&gt;(file, name, ext, std::move(options));</div>
<div class="line"><a id="l00558" name="l00558"></a><span class="lineno"> 558</span> <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00538" name="l00538"></a><span class="lineno"><a class="line" href="namespaceuzuki2_1_1hdf5.html#a6a49fe20086ded1bd5e95fc78472523c"> 538</a></span><span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="namespaceuzuki2_1_1hdf5.html#a6a49fe20086ded1bd5e95fc78472523c">validate</a>(<span class="keyword">const</span> H5::Group&amp; handle, <span class="keywordtype">int</span> num_external = 0, <a class="code hl_struct" href="structuzuki2_1_1hdf5_1_1Options.html">Options</a> options = <a class="code hl_struct" href="structuzuki2_1_1hdf5_1_1Options.html">Options</a>()) {</div>
<div class="line"><a id="l00539" name="l00539"></a><span class="lineno"> 539</span> DummyExternals ext(num_external);</div>
<div class="line"><a id="l00540" name="l00540"></a><span class="lineno"> 540</span> parse&lt;DummyProvisioner&gt;(handle, ext, std::move(options));</div>
<div class="line"><a id="l00541" name="l00541"></a><span class="lineno"> 541</span> <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00542" name="l00542"></a><span class="lineno"> 542</span>}</div>
<div class="line"><a id="l00543" name="l00543"></a><span class="lineno"> 543</span> </div>
<div class="line"><a id="l00553" name="l00553"></a><span class="lineno"><a class="line" href="namespaceuzuki2_1_1hdf5.html#ae561d669817325cd22dbed82897866b0"> 553</a></span><span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code hl_function" href="namespaceuzuki2_1_1hdf5.html#a6a49fe20086ded1bd5e95fc78472523c">validate</a>(<span class="keyword">const</span> std::string&amp; file, <span class="keyword">const</span> std::string&amp; name, <span class="keywordtype">int</span> num_external = 0, <a class="code hl_struct" href="structuzuki2_1_1hdf5_1_1Options.html">Options</a> options = <a class="code hl_struct" href="structuzuki2_1_1hdf5_1_1Options.html">Options</a>()) {</div>
<div class="line"><a id="l00554" name="l00554"></a><span class="lineno"> 554</span> DummyExternals ext(num_external);</div>
<div class="line"><a id="l00555" name="l00555"></a><span class="lineno"> 555</span> parse&lt;DummyProvisioner&gt;(file, name, ext, std::move(options));</div>
<div class="line"><a id="l00556" name="l00556"></a><span class="lineno"> 556</span> <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00557" name="l00557"></a><span class="lineno"> 557</span>}</div>
<div class="line"><a id="l00558" name="l00558"></a><span class="lineno"> 558</span> </div>
<div class="line"><a id="l00559" name="l00559"></a><span class="lineno"> 559</span>}</div>
<div class="line"><a id="l00560" name="l00560"></a><span class="lineno"> 560</span> </div>
<div class="line"><a id="l00561" name="l00561"></a><span class="lineno"> 561</span>}</div>
<div class="line"><a id="l00562" name="l00562"></a><span class="lineno"> 562</span> </div>
<div class="line"><a id="l00563" name="l00563"></a><span class="lineno"> 563</span>}</div>
<div class="line"><a id="l00564" name="l00564"></a><span class="lineno"> 564</span> </div>
<div class="line"><a id="l00565" name="l00565"></a><span class="lineno"> 565</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00563" name="l00563"></a><span class="lineno"> 563</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="ainterfaces_8hpp_html"><div class="ttname"><a href="interfaces_8hpp.html">interfaces.hpp</a></div><div class="ttdoc">Defines the interfaces to use in HDF5 parsing.</div></div>
<div class="ttc" id="anamespaceuzuki2_1_1hdf5_html_a66c01cda30115f3cfe2bd3397e5d51c2"><div class="ttname"><a href="namespaceuzuki2_1_1hdf5.html#a66c01cda30115f3cfe2bd3397e5d51c2">uzuki2::hdf5::parse</a></div><div class="ttdeci">ParsedList parse(const H5::Group &amp;handle, Externals ext, Options options=Options())</div><div class="ttdef"><b>Definition:</b> parse_hdf5.hpp:448</div></div>
<div class="ttc" id="anamespaceuzuki2_1_1hdf5_html_a6a49fe20086ded1bd5e95fc78472523c"><div class="ttname"><a href="namespaceuzuki2_1_1hdf5.html#a6a49fe20086ded1bd5e95fc78472523c">uzuki2::hdf5::validate</a></div><div class="ttdeci">void validate(const H5::Group &amp;handle, int num_external=0, Options options=Options())</div><div class="ttdef"><b>Definition:</b> parse_hdf5.hpp:540</div></div>
<div class="ttc" id="anamespaceuzuki2_1_1hdf5_html_a6a49fe20086ded1bd5e95fc78472523c"><div class="ttname"><a href="namespaceuzuki2_1_1hdf5.html#a6a49fe20086ded1bd5e95fc78472523c">uzuki2::hdf5::validate</a></div><div class="ttdeci">void validate(const H5::Group &amp;handle, int num_external=0, Options options=Options())</div><div class="ttdef"><b>Definition:</b> parse_hdf5.hpp:538</div></div>
<div class="ttc" id="anamespaceuzuki2_html"><div class="ttname"><a href="namespaceuzuki2.html">uzuki2</a></div><div class="ttdoc">Parse an R list from a HDF5 or JSON file.</div><div class="ttdef"><b>Definition:</b> parse_json.hpp:29</div></div>
<div class="ttc" id="astructuzuki2_1_1StringVector_html_a19642038725cf2a60f158245c876cab6"><div class="ttname"><a href="structuzuki2_1_1StringVector.html#a19642038725cf2a60f158245c876cab6">uzuki2::StringVector::Format</a></div><div class="ttdeci">Format</div><div class="ttdef"><b>Definition:</b> interfaces.hpp:148</div></div>
<div class="ttc" id="astructuzuki2_1_1hdf5_1_1Options_html"><div class="ttname"><a href="structuzuki2_1_1hdf5_1_1Options.html">uzuki2::hdf5::Options</a></div><div class="ttdoc">Options for HDF5 file parsing.</div><div class="ttdef"><b>Definition:</b> parse_hdf5.hpp:390</div></div>
Expand Down

0 comments on commit 3c146cc

Please sign in to comment.