From 323c9afa3ffbffe01bc81a7c83e8695c431cbbec Mon Sep 17 00:00:00 2001 From: Linas Vepstas Date: Sat, 26 Jun 2004 23:40:01 +0000 Subject: [PATCH] add clarifying documentation git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@10103 57a11ea4-9604-0410-9ed3-97b8803252fd --- src/engine/gnc-numeric.h | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/src/engine/gnc-numeric.h b/src/engine/gnc-numeric.h index 9fe76a0125..6f1ddfaf8c 100644 --- a/src/engine/gnc-numeric.h +++ b/src/engine/gnc-numeric.h @@ -176,7 +176,15 @@ gnc_numeric gnc_numeric_sub(gnc_numeric a, gnc_numeric b, gint64 denom, gint how); gnc_numeric gnc_numeric_mul(gnc_numeric a, gnc_numeric b, gint64 denom, gint how); -gnc_numeric gnc_numeric_div(gnc_numeric a, gnc_numeric b, + +/** Division. Note that division can overflow, in the following + * sense: if we write x=a/b and y=c/d then x/y = (a*d)/(b*c) + * If, after eliminating all common factors between the numerator + * (a*d) and the denominator (b*c), then if either the numerator + * and/or the denominator are *still* greater than 2^63, then + * the division has overflowed. + */ +gnc_numeric gnc_numeric_div(gnc_numeric x, gnc_numeric y, gint64 denom, gint how); /** Negate the argument */ gnc_numeric gnc_numeric_neg(gnc_numeric a);