From d557152285afd4e0d84a138d482b04d1ca14abe3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20B=C5=93sch?= Date: Sat, 8 Oct 2011 12:22:44 +0200 Subject: [PATCH] eval: document recently added random(), hypot(), gcd(). --- doc/eval.texi | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/doc/eval.texi b/doc/eval.texi index ac27750851..b41f31ec26 100644 --- a/doc/eval.texi +++ b/doc/eval.texi @@ -83,6 +83,20 @@ Return 1.0 if @var{expr} is zero, 0.0 otherwise. @item pow(x, y) Compute the power of @var{x} elevated @var{y}, it is equivalent to "(@var{x})^(@var{y})". + +@item random(x) +Return a pseudo random value between 0.0 and 1.0. @var{x} is the index of the +internal variable which will be used to save the seed/state. + +@item hypot(x, y) +This function is similar to the C function with the same name; it returns +"sqrt(@var{x}*@var{x} + @var{y}*@var{y})", the length of the hypotenuse of a +right triangle with sides of length @var{x} and @var{y}, or the distance of the +point (@var{x}, @var{y}) from the origin. + +@item gcd(x, y) +Return the greatest common divisor of @var{x} and @var{y}. If both @var{x} and +@var{y} are 0 or either or both are less than zero then behavior is undefined. @end table Note that: