mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2026-05-06 01:14:33 -04:00
2 lines
36 KiB
HTML
2 lines
36 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CCFloat (containers.CCFloat)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">Index</a> » <a href="../index.html">containers</a> » CCFloat</nav><header class="odoc-preamble"><h1>Module <code><span>CCFloat</span></code></h1><p>Basic operations on floating-point numbers</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.6.1</li></ul></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#infix-operators">Infix Operators</a></li></ul></nav></div><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-zero"><a href="#val-zero" class="anchor"></a><code><span><span class="keyword">val</span> zero : float</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-one"><a href="#val-one" class="anchor"></a><code><span><span class="keyword">val</span> one : float</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-minus_one"><a href="#val-minus_one" class="anchor"></a><code><span><span class="keyword">val</span> minus_one : float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-neg"><a href="#val-neg" class="anchor"></a><code><span><span class="keyword">val</span> neg : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-add"><a href="#val-add" class="anchor"></a><code><span><span class="keyword">val</span> add : <span>float <span class="arrow">-></span></span> <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-sub"><a href="#val-sub" class="anchor"></a><code><span><span class="keyword">val</span> sub : <span>float <span class="arrow">-></span></span> <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-mul"><a href="#val-mul" class="anchor"></a><code><span><span class="keyword">val</span> mul : <span>float <span class="arrow">-></span></span> <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-div"><a href="#val-div" class="anchor"></a><code><span><span class="keyword">val</span> div : <span>float <span class="arrow">-></span></span> <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-fma"><a href="#val-fma" class="anchor"></a><code><span><span class="keyword">val</span> fma : <span>float <span class="arrow">-></span></span> <span>float <span class="arrow">-></span></span> <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-rem"><a href="#val-rem" class="anchor"></a><code><span><span class="keyword">val</span> rem : <span>float <span class="arrow">-></span></span> <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-succ"><a href="#val-succ" class="anchor"></a><code><span><span class="keyword">val</span> succ : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pred"><a href="#val-pred" class="anchor"></a><code><span><span class="keyword">val</span> pred : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-abs"><a href="#val-abs" class="anchor"></a><code><span><span class="keyword">val</span> abs : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-infinity"><a href="#val-infinity" class="anchor"></a><code><span><span class="keyword">val</span> infinity : float</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-neg_infinity"><a href="#val-neg_infinity" class="anchor"></a><code><span><span class="keyword">val</span> neg_infinity : float</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-nan"><a href="#val-nan" class="anchor"></a><code><span><span class="keyword">val</span> nan : float</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-signaling_nan"><a href="#val-signaling_nan" class="anchor"></a><code><span><span class="keyword">val</span> signaling_nan : float</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-quiet_nan"><a href="#val-quiet_nan" class="anchor"></a><code><span><span class="keyword">val</span> quiet_nan : float</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pi"><a href="#val-pi" class="anchor"></a><code><span><span class="keyword">val</span> pi : float</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-max_float"><a href="#val-max_float" class="anchor"></a><code><span><span class="keyword">val</span> max_float : float</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-min_float"><a href="#val-min_float" class="anchor"></a><code><span><span class="keyword">val</span> min_float : float</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-epsilon"><a href="#val-epsilon" class="anchor"></a><code><span><span class="keyword">val</span> epsilon : float</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_finite"><a href="#val-is_finite" class="anchor"></a><code><span><span class="keyword">val</span> is_finite : <span>float <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_infinite"><a href="#val-is_infinite" class="anchor"></a><code><span><span class="keyword">val</span> is_infinite : <span>float <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_nan"><a href="#val-is_nan" class="anchor"></a><code><span><span class="keyword">val</span> is_nan : <span>float <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_integer"><a href="#val-is_integer" class="anchor"></a><code><span><span class="keyword">val</span> is_integer : <span>float <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-of_int"><a href="#val-of_int" class="anchor"></a><code><span><span class="keyword">val</span> of_int : <span>int <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-to_int"><a href="#val-to_int" class="anchor"></a><code><span><span class="keyword">val</span> to_int : <span>float <span class="arrow">-></span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-of_string"><a href="#val-of_string" class="anchor"></a><code><span><span class="keyword">val</span> of_string : <span>string <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_string_opt"><a href="#val-of_string_opt" class="anchor"></a><code><span><span class="keyword">val</span> of_string_opt : <span>string <span class="arrow">-></span></span> <span>float option</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_string"><a href="#val-to_string" class="anchor"></a><code><span><span class="keyword">val</span> to_string : <span>float <span class="arrow">-></span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-fpclass"><a href="#type-fpclass" class="anchor"></a><code><span><span class="keyword">type</span> fpclass</span><span> = <a href="../../ocaml/Stdlib/index.html#type-fpclass">fpclass</a></span><span> = </span></code><ol><li id="type-fpclass.FP_normal" class="def variant constructor anchored"><a href="#type-fpclass.FP_normal" class="anchor"></a><code><span>| </span><span><span class="constructor">FP_normal</span></span></code></li><li id="type-fpclass.FP_subnormal" class="def variant constructor anchored"><a href="#type-fpclass.FP_subnormal" class="anchor"></a><code><span>| </span><span><span class="constructor">FP_subnormal</span></span></code></li><li id="type-fpclass.FP_zero" class="def variant constructor anchored"><a href="#type-fpclass.FP_zero" class="anchor"></a><code><span>| </span><span><span class="constructor">FP_zero</span></span></code></li><li id="type-fpclass.FP_infinite" class="def variant constructor anchored"><a href="#type-fpclass.FP_infinite" class="anchor"></a><code><span>| </span><span><span class="constructor">FP_infinite</span></span></code></li><li id="type-fpclass.FP_nan" class="def variant constructor anchored"><a href="#type-fpclass.FP_nan" class="anchor"></a><code><span>| </span><span><span class="constructor">FP_nan</span></span></code></li></ol></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-classify_float"><a href="#val-classify_float" class="anchor"></a><code><span><span class="keyword">val</span> classify_float : <span>float <span class="arrow">-></span></span> <a href="#type-fpclass">fpclass</a></span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-pow"><a href="#val-pow" class="anchor"></a><code><span><span class="keyword">val</span> pow : <span>float <span class="arrow">-></span></span> <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-sqrt"><a href="#val-sqrt" class="anchor"></a><code><span><span class="keyword">val</span> sqrt : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-cbrt"><a href="#val-cbrt" class="anchor"></a><code><span><span class="keyword">val</span> cbrt : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-exp"><a href="#val-exp" class="anchor"></a><code><span><span class="keyword">val</span> exp : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-exp2"><a href="#val-exp2" class="anchor"></a><code><span><span class="keyword">val</span> exp2 : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-log"><a href="#val-log" class="anchor"></a><code><span><span class="keyword">val</span> log : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-log10"><a href="#val-log10" class="anchor"></a><code><span><span class="keyword">val</span> log10 : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-log2"><a href="#val-log2" class="anchor"></a><code><span><span class="keyword">val</span> log2 : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-expm1"><a href="#val-expm1" class="anchor"></a><code><span><span class="keyword">val</span> expm1 : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-log1p"><a href="#val-log1p" class="anchor"></a><code><span><span class="keyword">val</span> log1p : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-cos"><a href="#val-cos" class="anchor"></a><code><span><span class="keyword">val</span> cos : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-sin"><a href="#val-sin" class="anchor"></a><code><span><span class="keyword">val</span> sin : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-tan"><a href="#val-tan" class="anchor"></a><code><span><span class="keyword">val</span> tan : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-acos"><a href="#val-acos" class="anchor"></a><code><span><span class="keyword">val</span> acos : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-asin"><a href="#val-asin" class="anchor"></a><code><span><span class="keyword">val</span> asin : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-atan"><a href="#val-atan" class="anchor"></a><code><span><span class="keyword">val</span> atan : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-atan2"><a href="#val-atan2" class="anchor"></a><code><span><span class="keyword">val</span> atan2 : <span>float <span class="arrow">-></span></span> <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-hypot"><a href="#val-hypot" class="anchor"></a><code><span><span class="keyword">val</span> hypot : <span>float <span class="arrow">-></span></span> <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-cosh"><a href="#val-cosh" class="anchor"></a><code><span><span class="keyword">val</span> cosh : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-sinh"><a href="#val-sinh" class="anchor"></a><code><span><span class="keyword">val</span> sinh : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-tanh"><a href="#val-tanh" class="anchor"></a><code><span><span class="keyword">val</span> tanh : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-acosh"><a href="#val-acosh" class="anchor"></a><code><span><span class="keyword">val</span> acosh : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-asinh"><a href="#val-asinh" class="anchor"></a><code><span><span class="keyword">val</span> asinh : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-atanh"><a href="#val-atanh" class="anchor"></a><code><span><span class="keyword">val</span> atanh : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-erf"><a href="#val-erf" class="anchor"></a><code><span><span class="keyword">val</span> erf : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-erfc"><a href="#val-erfc" class="anchor"></a><code><span><span class="keyword">val</span> erfc : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-trunc"><a href="#val-trunc" class="anchor"></a><code><span><span class="keyword">val</span> trunc : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-round"><a href="#val-round" class="anchor"></a><code><span><span class="keyword">val</span> round : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-ceil"><a href="#val-ceil" class="anchor"></a><code><span><span class="keyword">val</span> ceil : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-floor"><a href="#val-floor" class="anchor"></a><code><span><span class="keyword">val</span> floor : <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-next_after"><a href="#val-next_after" class="anchor"></a><code><span><span class="keyword">val</span> next_after : <span>float <span class="arrow">-></span></span> <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-copy_sign"><a href="#val-copy_sign" class="anchor"></a><code><span><span class="keyword">val</span> copy_sign : <span>float <span class="arrow">-></span></span> <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-sign_bit"><a href="#val-sign_bit" class="anchor"></a><code><span><span class="keyword">val</span> sign_bit : <span>float <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-frexp"><a href="#val-frexp" class="anchor"></a><code><span><span class="keyword">val</span> frexp : <span>float <span class="arrow">-></span></span> float * int</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-ldexp"><a href="#val-ldexp" class="anchor"></a><code><span><span class="keyword">val</span> ldexp : <span>float <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-modf"><a href="#val-modf" class="anchor"></a><code><span><span class="keyword">val</span> modf : <span>float <span class="arrow">-></span></span> float * float</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = float</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span><span class="keyword">val</span> compare : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span><span class="keyword">val</span> equal : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-min"><a href="#val-min" class="anchor"></a><code><span><span class="keyword">val</span> min : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-max"><a href="#val-max" class="anchor"></a><code><span><span class="keyword">val</span> max : <span>float <span class="arrow">-></span></span> <span>float <span class="arrow">-></span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-min_max"><a href="#val-min_max" class="anchor"></a><code><span><span class="keyword">val</span> min_max : <span>float <span class="arrow">-></span></span> <span>float <span class="arrow">-></span></span> float * float</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-min_num"><a href="#val-min_num" class="anchor"></a><code><span><span class="keyword">val</span> min_num : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-max_num"><a href="#val-max_num" class="anchor"></a><code><span><span class="keyword">val</span> max_num : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-min_max_num"><a href="#val-min_max_num" class="anchor"></a><code><span><span class="keyword">val</span> min_max_num : <span>float <span class="arrow">-></span></span> <span>float <span class="arrow">-></span></span> float * float</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-seeded_hash"><a href="#val-seeded_hash" class="anchor"></a><code><span><span class="keyword">val</span> seeded_hash : <span>int <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-hash"><a href="#val-hash" class="anchor"></a><code><span><span class="keyword">val</span> hash : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Array"><a href="#module-Array" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Array/index.html">Array</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-ArrayLabels"><a href="#module-ArrayLabels" class="anchor"></a><code><span><span class="keyword">module</span> <a href="ArrayLabels/index.html">ArrayLabels</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-max_value"><a href="#val-max_value" class="anchor"></a><code><span><span class="keyword">val</span> max_value : <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>max_value</code> is Positive infinity. Equal to <a href="../../ocaml/Stdlib/index.html#val-infinity"><code>Stdlib.infinity</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-min_value"><a href="#val-min_value" class="anchor"></a><code><span><span class="keyword">val</span> min_value : <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>min_value</code> is Negative infinity. Equal to <a href="../../ocaml/Stdlib/index.html#val-neg_infinity"><code>Stdlib.neg_infinity</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-max_finite_value"><a href="#val-max_finite_value" class="anchor"></a><code><span><span class="keyword">val</span> max_finite_value : <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>max_finite_value</code> is the largest finite float value. Equal to <a href="../../ocaml/Stdlib/index.html#val-max_float"><code>Stdlib.max_float</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-scale"><a href="#val-scale" class="anchor"></a><code><span><span class="keyword">val</span> scale : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>scale x y</code> is equal to <code>x *. y</code>.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-printer"><a href="#type-printer" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a printer</span></span><span> = <span><a href="../../ocaml/Stdlib/Format/index.html#type-formatter">Format.formatter</a> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-random_gen"><a href="#type-random_gen" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a random_gen</span></span><span> = <span><a href="../../ocaml/Stdlib/Random/State/index.html#type-t">Random.State.t</a> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp"><a href="#val-pp" class="anchor"></a><code><span><span class="keyword">val</span> pp : <span><a href="#type-t">t</a> <a href="#type-printer">printer</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-random"><a href="#val-random" class="anchor"></a><code><span><span class="keyword">val</span> random : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <a href="#type-random_gen">random_gen</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-random_small"><a href="#val-random_small" class="anchor"></a><code><span><span class="keyword">val</span> random_small : <span><a href="#type-t">t</a> <a href="#type-random_gen">random_gen</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-random_range"><a href="#val-random_range" class="anchor"></a><code><span><span class="keyword">val</span> random_range : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <a href="#type-random_gen">random_gen</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-fsign"><a href="#val-fsign" class="anchor"></a><code><span><span class="keyword">val</span> fsign : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>fsign x</code> is one of <code>-1., -0., +0., +1.</code>, or <code>nan</code> if <code>x</code> is NaN.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.7</li></ul></div></div><div class="odoc-spec"><div class="spec exception anchored" id="exception-TrapNaN"><a href="#exception-TrapNaN" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">TrapNaN</span> <span class="keyword">of</span> string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-sign_exn"><a href="#val-sign_exn" class="anchor"></a><code><span><span class="keyword">val</span> sign_exn : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p><code>sign_exn x</code> will return the sign of <code>x</code> as <code>1, 0</code> or <code>-1</code>, or raise an exception <code>TrapNaN</code> if <code>x</code> is NaN. Note that infinities have defined signs in OCaml.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.7</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_string_exn"><a href="#val-of_string_exn" class="anchor"></a><code><span><span class="keyword">val</span> of_string_exn : <span>string <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Alias to <code>float_of_string</code>.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Failure</code> <p>in case of failure.</p></li></ul><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 1.2</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-equal_precision"><a href="#val-equal_precision" class="anchor"></a><code><span><span class="keyword">val</span> equal_precision : <span><span class="label">epsilon</span>:<a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p>Equality with allowed error up to a non negative epsilon value.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-classify"><a href="#val-classify" class="anchor"></a><code><span><span class="keyword">val</span> classify : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-fpclass">fpclass</a></span></code></div><div class="spec-doc"><p><code>classify x</code> returns the class of the given floating-point number <code>x</code>: normal, subnormal, zero, infinite or nan (not a number).</p></div></div><h3 id="infix-operators"><a href="#infix-operators" class="anchor"></a>Infix Operators</h3><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.17</li></ul><div class="odoc-spec"><div class="spec module anchored" id="module-Infix"><a href="#module-Infix" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Infix/index.html">Infix</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <span class="keyword">module</span> <span class="keyword">type</span> <span class="keyword">of</span> <a href="Infix/index.html">Infix</a></span></code></summary><div class="odoc-spec"><div class="spec value anchored" id="val-(=)"><a href="#val-(=)" class="anchor"></a><code><span><span class="keyword">val</span> (=) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.17</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(<>)"><a href="#val-(<>)" class="anchor"></a><code><span><span class="keyword">val</span> (<>) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.17</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(<)"><a href="#val-(<)" class="anchor"></a><code><span><span class="keyword">val</span> (<) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.17</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(>)"><a href="#val-(>)" class="anchor"></a><code><span><span class="keyword">val</span> (>) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.17</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(<=)"><a href="#val-(<=)" class="anchor"></a><code><span><span class="keyword">val</span> (<=) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.17</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(>=)"><a href="#val-(>=)" class="anchor"></a><code><span><span class="keyword">val</span> (>=) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.17</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(+)"><a href="#val-(+)" class="anchor"></a><code><span><span class="keyword">val</span> (+) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Addition.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.1</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(-)"><a href="#val-(-)" class="anchor"></a><code><span><span class="keyword">val</span> (-) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Subtraction.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.1</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(~-)"><a href="#val-(~-)" class="anchor"></a><code><span><span class="keyword">val</span> (~-) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Unary negation.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.1</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(*)"><a href="#val-(*)" class="anchor"></a><code><span><span class="keyword">val</span> (*) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Multiplication.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.1</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(/)"><a href="#val-(/)" class="anchor"></a><code><span><span class="keyword">val</span> (/) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Division.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.1</li></ul></div></div></details></div></div></body></html>
|