Skip to content

Commit

Permalink
Update docs for pr11532
Browse files Browse the repository at this point in the history
  • Loading branch information
DocBot committed Jan 29, 2025
1 parent da05692 commit 228b601
Show file tree
Hide file tree
Showing 576 changed files with 869,273 additions and 11 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@


* [Documentation for PR #11513](docs-pr11513/) (built from [4806dba](https://github.com/cvc5/cvc5/commit/4806dba) @ [PR #11513](https://github.com/cvc5/cvc5/pull/11513), Jan Tue 21, 17:07 UTC)
* [Documentation for PR #11532](docs-pr11532/) (built from [21d6833](https://github.com/cvc5/cvc5/commit/21d6833) @ [PR #11532](https://github.com/cvc5/cvc5/pull/11532), Jan Tue 21, 17:39 UTC)

***


* [Documentation for main](docs-main/) (built from [de69dae](https://github.com/cvc5/cvc5/commit/de69dae) @ [main](https://github.com/cvc5/cvc5/tree/main), 2 hours ago)
* [Documentation for PR #11548](docs-pr11548/) (built from [b67cf6f](https://github.com/cvc5/cvc5/commit/b67cf6f) @ [PR #11548](https://github.com/cvc5/cvc5/pull/11548), 79 seconds ago)
* [Documentation for PR #11547](docs-pr11547/) (built from [1cb21f4](https://github.com/cvc5/cvc5/commit/1cb21f4) @ [PR #11547](https://github.com/cvc5/cvc5/pull/11547), 82 minutes ago)
* [Documentation for PR #11546](docs-pr11546/) (built from [5bb81cc](https://github.com/cvc5/cvc5/commit/5bb81cc) @ [PR #11546](https://github.com/cvc5/cvc5/pull/11546), 52 minutes ago)
* [Documentation for PR #11545](docs-pr11545/) (built from [d8dee84](https://github.com/cvc5/cvc5/commit/d8dee84) @ [PR #11545](https://github.com/cvc5/cvc5/pull/11545), 3 hours ago)
* [Documentation for PR #11544](docs-pr11544/) (built from [9c0df1e](https://github.com/cvc5/cvc5/commit/9c0df1e) @ [PR #11544](https://github.com/cvc5/cvc5/pull/11544), 3 hours ago)
* [Documentation for main](docs-main/) (built from [de69dae](https://github.com/cvc5/cvc5/commit/de69dae) @ [main](https://github.com/cvc5/cvc5/tree/main), 3 hours ago)
* [Documentation for PR #11548](docs-pr11548/) (built from [b67cf6f](https://github.com/cvc5/cvc5/commit/b67cf6f) @ [PR #11548](https://github.com/cvc5/cvc5/pull/11548), 33 minutes ago)
* [Documentation for PR #11547](docs-pr11547/) (built from [1cb21f4](https://github.com/cvc5/cvc5/commit/1cb21f4) @ [PR #11547](https://github.com/cvc5/cvc5/pull/11547), 2 hours ago)
* [Documentation for PR #11546](docs-pr11546/) (built from [5bb81cc](https://github.com/cvc5/cvc5/commit/5bb81cc) @ [PR #11546](https://github.com/cvc5/cvc5/pull/11546), 84 minutes ago)
* [Documentation for PR #11545](docs-pr11545/) (built from [d8dee84](https://github.com/cvc5/cvc5/commit/d8dee84) @ [PR #11545](https://github.com/cvc5/cvc5/pull/11545), 4 hours ago)
* [Documentation for PR #11544](docs-pr11544/) (built from [9c0df1e](https://github.com/cvc5/cvc5/commit/9c0df1e) @ [PR #11544](https://github.com/cvc5/cvc5/pull/11544), 4 hours ago)
* [Documentation for PR #11543](docs-pr11543/) (built from [da665cb](https://github.com/cvc5/cvc5/commit/da665cb) @ [PR #11543](https://github.com/cvc5/cvc5/pull/11543), 3 hours ago)
* [Documentation for PR #11541](docs-pr11541/) (built from [a165592](https://github.com/cvc5/cvc5/commit/a165592) @ [PR #11541](https://github.com/cvc5/cvc5/pull/11541), 3 days ago)
* [Documentation for PR #11539](docs-pr11539/) (built from [435042d](https://github.com/cvc5/cvc5/commit/435042d) @ [PR #11539](https://github.com/cvc5/cvc5/pull/11539), 4 days ago)
* [Documentation for PR #11538](docs-pr11538/) (built from [0dee345](https://github.com/cvc5/cvc5/commit/0dee345) @ [PR #11538](https://github.com/cvc5/cvc5/pull/11538), 64 minutes ago)
* [Documentation for PR #11538](docs-pr11538/) (built from [0dee345](https://github.com/cvc5/cvc5/commit/0dee345) @ [PR #11538](https://github.com/cvc5/cvc5/pull/11538), 2 hours 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), 5 days 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), 6 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), 4 days 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), 6 days ago)
* [Documentation for PR #11532](docs-pr11532/) (built from [21d6833](https://github.com/cvc5/cvc5/commit/21d6833) @ [PR #11532](https://github.com/cvc5/cvc5/pull/11532), now)
* [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), 6 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), 6 days ago)
* [Documentation for PR #11529](docs-pr11529/) (built from [a0c7c49](https://github.com/cvc5/cvc5/commit/a0c7c49) @ [PR #11529](https://github.com/cvc5/cvc5/pull/11529), 6 days ago)
Expand All @@ -32,7 +32,7 @@
* [Documentation for PR #11519](docs-pr11519/) (built from [0811ad4](https://github.com/cvc5/cvc5/commit/0811ad4) @ [PR #11519](https://github.com/cvc5/cvc5/pull/11519), 6 days 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), 8 days 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), 8 days ago)
* [Documentation for PR #11513](docs-pr11513/) (built from [4806dba](https://github.com/cvc5/cvc5/commit/4806dba) @ [PR #11513](https://github.com/cvc5/cvc5/pull/11513), now)
* [Documentation for PR #11513](docs-pr11513/) (built from [4806dba](https://github.com/cvc5/cvc5/commit/4806dba) @ [PR #11513](https://github.com/cvc5/cvc5/pull/11513), 32 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), 4 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), 4 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), 8 days ago)
Expand Down
2 changes: 1 addition & 1 deletion docs-pr11532
154 changes: 154 additions & 0 deletions docs-pr11532-21d68330ec259b505cb9804084fffaf61e3cc1fd/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 228b601

Please sign in to comment.