Skip to content

Commit d973d79

Browse files
nikohansennikohansen
committed
[api-docs] update docs
1 parent 8da5d49 commit d973d79

23 files changed

+12416
-2112
lines changed

‎comocma-apidocs/apidocs.css‎

Lines changed: 982 additions & 59 deletions
Large diffs are not rendered by default.

‎comocma-apidocs/classIndex.html‎

Lines changed: 147 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,166 @@
22
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
33
"DTD/xhtml1-strict.dtd">
44
<html>
5+
6+
57
<head>
8+
69
<title>Class Hierarchy</title>
7-
<meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
8-
<link type="text/css" href="bootstrap.min.css" rel="stylesheet" />
9-
<link type="text/css" href="apidocs.css" rel="stylesheet" />
10-
</head>
10+
<meta name="generator" content="pydoctor 23.9.1">
11+
12+
</meta>
13+
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
14+
<meta name="viewport" content="width=device-width, initial-scale=1 maximum-scale=1" />
15+
<link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
16+
<link rel="stylesheet" type="text/css" href="apidocs.css" />
17+
<link rel="stylesheet" type="text/css" href="extra.css" />
18+
</head>
19+
1120
<body>
12-
<nav class="navbar navbar-default">
13-
<div class="container">
1421

15-
<div class="navbar-header">
16-
<a href="index.html" class="navbar-brand">
17-
comocma API Documentation
18-
</a>
22+
23+
24+
<nav class="navbar navbar-default mainnavbar">
25+
26+
27+
<div class="container-fluid">
28+
29+
30+
<div class="navbar-header">
31+
32+
<div class="navlinks">
33+
<span class="navbar-brand">
34+
comocma <a href="index.html">API Documentation</a>
35+
</span>
36+
37+
<a href="moduleIndex.html">
38+
Modules
39+
</a>
40+
41+
<a href="classIndex.html">
42+
Classes
43+
</a>
44+
45+
<a href="nameIndex.html">
46+
Names
47+
</a>
48+
49+
<div id="search-box-container">
50+
<div class="input-group">
51+
<input id="search-box" type="search" name="search-query" placeholder="Search..." aria-label="Search" minlength="2" class="form-control" autocomplete="off" />
52+
53+
<span class="input-group-btn">
54+
<a style="display: none;" class="btn btn-default" id="search-clear-button" title="Clear" onclick="clearSearch()"><img src="fonts/x-circle.svg" alt="Clear" /></a>
55+
<a class="btn btn-default" id="search-help-button" title="Help" onclick="toggleSearchHelpText()"><img src="fonts/info.svg" alt="Help" /></a>
56+
</span>
57+
</div>
1958
</div>
59+
2060
</div>
21-
</nav>
2261

23-
<div class="container">
62+
<div id="search-results-container" style="display: none;">
63+
64+
<div id="search-buttons">
65+
<span class="label label-default" id="search-docstrings-button">
66+
<label class="checkbox-inline">
67+
<input type="checkbox" id="toggle-search-in-docstrings-checkbox" value="false" onclick="toggleSearchInDocstrings()">
68+
search in docstrings
69+
</input>
70+
</label>
71+
</span>
72+
73+
</div>
74+
75+
<noscript>
76+
<h1>Cannot search: JavaScript is not supported/enabled in your browser.</h1>
77+
</noscript>
78+
79+
<div class="hint" id="search-help-box">
80+
<p class="rst-last">
81+
82+
Search bar offers the following options:
83+
<ul>
84+
<li>
85+
<strong>Term presence.</strong> The below example searches for documents that
86+
must contain “foo”, might contain “bar” and must not contain “baz”: <code>+foo bar -baz</code>
87+
</li>
88+
89+
<li>
90+
<strong>Wildcards.</strong> The below example searches for documents with words beginning with “foo”: <code>foo*</code>
91+
</li>
92+
93+
<li>
94+
<strong>Search in specific fields.</strong> The following search matches all objects
95+
in "twisted.mail" that matches “search”: <code>+qname:twisted.mail.* +search</code>
96+
97+
<p>
98+
Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'.
99+
Last two fields are only applicable if "search in docstrings" is enabled.
100+
</p>
101+
</li>
102+
103+
<li>
104+
<strong>Fuzzy matches.</strong> The following search matches all documents
105+
that have a word within 1 edit distance of “foo”: <code>foo~1</code>
106+
</li>
107+
</ul>
108+
109+
</p>
110+
</div>
111+
112+
<div id="search-status"> </div>
113+
114+
<div class="warning" id="search-warn-box" style="display: none;">
115+
<p class="rst-last"><span id="search-warn"></span></p>
116+
</div>
117+
118+
<table id="search-results">
119+
<!-- Filled dynamically by JS -->
120+
</table>
121+
122+
<div style="margin-top: 8px;">
123+
<p>Results provided by <a href="https://lunrjs.com">Lunr.js</a></p>
124+
</div>
125+
</div>
126+
127+
</div>
128+
129+
130+
</div>
131+
</nav>
132+
133+
<div class="container-fluid">
24134

