api: Fix documentation for kind IAND. (#7536)
authorAina Niemetz <aina.niemetz@gmail.com>
Mon, 1 Nov 2021 20:25:32 +0000 (13:25 -0700)
committerGitHub <noreply@github.com>
Mon, 1 Nov 2021 20:25:32 +0000 (20:25 +0000)
src/api/cpp/cvc5_kind.h

index a01f84c3fef0f29b23bc1ca6e0467ef0a4bbf34d..bece490982cf8927a08d51d39db22b4eddec4157 100644 (file)
@@ -377,7 +377,12 @@ enum Kind : int32_t
    */
   MULT,
   /**
-   * Operator for Integer AND
+   * Operator for bit-wise AND over integers, parameterized by a (positive)
+   * bitwidth k.
+   *
+   * ((_ iand k) i1 i2) is equivalent to:
+   * (bv2int (bvand ((_ int2bv k) i1) ((_ int2bv k) i2)))
+   * for all integers i1, i2.
    *
    * Parameters:
    *   - 1: Size of the bit-vector that determines the semantics of the IAND
@@ -385,8 +390,8 @@ enum Kind : int32_t
    * Create with:
    *   - `Solver::mkOp(Kind kind, uint32_t param) const`
    *
-   * Apply integer conversion to bit-vector.
-
+   * Apply integer and.
+   *
    * Parameters:
    *   - 1: Op of kind IAND
    *   - 2: Integer term
@@ -398,16 +403,17 @@ enum Kind : int32_t
    */
   IAND,
   /**
-   * Operator for raising 2 to a non-negative integer  power
+   * Operator for raising 2 to a non-negative integer power.
    *
    * Create with:
    *   - `Solver::mkOp(Kind kind) const`
    *
-
    * Parameters:
    *   - 1: Op of kind IAND
    *   - 2: Integer term
    *
+   * Apply 2 to the power operator.
+   *
    * Create with:
    *   - `Solver::mkTerm(const Op& op, const Term& child) const`
    *   - `Solver::mkTerm(const Op& op, const std::vector<Term>& children) const`