Skip to content

Commit

Permalink
release of v0.9.5
Browse files Browse the repository at this point in the history
including documentation update
  • Loading branch information
prohde committed Sep 28, 2022
1 parent c07315c commit a3ecee3
Show file tree
Hide file tree
Showing 89 changed files with 3,503 additions and 262 deletions.
Binary file modified docs/html/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/html/.doctrees/index.doctree
Binary file not shown.
Binary file modified docs/html/.doctrees/modules.doctree
Binary file not shown.
Binary file modified docs/html/.doctrees/shaclapi.api.doctree
Binary file not shown.
Binary file modified docs/html/.doctrees/shaclapi.config.doctree
Binary file not shown.
Binary file modified docs/html/.doctrees/shaclapi.doctree
Binary file not shown.
Binary file modified docs/html/.doctrees/shaclapi.logger.doctree
Binary file not shown.
Binary file modified docs/html/.doctrees/shaclapi.multiprocessing.PipeAdapter.doctree
Binary file not shown.
Binary file modified docs/html/.doctrees/shaclapi.multiprocessing.ThreadEx.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/html/.doctrees/shaclapi.multiprocessing.Xgjoin.Xgjoin.doctree
Binary file not shown.
Binary file modified docs/html/.doctrees/shaclapi.multiprocessing.Xgjoin.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/html/.doctrees/shaclapi.multiprocessing.contactSource.doctree
Binary file not shown.
Binary file modified docs/html/.doctrees/shaclapi.multiprocessing.doctree
Binary file not shown.
Binary file modified docs/html/.doctrees/shaclapi.multiprocessing.functions.doctree
Binary file not shown.
Binary file modified docs/html/.doctrees/shaclapi.multiprocessing.runner.doctree
Binary file not shown.
Binary file modified docs/html/.doctrees/shaclapi.output.doctree
Binary file not shown.
Binary file modified docs/html/.doctrees/shaclapi.query.doctree
Binary file not shown.
Binary file modified docs/html/.doctrees/shaclapi.reduction.Reduction.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/html/.doctrees/shaclapi.reduction.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/html/.doctrees/shaclapi.reduction.s2spy.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/html/.doctrees/shaclapi.reduction.travshacl.doctree
Binary file not shown.
Binary file modified docs/html/.doctrees/shaclapi.statsCalculation.doctree
Binary file not shown.
Binary file modified docs/html/.doctrees/shaclapi.triple.doctree
Binary file not shown.
2 changes: 2 additions & 0 deletions docs/html/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,8 @@ <h1>All modules for which code is available</h1>
<li><a href="shaclapi/multiprocessing/ThreadEx.html">shaclapi.multiprocessing.ThreadEx</a></li>
<li><a href="shaclapi/multiprocessing/Xgjoin/OperatorStructures.html">shaclapi.multiprocessing.Xgjoin.OperatorStructures</a></li>
<li><a href="shaclapi/multiprocessing/Xgjoin/Xgjoin.html">shaclapi.multiprocessing.Xgjoin.Xgjoin</a></li>
<li><a href="shaclapi/multiprocessing/Xgoptional/OperatorStructures.html">shaclapi.multiprocessing.Xgoptional.OperatorStructures</a></li>
<li><a href="shaclapi/multiprocessing/Xgoptional/Xgoptional.html">shaclapi.multiprocessing.Xgoptional.Xgoptional</a></li>
<li><a href="shaclapi/multiprocessing/contactSource.html">shaclapi.multiprocessing.contactSource</a></li>
<li><a href="shaclapi/multiprocessing/functions.html">shaclapi.multiprocessing.functions</a></li>
<li><a href="shaclapi/multiprocessing/runner.html">shaclapi.multiprocessing.runner</a></li>
Expand Down
87 changes: 63 additions & 24 deletions docs/html/_modules/shaclapi/api.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,243 @@

<!DOCTYPE html>

<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>shaclapi.multiprocessing.Xgoptional.OperatorStructures &#8212; shaclAPI documentation</title>
<script>
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "light"
</script>

<!-- Loaded before other Sphinx assets -->
<link href="../../../../_static/styles/theme.css?digest=92025949c220c2e29695" rel="stylesheet">
<link href="../../../../_static/styles/pydata-sphinx-theme.css?digest=92025949c220c2e29695" rel="stylesheet">


<link rel="stylesheet"
href="../../../../_static/vendor/fontawesome/5.13.0/css/all.min.css">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="../../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">

<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../../../_static/graphviz.css" />

<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../../../../_static/scripts/pydata-sphinx-theme.js?digest=92025949c220c2e29695">

<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/jquery.js"></script>
<script src="../../../../_static/underscore.js"></script>
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../../../../_static/doctools.js"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en">
</head>


<body data-spy="scroll" data-target="#bd-toc-nav" data-offset="180" data-default-mode="">
<div class="bd-header-announcement container-fluid" id="banner">


</div>


<nav class="bd-header navbar navbar-light navbar-expand-lg bg-light fixed-top bd-navbar" id="navbar-main"><div class="bd-header__inner container-xl">

<div id="navbar-start">





<a class="navbar-brand logo" href="../../../../index.html">





<p class="title logo__title">shaclAPI documentation</p>

</a>

</div>

<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar-collapsible" aria-controls="navbar-collapsible" aria-expanded="false" aria-label="Toggle navigation">
<span class="fas fa-bars"></span>
</button>


<div id="navbar-collapsible" class="col-lg-9 collapse navbar-collapse">
<div id="navbar-center" class="mr-auto">

<div class="navbar-center-item">
<ul id="navbar-main-elements" class="navbar-nav">
<li class="toctree-l1 nav-item">
<a class="reference internal nav-link" href="../../../../modules.html">
shaclapi
</a>
</li>


</ul>
</div>

</div>

<div id="navbar-end">

<div class="navbar-end-item">
<span id="theme-switch" class="btn btn-sm btn-outline-primary navbar-btn rounded-circle">
<a class="theme-switch" data-mode="light"><i class="fas fa-sun"></i></a>
<a class="theme-switch" data-mode="dark"><i class="far fa-moon"></i></a>
<a class="theme-switch" data-mode="auto"><i class="fas fa-adjust"></i></a>
</span>
</div>

<div class="navbar-end-item">
<ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
</ul>
</div>

</div>
</div>
</div>
</nav>


<div class="bd-container container-xl">
<div class="bd-container__inner row">


<!-- Only show if we have sidebars configured, else just a small margin -->
<div class="bd-sidebar-primary col-12 col-md-3 bd-sidebar">
<div class="sidebar-start-items"><form class="bd-search d-flex align-items-center" action="../../../../search.html" method="get">
<i class="icon fas fa-search"></i>
<input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" >
</form><nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
<div class="bd-toc-item active">

</div>
</nav>
</div>
<div class="sidebar-end-items">
</div>
</div>





<div class="bd-sidebar-secondary d-none d-xl-block col-xl-2 bd-toc">

</div>




<div class="bd-content col-12 col-md-9 col-xl-7">

<article class="bd-article" role="main">

<h1>Source code for shaclapi.multiprocessing.Xgoptional.OperatorStructures</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">Created on Jul 10, 2011</span>
<span class="sd">Implements the structures used by the ANAPSID Operators.</span>
<span class="sd">@author: Maribel Acosta Deibe</span>
<span class="sd">&quot;&quot;&quot;</span>


<div class="viewcode-block" id="Record"><a class="viewcode-back" href="../../../../shaclapi.multiprocessing.Xgoptional.OperatorStructures.html#shaclapi.multiprocessing.Xgoptional.OperatorStructures.Record">[docs]</a><span class="k">class</span> <span class="nc">Record</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Represents a structure that is inserted into the hash table.</span>
<span class="sd"> It is composed by a tuple, probeTS (timestamp when the tuple was probed)</span>
<span class="sd"> and insertTS (timestamp when the tuple was inserted in the table).</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">,</span> <span class="n">probeTS</span><span class="p">,</span> <span class="n">insertTS</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">flushTS</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">tuple</span> <span class="o">=</span> <span class="nb">tuple</span>
<span class="bp">self</span><span class="o">.</span><span class="n">probeTS</span> <span class="o">=</span> <span class="n">probeTS</span>
<span class="bp">self</span><span class="o">.</span><span class="n">insertTS</span> <span class="o">=</span> <span class="n">insertTS</span>
<span class="bp">self</span><span class="o">.</span><span class="n">flushTS</span> <span class="o">=</span> <span class="n">flushTS</span></div>


