man-pages/man3/MoreLabels.Map.OrderedType.3o.html
2021-03-31 01:06:50 +01:00

104 lines
1.5 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of MoreLabels.Map.OrderedType</TITLE>
</HEAD><BODY>
<H1>MoreLabels.Map.OrderedType</H1>
Section: OCaml library (3o)<BR>Updated: 2020-01-30<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
MoreLabels.Map.OrderedType - no description
<A NAME="lbAC">&nbsp;</A>
<H2>Module type</H2>
Module type MoreLabels.Map.OrderedType
<A NAME="lbAD">&nbsp;</A>
<H2>Documentation</H2>
<P>
Module type
<B>OrderedType</B>
<BR>&nbsp;=&nbsp;
<B>Map.OrderedType</B>
<P>
<P>
<P>
<P>
<P>
<P>
<P>
<I>type t </I>
<P>
<P>
The type of the map keys.
<P>
<P>
<P>
<I>val compare </I>
:
<B>t -&gt; t -&gt; int</B>
<P>
A total ordering function over the keys.
This is a two-argument function
<B>f</B>
such that
<B>f e1 e2</B>
is zero if the keys
<B>e1</B>
and
<B>e2</B>
are equal,
<B>f e1 e2</B>
is strictly negative if
<B>e1</B>
is smaller than
<B>e2</B>
,
and
<B>f e1 e2</B>
is strictly positive if
<B>e1</B>
is greater than
<B>e2</B>
.
Example: a suitable ordering function is the generic structural
comparison function
<B>compare</B>
.
<P>
<P>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="1"><A HREF="#lbAB">NAME</A><DD>
<DT id="2"><A HREF="#lbAC">Module type</A><DD>
<DT id="3"><A HREF="#lbAD">Documentation</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:48 GMT, March 31, 2021
</BODY>
</HTML>