25135
<div class="page-header">
26136
<h1>Class Hierarchy</h1>
137+
<div id="showPrivate">
138+
<button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
139+
</div>
27140
</div>
28141

29-
<ul>
30-
<li><code>cma.CMAEvolutionStrategy</code><ul><li><a name="comocma.como.CmaKernel"></a><a href="comocma.como.CmaKernel.html" data-type="Class" class="code">comocma.como.CmaKernel</a> - <span>inheriting from the <code>cma.CMAEvolutionStrategy</code> class, by adding the property <a href="comocma.como.CmaKernel.html#incumbent"><code>incumbent</code></a>, the attributes <code>objective_values</code> and <code>_last_offspring_f_values</code>.</span></li></ul></li><li><code>cma.interfaces.BaseDataLogger</code><ul><li><a name="comocma.sofomore_logger.SofomoreDataLogger"></a><a href="comocma.sofomore_logger.SofomoreDataLogger.html" data-type="Class" class="code">comocma.sofomore_logger.SofomoreDataLogger</a> - <span>data logger for class <code>CMAEvolutionStrategy</code>.</span></li></ul></li><li><code>cma.interfaces.OOOptimizer</code><ul><li><a name="comocma.como.Sofomore"></a><a href="comocma.como.Sofomore.html" data-type="Class" class="code">comocma.como.Sofomore</a> - <span class="undocumented">No summary</span></li></ul></li><li><a name="comocma.como.FitFun"></a><a href="comocma.como.FitFun.html" data-type="Class" class="code">comocma.como.FitFun</a> - <span>Define a callable multiobjective function from single objective ones. Example: fitness = comocma.FitFun(cma.ff.sphere, lambda x: cma.ff.sphere(x-1)).</span></li><li><a name="comocma.como.IndicatorFront"></a><a href="comocma.como.IndicatorFront.html" data-type="Class" class="code">comocma.como.IndicatorFront</a> - <span>with <a href="comocma.como.IndicatorFront.html#hypervolume_improvement"><code>hypervolume_improvement</code></a> method based on a varying empirical front.</span></li><li><a name="comocma.hv.HyperVolume"></a><a href="comocma.hv.HyperVolume.html" data-type="Class" class="code">comocma.hv.HyperVolume</a> - <span class="undocumented">No summary</span></li><li><a name="comocma.hv.MultiList"></a><a href="comocma.hv.MultiList.html" data-type="Class" class="code">comocma.hv.MultiList</a> - <span>A special data structure needed by FonsecaHyperVolume.</span></li><li><a name="comocma.hv.MultiList.Node"></a><a href="comocma.hv.MultiList.Node.html" data-type="Class" class="code">comocma.hv.MultiList.Node</a> - <span class="undocumented">Undocumented</span></li><li><code>list</code><ul><li><a name="comocma.nondominatedarchive.NonDominatedList"></a><a href="comocma.nondominatedarchive.NonDominatedList.html" data-type="Class" class="code">comocma.nondominatedarchive.NonDominatedList</a> - <span>A list of objective values in an empirical Pareto front, meaning that no point strictly domminates another one in all objectives.</span></li></ul></li></ul>
142+
<ul id="summaryTree">
143+
<li><code>cma.CMAEvolutionStrategy</code><ul><li><a name="comocma.como.CmaKernel"></a><div><code><a href="comocma.como.CmaKernel.html" class="internal-link">comocma.como.CmaKernel</a></code> - inheriting from the <code>cma.CMAEvolutionStrategy</code> class, by adding the property <code><a href="comocma.como.CmaKernel.html#incumbent" class="internal-link" title="comocma.como.CmaKernel.incumbent">incumbent</a></code>, the attributes <code><a href="comocma.como.CmaKernel.html#objective_values" class="internal-link" title="comocma.como.CmaKernel.objective_values">objective_values</a></code> and <code><a href="comocma.como.CmaKernel.html#_last_offspring_f_values" class="internal-link" title="comocma.como.CmaKernel._last_offspring_f_values">_last_offspring_f_values</a></code>.</div></li></ul></li><li><code>cma.interfaces.BaseDataLogger</code><ul><li><a name="comocma.sofomore_logger.SofomoreDataLogger"></a><div><code><a href="comocma.sofomore_logger.SofomoreDataLogger.html" class="internal-link">comocma.sofomore_logger.SofomoreDataLogger</a></code> - data logger for class <code>CMAEvolutionStrategy</code>.</div></li></ul></li><li><code>cma.interfaces.OOOptimizer</code><ul><li><a name="comocma.como.Sofomore"></a><div><code><a href="comocma.como.Sofomore.html" class="internal-link">comocma.como.Sofomore</a></code> - Sofomore framework for multiobjective optimization, with the ask-and-tell interface.</div></li></ul></li><li><a name="comocma.como.FitFun"></a><div><code><a href="comocma.como.FitFun.html" class="internal-link">comocma.como.FitFun</a></code> - Define a callable multiobjective function from single objective ones. Example:</div></li><li><a name="comocma.como.GetKernelPopsizeIncrementer"></a><div><code><a href="comocma.como.GetKernelPopsizeIncrementer.html" class="internal-link">comocma.como.GetKernelPopsizeIncrementer</a></code> - a <code>callable</code> that returns the result of a call of <code><a href="comocma.como.GetKernelPopsizeIncrementer.html#get_kernel" class="internal-link" title="comocma.como.GetKernelPopsizeIncrementer.get_kernel">get_kernel</a></code>.</div><ul><li><a name="comocma.como.GetKernelIPOP"></a><div><code><a href="comocma.como.GetKernelIPOP.html" class="internal-link">comocma.como.GetKernelIPOP</a></code> - non-adaptive IPOP incrementing scheme.</div></li></ul></li><li><a name="comocma.como.IndicatorFront"></a><div><code><a href="comocma.como.IndicatorFront.html" class="internal-link">comocma.como.IndicatorFront</a></code> - with <code><a href="comocma.como.IndicatorFront.html#hypervolume_improvement" class="internal-link" title="comocma.como.IndicatorFront.hypervolume_improvement">hypervolume_improvement</a></code> method based on a varying empirical front.</div></li><li><a name="comocma.como.RampUpSelector"></a><div><code><a href="comocma.como.RampUpSelector.html" class="internal-link">comocma.como.RampUpSelector</a></code> - Takes a list of ramp-up methods and a selection "criterion",</div></li><li><a name="comocma.como_logger.COMOPlot"></a><div><code><a href="comocma.como_logger.COMOPlot.html" class="internal-link">comocma.como_logger.COMOPlot</a></code> - A class designed to store, load and plot data relative to a Sofomore object.</div></li><li><a name="comocma.hv.HyperVolume"></a><div><code><a href="comocma.hv.HyperVolume.html" class="internal-link">comocma.hv.HyperVolume</a></code> - Hypervolume computation based on variant 3 of the algorithm in the paper: C. M. Fonseca, L. Paquete, and M. Lopez-Ibanez. An improved dimension-sweep algorithm for the hypervolume indicator. In IEEE Congress on Evolutionary Computation, pages 1157-1163, Vancouver, Canada, July 2006.</div></li><li><a name="comocma.hv.MultiList"></a><div><code><a href="comocma.hv.MultiList.html" class="internal-link">comocma.hv.MultiList</a></code> - A special data structure needed by FonsecaHyperVolume.</div></li><li><a name="comocma.hv.MultiList.Node"></a><div><code><a href="comocma.hv.MultiList.Node.html" class="internal-link">comocma.hv.MultiList.Node</a></code> - <span class="undocumented">Undocumented</span></div></li><li class="private"><code>dict</code><ul><li class="private"><a name="comocma.como._CounterDict"></a><div><code><a href="comocma.como._CounterDict.html" class="internal-link">comocma.como._CounterDict</a></code> - A dictionary with two additional features.</div></li></ul></li><li><code>list</code><ul><li><a name="comocma.nondominatedarchive.NonDominatedList"></a><div><code><a href="comocma.nondominatedarchive.NonDominatedList.html" class="internal-link">comocma.nondominatedarchive.NonDominatedList</a></code> - A list of objective values in an empirical Pareto front, meaning that no point strictly domminates another one in all objectives.</div></li></ul></li></ul>
31144

32145
</div>
146+
147+
<footer class="navbar navbar-default">
148+
149+
150+
<div class="container">
151+
<a href="index.html">API Documentation</a> for comocma,
152+
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
153+
23.9.1 at 2026-01-24 14:37:29.
154+
</div>
155+
156+
<!-- Search related scripts needs to be loaded at the end of HTML
157+
parsing not to introduce overhead and display HTML data asap -->
158+
<script src="ajax.js" type="text/javascript"></script>
159+
<script src="searchlib.js" type="text/javascript"></script>
160+
<script src="search.js" type="text/javascript"></script>
161+
162+
</footer>
163+
164+
<script src="pydoctor.js" type="text/javascript"></script>
165+
33166
</body>
34167
</html>

0 commit comments

Comments
 (0)