<div class="viewcode-block" id="RJTTail"><a class="viewcode-back" href="../../../../shaclapi.multiprocessing.Xgoptional.OperatorStructures.html#shaclapi.multiprocessing.Xgoptional.OperatorStructures.RJTTail">[docs]</a><span class="k">class</span> <span class="nc">RJTTail</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Represents the tail of a RJT.</span>
<span class="sd"> It is composed by a list of records and rjtprobeTS</span>
<span class="sd"> (timestamp when the last tuple in the RJT was probed).</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">record</span><span class="p">,</span> <span class="n">rjtProbeTS</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">records</span> <span class="o">=</span> <span class="p">[</span><span class="n">record</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">rjtProbeTS</span> <span class="o">=</span> <span class="n">rjtProbeTS</span>
<span class="bp">self</span><span class="o">.</span><span class="n">flushTS</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="s1">&#39;inf&#39;</span><span class="p">)</span>

<div class="viewcode-block" id="RJTTail.updateRecords"><a class="viewcode-back" href="../../../../shaclapi.multiprocessing.Xgoptional.OperatorStructures.html#shaclapi.multiprocessing.Xgoptional.OperatorStructures.RJTTail.updateRecords">[docs]</a> <span class="k">def</span> <span class="nf">updateRecords</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">record</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">records</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">record</span><span class="p">)</span></div>

<div class="viewcode-block" id="RJTTail.setRJTProbeTS"><a class="viewcode-back" href="../../../../shaclapi.multiprocessing.Xgoptional.OperatorStructures.html#shaclapi.multiprocessing.Xgoptional.OperatorStructures.RJTTail.setRJTProbeTS">[docs]</a> <span class="k">def</span> <span class="nf">setRJTProbeTS</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">rjtProbeTS</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">rjtProbeTS</span> <span class="o">=</span> <span class="n">rjtProbeTS</span></div></div>


<div class="viewcode-block" id="FileDescriptor"><a class="viewcode-back" href="../../../../shaclapi.multiprocessing.Xgoptional.OperatorStructures.html#shaclapi.multiprocessing.Xgoptional.OperatorStructures.FileDescriptor">[docs]</a><span class="k">class</span> <span class="nc">FileDescriptor</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Represents the description of a file, that contains a RJT in sec mem.</span>
<span class="sd"> It is composed by the name of the file, the associated resource,</span>
<span class="sd"> the current size (number of tuples), and the timestamp of the last</span>
<span class="sd"> RJTTail that have been flushed.</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">file</span><span class="p">,</span> <span class="n">size</span><span class="p">,</span> <span class="n">lastFlushTS</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">file</span> <span class="o">=</span> <span class="n">file</span>
<span class="bp">self</span><span class="o">.</span><span class="n">size</span> <span class="o">=</span> <span class="n">size</span>
<span class="bp">self</span><span class="o">.</span><span class="n">lastFlushTS</span> <span class="o">=</span> <span class="n">lastFlushTS</span>

<div class="viewcode-block" id="FileDescriptor.getSize"><a class="viewcode-back" href="../../../../shaclapi.multiprocessing.Xgoptional.OperatorStructures.html#shaclapi.multiprocessing.Xgoptional.OperatorStructures.FileDescriptor.getSize">[docs]</a> <span class="k">def</span> <span class="nf">getSize</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">size</span></div></div>
</pre></div>

</article>



<footer class="bd-footer-article">
<!-- Previous / next buttons -->
<div class='prev-next-area'>
</div>
</footer>

</div>

</div>
</div>



<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script src="../../../../_static/scripts/pydata-sphinx-theme.js?digest=92025949c220c2e29695"></script>

<footer class="bd-footer"><div class="bd-footer__inner container">

<div class="footer-item">
<p class="copyright">
&copy; Copyright 2022, Julian Gercke, Philipp D. Rohde, Fabian Johannsen.<br>
</p>
</div>

<div class="footer-item">
<p class="sphinx-version">
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 5.1.1.<br>
</p>
</div>

</div>
</footer>
</body>
</html>
Loading

0 comments on commit a3ecee3

Please sign in to comment.