Skip to content

Commit

Permalink
Update docs for pr11471
Browse files Browse the repository at this point in the history
  • Loading branch information
DocBot committed Dec 24, 2024
1 parent 167125e commit 0590860
Show file tree
Hide file tree
Showing 576 changed files with 865,116 additions and 11 deletions.
27 changes: 16 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,34 @@


* [Documentation for PR #11471](docs-pr11471/) (built from [80e634f](https://github.com/cvc5/cvc5/commit/80e634f) @ [PR #11471](https://github.com/cvc5/cvc5/pull/11471), Dec Tue 24, 06:03 UTC)

* [Documentation for main](docs-main/) (built from [0d26ecc](https://github.com/cvc5/cvc5/commit/0d26ecc) @ [main](https://github.com/cvc5/cvc5/tree/main), 9 hours ago)
* [Documentation for PR #11470](docs-pr11470/) (built from [413259c](https://github.com/cvc5/cvc5/commit/413259c) @ [PR #11470](https://github.com/cvc5/cvc5/pull/11470), 10 hours ago)
* [Documentation for PR #11468](docs-pr11468/) (built from [88511fc](https://github.com/cvc5/cvc5/commit/88511fc) @ [PR #11468](https://github.com/cvc5/cvc5/pull/11468), 2 days ago)
***


* [Documentation for main](docs-main/) (built from [0d26ecc](https://github.com/cvc5/cvc5/commit/0d26ecc) @ [main](https://github.com/cvc5/cvc5/tree/main), 13 hours ago)
* [Documentation for PR #11471](docs-pr11471/) (built from [80e634f](https://github.com/cvc5/cvc5/commit/80e634f) @ [PR #11471](https://github.com/cvc5/cvc5/pull/11471), now)
* [Documentation for PR #11470](docs-pr11470/) (built from [413259c](https://github.com/cvc5/cvc5/commit/413259c) @ [PR #11470](https://github.com/cvc5/cvc5/pull/11470), 14 hours ago)
* [Documentation for PR #11468](docs-pr11468/) (built from [88511fc](https://github.com/cvc5/cvc5/commit/88511fc) @ [PR #11468](https://github.com/cvc5/cvc5/pull/11468), 3 days ago)
* [Documentation for PR #11467](docs-pr11467/) (built from [0e9deed](https://github.com/cvc5/cvc5/commit/0e9deed) @ [PR #11467](https://github.com/cvc5/cvc5/pull/11467), 3 days ago)
* [Documentation for PR #11466](docs-pr11466/) (built from [44c747a](https://github.com/cvc5/cvc5/commit/44c747a) @ [PR #11466](https://github.com/cvc5/cvc5/pull/11466), 3 days ago)
* [Documentation for PR #11465](docs-pr11465/) (built from [d1dc731](https://github.com/cvc5/cvc5/commit/d1dc731) @ [PR #11465](https://github.com/cvc5/cvc5/pull/11465), 3 days ago)
* [Documentation for PR #11464](docs-pr11464/) (built from [65f588c](https://github.com/cvc5/cvc5/commit/65f588c) @ [PR #11464](https://github.com/cvc5/cvc5/pull/11464), 4 days ago)
* [Documentation for PR #11464](docs-pr11464/) (built from [65f588c](https://github.com/cvc5/cvc5/commit/65f588c) @ [PR #11464](https://github.com/cvc5/cvc5/pull/11464), 5 days ago)
* [Documentation for PR #11462](docs-pr11462/) (built from [83452f3](https://github.com/cvc5/cvc5/commit/83452f3) @ [PR #11462](https://github.com/cvc5/cvc5/pull/11462), 5 days ago)
* [Documentation for PR #11461](docs-pr11461/) (built from [675eed1](https://github.com/cvc5/cvc5/commit/675eed1) @ [PR #11461](https://github.com/cvc5/cvc5/pull/11461), 4 days ago)
* [Documentation for PR #11459](docs-pr11459/) (built from [73b2530](https://github.com/cvc5/cvc5/commit/73b2530) @ [PR #11459](https://github.com/cvc5/cvc5/pull/11459), 5 days ago)
* [Documentation for PR #11458](docs-pr11458/) (built from [befa8f3](https://github.com/cvc5/cvc5/commit/befa8f3) @ [PR #11458](https://github.com/cvc5/cvc5/pull/11458), 5 days ago)
* [Documentation for PR #11459](docs-pr11459/) (built from [73b2530](https://github.com/cvc5/cvc5/commit/73b2530) @ [PR #11459](https://github.com/cvc5/cvc5/pull/11459), 6 days ago)
* [Documentation for PR #11458](docs-pr11458/) (built from [befa8f3](https://github.com/cvc5/cvc5/commit/befa8f3) @ [PR #11458](https://github.com/cvc5/cvc5/pull/11458), 6 days ago)
* [Documentation for PR #11457](docs-pr11457/) (built from [7b76cf8](https://github.com/cvc5/cvc5/commit/7b76cf8) @ [PR #11457](https://github.com/cvc5/cvc5/pull/11457), 6 days ago)
* [Documentation for PR #11456](docs-pr11456/) (built from [f6244cd](https://github.com/cvc5/cvc5/commit/f6244cd) @ [PR #11456](https://github.com/cvc5/cvc5/pull/11456), 6 days ago)
* [Documentation for PR #11455](docs-pr11455/) (built from [cd1b4d6](https://github.com/cvc5/cvc5/commit/cd1b4d6) @ [PR #11455](https://github.com/cvc5/cvc5/pull/11455), 6 days ago)
* [Documentation for PR #11454](docs-pr11454/) (built from [02afd31](https://github.com/cvc5/cvc5/commit/02afd31) @ [PR #11454](https://github.com/cvc5/cvc5/pull/11454), 3 days ago)
* [Documentation for PR #11454](docs-pr11454/) (built from [02afd31](https://github.com/cvc5/cvc5/commit/02afd31) @ [PR #11454](https://github.com/cvc5/cvc5/pull/11454), 4 days ago)
* [Documentation for PR #11453](docs-pr11453/) (built from [f251337](https://github.com/cvc5/cvc5/commit/f251337) @ [PR #11453](https://github.com/cvc5/cvc5/pull/11453), 7 days ago)
* [Documentation for PR #11452](docs-pr11452/) (built from [2bd8015](https://github.com/cvc5/cvc5/commit/2bd8015) @ [PR #11452](https://github.com/cvc5/cvc5/pull/11452), 7 days ago)
* [Documentation for PR #11451](docs-pr11451/) (built from [b83417a](https://github.com/cvc5/cvc5/commit/b83417a) @ [PR #11451](https://github.com/cvc5/cvc5/pull/11451), 7 days ago)
* [Documentation for PR #11429](docs-pr11429/) (built from [2f8f0cf](https://github.com/cvc5/cvc5/commit/2f8f0cf) @ [PR #11429](https://github.com/cvc5/cvc5/pull/11429), 6 days ago)
* [Documentation for PR #11426](docs-pr11426/) (built from [9c9d395](https://github.com/cvc5/cvc5/commit/9c9d395) @ [PR #11426](https://github.com/cvc5/cvc5/pull/11426), 6 days ago)
* [Documentation for PR #11426](docs-pr11426/) (built from [9c9d395](https://github.com/cvc5/cvc5/commit/9c9d395) @ [PR #11426](https://github.com/cvc5/cvc5/pull/11426), 7 days ago)
* [Documentation for PR #11425](docs-pr11425/) (built from [6c0b5b3](https://github.com/cvc5/cvc5/commit/6c0b5b3) @ [PR #11425](https://github.com/cvc5/cvc5/pull/11425), 3 days ago)
* [Documentation for PR #11424](docs-pr11424/) (built from [9847bd5](https://github.com/cvc5/cvc5/commit/9847bd5) @ [PR #11424](https://github.com/cvc5/cvc5/pull/11424), 3 days ago)
* [Documentation for PR #11420](docs-pr11420/) (built from [15bb9eb](https://github.com/cvc5/cvc5/commit/15bb9eb) @ [PR #11420](https://github.com/cvc5/cvc5/pull/11420), 5 days ago)
* [Documentation for PR #11415](docs-pr11415/) (built from [3189232](https://github.com/cvc5/cvc5/commit/3189232) @ [PR #11415](https://github.com/cvc5/cvc5/pull/11415), 3 days ago)
* [Documentation for PR #11382](docs-pr11382/) (built from [7c2bd2b](https://github.com/cvc5/cvc5/commit/7c2bd2b) @ [PR #11382](https://github.com/cvc5/cvc5/pull/11382), 3 hours ago)
* [Documentation for PR #11420](docs-pr11420/) (built from [15bb9eb](https://github.com/cvc5/cvc5/commit/15bb9eb) @ [PR #11420](https://github.com/cvc5/cvc5/pull/11420), 6 days ago)
* [Documentation for PR #11415](docs-pr11415/) (built from [3189232](https://github.com/cvc5/cvc5/commit/3189232) @ [PR #11415](https://github.com/cvc5/cvc5/pull/11415), 4 days ago)
* [Documentation for PR #11382](docs-pr11382/) (built from [7c2bd2b](https://github.com/cvc5/cvc5/commit/7c2bd2b) @ [PR #11382](https://github.com/cvc5/cvc5/pull/11382), 8 hours ago)
* [Documentation for PR #11300](docs-pr11300/) (built from [4a4852b](https://github.com/cvc5/cvc5/commit/4a4852b) @ [PR #11300](https://github.com/cvc5/cvc5/pull/11300), 3 days ago)
1 change: 1 addition & 0 deletions docs-pr11471
154 changes: 154 additions & 0 deletions docs-pr11471-80e634ff5a496f7784db9138b4ded9ed06055d05/api/api.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@


<!DOCTYPE html>
<html class="writer-html5" lang="en">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-ML12X2V35B"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-ML12X2V35B');
</script>

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>API Documentation &mdash; cvc5 documentation</title>
<link rel="stylesheet" type="text/css" href="../static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../static/custom.css?v=b9602cbe" />


<script src="../static/jquery.js?v=5d32c60e"></script>
<script src="../static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="../" id="documentation_options" src="../static/documentation_options.js?v=b3ba4146"></script>
<script src="../static/doctools.js?v=888ff710"></script>
<script src="../static/sphinx_highlight.js?v=4825356b"></script>
<script src="../static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="C++ API" href="cpp/cpp.html" />
<link rel="prev" title="Quickstart Guide" href="../binary/quickstart.html" />
</head>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >



<a href="../index.html" class="icon icon-home">
cvc5
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../installation/installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../binary/binary.html">Binary Documentation</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">API Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cpp/cpp.html">C++ API</a></li>
<li class="toctree-l2"><a class="reference internal" href="c/c.html">C API</a></li>
<li class="toctree-l2"><a class="reference internal" href="java/java.html">Java API</a></li>
<li class="toctree-l2"><a class="reference internal" href="python/python.html">Python API</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../options.html">Options</a></li>
<li class="toctree-l1"><a class="reference internal" href="../output-tags.html">Output tags</a></li>
<li class="toctree-l1"><a class="reference internal" href="../proofs/proofs.html">Proof Production</a></li>
<li class="toctree-l1"><a class="reference internal" href="../resource-limits.html">Resource limits</a></li>
<li class="toctree-l1"><a class="reference internal" href="../skolem-ids.html">Skolem Identifiers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../statistics.html">Statistics</a></li>
<li class="toctree-l1"><a class="reference internal" href="../examples/examples.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="../theories/theories.html">Theory References</a></li>
<li class="toctree-l1"><a class="reference internal" href="../references.html">References</a></li>
<li class="toctree-l1"><a class="reference internal" href="../genindex.html">Index</a></li>
</ul>

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

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">cvc5</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">API Documentation</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="api-documentation">
<h1>API Documentation<a class="headerlink" href="#api-documentation" title="Permalink to this heading"></a></h1>
<p>Alternatively to using cvc5 <a class="reference internal" href="../binary/binary.html"><span class="doc">as a binary</span></a>, cvc5 can be
integrated at the back end of other tools via one of its rich and comprehensive
APIs.</p>
<p>The primary interface of cvc5 is its <a class="reference internal" href="cpp/cpp.html"><span class="doc">C++ API</span></a>.
Its <a class="reference internal" href="c/c.html"><span class="doc">C API</span></a>, <a class="reference internal" href="java/java.html"><span class="doc">Java API</span></a> and
<a class="reference internal" href="python/base/python.html"><span class="doc">base Python API</span></a> implement a thin wrapper around
the C++ API.
In addition to the base Python API, cvc5 also provides a more <a class="reference internal" href="python/pythonic/pythonic.html"><span class="doc">pythonic
Python API</span></a> at
<a class="reference external" href="https://github.com/cvc5/cvc5_pythonic_api">https://github.com/cvc5/cvc5_pythonic_api</a>,
documented <a class="reference internal" href="python/pythonic/pythonic.html"><span class="doc">here</span></a>.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="cpp/cpp.html">C++ API</a></li>
<li class="toctree-l1"><a class="reference internal" href="c/c.html">C API</a></li>
<li class="toctree-l1"><a class="reference internal" href="java/java.html">Java API</a></li>
<li class="toctree-l1"><a class="reference internal" href="python/python.html">Python API</a></li>
</ul>
</div>
</section>


</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../binary/quickstart.html" class="btn btn-neutral float-left" title="Quickstart Guide" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="cpp/cpp.html" class="btn btn-neutral float-right" title="C++ API" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2024, the authors of cvc5.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
Loading

0 comments on commit 0590860

Please sign in to comment.