GeezerVisonThe World Wide Web, restored to 800 pixels of glory. |
| Home|About|Gaming cabinet|Archives|How it works|Starter sites |
GeezerVison is showing github.com — dev-docs/python_api/engineering.html at master · networkit/dev-docs Expand file tree/ Copy pathengineering.htmlMore file actions 343 lines (304 loc) · 22.8 KB / Copy pathengineering.htmlFile metadata and controls343 lines (304 loc) · 22.8 KB 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 <!DOCTYPE html> <html lang="en" data-content_root="../"> <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <title>networkit.engineering</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" /> <link rel="stylesheet" type="text/css" href="../_static/bootstrap-sphinx.css?v=fa2d15c4" /> <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" /> <link rel="stylesheet" type="text/css" href="../_static/sg_gallery.css?v=c83e6b79" /> <link rel="stylesheet" type="text/css" href="../_static/bootstrap-treeview/bootstrap-treeview.min.css?v=8176a87d" /> <link rel="stylesheet" href="../_static/style.css" type="text/css" /> <script src="../_static/documentation_options.js?v=c0639414"></script> <script src="../_static/doctools.js?v=fd6eb6e6"></script> <script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> <script src="../_static/clipboard.min.js?v=a7894cd8"></script> <script src="../_static/copybutton.js?v=f281be69"></script> <script src="../_static/bootstrap-treeview/bootstrap-treeview.min.js?v=6a1e96b4"></script> <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/@jupyter-widgets/html-manager@^1.0.1/dist/embed-amd.js"></script> <script src="../_static/particles.min.js"></script> <script src="../_static/custom.js"></script> <script src="../_static/language_data.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="next" title="networkit.flow" href="flow.html" /> <link rel="prev" title="networkit.embedding" href="embedding.html" /> <meta charset='utf-8'> <meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> <meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'> <meta name="apple-mobile-web-app-capable" content="yes"> <script type="text/javascript" src="../_static/js/jquery-1.12.4.min.js"></script> <script type="text/javascript" src="../_static/js/jquery-fix.js"></script> <script type="text/javascript" src="../_static/bootstrap-3.4.1/js/bootstrap.min.js"></script> <script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script> </head><body> <a href="https://github.com/networkit/networkit" class="visible-desktop hidden-xs"><img style="position: absolute; width:auto; height: auto; max-width: 200px; top: 0px; right: 0; border: 0; z-index: 3;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_white_ffffff.png" alt="Fork me on GitHub"></a> <div id="fancy-particles-small"></div> <div id="navbar" class="navbar navbar-default "> <div class="container"> <div class="navbar-header"> <!-- .btn-navbar is used as the toggle for collapsed navbar content --> <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse"> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> <div style="float:left;height:auto; line-height:30px;"> <div style="overflow:hidden; line-height:15px"> <span style="display:block"> <a style="text-decoration: none; padding-top: 19.5px; padding-left:15px; height:30px;" class="navbar-brand" href="https://networkit.github.io"> NetworKit</a> </span> <div style="font-size:9pt; clear:left;">Large-Scale Network Analysis</div> </div> </div> </div> <div id="main-nav" class="collapse navbar-collapse nav-collapse"> <ul class="nav navbar-nav"> <li><a href="https://networkit.github.io/get_started.html">Get Started</a></li> <li><a href="../index.html">Documentation</a></li> <li><a href="https://networkit.github.io/features.html">Features</a></li> <li><a href="https://networkit.github.io/news.html">News</a></li> <li><a href="https://networkit.github.io/publications.html">Publications</a></li> <li><a href="https://networkit.github.io/networkit-day.html">NetworKit Day</a></li> <li><a href="https://networkit.github.io/credits.html">Credits & References</a></li> </ul> </div> </div> </div> <div class="container"> <div class="row"> <div class="col-md-3"> <div id="sidebar" class="bs-sidenav" role="complementary"> <div id="docs-version-switcher" class="docs-version-sidebar"> <label for="docs-version-select" class="docs-version-label">Version</label> <select id="docs-version-select" class="docs-version-select form-control" data-docs-channel="stable" data-docs-version-label="Stable (11.3)" data-docs-stable-label="Stable (11.3)" data-docs-nightly-label="Nightly" data-docs-stable-url="/dev-docs/" data-docs-nightly-url="/dev-docs/nightly/" data-docs-versions-url="/dev-docs/versions.json"> <option value="stable" selected>Stable (11.3)</option> <option value="nightly">Nightly</option> </select> </div> <ul class="sidebar"> <ul class="current"> <li class="toctree-l1 current"><a class="reference internal" href="modules.html">Python Documentation</a><ul class="current"> <li class="toctree-l2 current"><a class="reference internal" href="modules.html#modules">Modules</a><ul class="current"> <li class="toctree-l3"><a class="reference internal" href="networkit.html">networkit</a></li> <li class="toctree-l3"><a class="reference internal" href="algebraic.html">networkit.algebraic</a></li> <li class="toctree-l3"><a class="reference internal" href="base.html">networkit.base</a></li> <li class="toctree-l3"><a class="reference internal" href="centrality.html">networkit.centrality</a></li> <li class="toctree-l3"><a class="reference internal" href="clique.html">networkit.clique</a></li> <li class="toctree-l3"><a class="reference internal" href="coarsening.html">networkit.coarsening</a></li> <li class="toctree-l3"><a class="reference internal" href="coloring.html">networkit.coloring</a></li> <li class="toctree-l3"><a class="reference internal" href="community.html">networkit.community</a></li> <li class="toctree-l3"><a class="reference internal" href="components.html">networkit.components</a></li> <li class="toctree-l3"><a class="reference internal" href="correlation.html">networkit.correlation</a></li> <li class="toctree-l3"><a class="reference internal" href="distance.html">networkit.distance</a></li> <li class="toctree-l3"><a class="reference internal" href="dynamic.html">networkit.dynamic</a></li> <li class="toctree-l3"><a class="reference internal" href="dynamics.html">networkit.dynamics</a></li> <li class="toctree-l3"><a class="reference internal" href="dynbase.html">networkit.dynbase</a></li> <li class="toctree-l3"><a class="reference internal" href="embedding.html">networkit.embedding</a></li> <li class="toctree-l3 current"><a class="current reference internal" href="#">networkit.engineering</a></li> <li class="toctree-l3"><a class="reference internal" href="flow.html">networkit.flow</a></li> <li class="toctree-l3"><a class="reference internal" href="generators.html">networkit.generators</a></li> <li class="toctree-l3"><a class="reference internal" href="gephi.html">networkit.gephi</a></li> <li class="toctree-l3"><a class="reference internal" href="globals.html">networkit.globals</a></li> <li class="toctree-l3"><a class="reference internal" href="graph.html">networkit.graph</a></li> <li class="toctree-l3"><a class="reference internal" href="graphio.html">networkit.graphio</a></li> <li class="toctree-l3"><a class="reference internal" href="graphtools.html">networkit.graphtools</a></li> <li class="toctree-l3"><a class="reference internal" href="helpers.html">networkit.helpers</a></li> <li class="toctree-l3"><a class="reference internal" href="independentset.html">networkit.independentset</a></li> <li class="toctree-l3"><a class="reference internal" href="linkprediction.html">networkit.linkprediction</a></li> <li class="toctree-l3"><a class="reference internal" href="matching.html">networkit.matching</a></li> <li class="toctree-l3"><a class="reference internal" href="nxadapter.html">networkit.nxadapter</a></li> <li class="toctree-l3"><a class="reference internal" href="plot.html">networkit.plot</a></li> <li class="toctree-l3"><a class="reference internal" href="profiling.html">networkit.profiling</a></li> <li class="toctree-l3"><a class="reference internal" href="randomization.html">networkit.randomization</a></li> <li class="toctree-l3"><a class="reference internal" href="reachability.html">networkit.reachability</a></li> <li class="toctree-l3"><a class="reference internal" href="scd.html">networkit.scd</a></li> <li class="toctree-l3"><a class="reference internal" href="simulation.html">networkit.simulation</a></li> <li class="toctree-l3"><a class="reference internal" href="sparsification.html">networkit.sparsification</a></li> <li class="toctree-l3"><a class="reference internal" href="stats.html">networkit.stats</a></li> <li class="toctree-l3"><a class="reference internal" href="structures.html">networkit.structures</a></li> <li class="toctree-l3"><a class="reference internal" href="traversal.html">networkit.traversal</a></li> <li class="toctree-l3"><a class="reference internal" href="viz.html">networkit.viz</a></li> <li class="toctree-l3"><a class="reference internal" href="vizbridges.html">networkit.vizbridges</a></li> </ul> </li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../cpp_api/library_root.html">C++ Documentation</a></li> <li class="toctree-l1"><a class="reference internal" href="../notebooks.html">Jupyter Notebook</a></li> <li class="toctree-l1"><a class="reference internal" href="../DevGuide.html">Developer Guide</a></li> </ul> </ul> <form action="../search.html" method="get"> <div class="form-group"> <input type="text" name="q" class="form-control" placeholder="Search" /> </div> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div> <div class="col-md-9 content"> <section id="module-networkit.engineering"> <span id="networkit-engineering"></span><h1>networkit.engineering<a class="headerlink" href="#module-networkit.engineering" title="Link to this heading">¶</a></h1> <p>Tools for algorithm engineering.</p> <dl class="py function"> <dt class="sig sig-object py" id="networkit.engineering.getCurrentNumberOfThreads"> <span class="sig-prename descclassname"><span class="pre">networkit.engineering.</span></span><span class="sig-name descname"><span class="pre">getCurrentNumberOfThreads</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#networkit.engineering.getCurrentNumberOfThreads" title="Link to this definition">¶</a></dt> <dd><p>Get the number of currently running threads.</p> <dl class="field-list simple"> <dt class="field-odd">Returns<span class="colon">:</span></dt> <dd class="field-odd"><p>Number of threads.</p> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> <dd class="field-even"><p>int</p> </dd> </dl> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="networkit.engineering.getLogLevel"> <span class="sig-prename descclassname"><span class="pre">networkit.engineering.</span></span><span class="sig-name descname"><span class="pre">getLogLevel</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#networkit.engineering.getLogLevel" title="Link to this definition">¶</a></dt> <dd><p>Get the current log level.</p> <dl class="field-list simple"> <dt class="field-odd">Returns<span class="colon">:</span></dt> <dd class="field-odd"><p>The current loglevel.</p> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> <dd class="field-even"><p>logLevel</p> </dd> </dl> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="networkit.engineering.getMaxNumberOfThreads"> <span class="sig-prename descclassname"><span class="pre">networkit.engineering.</span></span><span class="sig-name descname"><span class="pre">getMaxNumberOfThreads</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#networkit.engineering.getMaxNumberOfThreads" title="Link to this definition">¶</a></dt> <dd><p>Get the maximum number of available threads</p> <dl class="field-list simple"> <dt class="field-odd">Returns<span class="colon">:</span></dt> <dd class="field-odd"><p>Max number of threads.</p> </dd> <dt class="field-even">Return type<span class="colon">:</span></dt> <dd class="field-even"><p>int</p> </dd> </dl> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="networkit.engineering.setLogLevel"> <span class="sig-prename descclassname"><span class="pre">networkit.engineering.</span></span><span class="sig-name descname"><span class="pre">setLogLevel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">loglevel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#networkit.engineering.setLogLevel" title="Link to this definition">¶</a></dt> <dd><p>Set the current loglevel</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><p><strong>loglevel</strong> (<em>str</em>) – The new loglevel. Possible values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL, QUIET</p> </dd> </dl> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="networkit.engineering.setNumberOfThreads"> <span class="sig-prename descclassname"><span class="pre">networkit.engineering.</span></span><span class="sig-name descname"><span class="pre">setNumberOfThreads</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">nThreads</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#networkit.engineering.setNumberOfThreads" title="Link to this definition">¶</a></dt> <dd><p>Set the number of OpenMP threads</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><p><strong>nThreads</strong> (<em>int</em>) – Number of threads.</p> </dd> </dl> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="networkit.engineering.setPrintLocation"> <span class="sig-prename descclassname"><span class="pre">networkit.engineering.</span></span><span class="sig-name descname"><span class="pre">setPrintLocation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flag</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#networkit.engineering.setPrintLocation" title="Link to this definition">¶</a></dt> <dd><p>Switch locations in log statements on or off</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><p><strong>flag</strong> (<em>bool</em>) – Sets whether to also log file, function and line of code. Default: False.</p> </dd> </dl> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="networkit.engineering.setSeed"> <span class="sig-prename descclassname"><span class="pre">networkit.engineering.</span></span><span class="sig-name descname"><span class="pre">setSeed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seed</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">useThreadId</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#networkit.engineering.setSeed" title="Link to this definition">¶</a></dt> <dd><p>Set the random seed that is used in NetworKit.</p> <p>Note that there is a separate random number generator per thread.</p> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>seed</strong> (<em>int</em>) – The seed</p></li> <li><p><strong>useThreadId</strong> (<em>bool</em>) – If the thread id shall be added to the seed</p></li> </ul> </dd> </dl> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="networkit.engineering.strongScaling"> <span class="sig-prename descclassname"><span class="pre">networkit.engineering.</span></span><span class="sig-name descname"><span class="pre">strongScaling</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">algorithmClass</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">threadSequence</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inargs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inputTitle</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">repetitions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outPath</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#networkit.engineering.strongScaling" title="Link to this definition">¶</a></dt> <dd><p>Evaluate strong scaling, i.e. how the performance varies with the number of threads for a fixed input size.</p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>Algorithm is executed by calling <code class="code docutils literal notranslate"><span class="pre">algorithmClass(**inargs)</span></code>. See parameter for more details.</p> </div> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>algorithmClass</strong> – Algorithm, which should be tested.</p></li> <li><p><strong>threadSequence</strong> (<em>list</em><em>(</em><em>int</em><em>)</em>) – A list of thread numbers to run the <code class="code docutils literal notranslate"><span class="pre">algorithmClass</span></code> with.</p></li> <li><p><strong>inargs</strong> (<a href="#id1"><span class="problematic" id="id2">**</span></a>kwargs) – Input arguments for algorithm.</p></li> <li><p><strong>inputTitle</strong> (<em>str</em><em>, </em><em>optional</em>) – Set a title for the output. Default: None</p></li> <li><p><strong>repetitions</strong> (<em>int</em><em>, </em><em>optional</em>) – Number of repetitions. Default: 1</p></li> <li><p><strong>outPath</strong> (<em>str</em><em>, </em><em>optional</em>) – File for writing the output to. Default: None</p></li> </ul> </dd> </dl> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="networkit.engineering.weakScaling"> <span class="sig-prename descclassname"><span class="pre">networkit.engineering.</span></span><span class="sig-name descname"><span class="pre">weakScaling</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">algorithmClass</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inargs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">threadSequence</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inputSequence</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inputTitles</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">repetitions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outPath</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#networkit.engineering.weakScaling" title="Link to this definition">¶</a></dt> <dd><p>Evaluate weak scaling, i.e. how the performance varies with the number of threads for a fixed input size per processor.</p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>Algorithm is executed by calling <code class="code docutils literal notranslate"><span class="pre">algorithmClass(input,</span> <span class="pre">**inargs)</span></code>. See parameter for more details.</p> </div> <dl class="field-list simple"> <dt class="field-odd">Parameters<span class="colon">:</span></dt> <dd class="field-odd"><ul class="simple"> <li><p><strong>algorithmClass</strong> – Algorithm, which should be tested.</p></li> <li><p><strong>inargs</strong> (<a href="#id3"><span class="problematic" id="id4">**</span></a>kwargs) – Input arguments for algorithm.</p></li> <li><p><strong>threadSequence</strong> (<em>list</em><em>(</em><em>int</em><em>)</em>) – A list of thread numbers to run the <code class="code docutils literal notranslate"><span class="pre">algorithmClass</span></code> with.</p></li> <li><p><strong>inputSequence</strong> (<em>list</em><em>(</em><em>networkit.Graph</em><em>)</em>) – A list of graphs. The input algorithm is evaluated against every list-member.</p></li> <li><p><strong>inputTitles</strong> (<em>str</em><em>, </em><em>optional</em>) – Set a title for the output. Default: None</p></li> <li><p><strong>repetitions</strong> (<em>int</em><em>, </em><em>optional</em>) – Number of repetitions. Default: 1</p></li> <li><p><strong>outPath</strong> (<em>str</em><em>, </em><em>optional</em>) – File for writing the output to. Default: None</p></li> </ul> </dd> </dl> </dd></dl> </section> </div> </div> </div> <footer class="footer"> <div class="container"> <p class="pull-right"> <a href="#">Back to top</a> <br/> </p> <p style="float:left; max-width: 70%;"> © Copyright 2018 Humboldt-Universität zu Berlin - Department of Computer Science - Modeling and Analysis of Complex Systems and contributors.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 9.2.0.<br/> </p> <span style="padding-left: 10px"> <a href="https://networkit.github.io/contact.html">Contact, Imprint and Privacy</a> </span> </div> </footer> </body> </html> |
| You are visitor 01402503 — GeezerVison does not store the pages you look up. Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required. |