docs/api/cpp/cpp.rst

.. _cpp-api:

C++ API Documentation
=====================

.. toctree::
  :maxdepth: 1

  quickstart
  class_hierarchy

.. container:: hide-toctree

  .. toctree::
    :maxdepth: 0

    datatype
    datatypeconstructor
    datatypeconstructordecl
    datatypedecl
    datatypeselector
    exceptions
    grammar
    kind
    op
    result
    roundingmode
    solver
    sort
    statistics
    term
Add more examples to the documentation (#6569) This PR adds (most of) the existing examples to the documentation, and does some other minor updates on the documentation. Some details: - for consistency, all cpp examples are moved from examples/api to examples/api/cpp - add capabilities for SMT-LIB examples, and two simple smt2 examples - more docs/examples/*.rst files - two new documentation categories: installation (how to obtain, compile and install cvc5) and binary (about the cvc5 binary) 2021-05-26 08:30:45 +02:00			`.. _cpp-api:`

Split C++ API docs from general docs (#6365) 2021-04-20 23:10:38 +02:00			`C++ API Documentation`
			`=====================`

			`.. toctree::`
docs: Add quickstart guide. (#6782) 2021-06-23 12:08:21 -07:00			`:maxdepth: 1`
Split C++ API docs from general docs (#6365) 2021-04-20 23:10:38 +02:00
docs: Add quickstart guide. (#6782) 2021-06-23 12:08:21 -07:00			`quickstart`
docs: Split out and merge C++ class hierarchy. (#6781) This restructures the entry page for the C++ API documentation in preparation for adding a quickstart and linking to examples and adding more content. 2021-06-21 15:46:07 -07:00			`class_hierarchy`

			`.. container:: hide-toctree`

			`.. toctree::`
			`:maxdepth: 0`

			`datatype`
			`datatypeconstructor`
			`datatypeconstructordecl`
			`datatypedecl`
			`datatypeselector`
			`exceptions`
			`grammar`
			`kind`
			`op`
			`result`
			`roundingmode`
			`solver`
			`sort`
			`statistics`
			`term`
Use std::hash for API types (#6432) This PR replaces all api::*HashFunction objects by specializations of std::hash. std::hash is meant to be extended in this way, and it allows for a much cleaner usage of std::unordered_set and std::unordered_map with these types. 2021-04-27 07:31:58 +02:00