Skip to content

Commit 8f125c2

Browse files
schmoukschmouk
committed
#312-create doxygen HTML documentation
Completed.
1 parent 022c609 commit 8f125c2

File tree

603 files changed

+83916
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

603 files changed

+83916
-1
lines changed

‎c++11/cppRandLib-cpp11.cfg‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# Doxyfile 1.14.0
2+
3+
# This file describes the settings to be used by the documentation system
4+
# Doxygen (www.doxygen.org) for a project.
5+
#
6+
# All text after a double hash (##) is considered a comment and is placed in
7+
# front of the TAG it is preceding.
8+
#
9+
# All text after a single hash (#) is considered a comment and will be ignored.
10+
# The format is:
11+
# TAG = value [value, ...]
12+
# For lists, items can also be appended using:
13+
# TAG += value [value, ...]
14+
# Values that contain spaces should be placed between quotes (\" \").
15+
#
16+
# Note:
17+
#
18+
# Use Doxygen to compare the used configuration file with the template
19+
# configuration file:
20+
# doxygen -x [configFile]
21+
# Use Doxygen to compare the used configuration file with the template
22+
# configuration file without replacing the environment variables or CMake type
23+
# replacement variables:
24+
# doxygen -x_noenv [configFile]
25+
26+
#---------------------------------------------------------------------------
27+
# Project related configuration options
28+
#---------------------------------------------------------------------------
29+
PROJECT_NAME = "CppRandLib - c++11"
30+
PROJECT_NUMBER = "2.1.2"
31+
PROJECT_BRIEF = "Best-in-class Pseudo Random Number Generators"
32+
OUTPUT_DIRECTORY =
33+
34+
ABBREVIATE_BRIEF = "The $name class" \
35+
"The $name widget" \
36+
"The $name file" \
37+
is \
38+
provides \
39+
specifies \
40+
contains \
41+
represents \
42+
a \
43+
an \
44+
the
45+
46+
ALWAYS_DETAILED_SEC = YES
47+
FULL_PATH_NAMES = NO
48+
BUILTIN_STL_SUPPORT = YES
49+
TIMESTAMP = DATE ##YES ##NO ##DATETIME ##
50+
51+
#---------------------------------------------------------------------------
52+
# Build related configuration options
53+
#---------------------------------------------------------------------------
54+
HIDE_UNDOC_NAMESPACES = NO
55+
SORT_BRIEF_DOCS = YES
56+
WARN_NO_PARAMDOC = NO
57+
58+
#---------------------------------------------------------------------------
59+
# Configuration options related to the input files
60+
#---------------------------------------------------------------------------
61+
INPUT = ./
62+
INPUT_ENCODING = UTF-8
63+
USE_MDFILE_AS_MAINPAGE = ../README.md
64+
65+
#---------------------------------------------------------------------------
66+
# Configuration options related to source browsing
67+
#---------------------------------------------------------------------------
68+
REFERENCED_BY_RELATION = YES
69+
REFERENCES_RELATION = YES
70+
71+
#---------------------------------------------------------------------------
72+
# Configuration options related to the HTML output
73+
#---------------------------------------------------------------------------
74+
GENERATE_HTML = YES
75+
HTML_OUTPUT = html
76+
HTML_FILE_EXTENSION = .html
77+
HTML_COLORSTYLE_HUE = 220
78+
HTML_COLORSTYLE_SAT = 100
79+
HTML_COLORSTYLE_GAMMA = 80
80+
HTML_DYNAMIC_MENUS = YES
81+
HTML_DYNAMIC_SECTIONS = NO
82+
HTML_CODE_FOLDING = NO ##YES
83+
HTML_COPY_CLIPBOARD = YES
84+
HTML_INDEX_NUM_ENTRIES = 100
85+
GENERATE_TREEVIEW = YES
86+
FULL_SIDEBAR = NO
87+
TREEVIEW_WIDTH = 250
88+
EXT_LINKS_IN_WINDOW = NO
89+
SEARCHENGINE = YES
90+
SERVER_BASED_SEARCH = NO
91+
EXTERNAL_SEARCH = NO
92+
93+
#---------------------------------------------------------------------------
94+
# Configuration options related to the LaTeX output
95+
#---------------------------------------------------------------------------
96+
GENERATE_LATEX = NO

‎c++11/html/annotated.html‎

Lines changed: 160 additions & 0 deletions
Large diffs are not rendered by default.

