Skip to content

Commit

Permalink
Update docs for pr11436
Browse files Browse the repository at this point in the history
  • Loading branch information
DocBot committed Dec 13, 2024
1 parent c6a4ec9 commit ed7c2cd
Show file tree
Hide file tree
Showing 576 changed files with 864,477 additions and 16 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@


* [Documentation for PR #11450](docs-pr11450/) (built from [22817d8](https://github.com/cvc5/cvc5/commit/22817d8) @ [PR #11450](https://github.com/cvc5/cvc5/pull/11450), Dec Fri 13, 16:10 UTC)
* [Documentation for PR #11436](docs-pr11436/) (built from [1847570](https://github.com/cvc5/cvc5/commit/1847570) @ [PR #11436](https://github.com/cvc5/cvc5/pull/11436), Dec Fri 13, 17:27 UTC)

***


* [Documentation for main](docs-main/) (built from [1b8dd45](https://github.com/cvc5/cvc5/commit/1b8dd45) @ [main](https://github.com/cvc5/cvc5/tree/main), 14 hours ago)
* [Documentation for PR #11450](docs-pr11450/) (built from [22817d8](https://github.com/cvc5/cvc5/commit/22817d8) @ [PR #11450](https://github.com/cvc5/cvc5/pull/11450), now)
* [Documentation for PR #11449](docs-pr11449/) (built from [2660608](https://github.com/cvc5/cvc5/commit/2660608) @ [PR #11449](https://github.com/cvc5/cvc5/pull/11449), 39 minutes ago)
* [Documentation for PR #11448](docs-pr11448/) (built from [7d36a64](https://github.com/cvc5/cvc5/commit/7d36a64) @ [PR #11448](https://github.com/cvc5/cvc5/pull/11448), 44 minutes ago)
* [Documentation for PR #11447](docs-pr11447/) (built from [b3162fd](https://github.com/cvc5/cvc5/commit/b3162fd) @ [PR #11447](https://github.com/cvc5/cvc5/pull/11447), 62 minutes ago)
* [Documentation for PR #11445](docs-pr11445/) (built from [7faa941](https://github.com/cvc5/cvc5/commit/7faa941) @ [PR #11445](https://github.com/cvc5/cvc5/pull/11445), 19 hours ago)
* [Documentation for PR #11444](docs-pr11444/) (built from [7d7e812](https://github.com/cvc5/cvc5/commit/7d7e812) @ [PR #11444](https://github.com/cvc5/cvc5/pull/11444), 22 hours ago)
* [Documentation for PR #11443](docs-pr11443/) (built from [95c3d30](https://github.com/cvc5/cvc5/commit/95c3d30) @ [PR #11443](https://github.com/cvc5/cvc5/pull/11443), 23 hours ago)
* [Documentation for PR #11442](docs-pr11442/) (built from [42fca49](https://github.com/cvc5/cvc5/commit/42fca49) @ [PR #11442](https://github.com/cvc5/cvc5/pull/11442), 23 hours ago)
* [Documentation for main](docs-main/) (built from [1b8dd45](https://github.com/cvc5/cvc5/commit/1b8dd45) @ [main](https://github.com/cvc5/cvc5/tree/main), 15 hours ago)
* [Documentation for PR #11450](docs-pr11450/) (built from [22817d8](https://github.com/cvc5/cvc5/commit/22817d8) @ [PR #11450](https://github.com/cvc5/cvc5/pull/11450), 77 minutes ago)
* [Documentation for PR #11449](docs-pr11449/) (built from [2660608](https://github.com/cvc5/cvc5/commit/2660608) @ [PR #11449](https://github.com/cvc5/cvc5/pull/11449), 2 hours ago)
* [Documentation for PR #11448](docs-pr11448/) (built from [7d36a64](https://github.com/cvc5/cvc5/commit/7d36a64) @ [PR #11448](https://github.com/cvc5/cvc5/pull/11448), 2 hours ago)
* [Documentation for PR #11447](docs-pr11447/) (built from [b3162fd](https://github.com/cvc5/cvc5/commit/b3162fd) @ [PR #11447](https://github.com/cvc5/cvc5/pull/11447), 2 hours ago)
* [Documentation for PR #11445](docs-pr11445/) (built from [7faa941](https://github.com/cvc5/cvc5/commit/7faa941) @ [PR #11445](https://github.com/cvc5/cvc5/pull/11445), 21 hours ago)
* [Documentation for PR #11444](docs-pr11444/) (built from [7d7e812](https://github.com/cvc5/cvc5/commit/7d7e812) @ [PR #11444](https://github.com/cvc5/cvc5/pull/11444), 23 hours ago)
* [Documentation for PR #11443](docs-pr11443/) (built from [95c3d30](https://github.com/cvc5/cvc5/commit/95c3d30) @ [PR #11443](https://github.com/cvc5/cvc5/pull/11443), 24 hours ago)
* [Documentation for PR #11442](docs-pr11442/) (built from [42fca49](https://github.com/cvc5/cvc5/commit/42fca49) @ [PR #11442](https://github.com/cvc5/cvc5/pull/11442), 25 hours ago)
* [Documentation for PR #11441](docs-pr11441/) (built from [fdf0039](https://github.com/cvc5/cvc5/commit/fdf0039) @ [PR #11441](https://github.com/cvc5/cvc5/pull/11441), 2 days ago)
* [Documentation for PR #11440](docs-pr11440/) (built from [6da8a83](https://github.com/cvc5/cvc5/commit/6da8a83) @ [PR #11440](https://github.com/cvc5/cvc5/pull/11440), 18 hours ago)
* [Documentation for PR #11440](docs-pr11440/) (built from [6da8a83](https://github.com/cvc5/cvc5/commit/6da8a83) @ [PR #11440](https://github.com/cvc5/cvc5/pull/11440), 19 hours ago)
* [Documentation for PR #11439](docs-pr11439/) (built from [1439ddb](https://github.com/cvc5/cvc5/commit/1439ddb) @ [PR #11439](https://github.com/cvc5/cvc5/pull/11439), 2 days ago)
* [Documentation for PR #11438](docs-pr11438/) (built from [2151995](https://github.com/cvc5/cvc5/commit/2151995) @ [PR #11438](https://github.com/cvc5/cvc5/pull/11438), 2 days ago)
* [Documentation for PR #11437](docs-pr11437/) (built from [1795a54](https://github.com/cvc5/cvc5/commit/1795a54) @ [PR #11437](https://github.com/cvc5/cvc5/pull/11437), 2 days ago)
* [Documentation for PR #11436](docs-pr11436/) (built from [d4468ca](https://github.com/cvc5/cvc5/commit/d4468ca) @ [PR #11436](https://github.com/cvc5/cvc5/pull/11436), 3 days ago)
* [Documentation for PR #11436](docs-pr11436/) (built from [1847570](https://github.com/cvc5/cvc5/commit/1847570) @ [PR #11436](https://github.com/cvc5/cvc5/pull/11436), now)
* [Documentation for PR #11435](docs-pr11435/) (built from [8e5f1a6](https://github.com/cvc5/cvc5/commit/8e5f1a6) @ [PR #11435](https://github.com/cvc5/cvc5/pull/11435), 3 days ago)
* [Documentation for PR #11434](docs-pr11434/) (built from [c050919](https://github.com/cvc5/cvc5/commit/c050919) @ [PR #11434](https://github.com/cvc5/cvc5/pull/11434), 3 days ago)
* [Documentation for PR #11433](docs-pr11433/) (built from [97c090d](https://github.com/cvc5/cvc5/commit/97c090d) @ [PR #11433](https://github.com/cvc5/cvc5/pull/11433), 3 days ago)
* [Documentation for PR #11432](docs-pr11432/) (built from [56c53d3](https://github.com/cvc5/cvc5/commit/56c53d3) @ [PR #11432](https://github.com/cvc5/cvc5/pull/11432), 3 days ago)
* [Documentation for PR #11431](docs-pr11431/) (built from [2be4218](https://github.com/cvc5/cvc5/commit/2be4218) @ [PR #11431](https://github.com/cvc5/cvc5/pull/11431), 18 hours ago)
* [Documentation for PR #11431](docs-pr11431/) (built from [2be4218](https://github.com/cvc5/cvc5/commit/2be4218) @ [PR #11431](https://github.com/cvc5/cvc5/pull/11431), 19 hours ago)
* [Documentation for PR #11430](docs-pr11430/) (built from [9369244](https://github.com/cvc5/cvc5/commit/9369244) @ [PR #11430](https://github.com/cvc5/cvc5/pull/11430), 3 days ago)
* [Documentation for PR #11429](docs-pr11429/) (built from [6ebd82b](https://github.com/cvc5/cvc5/commit/6ebd82b) @ [PR #11429](https://github.com/cvc5/cvc5/pull/11429), 3 days ago)
* [Documentation for PR #11428](docs-pr11428/) (built from [36123a8](https://github.com/cvc5/cvc5/commit/36123a8) @ [PR #11428](https://github.com/cvc5/cvc5/pull/11428), 3 days ago)
Expand All @@ -46,9 +46,9 @@
* [Documentation for PR #11412](docs-pr11412/) (built from [a1d8bbf](https://github.com/cvc5/cvc5/commit/a1d8bbf) @ [PR #11412](https://github.com/cvc5/cvc5/pull/11412), 8 days ago)
* [Documentation for PR #11411](docs-pr11411/) (built from [ad27b53](https://github.com/cvc5/cvc5/commit/ad27b53) @ [PR #11411](https://github.com/cvc5/cvc5/pull/11411), 8 days ago)
* [Documentation for PR #11410](docs-pr11410/) (built from [a1faa0a](https://github.com/cvc5/cvc5/commit/a1faa0a) @ [PR #11410](https://github.com/cvc5/cvc5/pull/11410), 8 days ago)
* [Documentation for PR #11402](docs-pr11402/) (built from [66187fa](https://github.com/cvc5/cvc5/commit/66187fa) @ [PR #11402](https://github.com/cvc5/cvc5/pull/11402), 19 hours ago)
* [Documentation for PR #11402](docs-pr11402/) (built from [66187fa](https://github.com/cvc5/cvc5/commit/66187fa) @ [PR #11402](https://github.com/cvc5/cvc5/pull/11402), 20 hours ago)
* [Documentation for PR #11392](docs-pr11392/) (built from [d13dda7](https://github.com/cvc5/cvc5/commit/d13dda7) @ [PR #11392](https://github.com/cvc5/cvc5/pull/11392), 4 days ago)
* [Documentation for PR #11389](docs-pr11389/) (built from [f8c135e](https://github.com/cvc5/cvc5/commit/f8c135e) @ [PR #11389](https://github.com/cvc5/cvc5/pull/11389), 8 days ago)
* [Documentation for PR #11348](docs-pr11348/) (built from [11017ba](https://github.com/cvc5/cvc5/commit/11017ba) @ [PR #11348](https://github.com/cvc5/cvc5/pull/11348), 16 hours ago)
* [Documentation for PR #11348](docs-pr11348/) (built from [11017ba](https://github.com/cvc5/cvc5/commit/11017ba) @ [PR #11348](https://github.com/cvc5/cvc5/pull/11348), 17 hours ago)
* [Documentation for PR #11297](docs-pr11297/) (built from [69d8c75](https://github.com/cvc5/cvc5/commit/69d8c75) @ [PR #11297](https://github.com/cvc5/cvc5/pull/11297), 4 days ago)
* [Documentation for PR #11176](docs-pr11176/) (built from [e68066c](https://github.com/cvc5/cvc5/commit/e68066c) @ [PR #11176](https://github.com/cvc5/cvc5/pull/11176), 3 days ago)
2 changes: 1 addition & 1 deletion docs-pr11436
154 changes: 154 additions & 0 deletions docs-pr11436-184757005d554c79e69a25e06567c832de3e2686/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 ed7c2cd

Please sign in to comment.