Skip to content

Commit

Permalink
updated doxygen documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Laouen committed Aug 13, 2018
1 parent 94e5d4d commit a9573cf
Show file tree
Hide file tree
Showing 91 changed files with 1,217 additions and 523 deletions.
2 changes: 1 addition & 1 deletion doc/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ INLINE_INHERITED_MEMB = NO
# shortest path that makes the file name unique will be used
# The default value is: YES.

FULL_PATH_NAMES = YES
FULL_PATH_NAMES = NO

# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
# Stripping is only done if one of the specified strings matches the left-hand
Expand Down
9 changes: 4 additions & 5 deletions doc/html/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
Expand Down Expand Up @@ -119,15 +118,15 @@
<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structboost_1_1real_1_1boundary.html" target="_self">boundary</a></td><td class="desc">Explicitly represents a number as a vector of digits with a sign and an exponent </td></tr>
<tr id="row_0_0_1_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structboost_1_1real_1_1interval.html" target="_self">interval</a></td><td class="desc">Represent an interval composed by two boundaries, a lower boundary and an upper boundary. The boundaries are <a class="el" href="structboost_1_1real_1_1boundary.html" title="Explicitly represents a number as a vector of digits with a sign and an exponent. ...">boost::real::boundary</a> structs that represent fully represented numbers </td></tr>
<tr id="row_0_0_2_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structboost_1_1real_1_1invalid__representation__exception.html" target="_self">invalid_representation_exception</a></td><td class="desc"></td></tr>
<tr id="row_0_0_3_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structboost_1_1real_1_1invalid__string__number.html" target="_self">invalid_string_number</a></td><td class="desc"></td></tr>
<tr id="row_0_0_3_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structboost_1_1real_1_1invalid__string__number__exception.html" target="_self">invalid_string_number_exception</a></td><td class="desc"></td></tr>
<tr id="row_0_0_4_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structboost_1_1real_1_1none__operation__exception.html" target="_self">none_operation_exception</a></td><td class="desc"></td></tr>
<tr id="row_0_0_5_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structboost_1_1real_1_1precision__exception.html" target="_self">precision_exception</a></td><td class="desc"></td></tr>
<tr id="row_0_0_6_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_0_0_6_" class="arrow" onclick="toggleFolder('0_0_6_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classboost_1_1real_1_1real.html" target="_self">real</a></td><td class="desc">Boost::real::real is a C++ class that represent real numbers as abstract entities that can be dynamically approximated as much as needed (until a set maximum precision) to be able to operate with them. Numbers can be added, subtracted, multiplied and compared by lower and by equality </td></tr>
<tr id="row_0_0_6_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_0_0_6_" class="arrow" onclick="toggleFolder('0_0_6_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classboost_1_1real_1_1real.html" target="_self">real</a></td><td class="desc">Boost::real::real is a C++ class that represent real numbers as abstract entities that can be dynamically approximated as much as needed (until a set maximum precision) to be able to operate with them. Numbers can be added, subtracted, multiplied and compared by lower than and equality </td></tr>
<tr id="row_0_0_6_0_"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classboost_1_1real_1_1real_1_1const__precision__iterator.html" target="_self">const_precision_iterator</a></td><td class="desc">Forward iterator that iterates a <a class="el" href="classboost_1_1real_1_1real.html" title="boost::real::real is a C++ class that represent real numbers as abstract entities that can be dynamic...">boost::real::real</a> number approximation intervals. The iterator calculates the initial interval with the initial precision and then it increase the precision in each iteration (++) and recalculate the interval </td></tr>
<tr id="row_0_0_7_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_0_0_7_" class="arrow" onclick="toggleFolder('0_0_7_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classboost_1_1real_1_1real__algorithm.html" target="_self">real_algorithm</a></td><td class="desc">Boost::real::real_algorithm is a C++ class that represents real numbers as a a function that calculates the n-th digit o the number, a sign and an exponent </td></tr>
<tr id="row_0_0_7_0_"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classboost_1_1real_1_1real__algorithm_1_1const__precision__iterator.html" target="_self">const_precision_iterator</a></td><td class="desc">Forward iterator that iterates a <a class="el" href="classboost_1_1real_1_1real__algorithm.html" title="boost::real::real_algorithm is a C++ class that represents real numbers as a a function that calculat...">boost::real::real_algorithm</a> number approximation intervals. The iterator calculates the initial interval with the initial precision and then it increase the precision in each iteration (++) and recalculate the interval </td></tr>
<tr id="row_0_0_8_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_0_0_8_" class="arrow" onclick="toggleFolder('0_0_8_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classboost_1_1real_1_1real__explicit.html" target="_self">real_explicit</a></td><td class="desc">Boost::real::real_explicit is a C++ class that fully represents real numbers as a a vector of digits, a sign and an exponent </td></tr>
<tr id="row_0_0_8_0_"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classboost_1_1real_1_1real__explicit_1_1const__precision__iterator.html" target="_self">const_precision_iterator</a></td><td class="desc">Forward iterator that iterates a <a class="el" href="classboost_1_1real_1_1real__explicit.html" title="boost::real::real_explicit is a C++ class that fully represents real numbers as a a vector of digits...">boost::real::real_explicit</a> number approximation intervals. The iterator calculates the initial interval with the initial precision and then it increase the precision in each iteration (++) and recalculate the interval </td></tr>
<tr id="row_0_0_8_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_0_0_8_" class="arrow" onclick="toggleFolder('0_0_8_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classboost_1_1real_1_1real__explicit.html" target="_self">real_explicit</a></td><td class="desc">Boost::real::real_explicit is a C++ class that fully represents real numbers as a vector of digits, a sign and an exponent </td></tr>
<tr id="row_0_0_8_0_"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classboost_1_1real_1_1real__explicit_1_1const__precision__iterator.html" target="_self">const_precision_iterator</a></td><td class="desc">Forward iterator that iterates a <a class="el" href="classboost_1_1real_1_1real__explicit.html" title="boost::real::real_explicit is a C++ class that fully represents real numbers as a vector of digits...">boost::real::real_explicit</a> number approximation intervals. The iterator calculates the initial interval with the initial precision and then it increase the precision in each iteration (++) and recalculate the interval </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
Expand Down
2 changes: 1 addition & 1 deletion doc/html/annotated_dup.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ var annotated_dup =
[ "boundary", "structboost_1_1real_1_1boundary.html", "structboost_1_1real_1_1boundary" ],
[ "interval", "structboost_1_1real_1_1interval.html", "structboost_1_1real_1_1interval" ],
[ "invalid_representation_exception", "structboost_1_1real_1_1invalid__representation__exception.html", "structboost_1_1real_1_1invalid__representation__exception" ],
[ "invalid_string_number", "structboost_1_1real_1_1invalid__string__number.html", "structboost_1_1real_1_1invalid__string__number" ],
[ "invalid_string_number_exception", "structboost_1_1real_1_1invalid__string__number__exception.html", "structboost_1_1real_1_1invalid__string__number__exception" ],
[ "none_operation_exception", "structboost_1_1real_1_1none__operation__exception.html", "structboost_1_1real_1_1none__operation__exception" ],
[ "precision_exception", "structboost_1_1real_1_1precision__exception.html", "structboost_1_1real_1_1precision__exception" ],
[ "real", "classboost_1_1real_1_1real.html", "classboost_1_1real_1_1real" ],
Expand Down
26 changes: 13 additions & 13 deletions doc/html/boundary_8hpp_source.html

Large diffs are not rendered by default.

3 changes: 1 addition & 2 deletions doc/html/boundary__helper_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Boost.Real: /home/lao/Documents/git/Real/include/real/boundary_helper.hpp Source File</title>
<title>Boost.Real: boundary_helper.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
Expand Down Expand Up @@ -49,7 +49,6 @@
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
Expand Down
Loading

0 comments on commit a9573cf

Please sign in to comment.