‎c++11/html/annotated_dup.js‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
var annotated_dup =
2+
[
3+
[ "AlphaBetaArgsException", "struct_alpha_beta_args_exception.html", null ],
4+
[ "ArithmeticValueTypeException", "struct_arithmetic_value_type_exception.html", null ],
5+
[ "BaseException", "struct_base_exception.html", null ],
6+
[ "ChoiceEmptySequenceException", "struct_choice_empty_sequence_exception.html", null ],
7+
[ "Cwg128", "class_cwg128.html", "class_cwg128" ],
8+
[ "Cwg128_64", "class_cwg128__64.html", "class_cwg128__64" ],
9+
[ "Cwg64", "class_cwg64.html", "class_cwg64" ],
10+
[ "ExponentialZeroLambdaException", "struct_exponential_zero_lambda_exception.html", null ],
11+
[ "FastRand32", "class_fast_rand32.html", "class_fast_rand32" ],
12+
[ "FastRand63", "class_fast_rand63.html", "class_fast_rand63" ],
13+
[ "FloatingPointTypeException", "struct_floating_point_type_exception.html", null ],
14+
[ "FloatValueRange01Exception", "struct_float_value_range01_exception.html", null ],
15+
[ "GaussSigmaException", "struct_gauss_sigma_exception.html", null ],
16+
[ "IndexableContainerException", "struct_indexable_container_exception.html", null ],
17+
[ "IntegralValueTypeException", "struct_integral_value_type_exception.html", null ],
18+
[ "MaxValueTypeException", "struct_max_value_type_exception.html", null ],
19+
[ "Melg19937", "class_melg19937.html", "class_melg19937" ],
20+
[ "Melg44497", "class_melg44497.html", "class_melg44497" ],
21+
[ "Melg607", "class_melg607.html", "class_melg607" ],
22+
[ "MinValueTypeException", "struct_min_value_type_exception.html", null ],
23+
[ "Mrg1457", "class_mrg1457.html", "class_mrg1457" ],
24+
[ "Mrg287", "class_mrg287.html", "class_mrg287" ],
25+
[ "Mrg49507", "class_mrg49507.html", "class_mrg49507" ],
26+
[ "NegativeKappaException", "struct_negative_kappa_exception.html", null ],
27+
[ "NegativeRotationException", "struct_negative_rotation_exception.html", null ],
28+
[ "NormalSigmaException", "struct_normal_sigma_exception.html", null ],
29+
[ "ParetoArgsValueException", "struct_pareto_args_value_exception.html", null ],
30+
[ "Pcg1024_32", "class_pcg1024__32.html", "class_pcg1024__32" ],
31+
[ "Pcg128_64", "class_pcg128__64.html", "class_pcg128__64" ],
32+
[ "Pcg64_32", "class_pcg64__32.html", "class_pcg64__32" ],
33+
[ "PositiveValueException", "struct_positive_value_exception.html", null ],
34+
[ "ProbaOutOfRangeException", "struct_proba_out_of_range_exception.html", null ],
35+
[ "RangeIncoherentValuesException", "struct_range_incoherent_values_exception.html", null ],
36+
[ "RangeSameValuesException", "struct_range_same_values_exception.html", null ],
37+
[ "RangeZeroStepException", "struct_range_zero_step_exception.html", null ],
38+
[ "SampleCountException", "struct_sample_count_exception.html", null ],
39+
[ "SampleCountsTypeException", "struct_sample_counts_type_exception.html", null ],
40+
[ "SampleSizesException", "struct_sample_sizes_exception.html", null ],
41+
[ "Squares32", "class_squares32.html", "class_squares32" ],
42+
[ "Squares64", "class_squares64.html", "class_squares64" ],
43+
[ "StepValueTypeException", "struct_step_value_type_exception.html", null ],
44+
[ "TooBigRotationException", "struct_too_big_rotation_exception.html", null ],
45+
[ "TooMuchReturnedBitsException", "struct_too_much_returned_bits_exception.html", null ],
46+
[ "ValueTypeException", "struct_value_type_exception.html", null ],
47+
[ "WeibullArgsValueException", "struct_weibull_args_value_exception.html", null ],
48+
[ "Well1024a", "class_well1024a.html", "class_well1024a" ],
49+
[ "Well19937c", "class_well19937c.html", "class_well19937c" ],
50+
[ "Well44497b", "class_well44497b.html", "class_well44497b" ],
51+
[ "Well512a", "class_well512a.html", "class_well512a" ],
52+
[ "Xoroshiro1024", "class_xoroshiro1024.html", "class_xoroshiro1024" ],
53+
[ "Xoroshiro256", "class_xoroshiro256.html", "class_xoroshiro256" ],
54+
[ "Xoroshiro512", "class_xoroshiro512.html", "class_xoroshiro512" ],
55+
[ "ZeroLengthException", "struct_zero_length_exception.html", null ],
56+
[ "ZeroValueException", "struct_zero_value_exception.html", null ]
57+
];

