<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Text" rel="Chapter" href="Text.html">
<link title="Encoding" rel="Chapter" href="Encoding.html"><title>Index of values</title>
</head>
<body>
<div class="navbar"> <a class="up" href="index.html" title="Index">Up</a>
</div>
<h1>Index of values</h1>
<table>
<tr><td align="left"><br>C</td></tr>
<tr><td><a href="Text.html#VALcapitalize">capitalize</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">capitalize t</code> returns <code class="code">t</code> with its first letter upper-cased
</div>
</td></tr>
<tr><td><a href="Text.html#VALchar">char</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">char code</code> returns the character corresponding to the given
unicode code-point.
</div>
</td></tr>
<tr><td><a href="Text.html#VALcheck">check</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">check str</code> checks that <code class="code">str</code> is a valid UTF-8 encoded
string.
</div>
</td></tr>
<tr><td><a href="Text.html#VALchunk">chunk</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">chunk a b</code> returns the chunk of text between <code class="code">a</code> and
<code class="code">b</code>.
</div>
</td></tr>
<tr><td><a href="Text.html#VALcode">code</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">code text</code> returns the unicode code-point of first character of
<code class="code">text</code>.
</div>
</td></tr>
<tr><td><a href="Text.html#VALcompare">compare</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
Compares two texts according to the current locale
</div>
</td></tr>
<tr><td><a href="Text.html#VALconcat">concat</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">concat sep l</code> returns the concatenation of all texts contained
in <code class="code">l</code>, separated by <code class="code">sep</code>.
</div>
</td></tr>
<tr><td><a href="Text.html#VALcontains">contains</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">contains text sub</code> returns whether <code class="code">sub</code> appears in <code class="code">text</code>
</div>
</td></tr>
<tr><td><a href="Text.html#VALcount">count</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">count f text</code> returhs the number of characters of <code class="code">text</code>
verifying <code class="code">f</code>
</div>
</td></tr>
<tr><td align="left"><br>D</td></tr>
<tr><td><a href="Encoding.html#VALdecode">decode</a> [<a href="Encoding.html">Encoding</a>]</td>
<td><div class="info">
<code class="code">decode decoder buffer ptr len</code> decodes with <code class="code">decoder</code> bytes at
position <code class="code">ptr</code> in <code class="code">buffer</code>
</div>
</td></tr>
<tr><td><a href="Text.html#VALdecode">decode</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">decode ?encoding str</code> decode the given string encoded in
<code class="code">encoding</code>, which defaults to <a href="Encoding.html#VALsystem"><code class="code">Encoding.system</code></a>
</div>
</td></tr>
<tr><td><a href="Encoding.html#VALdecoder">decoder</a> [<a href="Encoding.html">Encoding</a>]</td>
<td><div class="info">
Creates a decoder from an encoding-name
</div>
</td></tr>
<tr><td align="left"><br>E</td></tr>
<tr><td><a href="Encoding.html#VALencode">encode</a> [<a href="Encoding.html">Encoding</a>]</td>
<td><div class="info">
<code class="code">encode decoder buffer ptr len code</code> encodes <code class="code">code</code> with
<code class="code">encoder</code> at position <code class="code">ptr</code> in <code class="code">buffer</code>
</div>
</td></tr>
<tr><td><a href="Text.html#VALencode">encode</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">encode ?encoding txt</code> encode the given text with <code class="code">encoding</code>,
which defaults to <a href="Encoding.html#VALsystem"><code class="code">Encoding.system</code></a> plus transliteration.
</div>
</td></tr>
<tr><td><a href="Encoding.html#VALencoder">encoder</a> [<a href="Encoding.html">Encoding</a>]</td>
<td><div class="info">
Creates an encoder from an encoding-name
</div>
</td></tr>
<tr><td><a href="Text.html#VALends_with">ends_with</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">ends_with s suffix</code> returns <code class="code">true</code> iff <code class="code">s</code> ends with
<code class="code">suffix</code>.
</div>
</td></tr>
<tr><td><a href="Encoding.html#VALequal">equal</a> [<a href="Encoding.html">Encoding</a>]</td>
<td><div class="info">
<code class="code">equal e1 e2</code> returns whether <code class="code">e1</code> and <code class="code">e2</code> denotes the same
encoding.
</div>
</td></tr>
<tr><td><a href="Text.html#VALequal_at">equal_at</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">equal_at ptr str</code> returns wether <code class="code">ptr</code> points to a substring
equal to <code class="code">str</code>
</div>
</td></tr>
<tr><td><a href="Text.html#VALexists">exists</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">exists f text</code> returns whether at least one character of <code class="code">text</code>
verify <code class="code">f</code>
</div>
</td></tr>
<tr><td><a href="Text.html#VALexplode">explode</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">explode txt</code> returns the list of all characters of <code class="code">txt</code>.
</div>
</td></tr>
<tr><td align="left"><br>F</td></tr>
<tr><td><a href="Text.html#VALfilter">filter</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">filter text</code> ~ <code class="code">implode (List.filter f (explode text))</code>
</div>
</td></tr>
<tr><td><a href="Text.html#VALfind">find</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">find ?from text patt</code> returns a pointer to the first occurrence
of <code class="code">patt</code> in <code class="code">text</code>.
</div>
</td></tr>
<tr><td><a href="Text.html#VALfold">fold</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">fold f x text</code> ~ <code class="code">List.fold_left f x (explode text)</code>
</div>
</td></tr>
<tr><td><a href="Text.html#VALfor_all">for_all</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">for_all f text</code> returns whether all characters of <code class="code">text</code> verify
the predicate <code class="code">f</code>
</div>
</td></tr>
<tr><td align="left"><br>G</td></tr>
<tr><td><a href="Text.html#VALget">get</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">get text n</code> returns the <code class="code">n</code>-th character of <code class="code">text</code>.
</div>
</td></tr>
<tr><td align="left"><br>I</td></tr>
<tr><td><a href="Text.html#VALicompare">icompare</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
Compares two texts, case-insensitive
</div>
</td></tr>
<tr><td><a href="Text.html#VALimplode">implode</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">implode l</code> returns the concatenation of all texts contained in
<code class="code">l</code>.
</div>
</td></tr>
<tr><td><a href="Text.html#VALinit">init</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">init n f</code> returns <code class="code">f 0 ^ f 1 ^ ... ^ f (n - 1)</code>
</div>
</td></tr>
<tr><td><a href="Text.html#VALis_alnum">is_alnum</a> [<a href="Text.html">Text</a>]</td>
<td></td></tr>
<tr><td><a href="Text.html#VALis_alpha">is_alpha</a> [<a href="Text.html">Text</a>]</td>
<td></td></tr>
<tr><td><a href="Text.html#VALis_ascii">is_ascii</a> [<a href="Text.html">Text</a>]</td>
<td></td></tr>
<tr><td><a href="Text.html#VALis_blank">is_blank</a> [<a href="Text.html">Text</a>]</td>
<td></td></tr>
<tr><td><a href="Text.html#VALis_cntrl">is_cntrl</a> [<a href="Text.html">Text</a>]</td>
<td></td></tr>
<tr><td><a href="Text.html#VALis_digit">is_digit</a> [<a href="Text.html">Text</a>]</td>
<td></td></tr>
<tr><td><a href="Text.html#VALis_graph">is_graph</a> [<a href="Text.html">Text</a>]</td>
<td></td></tr>
<tr><td><a href="Text.html#VALis_lower">is_lower</a> [<a href="Text.html">Text</a>]</td>
<td></td></tr>
<tr><td><a href="Text.html#VALis_print">is_print</a> [<a href="Text.html">Text</a>]</td>
<td></td></tr>
<tr><td><a href="Text.html#VALis_punct">is_punct</a> [<a href="Text.html">Text</a>]</td>
<td></td></tr>
<tr><td><a href="Text.html#VALis_space">is_space</a> [<a href="Text.html">Text</a>]</td>
<td></td></tr>
<tr><td><a href="Text.html#VALis_upper">is_upper</a> [<a href="Text.html">Text</a>]</td>
<td></td></tr>
<tr><td><a href="Text.html#VALis_xdigit">is_xdigit</a> [<a href="Text.html">Text</a>]</td>
<td></td></tr>
<tr><td><a href="Text.html#VALiter">iter</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">iter f text</code> ~ <code class="code">List.iter f (explode text)</code>
</div>
</td></tr>
<tr><td align="left"><br>L</td></tr>
<tr><td><a href="Text.html#VALlchop">lchop</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">lchop t</code> returns <code class="code">t</code> without is first character.
</div>
</td></tr>
<tr><td><a href="Text.html#VALlength">length</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
Return the number of unicode character contained in the given
text
</div>
</td></tr>
<tr><td><a href="Text.html#VALlines">lines</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
Returns all lines of the given text, without end of line
characters.
</div>
</td></tr>
<tr><td><a href="Text.html#VALlower">lower</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">lower t</code> returns the upper-cased version of <code class="code">t</code>.
</div>
</td></tr>
<tr><td><a href="Text.html#VALlstrip">lstrip</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">lstrip ?chars text</code> removes all characters of <code class="code">text</code> which are
part of <code class="code">chars</code> at the left.
</div>
</td></tr>
<tr><td align="left"><br>M</td></tr>
<tr><td><a href="Text.html#VALmap">map</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">map f text</code> ~ <code class="code">implode (List.map f (explode text))</code>
</div>
</td></tr>
<tr><td><a href="Text.html#VALmove">move</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">move n ptr</code> moves <code class="code">ptr</code> by <code class="code">n</code> unicode characters.
</div>
</td></tr>
<tr><td align="left"><br>N</td></tr>
<tr><td><a href="Text.html#VALnext">next</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">next ptr</code> if <code class="code">ptr</code> is at the end of text, returns <code class="code">None</code>,
otherwise, returns <code class="code">Some(ch, ptr')</code> where <code class="code">ch</code> is the character
at current position and <code class="code">ptr'</code> is the pointer to the next
character of the text.
</div>
</td></tr>
<tr><td align="left"><br>O</td></tr>
<tr><td><a href="Text.html#VALoffset">offset</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">offset ptr</code> returns the position in bytes of <code class="code">ptr</code>
</div>
</td></tr>
<tr><td align="left"><br>P</td></tr>
<tr><td><a href="Text.html#VALpointer_at">pointer_at</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">pointer_at txt n</code> returns a pointer to the character at
position <code class="code">n</code> in <code class="code">txt</code>.
</div>
</td></tr>
<tr><td><a href="Text.html#VALpointer_l">pointer_l</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
Returns a pointer to the left of the given text
</div>
</td></tr>
<tr><td><a href="Text.html#VALpointer_r">pointer_r</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
Returns a pointer to the right of the given text
</div>
</td></tr>
<tr><td><a href="Text.html#VALposition">position</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">position ptr</code> returns the position in unicode character of <code class="code">ptr</code>
</div>
</td></tr>
<tr><td><a href="Text.html#VALprev">prev</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">prev ptr</code> if <code class="code">ptr</code> is at the beginning of text, returns <code class="code">None</code>,
otherwise, returns <code class="code">Some(ch, ptr')</code> where <code class="code">ptr'</code> points to the
previous character and <code class="code">ch</code> is the character at <code class="code">ptr'</code>.
</div>
</td></tr>
<tr><td align="left"><br>R</td></tr>
<tr><td><a href="Text.html#VALrchop">rchop</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">rchop t</code> returns <code class="code">t</code> without is last character.
</div>
</td></tr>
<tr><td><a href="Encoding.html#VALrecode_string">recode_string</a> [<a href="Encoding.html">Encoding</a>]</td>
<td><div class="info">
<code class="code">recode_string ~src ~dst str</code> recode <code class="code">str</code> from <code class="code">src</code> encoding
to <code class="code">dst</code> encoding.
</div>
</td></tr>
<tr><td><a href="Text.html#VALrepeat">repeat</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">repeat n text</code> returns <code class="code">text</code> concatened <code class="code">n</code>-times with
itself.
</div>
</td></tr>
<tr><td><a href="Text.html#VALreplace">replace</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">replace text ~patt ~repl</code> replace all occurences of <code class="code">patt</code> in
<code class="code">text</code> by <code class="code">repl</code>.
</div>
</td></tr>
<tr><td><a href="Text.html#VALrev">rev</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">rev t</code> returns the sequence of characters of <code class="code">t</code> in reverse
order.
</div>
</td></tr>
<tr><td><a href="Text.html#VALrev_concat">rev_concat</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">rev_concat sep l</code> returns the concatenation of all texts
contained in <code class="code">l</code>, separated by <code class="code">sep</code>.
</div>
</td></tr>
<tr><td><a href="Text.html#VALrev_explode">rev_explode</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">rev_explode txt</code> returns the list of all characters of <code class="code">txt</code>,
in reverse order.
</div>
</td></tr>
<tr><td><a href="Text.html#VALrev_filter">rev_filter</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">rev_filter text</code> ~ <code class="code">implode (List.filter f (rev_explode text))</code>
</div>
</td></tr>
<tr><td><a href="Text.html#VALrev_find">rev_find</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">find ?from text patt</code> returns a pointer to the last occurrence
of <code class="code">patt</code> in <code class="code">text</code>.
</div>
</td></tr>
<tr><td><a href="Text.html#VALrev_fold">rev_fold</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">fold f text x</code> ~ <code class="code">List.fold_left f x (rev_explode text)</code>
</div>
</td></tr>
<tr><td><a href="Text.html#VALrev_implode">rev_implode</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">rev_implode l</code> returns the concatenation of all texts contained
in <code class="code">l</code>, in reverse order.
</div>
</td></tr>
<tr><td><a href="Text.html#VALrev_init">rev_init</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">rev_init n f</code> returns <code class="code">f (n - 1) ^ f 1 ^ ... ^ f 0</code>
</div>
</td></tr>
<tr><td><a href="Text.html#VALrev_iter">rev_iter</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">iter f text</code> ~ <code class="code">List.iter f (rev_explode text)</code>
</div>
</td></tr>
<tr><td><a href="Text.html#VALrev_map">rev_map</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">rev_map f text</code> ~ <code class="code">implode (List.rev_map f (explode text))</code>
</div>
</td></tr>
<tr><td><a href="Text.html#VALrev_split">rev_split</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">rev_split ?max text sep</code> split <code class="code">text</code> according to <code class="code">sep</code> in reverse
order.
</div>
</td></tr>
<tr><td><a href="Text.html#VALrstrip">rstrip</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">rstrip ?chars text</code> removes all characters of <code class="code">text</code> which are
part of <code class="code">chars</code> at the right.
</div>
</td></tr>
<tr><td align="left"><br>S</td></tr>
<tr><td><a href="Text.html#VALslice">slice</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">slice text a b</code> returns the text contained in <code class="code">txt</code> between <code class="code">a</code>
and <code class="code">b</code> (exlusive).
</div>
</td></tr>
<tr><td><a href="Text.html#VALsplice">splice</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">splice text a b repl</code> replace the text between <code class="code">a</code> and <code class="code">b</code>
(exclusive) by <code class="code">repl</code>.
</div>
</td></tr>
<tr><td><a href="Text.html#VALsplit">split</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">split ?max ?sep text</code> split <code class="code">text</code> according to <code class="code">sep</code>.
</div>
</td></tr>
<tr><td><a href="Text.html#VALstarts_with">starts_with</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">starts_with text prefix</code> returns <code class="code">true</code> iff <code class="code">s</code> starts with
<code class="code">prefix</code>.
</div>
</td></tr>
<tr><td><a href="Text.html#VALstrip">strip</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">strip ?chars text</code> removes all characters of <code class="code">text</code> which are
part of <code class="code">chars</code> at the right and left.
</div>
</td></tr>
<tr><td><a href="Text.html#VALsub">sub</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">sub text pos len</code> Returns the sub-text of <code class="code">text</code> starting at
position <code class="code">pos</code> and of length <code class="code">len</code>.
</div>
</td></tr>
<tr><td><a href="Encoding.html#VALsystem">system</a> [<a href="Encoding.html">Encoding</a>]</td>
<td><div class="info">
The character encoding used by the system
</div>
</td></tr>
<tr><td align="left"><br>T</td></tr>
<tr><td><a href="Text.html#VALto_ascii">to_ascii</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">to_ascii txt</code> returns an approximative ascii version of
<code class="code">txt</code>.
</div>
</td></tr>
<tr><td><a href="Text.html#VALtransform">transform</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">transform str</code> transforms <code class="code">str</code> in a way such that comparing
two string <code class="code">str1</code> and <code class="code">str2</code> transformed with
<code class="code">Pervasives.compare</code> give the same result as comparing them with
<a href="Text.html#VALcompare"><code class="code">Text.compare</code></a>.
</div>
</td></tr>
<tr><td align="left"><br>U</td></tr>
<tr><td><a href="Text.html#VALuncapitalize">uncapitalize</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">capitalize t</code> returns <code class="code">t</code> with its first letter lower-cased
</div>
</td></tr>
<tr><td><a href="Text.html#VALupper">upper</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
<code class="code">upper t</code> returns the upper-cased version of <code class="code">t</code>.
</div>
</td></tr>
<tr><td align="left"><br>V</td></tr>
<tr><td><a href="Text.html#VALvalidate">validate</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
Same as check but raises an exception in case the argument is
not a valid text.
</div>
</td></tr>
<tr><td align="left"><br>W</td></tr>
<tr><td><a href="Text.html#VALwords">words</a> [<a href="Text.html">Text</a>]</td>
<td><div class="info">
Returns all words of the given text.
</div>
</td></tr>
</table>
</body>
</html>
