PR#4507: incorrect documentation for epsilon_float

git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@8845 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
master
Xavier Leroy 2008-03-18 14:10:25 +00:00
parent 640b24249d
commit 6559ae1996
1 changed files with 4 additions and 1 deletions

View File

@ -361,7 +361,10 @@ val min_float : float
(** The smallest positive, non-zero, non-denormalized value of type [float]. *)
val epsilon_float : float
(** The smallest positive float [x] such that [1.0 +. x <> 1.0]. *)
(** The difference between [1.0] and the smallest exactly representable
floating-point number greater than [1.0]. In other words,
[epsilon_float] is the smallest positive floating-point number [x]
such that [(1.0 +. x) -. 1.0 = x]. *)
type fpclass =
FP_normal (** Normal number, none of the below *)