‎c++11/html/class_cwg128-members.html‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.14.0"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>CppRandLib - c++11: Member List</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<script type="text/javascript" src="clipboard.js"></script>
13+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
14+
<script type="text/javascript" src="navtreedata.js"></script>
15+
<script type="text/javascript" src="navtree.js"></script>
16+
<script type="text/javascript" src="cookie.js"></script>
17+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
18+
<script type="text/javascript" src="search/searchdata.js"></script>
19+
<script type="text/javascript" src="search/search.js"></script>
20+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
21+
</head>
22+
<body>
23+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
24+
<div id="titlearea">
25+
<table cellspacing="0" cellpadding="0">
26+
<tbody>
27+
<tr id="projectrow">
28+
<td id="projectalign">
29+
<div id="projectname">CppRandLib - c++11<span id="projectnumber">&#160;2.1.2</span>
30+
</div>
31+
<div id="projectbrief">Best-in-class Pseudo Random Number Generators</div>
32+
</td>
33+
</tr>
34+
</tbody>
35+
</table>
36+
</div>
37+
<!-- end header part -->
38+
<!-- Generated by Doxygen 1.14.0 -->
39+
<script type="text/javascript">
40+
var searchBox = new SearchBox("searchBox", "search/",'.html');
41+
</script>
42+
<script type="text/javascript" src="menudata.js"></script>
43+
<script type="text/javascript" src="menu.js"></script>
44+
<script type="text/javascript">
45+
$(function() {
46+
initMenu('',true,false,'search.php','Search',true);
47+
$(function() { init_search(); });
48+
});
49+
</script>
50+
<div id="main-nav"></div>
51+
</div><!-- top -->
52+
<div id="side-nav" class="ui-resizable side-nav-resizable">
53+
<div id="nav-tree">
54+
<div id="nav-tree-contents">
55+
<div id="nav-sync" class="sync"></div>
56+
</div>
57+
</div>
58+
<div id="splitbar" style="-moz-user-select:none;"
59+
class="ui-resizable-handle">
60+
</div>
61+
</div>
62+
<script type="text/javascript">
63+
$(function(){initNavTree('class_cwg128.html','',''); });
64+
</script>
65+
<div id="container">
66+
<div id="doc-content">
67+
<!-- window showing the filter options -->
68+
<div id="MSearchSelectWindow"
69+
onmouseover="return searchBox.OnSearchSelectShow()"
70+
onmouseout="return searchBox.OnSearchSelectHide()"
71+
onkeydown="return searchBox.OnSearchSelectKey(event)">
72+
</div>
73+
74+
<!-- iframe showing the search results (closed by default) -->
75+
<div id="MSearchResultsWindow">
76+
<div id="MSearchResults">
77+
<div class="SRPage">
78+
<div id="SRIndex">
79+
<div id="SRResults"></div>
80+
<div class="SRStatus" id="Loading">Loading...</div>
81+
<div class="SRStatus" id="Searching">Searching...</div>
82+
<div class="SRStatus" id="NoMatches">No Matches</div>
83+
</div>
84+
</div>
85+
</div>
86+
</div>
87+
88+
<div class="header">
89+
<div class="headertitle"><div class="title">Cwg128 Member List</div></div>
90+
</div><!--header-->
91+
<div class="contents">
92+
93+
<p>This is the complete list of members for <a class="el" href="class_cwg128.html">Cwg128</a>, including all inherited members.</p>
94+
<table class="directory">
95+
<tr class="even"><td class="entry"><a class="el" href="class_cwg128.html#a7cda34137acac72cc3414b8f48384e26">_setstate</a>(const std::uint64_t seed_) noexcept override</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
96+
<tr class="odd"><td class="entry"><a class="el" href="class_cwg128.html#ab77b90e8087586cd95b1527214f08c27">_setstate</a>(const utils::UInt128 &amp;seed_) noexcept override</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
97+
<tr class="even"><td class="entry"><a class="el" href="class_cwg128.html#af6b220143ca3251d868b974a523c3de1">Cwg128</a>() noexcept=default</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
98+
<tr class="odd"><td class="entry"><a class="el" href="class_cwg128.html#ae238ad4454bf2def5f34292d8360f3ba">Cwg128</a>(const int seed) noexcept</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"></td></tr>
99+
<tr class="even"><td class="entry"><a class="el" href="class_cwg128.html#a36bb8db81642e2cdabd58f5358718545">Cwg128</a>(const unsigned int seed) noexcept</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"></td></tr>
100+
<tr class="odd"><td class="entry"><a class="el" href="class_cwg128.html#a28e498a4d442998d4826b2f87eb5a9ed">Cwg128</a>(const long seed) noexcept</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"></td></tr>
101+
<tr class="even"><td class="entry"><a class="el" href="class_cwg128.html#a235b5037e92d0a942561ff1c61a1c818">Cwg128</a>(const unsigned long seed) noexcept</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"></td></tr>
102+
<tr class="odd"><td class="entry"><a class="el" href="class_cwg128.html#a5662dc520c3f0d31d95cfdbc4bf6c141">Cwg128</a>(const long long seed) noexcept</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"></td></tr>
103+
<tr class="even"><td class="entry"><a class="el" href="class_cwg128.html#a8f0b5780daa1773a9b3caaceea50236f">Cwg128</a>(const unsigned long long seed) noexcept</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"></td></tr>
104+
<tr class="odd"><td class="entry"><a class="el" href="class_cwg128.html#a3ca6e50a172e77a2491e7028ab7cd1a4">Cwg128</a>(const utils::UInt128 &amp;seed) noexcept</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"></td></tr>
105+
<tr class="even"><td class="entry"><a class="el" href="class_cwg128.html#acf4ca0bb98bdd63b81f759ddcfd5ec76">Cwg128</a>(const double seed)</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"></td></tr>
106+
<tr class="odd"><td class="entry"><a class="el" href="class_cwg128.html#a9106296fbadda10e3b98a5d3fad9656f">Cwg128</a>(const state_type &amp;internal_state) noexcept</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"></td></tr>
107+
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>MyBaseClass</b> typedef (defined in <a class="el" href="class_cwg128.html">Cwg128</a>)</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"></td></tr>
108+
<tr class="odd"><td class="entry"><a class="el" href="class_cwg128.html#ac0bfef09da90667cde9743befa9f9552">next</a>() noexcept override</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
109+
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>output_type</b> typedef (defined in <a class="el" href="class_cwg128.html">Cwg128</a>)</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"></td></tr>
110+
<tr class="odd"><td class="entry"><a class="el" href="class_cwg128.html#ae9d9fb1b66331ec74bfed8cb3f2a53b7">random</a>()</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
111+
<tr class="even"><td class="entry"><a class="el" href="class_cwg128.html#ab8286bf56b432e6ddc39ef70e97c8296">random</a>() noexcept</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
112+
<tr class="odd"><td class="entry"><a class="el" href="class_cwg128.html#ab805f5413b8b3d17a351068994001a17">seed</a>() noexcept</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"></td></tr>
113+
<tr class="even"><td class="entry"><a class="el" href="class_cwg128.html#a4f6bf8976592b21f0bb18b71efd2867c">seed</a>(const int seed_) noexcept</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"></td></tr>
114+
<tr class="odd"><td class="entry"><a class="el" href="class_cwg128.html#a8dad3190e241f2114a067797081bdbd8">seed</a>(const unsigned int seed_) noexcept</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"></td></tr>
115+
<tr class="even"><td class="entry"><a class="el" href="class_cwg128.html#ab1ce2cb9cdc97494b1b0cadf51f34201">seed</a>(const long seed_) noexcept</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"></td></tr>
116+
<tr class="odd"><td class="entry"><a class="el" href="class_cwg128.html#a0151e8f8c84f458f27f8c8cd8d31af07">seed</a>(const unsigned long seed_) noexcept</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"></td></tr>
117+
<tr class="even"><td class="entry"><a class="el" href="class_cwg128.html#af3f3a0eba5b2c96f3f2758cd061bf01d">seed</a>(const long long seed_) noexcept</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"></td></tr>
118+
<tr class="odd"><td class="entry"><a class="el" href="class_cwg128.html#a24481951dcf31b56bd6a870ef51a1956">seed</a>(const unsigned long long seed_) noexcept</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"></td></tr>
119+
<tr class="even"><td class="entry"><a class="el" href="class_cwg128.html#a317b547415b7915c5a2a265b67c1a30c">seed</a>(const utils::UInt128 &amp;seed_) noexcept</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"></td></tr>
120+
<tr class="odd"><td class="entry"><a class="el" href="class_cwg128.html#a87adeb754a3368e99b54d8f74b92dc2d">seed</a>(const double seed_)</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"></td></tr>
121+
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>state_type</b> typedef (defined in <a class="el" href="class_cwg128.html">Cwg128</a>)</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"></td></tr>
122+
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>value_type</b> typedef (defined in <a class="el" href="class_cwg128.html">Cwg128</a>)</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"></td></tr>
123+
<tr class="even"><td class="entry"><a class="el" href="class_cwg128.html#a02c800d54db169a09aca0ac601d9d0d3">~Cwg128</a>() noexcept=default</td><td class="entry"><a class="el" href="class_cwg128.html">Cwg128</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
124+
</table></div><!-- contents -->
125+
</div><!-- doc-content -->
126+
</div><!-- container -->
127+
<!-- start footer part -->
128+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
129+
<ul>
130+
<li class="footer">Generated on <span class="timestamp"></span> for CppRandLib - c++11 by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li>
131+
</ul>
132+
</div>
133+
</body>
134+
</html>

0 commit comments

Comments
 (0)