Skip to content
This repository has been archived by the owner on Jan 15, 2025. It is now read-only.

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Feb 20, 2024
1 parent 79a6614 commit f9d9f8b
Show file tree
Hide file tree
Showing 14 changed files with 1,428 additions and 636 deletions.
775 changes: 241 additions & 534 deletions bi_8hpp_source.html
View file

Large diffs are not rendered by default.

62 changes: 29 additions & 33 deletions bi__exceptions_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,42 +108,38 @@
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="keyword">namespace </span>bi {</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="foldopen" id="foldopen00025" data-start="{" data-end="};">
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="classbi_1_1exception.html"> 25</a></span><span class="keyword">class </span><a class="code hl_class" href="classbi_1_1exception.html">exception</a> : <span class="keyword">public</span> std::runtime_error {</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#ifdef __cpp_lib_source_location</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <a class="code hl_class" href="classbi_1_1exception.html">exception</a>(<span class="keyword">const</span> std::string&amp; message, <span class="keyword">const</span> std::source_location&amp; location =</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> std::source_location::current())</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> : std::runtime_error(message + <span class="stringliteral">&quot;Thrown at &quot;</span> + location.file_name() + <span class="stringliteral">&quot;:&quot;</span> +</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> std::to_string(location.line()) + <span class="stringliteral">&quot; in function &quot;</span> +</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> location.function_name()) {}</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classbi_1_1exception.html">exception</a>(<span class="keyword">const</span> std::string&amp; message)</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> : std::runtime_error(message) {}</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span>};</div>
<div class="foldopen" id="foldopen00018" data-start="{" data-end="};">
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="classbi_1_1exception.html"> 18</a></span><span class="keyword">class </span><a class="code hl_class" href="classbi_1_1exception.html">exception</a> : <span class="keyword">public</span> std::runtime_error {</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#ifdef __cpp_lib_source_location</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <a class="code hl_class" href="classbi_1_1exception.html">exception</a>(<span class="keyword">const</span> std::string&amp; message, <span class="keyword">const</span> std::source_location&amp; location =</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> std::source_location::current());</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classbi_1_1exception.html">exception</a>(<span class="keyword">const</span> std::string&amp; message);</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span>};</div>
</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="foldopen" id="foldopen00044" data-start="{" data-end="};">
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="classbi_1_1overflow__error.html"> 44</a></span><span class="keyword">class </span><a class="code hl_class" href="classbi_1_1overflow__error.html">overflow_error</a> : <span class="keyword">public</span> <a class="code hl_class" href="classbi_1_1exception.html">exception</a> {</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">using </span>exception::exception;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span>};</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="foldopen" id="foldopen00028" data-start="{" data-end="};">
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="classbi_1_1overflow__error.html"> 28</a></span><span class="keyword">class </span><a class="code hl_class" href="classbi_1_1overflow__error.html">overflow_error</a> : <span class="keyword">public</span> <a class="code hl_class" href="classbi_1_1exception.html">exception</a> {</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">using </span>exception::exception;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span>};</div>
</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="foldopen" id="foldopen00052" data-start="{" data-end="};">
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="classbi_1_1division__by__zero.html"> 52</a></span><span class="keyword">class </span><a class="code hl_class" href="classbi_1_1division__by__zero.html">division_by_zero</a> : <span class="keyword">public</span> <a class="code hl_class" href="classbi_1_1exception.html">exception</a> {</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">using </span>exception::exception;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span>};</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="foldopen" id="foldopen00033" data-start="{" data-end="};">
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="classbi_1_1division__by__zero.html"> 33</a></span><span class="keyword">class </span><a class="code hl_class" href="classbi_1_1division__by__zero.html">division_by_zero</a> : <span class="keyword">public</span> <a class="code hl_class" href="classbi_1_1exception.html">exception</a> {</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">using </span>exception::exception;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span>};</div>
</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span>} <span class="comment">// namespace bi</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="preprocessor">#endif </span><span class="comment">// BI_INCLUDE_BI_EXCEPTIONS_HPP_</span></div>
<div class="ttc" id="aclassbi_1_1division__by__zero_html"><div class="ttname"><a href="classbi_1_1division__by__zero.html">bi::division_by_zero</a></div><div class="ttdoc">Throws if a division by zero attempt is detected.</div><div class="ttdef"><b>Definition</b> bi_exceptions.hpp:52</div></div>
<div class="ttc" id="aclassbi_1_1exception_html"><div class="ttname"><a href="classbi_1_1exception.html">bi::exception</a></div><div class="ttdoc">Base exception class for the bi library.</div><div class="ttdef"><b>Definition</b> bi_exceptions.hpp:25</div></div>
<div class="ttc" id="aclassbi_1_1overflow__error_html"><div class="ttname"><a href="classbi_1_1overflow__error.html">bi::overflow_error</a></div><div class="ttdoc">Throws if an operation expects the result to require a digit vector with size() exceeding max_size()....</div><div class="ttdef"><b>Definition</b> bi_exceptions.hpp:44</div></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span>} <span class="comment">// namespace bi</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="preprocessor">#endif </span><span class="comment">// BI_INCLUDE_BI_EXCEPTIONS_HPP_</span></div>
<div class="ttc" id="aclassbi_1_1division__by__zero_html"><div class="ttname"><a href="classbi_1_1division__by__zero.html">bi::division_by_zero</a></div><div class="ttdoc">Throws if a division by zero attempt is detected.</div><div class="ttdef"><b>Definition</b> bi_exceptions.hpp:33</div></div>
<div class="ttc" id="aclassbi_1_1exception_html"><div class="ttname"><a href="classbi_1_1exception.html">bi::exception</a></div><div class="ttdoc">Base exception class for the bi library.</div><div class="ttdef"><b>Definition</b> bi_exceptions.hpp:18</div></div>
<div class="ttc" id="aclassbi_1_1overflow__error_html"><div class="ttname"><a href="classbi_1_1overflow__error.html">bi::overflow_error</a></div><div class="ttdoc">Throws if an operation expects the result to require a digit vector with size() exceeding max_size()....</div><div class="ttdef"><b>Definition</b> bi_exceptions.hpp:28</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
Loading

0 comments on commit f9d9f8b

Please sign in to comment.