Skip to content

Commit

Permalink
Update docs for pr11176
Browse files Browse the repository at this point in the history
  • Loading branch information
DocBot committed Jan 15, 2025
1 parent eb6d06b commit c2f069a
Show file tree
Hide file tree
Showing 576 changed files with 867,959 additions and 11 deletions.
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@


* [Documentation for PR #11176](docs-pr11176/) (built from [2b99a8c](https://github.com/cvc5/cvc5/commit/2b99a8c) @ [PR #11176](https://github.com/cvc5/cvc5/pull/11176), Jan Wed 15, 02:12 UTC)

***


* [Documentation for main](docs-main/) (built from [8dca52e](https://github.com/cvc5/cvc5/commit/8dca52e) @ [main](https://github.com/cvc5/cvc5/tree/main), 3 hours ago)
* [Documentation for PR #11525](docs-pr11525/) (built from [aa47499](https://github.com/cvc5/cvc5/commit/aa47499) @ [PR #11525](https://github.com/cvc5/cvc5/pull/11525), 2 hours ago)
* [Documentation for PR #11524](docs-pr11524/) (built from [60c629e](https://github.com/cvc5/cvc5/commit/60c629e) @ [PR #11524](https://github.com/cvc5/cvc5/pull/11524), 3 hours ago)
* [Documentation for PR #11523](docs-pr11523/) (built from [e7addbf](https://github.com/cvc5/cvc5/commit/e7addbf) @ [PR #11523](https://github.com/cvc5/cvc5/pull/11523), 3 hours ago)
* [Documentation for PR #11522](docs-pr11522/) (built from [2926934](https://github.com/cvc5/cvc5/commit/2926934) @ [PR #11522](https://github.com/cvc5/cvc5/pull/11522), 4 hours ago)
* [Documentation for PR #11525](docs-pr11525/) (built from [aa47499](https://github.com/cvc5/cvc5/commit/aa47499) @ [PR #11525](https://github.com/cvc5/cvc5/pull/11525), 3 hours ago)
* [Documentation for PR #11524](docs-pr11524/) (built from [60c629e](https://github.com/cvc5/cvc5/commit/60c629e) @ [PR #11524](https://github.com/cvc5/cvc5/pull/11524), 4 hours ago)
* [Documentation for PR #11523](docs-pr11523/) (built from [e7addbf](https://github.com/cvc5/cvc5/commit/e7addbf) @ [PR #11523](https://github.com/cvc5/cvc5/pull/11523), 4 hours ago)
* [Documentation for PR #11522](docs-pr11522/) (built from [2926934](https://github.com/cvc5/cvc5/commit/2926934) @ [PR #11522](https://github.com/cvc5/cvc5/pull/11522), 5 hours ago)
* [Documentation for PR #11518](docs-pr11518/) (built from [e6e1b68](https://github.com/cvc5/cvc5/commit/e6e1b68) @ [PR #11518](https://github.com/cvc5/cvc5/pull/11518), 29 hours ago)
* [Documentation for PR #11517](docs-pr11517/) (built from [bc35d3d](https://github.com/cvc5/cvc5/commit/bc35d3d) @ [PR #11517](https://github.com/cvc5/cvc5/pull/11517), 31 hours ago)
* [Documentation for PR #11517](docs-pr11517/) (built from [bc35d3d](https://github.com/cvc5/cvc5/commit/bc35d3d) @ [PR #11517](https://github.com/cvc5/cvc5/pull/11517), 32 hours ago)
* [Documentation for PR #11516](docs-pr11516/) (built from [1a1407f](https://github.com/cvc5/cvc5/commit/1a1407f) @ [PR #11516](https://github.com/cvc5/cvc5/pull/11516), 4 days ago)
* [Documentation for PR #11515](docs-pr11515/) (built from [08b9f6b](https://github.com/cvc5/cvc5/commit/08b9f6b) @ [PR #11515](https://github.com/cvc5/cvc5/pull/11515), 3 days ago)
* [Documentation for PR #11515](docs-pr11515/) (built from [08b9f6b](https://github.com/cvc5/cvc5/commit/08b9f6b) @ [PR #11515](https://github.com/cvc5/cvc5/pull/11515), 4 days ago)
* [Documentation for PR #11514](docs-pr11514/) (built from [435a1dc](https://github.com/cvc5/cvc5/commit/435a1dc) @ [PR #11514](https://github.com/cvc5/cvc5/pull/11514), 2 days ago)
* [Documentation for PR #11513](docs-pr11513/) (built from [a3c73e6](https://github.com/cvc5/cvc5/commit/a3c73e6) @ [PR #11513](https://github.com/cvc5/cvc5/pull/11513), 8 hours ago)
* [Documentation for PR #11513](docs-pr11513/) (built from [a3c73e6](https://github.com/cvc5/cvc5/commit/a3c73e6) @ [PR #11513](https://github.com/cvc5/cvc5/pull/11513), 9 hours ago)
* [Documentation for PR #11512](docs-pr11512/) (built from [443f9b2](https://github.com/cvc5/cvc5/commit/443f9b2) @ [PR #11512](https://github.com/cvc5/cvc5/pull/11512), 3 days ago)
* [Documentation for PR #11511](docs-pr11511/) (built from [4ceb6df](https://github.com/cvc5/cvc5/commit/4ceb6df) @ [PR #11511](https://github.com/cvc5/cvc5/pull/11511), 4 days ago)
* [Documentation for PR #11510](docs-pr11510/) (built from [fb49845](https://github.com/cvc5/cvc5/commit/fb49845) @ [PR #11510](https://github.com/cvc5/cvc5/pull/11510), 4 days ago)
Expand All @@ -24,14 +28,14 @@
* [Documentation for PR #11503](docs-pr11503/) (built from [3469599](https://github.com/cvc5/cvc5/commit/3469599) @ [PR #11503](https://github.com/cvc5/cvc5/pull/11503), 5 days ago)
* [Documentation for PR #11501](docs-pr11501/) (built from [51a9523](https://github.com/cvc5/cvc5/commit/51a9523) @ [PR #11501](https://github.com/cvc5/cvc5/pull/11501), 4 days ago)
* [Documentation for PR #11500](docs-pr11500/) (built from [73f9f2f](https://github.com/cvc5/cvc5/commit/73f9f2f) @ [PR #11500](https://github.com/cvc5/cvc5/pull/11500), 6 days ago)
* [Documentation for PR #11499](docs-pr11499/) (built from [545bccb](https://github.com/cvc5/cvc5/commit/545bccb) @ [PR #11499](https://github.com/cvc5/cvc5/pull/11499), 6 days ago)
* [Documentation for PR #11499](docs-pr11499/) (built from [545bccb](https://github.com/cvc5/cvc5/commit/545bccb) @ [PR #11499](https://github.com/cvc5/cvc5/pull/11499), 7 days ago)
* [Documentation for PR #11498](docs-pr11498/) (built from [149dd61](https://github.com/cvc5/cvc5/commit/149dd61) @ [PR #11498](https://github.com/cvc5/cvc5/pull/11498), 7 days ago)
* [Documentation for PR #11497](docs-pr11497/) (built from [bbff037](https://github.com/cvc5/cvc5/commit/bbff037) @ [PR #11497](https://github.com/cvc5/cvc5/pull/11497), 6 days ago)
* [Documentation for PR #11496](docs-pr11496/) (built from [5f4757a](https://github.com/cvc5/cvc5/commit/5f4757a) @ [PR #11496](https://github.com/cvc5/cvc5/pull/11496), 7 days ago)
* [Documentation for PR #11494](docs-pr11494/) (built from [70ae2e9](https://github.com/cvc5/cvc5/commit/70ae2e9) @ [PR #11494](https://github.com/cvc5/cvc5/pull/11494), 5 days ago)
* [Documentation for PR #11493](docs-pr11493/) (built from [b0938e6](https://github.com/cvc5/cvc5/commit/b0938e6) @ [PR #11493](https://github.com/cvc5/cvc5/pull/11493), 4 days ago)
* [Documentation for PR #11491](docs-pr11491/) (built from [3f84a11](https://github.com/cvc5/cvc5/commit/3f84a11) @ [PR #11491](https://github.com/cvc5/cvc5/pull/11491), 2 days ago)
* [Documentation for PR #11483](docs-pr11483/) (built from [8dd6613](https://github.com/cvc5/cvc5/commit/8dd6613) @ [PR #11483](https://github.com/cvc5/cvc5/pull/11483), 27 hours ago)
* [Documentation for PR #11483](docs-pr11483/) (built from [8dd6613](https://github.com/cvc5/cvc5/commit/8dd6613) @ [PR #11483](https://github.com/cvc5/cvc5/pull/11483), 28 hours ago)
* [Documentation for PR #11479](docs-pr11479/) (built from [d3059a1](https://github.com/cvc5/cvc5/commit/d3059a1) @ [PR #11479](https://github.com/cvc5/cvc5/pull/11479), 4 days ago)
* [Documentation for PR #11476](docs-pr11476/) (built from [e1ddda6](https://github.com/cvc5/cvc5/commit/e1ddda6) @ [PR #11476](https://github.com/cvc5/cvc5/pull/11476), 7 days ago)
* [Documentation for PR #11473](docs-pr11473/) (built from [34d05a0](https://github.com/cvc5/cvc5/commit/34d05a0) @ [PR #11473](https://github.com/cvc5/cvc5/pull/11473), 3 days ago)
Expand All @@ -41,4 +45,4 @@
* [Documentation for PR #11434](docs-pr11434/) (built from [1fdbf36](https://github.com/cvc5/cvc5/commit/1fdbf36) @ [PR #11434](https://github.com/cvc5/cvc5/pull/11434), 7 days ago)
* [Documentation for PR #11427](docs-pr11427/) (built from [8f612ea](https://github.com/cvc5/cvc5/commit/8f612ea) @ [PR #11427](https://github.com/cvc5/cvc5/pull/11427), 6 days ago)
* [Documentation for PR #11382](docs-pr11382/) (built from [5d32601](https://github.com/cvc5/cvc5/commit/5d32601) @ [PR #11382](https://github.com/cvc5/cvc5/pull/11382), 7 days ago)
* [Documentation for PR #11176](docs-pr11176/) (built from [5b56248](https://github.com/cvc5/cvc5/commit/5b56248) @ [PR #11176](https://github.com/cvc5/cvc5/pull/11176), 24 hours ago)
* [Documentation for PR #11176](docs-pr11176/) (built from [2b99a8c](https://github.com/cvc5/cvc5/commit/2b99a8c) @ [PR #11176](https://github.com/cvc5/cvc5/pull/11176), now)
2 changes: 1 addition & 1 deletion docs-pr11176
154 changes: 154 additions & 0 deletions docs-pr11176-2b99a8c55528a4baa2c041d8087962ee89711139/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=b86133f3" />
<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 2025, 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 c2f069a

Please sign in to comment.