Skip to content

Commit fc2e845

Browse files
author
DocBot
committed
Update docs for pr11745
1 parent f884909 commit fc2e845

File tree

578 files changed

+514470
-4
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

578 files changed

+514470
-4
lines changed

‎README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11

22

3-
* [Documentation for main](docs-main/) (built from [82ff0f2](https://github.com/cvc5/cvc5/commit/82ff0f2) @ [main](https://github.com/cvc5/cvc5/tree/main), Mar Tue 18, 16:06 UTC)
3+
* [Documentation for PR #11745](docs-pr11745/) (built from [1caa263](https://github.com/cvc5/cvc5/commit/1caa263) @ [PR #11745](https://github.com/cvc5/cvc5/pull/11745), Mar Tue 18, 18:55 UTC)
44

55
***
66

77

8-
* [Documentation for main](docs-main/) (built from [82ff0f2](https://github.com/cvc5/cvc5/commit/82ff0f2) @ [main](https://github.com/cvc5/cvc5/tree/main), now)
9-
* [Documentation for PR #11743](docs-pr11743/) (built from [7ee9cb4](https://github.com/cvc5/cvc5/commit/7ee9cb4) @ [PR #11743](https://github.com/cvc5/cvc5/pull/11743), 22 hours ago)
8+
* [Documentation for main](docs-main/) (built from [82ff0f2](https://github.com/cvc5/cvc5/commit/82ff0f2) @ [main](https://github.com/cvc5/cvc5/tree/main), 3 hours ago)
9+
* [Documentation for PR #11745](docs-pr11745/) (built from [1caa263](https://github.com/cvc5/cvc5/commit/1caa263) @ [PR #11745](https://github.com/cvc5/cvc5/pull/11745), now)
10+
* [Documentation for PR #11743](docs-pr11743/) (built from [7ee9cb4](https://github.com/cvc5/cvc5/commit/7ee9cb4) @ [PR #11743](https://github.com/cvc5/cvc5/pull/11743), 25 hours ago)
1011
* [Documentation for PR #11741](docs-pr11741/) (built from [9ffcfce](https://github.com/cvc5/cvc5/commit/9ffcfce) @ [PR #11741](https://github.com/cvc5/cvc5/pull/11741), 4 days ago)
1112
* [Documentation for PR #11739](docs-pr11739/) (built from [b1cd64a](https://github.com/cvc5/cvc5/commit/b1cd64a) @ [PR #11739](https://github.com/cvc5/cvc5/pull/11739), 5 days ago)
1213
* [Documentation for PR #11738](docs-pr11738/) (built from [72f2519](https://github.com/cvc5/cvc5/commit/72f2519) @ [PR #11738](https://github.com/cvc5/cvc5/pull/11738), 5 days ago)
13-
* [Documentation for PR #11737](docs-pr11737/) (built from [522fbfe](https://github.com/cvc5/cvc5/commit/522fbfe) @ [PR #11737](https://github.com/cvc5/cvc5/pull/11737), 34 hours ago)
14+
* [Documentation for PR #11737](docs-pr11737/) (built from [522fbfe](https://github.com/cvc5/cvc5/commit/522fbfe) @ [PR #11737](https://github.com/cvc5/cvc5/pull/11737), 2 days ago)
1415
* [Documentation for PR #11735](docs-pr11735/) (built from [855aa03](https://github.com/cvc5/cvc5/commit/855aa03) @ [PR #11735](https://github.com/cvc5/cvc5/pull/11735), 6 days ago)
1516
* [Documentation for PR #11733](docs-pr11733/) (built from [1ced5af](https://github.com/cvc5/cvc5/commit/1ced5af) @ [PR #11733](https://github.com/cvc5/cvc5/pull/11733), 6 days ago)
1617
* [Documentation for PR #11732](docs-pr11732/) (built from [cf6d23d](https://github.com/cvc5/cvc5/commit/cf6d23d) @ [PR #11732](https://github.com/cvc5/cvc5/pull/11732), 6 days ago)

‎docs-pr11745

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs-pr11745-1caa263342353295471c2b227e4ed5e1ff4cede1

‎docs-pr11745-1caa263342353295471c2b227e4ed5e1ff4cede1/api/api.html

+156
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
2+
3+
<!DOCTYPE html>
4+
<html class="writer-html5" lang="en" data-content_root="../">
5+
<head>
6+
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
7+
8+
<!-- Google tag (gtag.js) -->
9+
<script async src="https://www.googletagmanager.com/gtag/js?id=G-ML12X2V35B"></script>
10+
<script>
11+
window.dataLayer = window.dataLayer || [];
12+
function gtag(){dataLayer.push(arguments);}
13+
gtag('js', new Date());
14+
gtag('config', 'G-ML12X2V35B');
15+
</script>
16+
17+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
18+
<title>API Documentation &mdash; cvc5 documentation</title>
19+
<link rel="stylesheet" type="text/css" href="../static/pygments.css?v=b86133f3" />
20+
<link rel="stylesheet" type="text/css" href="../static/css/theme.css?v=e59714d7" />
21+
<link rel="stylesheet" type="text/css" href="../static/custom.css?v=b9602cbe" />
22+
23+
24+
<script src="../static/jquery.js?v=5d32c60e"></script>
25+
<script src="../static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
26+
<script src="../static/documentation_options.js?v=5929fcd5"></script>
27+
<script src="../static/doctools.js?v=9bcbadda"></script>
28+
<script src="../static/sphinx_highlight.js?v=dc90522c"></script>
29+
<script>window.MathJax = {"loader": {"load": ["[tex]/ams", "[tex]/bussproofs"]}, "tex": {"packages": {"[+]": ["ams", "bussproofs"]}, "macros": {"xor": "\\mathbin{xor}", "ite": ["#1 \\mathbin{?} #2 \\mathbin{:} #3", 3], "inferrule": ["\\begin{prooftree}\\AxiomC{$#1$}\\UnaryInfC{$#2$}\\end{prooftree}", 2], "inferruleSC": ["\\begin{prooftree}\\AxiomC{$#1$}\\RightLabel{ #3}\\UnaryInfC{$#2$}\\end{prooftree}", 3]}}}</script>
30+
<script defer="defer" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
31+
<script src="../static/js/theme.js"></script>
32+
<link rel="index" title="Index" href="../genindex.html" />
33+
<link rel="search" title="Search" href="../search.html" />
34+
<link rel="next" title="C++ API" href="cpp/cpp.html" />
35+
<link rel="prev" title="Quickstart Guide" href="../binary/quickstart.html" />
36+
</head>
37+
38+
<body class="wy-body-for-nav">
39+
<div class="wy-grid-for-nav">
40+
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
41+
<div class="wy-side-scroll">
42+
<div class="wy-side-nav-search" >
43+
44+
45+
46+
<a href="../index.html" class="icon icon-home">
47+
cvc5
48+
</a>
49+
<div role="search">
50+
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
51+
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
52+
<input type="hidden" name="check_keywords" value="yes" />
53+
<input type="hidden" name="area" value="default" />
54+
</form>
55+
</div>
56+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
57+
<ul class="current">
58+
<li class="toctree-l1"><a class="reference internal" href="../installation/installation.html">Installation</a></li>
59+
<li class="toctree-l1"><a class="reference internal" href="../binary/binary.html">Binary Documentation</a></li>
60+
<li class="toctree-l1 current"><a class="current reference internal" href="#">API Documentation</a><ul>
61+
<li class="toctree-l2"><a class="reference internal" href="cpp/cpp.html">C++ API</a></li>
62+
<li class="toctree-l2"><a class="reference internal" href="c/c.html">C API</a></li>
63+
<li class="toctree-l2"><a class="reference internal" href="java/java.html">Java API</a></li>
64+
<li class="toctree-l2"><a class="reference internal" href="python/python.html">Python API</a></li>
65+
</ul>
66+
</li>
67+
<li class="toctree-l1"><a class="reference internal" href="../options.html">Options</a></li>
68+
<li class="toctree-l1"><a class="reference internal" href="../output-tags.html">Output tags</a></li>
69+
<li class="toctree-l1"><a class="reference internal" href="../proofs/proofs.html">Proof Production</a></li>
70+
<li class="toctree-l1"><a class="reference internal" href="../resource-limits.html">Resource limits</a></li>
71+
<li class="toctree-l1"><a class="reference internal" href="../skolem-ids.html">Skolem Identifiers</a></li>
72+
<li class="toctree-l1"><a class="reference internal" href="../statistics.html">Statistics</a></li>
73+
<li class="toctree-l1"><a class="reference internal" href="../examples/examples.html">Examples</a></li>
74+
<li class="toctree-l1"><a class="reference internal" href="../theories/theories.html">Theory References</a></li>
75+
<li class="toctree-l1"><a class="reference internal" href="../references.html">References</a></li>
76+
<li class="toctree-l1"><a class="reference internal" href="../genindex.html">Index</a></li>
77+
</ul>
78+
79+
</div>
80+
</div>
81+
</nav>
82+
83+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
84+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
85+
<a href="../index.html">cvc5</a>
86+
</nav>
87+
88+
<div class="wy-nav-content">
89+
<div class="rst-content">
90+
<div role="navigation" aria-label="Page navigation">
91+
<ul class="wy-breadcrumbs">
92+
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
93+
<li class="breadcrumb-item active">API Documentation</li>
94+
<li class="wy-breadcrumbs-aside">
95+
</li>
96+
</ul>
97+
<hr/>
98+
</div>
99+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
100+
<div itemprop="articleBody">
101+
102+
<section id="api-documentation">
103+
<h1>API Documentation<a class="headerlink" href="#api-documentation" title="Link to this heading"></a></h1>
104+
<p>Alternatively to using cvc5 <a class="reference internal" href="../binary/binary.html"><span class="doc">as a binary</span></a>, cvc5 can be
105+
integrated at the back end of other tools via one of its rich and comprehensive
106+
APIs.</p>
107+
<p>The primary interface of cvc5 is its <a class="reference internal" href="cpp/cpp.html"><span class="doc">C++ API</span></a>.
108+
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
109+
<a class="reference internal" href="python/base/python.html"><span class="doc">base Python API</span></a> implement a thin wrapper around
110+
the C++ API.
111+
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
112+
Python API</span></a> at
113+
<a class="reference external" href="https://github.com/cvc5/cvc5_pythonic_api">https://github.com/cvc5/cvc5_pythonic_api</a>,
114+
documented <a class="reference internal" href="python/pythonic/pythonic.html"><span class="doc">here</span></a>.</p>
115+
<div class="toctree-wrapper compound">
116+
<ul>
117+
<li class="toctree-l1"><a class="reference internal" href="cpp/cpp.html">C++ API</a></li>
118+
<li class="toctree-l1"><a class="reference internal" href="c/c.html">C API</a></li>
119+
<li class="toctree-l1"><a class="reference internal" href="java/java.html">Java API</a></li>
120+
<li class="toctree-l1"><a class="reference internal" href="python/python.html">Python API</a></li>
121+
</ul>
122+
</div>
123+
</section>
124+
125+
126+
</div>
127+
</div>
128+
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
129+
<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>
130+
<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>
131+
</div>
132+
133+
<hr/>
134+
135+
<div role="contentinfo">
136+
<p>&#169; Copyright 2025, the authors of cvc5.</p>
137+
</div>
138+
139+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
140+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
141+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
142+
143+
144+
</footer>
145+
</div>
146+
</div>
147+
</section>
148+
</div>
149+
<script>
150+
jQuery(function () {
151+
SphinxRtdTheme.Navigation.enable(true);
152+
});
153+
</script>
154+
155+
</body>
156+
</html>

0 commit comments

Comments
 (0)