ocaml-containers/dev/containers-data/CCMultiSet/Make/argument-1-O/index.html
2023-02-15 17:36:59 +00:00

2 lines
No EOL
1.9 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>O (containers-data.CCMultiSet.Make.O)</title><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.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">containers-data</a> &#x00BB; <a href="../../index.html">CCMultiSet</a> &#x00BB; <a href="../index.html">Make</a> &#x00BB; O</nav><header class="odoc-preamble"><h1>Parameter <code><span>Make.O</span></code></h1></header><div class="odoc-content"><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></code></div><div class="spec-doc"><p>The type of the set elements.</p></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">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p>A total ordering function over the set elements. This is a two-argument function <code>f</code> such that <code>f e1 e2</code> is zero if the elements <code>e1</code> and <code>e2</code> are equal, <code>f e1 e2</code> is strictly negative if <code>e1</code> is smaller than <code>e2</code>, and <code>f e1 e2</code> is strictly positive if <code>e1</code> is greater than <code>e2</code>. Example: a suitable ordering function is the generic structural comparison function <a href="../../../../ocaml/Stdlib/index.html#val-compare"><code>Stdlib.compare</code></a>.</p></div></div></div></body></html>