| Current File : //proc/thread-self/root/kunden/usr/share/doc/libdatrie-devel/alpha-map_8h.html |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libdatrie: datrie/alpha-map.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libdatrie
 <span id="projectnumber">0.2.13</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_23cbef3b1b2df757deb7708cc4a2d793.html">datrie</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">alpha-map.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>AlphaMap data type and functions.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ab369cb9c893b9f233b97173e0c63d25e"><td class="memItemLeft" align="right" valign="top"><a id="ab369cb9c893b9f233b97173e0c63d25e"></a>
typedef struct _AlphaMap </td><td class="memItemRight" valign="bottom"><a class="el" href="alpha-map_8h.html#ab369cb9c893b9f233b97173e0c63d25e">AlphaMap</a></td></tr>
<tr class="memdesc:ab369cb9c893b9f233b97173e0c63d25e"><td class="mdescLeft"> </td><td class="mdescRight">AlphaMap data type. <br /></td></tr>
<tr class="separator:ab369cb9c893b9f233b97173e0c63d25e"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a4b69218d56e895d06c472a706ad4ebcd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="alpha-map_8h.html#ab369cb9c893b9f233b97173e0c63d25e">AlphaMap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="alpha-map_8h.html#a4b69218d56e895d06c472a706ad4ebcd">alpha_map_new</a> (void)</td></tr>
<tr class="memdesc:a4b69218d56e895d06c472a706ad4ebcd"><td class="mdescLeft"> </td><td class="mdescRight">Create new alphabet map. <a href="alpha-map_8h.html#a4b69218d56e895d06c472a706ad4ebcd">More...</a><br /></td></tr>
<tr class="separator:a4b69218d56e895d06c472a706ad4ebcd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acac189971e2655fa767bc65549e30e1e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="alpha-map_8h.html#ab369cb9c893b9f233b97173e0c63d25e">AlphaMap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="alpha-map_8h.html#acac189971e2655fa767bc65549e30e1e">alpha_map_clone</a> (const <a class="el" href="alpha-map_8h.html#ab369cb9c893b9f233b97173e0c63d25e">AlphaMap</a> *a_map)</td></tr>
<tr class="memdesc:acac189971e2655fa767bc65549e30e1e"><td class="mdescLeft"> </td><td class="mdescRight">Create a clone of alphabet map. <a href="alpha-map_8h.html#acac189971e2655fa767bc65549e30e1e">More...</a><br /></td></tr>
<tr class="separator:acac189971e2655fa767bc65549e30e1e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8fc1275b8136f5195100b6c9c15c9c87"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="alpha-map_8h.html#a8fc1275b8136f5195100b6c9c15c9c87">alpha_map_free</a> (<a class="el" href="alpha-map_8h.html#ab369cb9c893b9f233b97173e0c63d25e">AlphaMap</a> *alpha_map)</td></tr>
<tr class="memdesc:a8fc1275b8136f5195100b6c9c15c9c87"><td class="mdescLeft"> </td><td class="mdescRight">Free an alphabet map object. <a href="alpha-map_8h.html#a8fc1275b8136f5195100b6c9c15c9c87">More...</a><br /></td></tr>
<tr class="separator:a8fc1275b8136f5195100b6c9c15c9c87"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a984d912ebcbc73c9b43d23233138bdcf"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="alpha-map_8h.html#a984d912ebcbc73c9b43d23233138bdcf">alpha_map_add_range</a> (<a class="el" href="alpha-map_8h.html#ab369cb9c893b9f233b97173e0c63d25e">AlphaMap</a> *alpha_map, <a class="el" href="triedefs_8h.html#acae969caa2057c6accde0e977546a5be">AlphaChar</a> begin, <a class="el" href="triedefs_8h.html#acae969caa2057c6accde0e977546a5be">AlphaChar</a> end)</td></tr>
<tr class="memdesc:a984d912ebcbc73c9b43d23233138bdcf"><td class="mdescLeft"> </td><td class="mdescRight">Add a range to alphabet map. <a href="alpha-map_8h.html#a984d912ebcbc73c9b43d23233138bdcf">More...</a><br /></td></tr>
<tr class="separator:a984d912ebcbc73c9b43d23233138bdcf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7bc0fcfaffa2c92ebd28b4b2ed4dcf20"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="alpha-map_8h.html#a7bc0fcfaffa2c92ebd28b4b2ed4dcf20">alpha_char_strlen</a> (const <a class="el" href="triedefs_8h.html#acae969caa2057c6accde0e977546a5be">AlphaChar</a> *str)</td></tr>
<tr class="memdesc:a7bc0fcfaffa2c92ebd28b4b2ed4dcf20"><td class="mdescLeft"> </td><td class="mdescRight">Alphabet string length. <a href="alpha-map_8h.html#a7bc0fcfaffa2c92ebd28b4b2ed4dcf20">More...</a><br /></td></tr>
<tr class="separator:a7bc0fcfaffa2c92ebd28b4b2ed4dcf20"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac3b3552ca283aff2f3b4ce624128c109"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="alpha-map_8h.html#ac3b3552ca283aff2f3b4ce624128c109">alpha_char_strcmp</a> (const <a class="el" href="triedefs_8h.html#acae969caa2057c6accde0e977546a5be">AlphaChar</a> *str1, const <a class="el" href="triedefs_8h.html#acae969caa2057c6accde0e977546a5be">AlphaChar</a> *str2)</td></tr>
<tr class="memdesc:ac3b3552ca283aff2f3b4ce624128c109"><td class="mdescLeft"> </td><td class="mdescRight">Compare alphabet strings. <a href="alpha-map_8h.html#ac3b3552ca283aff2f3b4ce624128c109">More...</a><br /></td></tr>
<tr class="separator:ac3b3552ca283aff2f3b4ce624128c109"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>AlphaMap data type and functions. </p>
<p>AlphaMap is a mapping between AlphaChar and TrieChar. AlphaChar is the alphabet character used in words of a target language, while TrieChar is a small integer with packed range of values and is actually used in trie state transition calculations.</p>
<p>Since double-array trie relies on sparse state transition table, a small set of input characters can make the table small, i.e. with small number of columns. But in real life, alphabet characters can be of non-continuous range of values. The unused slots between them can waste the space in the table, and can increase the chance of unused array cells.</p>
<p>AlphaMap is thus defined for mapping between non-continuous ranges of values of AlphaChar and packed and continuous range of Triechar.</p>
<p>In this implementation, TrieChar is defined as a single-byte integer, which means the largest AlphaChar set that is supported is of 255 values, as the special value of 0 is reserved for null-termination code. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ac3b3552ca283aff2f3b4ce624128c109"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac3b3552ca283aff2f3b4ce624128c109">◆ </a></span>alpha_char_strcmp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int alpha_char_strcmp </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="triedefs_8h.html#acae969caa2057c6accde0e977546a5be">AlphaChar</a> * </td>
<td class="paramname"><em>str1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="triedefs_8h.html#acae969caa2057c6accde0e977546a5be">AlphaChar</a> * </td>
<td class="paramname"><em>str2</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Compare alphabet strings. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str1,str2</td><td>: the arrays of null-terminated AlphaChar strings to compare</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>negative if <em>str1</em> < <em>str2</em>; 0 if <em>str1</em> == <em>str2</em>; positive if <em>str1</em> > <em>str2</em> </dd></dl>
<p>Available since: 0.2.7 </p>
</div>
</div>
<a id="a7bc0fcfaffa2c92ebd28b4b2ed4dcf20"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7bc0fcfaffa2c92ebd28b4b2ed4dcf20">◆ </a></span>alpha_char_strlen()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int alpha_char_strlen </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="triedefs_8h.html#acae969caa2057c6accde0e977546a5be">AlphaChar</a> * </td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Alphabet string length. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>: the array of null-terminated AlphaChar string to measure</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the total characters in <em>str</em>. </dd></dl>
</div>
</div>
<a id="a984d912ebcbc73c9b43d23233138bdcf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a984d912ebcbc73c9b43d23233138bdcf">◆ </a></span>alpha_map_add_range()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int alpha_map_add_range </td>
<td>(</td>
<td class="paramtype"><a class="el" href="alpha-map_8h.html#ab369cb9c893b9f233b97173e0c63d25e">AlphaMap</a> * </td>
<td class="paramname"><em>alpha_map</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="triedefs_8h.html#acae969caa2057c6accde0e977546a5be">AlphaChar</a> </td>
<td class="paramname"><em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="triedefs_8h.html#acae969caa2057c6accde0e977546a5be">AlphaChar</a> </td>
<td class="paramname"><em>end</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a range to alphabet map. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">alpha_map</td><td>: the alphabet map object </td></tr>
<tr><td class="paramname">begin</td><td>: the first character of the range </td></tr>
<tr><td class="paramname">end</td><td>: the last character of the range</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, non-zero on failure</dd></dl>
<p>Add a range of character codes from <em>begin</em> to <em>end</em> to the alphabet set. </p>
</div>
</div>
<a id="acac189971e2655fa767bc65549e30e1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acac189971e2655fa767bc65549e30e1e">◆ </a></span>alpha_map_clone()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="alpha-map_8h.html#ab369cb9c893b9f233b97173e0c63d25e">AlphaMap</a>* alpha_map_clone </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="alpha-map_8h.html#ab369cb9c893b9f233b97173e0c63d25e">AlphaMap</a> * </td>
<td class="paramname"><em>a_map</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a clone of alphabet map. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a_map</td><td>: the source alphabet map to clone</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the alphabet map clone, NULL on failure</dd></dl>
<p>The created object must be freed with <a class="el" href="alpha-map_8h.html#a8fc1275b8136f5195100b6c9c15c9c87" title="Free an alphabet map object.">alpha_map_free()</a>. </p>
</div>
</div>
<a id="a8fc1275b8136f5195100b6c9c15c9c87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8fc1275b8136f5195100b6c9c15c9c87">◆ </a></span>alpha_map_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void alpha_map_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="alpha-map_8h.html#ab369cb9c893b9f233b97173e0c63d25e">AlphaMap</a> * </td>
<td class="paramname"><em>alpha_map</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free an alphabet map object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">alpha_map</td><td>: the alphabet map object to free</td></tr>
</table>
</dd>
</dl>
<p>Destruct the <em>alpha_map</em> and free its allocated memory. </p>
</div>
</div>
<a id="a4b69218d56e895d06c472a706ad4ebcd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b69218d56e895d06c472a706ad4ebcd">◆ </a></span>alpha_map_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="alpha-map_8h.html#ab369cb9c893b9f233b97173e0c63d25e">AlphaMap</a>* alpha_map_new </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create new alphabet map. </p>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the newly created alphabet map, NULL on failure</dd></dl>
<p>Create a new empty alphabet map. The map contents can then be added with <a class="el" href="alpha-map_8h.html#a984d912ebcbc73c9b43d23233138bdcf" title="Add a range to alphabet map.">alpha_map_add_range()</a>.</p>
<p>The created object must be freed with <a class="el" href="alpha-map_8h.html#a8fc1275b8136f5195100b6c9c15c9c87" title="Free an alphabet map object.">alpha_map_free()</a>. </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>