Skip to content

Commit

Permalink
Update docs for pr11513
Browse files Browse the repository at this point in the history
  • Loading branch information
DocBot committed Jan 17, 2025
1 parent e3b3dff commit cf2510e
Show file tree
Hide file tree
Showing 576 changed files with 869,670 additions and 7 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@


* [Documentation for PR #11493](docs-pr11493/) (built from [474620f](https://github.com/cvc5/cvc5/commit/474620f) @ [PR #11493](https://github.com/cvc5/cvc5/pull/11493), Jan Fri 17, 21:02 UTC)
* [Documentation for PR #11513](docs-pr11513/) (built from [5594929](https://github.com/cvc5/cvc5/commit/5594929) @ [PR #11513](https://github.com/cvc5/cvc5/pull/11513), Jan Fri 17, 21:05 UTC)

***


* [Documentation for main](docs-main/) (built from [ca078a5](https://github.com/cvc5/cvc5/commit/ca078a5) @ [main](https://github.com/cvc5/cvc5/tree/main), 30 hours ago)
* [Documentation for PR #11538](docs-pr11538/) (built from [762a247](https://github.com/cvc5/cvc5/commit/762a247) @ [PR #11538](https://github.com/cvc5/cvc5/pull/11538), 9 minutes ago)
* [Documentation for PR #11538](docs-pr11538/) (built from [762a247](https://github.com/cvc5/cvc5/commit/762a247) @ [PR #11538](https://github.com/cvc5/cvc5/pull/11538), 12 minutes ago)
* [Documentation for PR #11536](docs-pr11536/) (built from [c4049d4](https://github.com/cvc5/cvc5/commit/c4049d4) @ [PR #11536](https://github.com/cvc5/cvc5/pull/11536), 28 hours ago)
* [Documentation for PR #11534](docs-pr11534/) (built from [4191eb8](https://github.com/cvc5/cvc5/commit/4191eb8) @ [PR #11534](https://github.com/cvc5/cvc5/pull/11534), 2 days ago)
* [Documentation for PR #11533](docs-pr11533/) (built from [fc66318](https://github.com/cvc5/cvc5/commit/fc66318) @ [PR #11533](https://github.com/cvc5/cvc5/pull/11533), 57 minutes ago)
* [Documentation for PR #11533](docs-pr11533/) (built from [fc66318](https://github.com/cvc5/cvc5/commit/fc66318) @ [PR #11533](https://github.com/cvc5/cvc5/pull/11533), 60 minutes ago)
* [Documentation for PR #11532](docs-pr11532/) (built from [a53c29c](https://github.com/cvc5/cvc5/commit/a53c29c) @ [PR #11532](https://github.com/cvc5/cvc5/pull/11532), 2 days ago)
* [Documentation for PR #11531](docs-pr11531/) (built from [40c838c](https://github.com/cvc5/cvc5/commit/40c838c) @ [PR #11531](https://github.com/cvc5/cvc5/pull/11531), 2 days ago)
* [Documentation for PR #11530](docs-pr11530/) (built from [ee5e154](https://github.com/cvc5/cvc5/commit/ee5e154) @ [PR #11530](https://github.com/cvc5/cvc5/pull/11530), 2 days ago)
Expand All @@ -27,7 +27,7 @@
* [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), 7 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), 6 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), 5 days ago)
* [Documentation for PR #11513](docs-pr11513/) (built from [7d9f3c2](https://github.com/cvc5/cvc5/commit/7d9f3c2) @ [PR #11513](https://github.com/cvc5/cvc5/pull/11513), 2 hours ago)
* [Documentation for PR #11513](docs-pr11513/) (built from [5594929](https://github.com/cvc5/cvc5/commit/5594929) @ [PR #11513](https://github.com/cvc5/cvc5/pull/11513), now)
* [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), 6 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), 7 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), 7 days ago)
Expand All @@ -38,9 +38,9 @@
* [Documentation for PR #11505](docs-pr11505/) (built from [335f92f](https://github.com/cvc5/cvc5/commit/335f92f) @ [PR #11505](https://github.com/cvc5/cvc5/pull/11505), 8 days ago)
* [Documentation for PR #11504](docs-pr11504/) (built from [6f33b91](https://github.com/cvc5/cvc5/commit/6f33b91) @ [PR #11504](https://github.com/cvc5/cvc5/pull/11504), 8 days ago)
* [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), 8 days ago)
* [Documentation for PR #11501](docs-pr11501/) (built from [0654581](https://github.com/cvc5/cvc5/commit/0654581) @ [PR #11501](https://github.com/cvc5/cvc5/pull/11501), 49 minutes ago)
* [Documentation for PR #11501](docs-pr11501/) (built from [0654581](https://github.com/cvc5/cvc5/commit/0654581) @ [PR #11501](https://github.com/cvc5/cvc5/pull/11501), 52 minutes 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), 8 days ago)
* [Documentation for PR #11493](docs-pr11493/) (built from [474620f](https://github.com/cvc5/cvc5/commit/474620f) @ [PR #11493](https://github.com/cvc5/cvc5/pull/11493), now)
* [Documentation for PR #11493](docs-pr11493/) (built from [474620f](https://github.com/cvc5/cvc5/commit/474620f) @ [PR #11493](https://github.com/cvc5/cvc5/pull/11493), 3 minutes 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), 5 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), 4 days 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), 7 days ago)
Expand Down
2 changes: 1 addition & 1 deletion docs-pr11513
154 changes: 154 additions & 0 deletions docs-pr11513-5594929c2601515d65611c4b3bf5486770481725/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 cf2510e

Please sign in to comment.