diff options
author | yoni206 <yoni206@users.noreply.github.com> | 2021-10-27 20:41:24 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-10-27 17:41:24 +0000 |
commit | cd5fb80d86a03ade6037531e52f6c3dd3f708bbf (patch) | |
tree | 4bb7d92aacd4ff34fa969f35f5fee3698a40625a /src/api/cpp/cvc5.h | |
parent | 9cf32b5d3f12a886779b85066d8c5997b49aefc1 (diff) |
Python api documentation for sorts (#7440)
This PR adds documentation for the Sort python API.
Diffstat (limited to 'src/api/cpp/cvc5.h')
-rw-r--r-- | src/api/cpp/cvc5.h | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/src/api/cpp/cvc5.h b/src/api/cpp/cvc5.h index c618106a6..f0a36b792 100644 --- a/src/api/cpp/cvc5.h +++ b/src/api/cpp/cvc5.h @@ -354,19 +354,19 @@ class CVC5_EXPORT Sort /** * Is this a Boolean sort? - * @return true if the sort is a Boolean sort + * @return true if the sort is the Boolean sort */ bool isBoolean() const; /** * Is this a integer sort? - * @return true if the sort is a integer sort + * @return true if the sort is the integer sort */ bool isInteger() const; /** * Is this a real sort? - * @return true if the sort is a real sort + * @return true if the sort is the real sort */ bool isReal() const; @@ -462,7 +462,7 @@ class CVC5_EXPORT Sort /** * Is this an array sort? - * @return true if the sort is a array sort + * @return true if the sort is an array sort */ bool isArray() const; @@ -485,8 +485,8 @@ class CVC5_EXPORT Sort bool isSequence() const; /** - * Is this a sort kind? - * @return true if this is a sort kind + * Is this an uninterpreted sort? + * @return true if this is an uninterpreted sort */ bool isUninterpretedSort() const; @@ -499,9 +499,9 @@ class CVC5_EXPORT Sort /** * Is this a first-class sort? * First-class sorts are sorts for which: - * (1) we handle equalities between terms of that type, and - * (2) they are allowed to be parameters of parametric sorts (e.g. index or - * element sorts of arrays). + * 1. we handle equalities between terms of that type, and + * 2. they are allowed to be parameters of parametric sorts (e.g. index or + * element sorts of arrays). * * Examples of sorts that are not first-class include sort constructor sorts * and regular expression sorts. @@ -641,7 +641,7 @@ class CVC5_EXPORT Sort Sort getArrayIndexSort() const; /** - * @return the array element sort of an array element sort + * @return the array element sort of an array sort */ Sort getArrayElementSort() const; |