diff options
| author | Damien Doligez <damien.doligez-inria.fr> | 2012-03-31 22:15:34 +0000 |
|---|---|---|
| committer | Damien Doligez <damien.doligez-inria.fr> | 2012-03-31 22:15:34 +0000 |
| commit | 22e3b040d485460ee5e57d1fe01d3c22951c1b2a (patch) | |
| tree | f5dc4d50ca27367c84a0f49c2dc836dcc1d16cb7 /otherlibs/num/ratio.mli | |
| parent | 4191b43bc931db3ae0d8175e56354950968be0c2 (diff) | |
PR#5310: Ratio.create_ratio/create_normalized_ratio have misleading names
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@12304 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
Diffstat (limited to 'otherlibs/num/ratio.mli')
| -rw-r--r-- | otherlibs/num/ratio.mli | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/otherlibs/num/ratio.mli b/otherlibs/num/ratio.mli index 60c0f66db..408aea9b4 100644 --- a/otherlibs/num/ratio.mli +++ b/otherlibs/num/ratio.mli @@ -13,7 +13,10 @@ (* $Id$ *) -(* Module [Ratio]: operations on rational numbers *) +(** Operation on rational numbers. + + This module is used to support the implementation of {!Num} and + should not be called directly. *) open Nat open Big_int @@ -25,6 +28,8 @@ open Big_int type ratio +(**/**) + val null_denominator : ratio -> bool val numerator_ratio : ratio -> big_int val denominator_ratio : ratio -> big_int @@ -32,8 +37,9 @@ val sign_ratio : ratio -> int val normalize_ratio : ratio -> ratio val cautious_normalize_ratio : ratio -> ratio val cautious_normalize_ratio_when_printing : ratio -> ratio -val create_ratio : big_int -> big_int -> ratio +val create_ratio : big_int -> big_int -> ratio (* assumes nothing *) val create_normalized_ratio : big_int -> big_int -> ratio + (* assumes normalized argument *) val is_normalized_ratio : ratio -> bool val report_sign_ratio : ratio -> big_int -> big_int val abs_ratio : ratio -> ratio |