		Search-engine friendly clone of the ACL2 documentation.

Floating-point-operations

Float-rem

Remainder % on floats [JLS14:4.2.4] [JLS14:15.17.3].

Signature
(float-rem operand-left operand-right) → result
Arguments: operand-left — Guard (float-valuep operand-left).; operand-right — Guard (float-valuep operand-right).
Returns: result — Type (float-valuep result).

Definitions and Theorems

Function: float-rem

(defun float-rem (operand-left operand-right)
  (declare (xargs :guard (and (float-valuep operand-left)
                              (float-valuep operand-right))))
  (b* ((x (float-value->float operand-left))
       (y (float-value->float operand-right)))
    (float-value (float-rem-abs x y))))

Theorem: float-valuep-of-float-rem

(defthm float-valuep-of-float-rem
  (b* ((result (float-rem operand-left operand-right)))
    (float-valuep result))
  :rule-classes :rewrite)

Theorem: float-rem-of-float-value-fix-operand-left

(defthm float-rem-of-float-value-fix-operand-left
  (equal (float-rem (float-value-fix operand-left)
                    operand-right)
         (float-rem operand-left operand-right)))

Theorem: float-rem-float-value-equiv-congruence-on-operand-left

(defthm float-rem-float-value-equiv-congruence-on-operand-left
  (implies (float-value-equiv operand-left operand-left-equiv)
           (equal (float-rem operand-left operand-right)
                  (float-rem operand-left-equiv operand-right)))
  :rule-classes :congruence)

Theorem: float-rem-of-float-value-fix-operand-right

(defthm float-rem-of-float-value-fix-operand-right
  (equal (float-rem operand-left
                    (float-value-fix operand-right))
         (float-rem operand-left operand-right)))

Theorem: float-rem-float-value-equiv-congruence-on-operand-right

(defthm float-rem-float-value-equiv-congruence-on-operand-right
  (implies (float-value-equiv operand-right operand-right-equiv)
           (equal (float-rem operand-left operand-right)
                  (float-rem operand-left operand-right-equiv)))
  :rule-classes :congruence)