Skip to content

Commit f663208

Browse files
committed
improve documentation for new API method.
1 parent 19915af commit f663208

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

src/org/sosy_lab/java_smt/api/FloatingPointFormulaManager.java

+4-3
Original file line numberDiff line numberDiff line change
@@ -202,10 +202,11 @@ FloatingPointFormula multiply(
202202
FloatingPointRoundingMode pFloatingPointRoundingMode);
203203

204204
/**
205-
* remainder: x - y * n, where n in Z is nearest to x/y. Can be negative even or two positive
206-
* arguments (as opposed to integer modulo operators)
205+
* remainder: x - y * n, where n in Z is nearest to x/y. The result can be negative even for two
206+
* positive arguments, e.g. "rem(5, 4) == 1" and "rem(5, 6) == -1", as opposed to integer modulo
207+
* operators.
207208
*/
208-
FloatingPointFormula remainder(FloatingPointFormula number1, FloatingPointFormula number2);
209+
FloatingPointFormula remainder(FloatingPointFormula dividend, FloatingPointFormula divisor);
209210

210211
// ----------------- Numeric relations, return type BooleanFormula -----------------
211212

0 commit comments

Comments
 (0)