Files
cvc5/docs/api/python/pythonic/string.rst
yoni206 91572c54c6 Add strings and sequences to the pythonic API documentation (#10654)
This PR adds the documentation for strings and sequences in the pythonic API.
2024-04-19 07:34:00 -05:00

65 lines
1.7 KiB
ReStructuredText

Strings
============
Basic String Term Builders
------------------------------
.. autofunction:: cvc5.pythonic.StringSort
.. autofunction:: cvc5.pythonic.String
.. autofunction:: cvc5.pythonic.Strings
.. autofunction:: cvc5.pythonic.StringVal
String Operators
-------------------
.. autofunction:: cvc5.pythonic.Length
.. autofunction:: cvc5.pythonic.SubString
.. autofunction:: cvc5.pythonic.Contains
.. autofunction:: cvc5.pythonic.PrefixOf
.. autofunction:: cvc5.pythonic.SuffixOf
.. autofunction:: cvc5.pythonic.IndexOf
.. autofunction:: cvc5.pythonic.Replace
.. autofunction:: cvc5.pythonic.StrToInt
.. autofunction:: cvc5.pythonic.IntToStr
.. autofunction:: cvc5.pythonic.StrToCode
.. autofunction:: cvc5.pythonic.StrFromCode
See the following operator overload for string terms:
* get character (special case of SubString): :py:meth:`cvc5.pythonic.StringRef.__getitem__`
Basic Regular Expression Term Builders
---------------------------------------
.. autofunction:: cvc5.pythonic.Re
.. autofunction:: cvc5.pythonic.Full
.. autofunction:: cvc5.pythonic.Option
.. autofunction:: cvc5.pythonic.Range
.. autofunction:: cvc5.pythonic.AllChar
Regular Expression Operators
-----------------------------
.. autofunction:: cvc5.pythonic.InRe
.. autofunction:: cvc5.pythonic.Union
.. autofunction:: cvc5.pythonic.Intersect
.. autofunction:: cvc5.pythonic.Complement
.. autofunction:: cvc5.pythonic.Plus
.. autofunction:: cvc5.pythonic.Star
.. autofunction:: cvc5.pythonic.Loop
.. autofunction:: cvc5.pythonic.Diff
Classes (with overloads)
------------------------
.. autoclass:: cvc5.pythonic.StringSortRef
:members:
:special-members:
.. autoclass:: cvc5.pythonic.StringRef
:members:
:special-members: