namespacefasttext.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.13"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>fastText: fasttext Namespace Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="resize.js"></script>
  14. <script type="text/javascript" src="navtreedata.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript">
  17. $(document).ready(initResizable);
  18. </script>
  19. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  20. <script type="text/javascript" src="search/searchdata.js"></script>
  21. <script type="text/javascript" src="search/search.js"></script>
  22. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  23. </head>
  24. <body>
  25. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  26. <div id="titlearea">
  27. <table cellspacing="0" cellpadding="0">
  28. <tbody>
  29. <tr style="height: 56px;">
  30. <td id="projectlogo"><img alt="Logo" src="favicon.png"/></td>
  31. <td id="projectalign" style="padding-left: 0.5em;">
  32. <div id="projectname">fastText
  33. &#160;<span id="projectnumber">d00d36476b15</span>
  34. </div>
  35. <div id="projectbrief">Fast text processing tool/library</div>
  36. </td>
  37. </tr>
  38. </tbody>
  39. </table>
  40. </div>
  41. <!-- end header part -->
  42. <!-- Generated by Doxygen 1.8.13 -->
  43. <script type="text/javascript">
  44. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  45. </script>
  46. <script type="text/javascript" src="menudata.js"></script>
  47. <script type="text/javascript" src="menu.js"></script>
  48. <script type="text/javascript">
  49. $(function() {
  50. initMenu('',true,false,'search.php','Search');
  51. $(document).ready(function() { init_search(); });
  52. });
  53. </script>
  54. <div id="main-nav"></div>
  55. </div><!-- top -->
  56. <div id="side-nav" class="ui-resizable side-nav-resizable">
  57. <div id="nav-tree">
  58. <div id="nav-tree-contents">
  59. <div id="nav-sync" class="sync"></div>
  60. </div>
  61. </div>
  62. <div id="splitbar" style="-moz-user-select:none;"
  63. class="ui-resizable-handle">
  64. </div>
  65. </div>
  66. <script type="text/javascript">
  67. $(document).ready(function(){initNavTree('namespacefasttext.html','');});
  68. </script>
  69. <div id="doc-content">
  70. <!-- window showing the filter options -->
  71. <div id="MSearchSelectWindow"
  72. onmouseover="return searchBox.OnSearchSelectShow()"
  73. onmouseout="return searchBox.OnSearchSelectHide()"
  74. onkeydown="return searchBox.OnSearchSelectKey(event)">
  75. </div>
  76. <!-- iframe showing the search results (closed by default) -->
  77. <div id="MSearchResultsWindow">
  78. <iframe src="javascript:void(0)" frameborder="0"
  79. name="MSearchResults" id="MSearchResults">
  80. </iframe>
  81. </div>
  82. <div class="header">
  83. <div class="summary">
  84. <a href="#namespaces">Namespaces</a> &#124;
  85. <a href="#nested-classes">Classes</a> &#124;
  86. <a href="#typedef-members">Typedefs</a> &#124;
  87. <a href="#enum-members">Enumerations</a> &#124;
  88. <a href="#func-members">Functions</a> </div>
  89. <div class="headertitle">
  90. <div class="title">fasttext Namespace Reference</div> </div>
  91. </div><!--header-->
  92. <div class="contents">
  93. <table class="memberdecls">
  94. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
  95. Namespaces</h2></td></tr>
  96. <tr class="memitem:namespacefasttext_1_1utils"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacefasttext_1_1utils.html">utils</a></td></tr>
  97. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. </table><table class="memberdecls">
  99. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  100. Classes</h2></td></tr>
  101. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfasttext_1_1Args.html">Args</a></td></tr>
  102. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfasttext_1_1Dictionary.html">Dictionary</a></td></tr>
  104. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfasttext_1_1entry.html">entry</a></td></tr>
  106. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfasttext_1_1FastText.html">FastText</a></td></tr>
  108. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfasttext_1_1Matrix.html">Matrix</a></td></tr>
  110. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfasttext_1_1Model.html">Model</a></td></tr>
  112. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfasttext_1_1Node.html">Node</a></td></tr>
  114. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfasttext_1_1ProductQuantizer.html">ProductQuantizer</a></td></tr>
  116. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfasttext_1_1QMatrix.html">QMatrix</a></td></tr>
  118. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfasttext_1_1Vector.html">Vector</a></td></tr>
  120. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. </table><table class="memberdecls">
  122. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  123. Typedefs</h2></td></tr>
  124. <tr class="memitem:a6778f74ca8c360ba917216cb7fcbf497"><td class="memItemLeft" align="right" valign="top">typedef int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacefasttext.html#a6778f74ca8c360ba917216cb7fcbf497">id_type</a></td></tr>
  125. <tr class="separator:a6778f74ca8c360ba917216cb7fcbf497"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a7afdad102f318271c14154b8e65e5ea3"><td class="memItemLeft" align="right" valign="top">typedef float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacefasttext.html#a7afdad102f318271c14154b8e65e5ea3">real</a></td></tr>
  127. <tr class="separator:a7afdad102f318271c14154b8e65e5ea3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. </table><table class="memberdecls">
  129. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  130. Enumerations</h2></td></tr>
  131. <tr class="memitem:a349df214746a2ea0e5d7c26326b03d6f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacefasttext.html#a349df214746a2ea0e5d7c26326b03d6f">model_name</a> : int { <a class="el" href="namespacefasttext.html#a349df214746a2ea0e5d7c26326b03d6fae4709295b2cc44d67facf32b1099f1af">model_name::cbow</a> =1,
  132. <a class="el" href="namespacefasttext.html#a349df214746a2ea0e5d7c26326b03d6fa5dae429688af1c521ad87ac394192c6d">model_name::sg</a>,
  133. <a class="el" href="namespacefasttext.html#a349df214746a2ea0e5d7c26326b03d6fa2eeecd72c567401e6988624b179d0b14">model_name::sup</a>
  134. }</td></tr>
  135. <tr class="separator:a349df214746a2ea0e5d7c26326b03d6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a1ba04862fd670674501ccacc936e1952"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacefasttext.html#a1ba04862fd670674501ccacc936e1952">loss_name</a> : int { <a class="el" href="namespacefasttext.html#a1ba04862fd670674501ccacc936e1952a789406d01073ca1782d86293dcfc0764">loss_name::hs</a> =1,
  137. <a class="el" href="namespacefasttext.html#a1ba04862fd670674501ccacc936e1952af01a37d157918910f2035b2af81ea4e1">loss_name::ns</a>,
  138. <a class="el" href="namespacefasttext.html#a1ba04862fd670674501ccacc936e1952ace2f1fbd249d24aabc07ac4488ab5b8c">loss_name::softmax</a>
  139. }</td></tr>
  140. <tr class="separator:a1ba04862fd670674501ccacc936e1952"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:a532eedeee97e8d66a96b519d165f4eb7"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacefasttext.html#a532eedeee97e8d66a96b519d165f4eb7">entry_type</a> : int8_t { <a class="el" href="namespacefasttext.html#a532eedeee97e8d66a96b519d165f4eb7ac47d187067c6cf953245f128b5fde62a">entry_type::word</a> =0,
  142. <a class="el" href="namespacefasttext.html#a532eedeee97e8d66a96b519d165f4eb7ad304ba20e96d87411588eeabac850e34">entry_type::label</a> =1
  143. }</td></tr>
  144. <tr class="separator:a532eedeee97e8d66a96b519d165f4eb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. </table><table class="memberdecls">
  146. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  147. Functions</h2></td></tr>
  148. <tr class="memitem:a4336b1849ad0c1f134ed0ac9842f053c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacefasttext.html#a7afdad102f318271c14154b8e65e5ea3">real</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacefasttext.html#a4336b1849ad0c1f134ed0ac9842f053c">distL2</a> (const <a class="el" href="namespacefasttext.html#a7afdad102f318271c14154b8e65e5ea3">real</a> *x, const <a class="el" href="namespacefasttext.html#a7afdad102f318271c14154b8e65e5ea3">real</a> *y, int32_t d)</td></tr>
  149. <tr class="separator:a4336b1849ad0c1f134ed0ac9842f053c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:a23eb4596f3beb9859b22cf64a83461d6"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacefasttext.html#a23eb4596f3beb9859b22cf64a83461d6">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="classfasttext_1_1Vector.html">Vector</a> &amp;v)</td></tr>
  151. <tr class="separator:a23eb4596f3beb9859b22cf64a83461d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. </table>
  153. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  154. <div class="textblock"><p>Copyright (c) 2016-present, Facebook, Inc. All rights reserved.</p>
  155. <p>This source code is licensed under the MIT-style license found in the LICENSE file in the root directory of this source tree. </p>
  156. </div><h2 class="groupheader">Typedef Documentation</h2>
  157. <a id="a6778f74ca8c360ba917216cb7fcbf497"></a>
  158. <h2 class="memtitle"><span class="permalink"><a href="#a6778f74ca8c360ba917216cb7fcbf497">&#9670;&nbsp;</a></span>id_type</h2>
  159. <div class="memitem">
  160. <div class="memproto">
  161. <table class="memname">
  162. <tr>
  163. <td class="memname">typedef int32_t <a class="el" href="namespacefasttext.html#a6778f74ca8c360ba917216cb7fcbf497">fasttext::id_type</a></td>
  164. </tr>
  165. </table>
  166. </div><div class="memdoc">
  167. </div>
  168. </div>
  169. <a id="a7afdad102f318271c14154b8e65e5ea3"></a>
  170. <h2 class="memtitle"><span class="permalink"><a href="#a7afdad102f318271c14154b8e65e5ea3">&#9670;&nbsp;</a></span>real</h2>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname">typedef float <a class="el" href="namespacefasttext.html#a7afdad102f318271c14154b8e65e5ea3">fasttext::real</a></td>
  176. </tr>
  177. </table>
  178. </div><div class="memdoc">
  179. </div>
  180. </div>
  181. <h2 class="groupheader">Enumeration Type Documentation</h2>
  182. <a id="a532eedeee97e8d66a96b519d165f4eb7"></a>
  183. <h2 class="memtitle"><span class="permalink"><a href="#a532eedeee97e8d66a96b519d165f4eb7">&#9670;&nbsp;</a></span>entry_type</h2>
  184. <div class="memitem">
  185. <div class="memproto">
  186. <table class="mlabels">
  187. <tr>
  188. <td class="mlabels-left">
  189. <table class="memname">
  190. <tr>
  191. <td class="memname">enum <a class="el" href="namespacefasttext.html#a532eedeee97e8d66a96b519d165f4eb7">fasttext::entry_type</a> : int8_t</td>
  192. </tr>
  193. </table>
  194. </td>
  195. <td class="mlabels-right">
  196. <span class="mlabels"><span class="mlabel">strong</span></span> </td>
  197. </tr>
  198. </table>
  199. </div><div class="memdoc">
  200. <table class="fieldtable">
  201. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a532eedeee97e8d66a96b519d165f4eb7ac47d187067c6cf953245f128b5fde62a"></a>word&#160;</td><td class="fielddoc"></td></tr>
  202. <tr><td class="fieldname"><a id="a532eedeee97e8d66a96b519d165f4eb7ad304ba20e96d87411588eeabac850e34"></a>label&#160;</td><td class="fielddoc"></td></tr>
  203. </table>
  204. </div>
  205. </div>
  206. <a id="a1ba04862fd670674501ccacc936e1952"></a>
  207. <h2 class="memtitle"><span class="permalink"><a href="#a1ba04862fd670674501ccacc936e1952">&#9670;&nbsp;</a></span>loss_name</h2>
  208. <div class="memitem">
  209. <div class="memproto">
  210. <table class="mlabels">
  211. <tr>
  212. <td class="mlabels-left">
  213. <table class="memname">
  214. <tr>
  215. <td class="memname">enum <a class="el" href="namespacefasttext.html#a1ba04862fd670674501ccacc936e1952">fasttext::loss_name</a> : int</td>
  216. </tr>
  217. </table>
  218. </td>
  219. <td class="mlabels-right">
  220. <span class="mlabels"><span class="mlabel">strong</span></span> </td>
  221. </tr>
  222. </table>
  223. </div><div class="memdoc">
  224. <table class="fieldtable">
  225. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a1ba04862fd670674501ccacc936e1952a789406d01073ca1782d86293dcfc0764"></a>hs&#160;</td><td class="fielddoc"></td></tr>
  226. <tr><td class="fieldname"><a id="a1ba04862fd670674501ccacc936e1952af01a37d157918910f2035b2af81ea4e1"></a>ns&#160;</td><td class="fielddoc"></td></tr>
  227. <tr><td class="fieldname"><a id="a1ba04862fd670674501ccacc936e1952ace2f1fbd249d24aabc07ac4488ab5b8c"></a>softmax&#160;</td><td class="fielddoc"></td></tr>
  228. </table>
  229. </div>
  230. </div>
  231. <a id="a349df214746a2ea0e5d7c26326b03d6f"></a>
  232. <h2 class="memtitle"><span class="permalink"><a href="#a349df214746a2ea0e5d7c26326b03d6f">&#9670;&nbsp;</a></span>model_name</h2>
  233. <div class="memitem">
  234. <div class="memproto">
  235. <table class="mlabels">
  236. <tr>
  237. <td class="mlabels-left">
  238. <table class="memname">
  239. <tr>
  240. <td class="memname">enum <a class="el" href="namespacefasttext.html#a349df214746a2ea0e5d7c26326b03d6f">fasttext::model_name</a> : int</td>
  241. </tr>
  242. </table>
  243. </td>
  244. <td class="mlabels-right">
  245. <span class="mlabels"><span class="mlabel">strong</span></span> </td>
  246. </tr>
  247. </table>
  248. </div><div class="memdoc">
  249. <table class="fieldtable">
  250. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a349df214746a2ea0e5d7c26326b03d6fae4709295b2cc44d67facf32b1099f1af"></a>cbow&#160;</td><td class="fielddoc"></td></tr>
  251. <tr><td class="fieldname"><a id="a349df214746a2ea0e5d7c26326b03d6fa5dae429688af1c521ad87ac394192c6d"></a>sg&#160;</td><td class="fielddoc"></td></tr>
  252. <tr><td class="fieldname"><a id="a349df214746a2ea0e5d7c26326b03d6fa2eeecd72c567401e6988624b179d0b14"></a>sup&#160;</td><td class="fielddoc"></td></tr>
  253. </table>
  254. </div>
  255. </div>
  256. <h2 class="groupheader">Function Documentation</h2>
  257. <a id="a4336b1849ad0c1f134ed0ac9842f053c"></a>
  258. <h2 class="memtitle"><span class="permalink"><a href="#a4336b1849ad0c1f134ed0ac9842f053c">&#9670;&nbsp;</a></span>distL2()</h2>
  259. <div class="memitem">
  260. <div class="memproto">
  261. <table class="memname">
  262. <tr>
  263. <td class="memname"><a class="el" href="namespacefasttext.html#a7afdad102f318271c14154b8e65e5ea3">real</a> fasttext::distL2 </td>
  264. <td>(</td>
  265. <td class="paramtype">const <a class="el" href="namespacefasttext.html#a7afdad102f318271c14154b8e65e5ea3">real</a> *&#160;</td>
  266. <td class="paramname"><em>x</em>, </td>
  267. </tr>
  268. <tr>
  269. <td class="paramkey"></td>
  270. <td></td>
  271. <td class="paramtype">const <a class="el" href="namespacefasttext.html#a7afdad102f318271c14154b8e65e5ea3">real</a> *&#160;</td>
  272. <td class="paramname"><em>y</em>, </td>
  273. </tr>
  274. <tr>
  275. <td class="paramkey"></td>
  276. <td></td>
  277. <td class="paramtype">int32_t&#160;</td>
  278. <td class="paramname"><em>d</em>&#160;</td>
  279. </tr>
  280. <tr>
  281. <td></td>
  282. <td>)</td>
  283. <td></td><td></td>
  284. </tr>
  285. </table>
  286. </div><div class="memdoc">
  287. </div>
  288. </div>
  289. <a id="a23eb4596f3beb9859b22cf64a83461d6"></a>
  290. <h2 class="memtitle"><span class="permalink"><a href="#a23eb4596f3beb9859b22cf64a83461d6">&#9670;&nbsp;</a></span>operator<<()</h2>
  291. <div class="memitem">
  292. <div class="memproto">
  293. <table class="memname">
  294. <tr>
  295. <td class="memname">std::ostream &amp; fasttext::operator&lt;&lt; </td>
  296. <td>(</td>
  297. <td class="paramtype">std::ostream &amp;&#160;</td>
  298. <td class="paramname"><em>os</em>, </td>
  299. </tr>
  300. <tr>
  301. <td class="paramkey"></td>
  302. <td></td>
  303. <td class="paramtype">const <a class="el" href="classfasttext_1_1Vector.html">Vector</a> &amp;&#160;</td>
  304. <td class="paramname"><em>v</em>&#160;</td>
  305. </tr>
  306. <tr>
  307. <td></td>
  308. <td>)</td>
  309. <td></td><td></td>
  310. </tr>
  311. </table>
  312. </div><div class="memdoc">
  313. </div>
  314. </div>
  315. </div><!-- contents -->
  316. </div><!-- doc-content -->
  317. <!-- start footer part -->
  318. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  319. <ul>
  320. <li class="navelem"><a class="el" href="namespacefasttext.html">fasttext</a></li>
  321. <li class="footer">Generated by
  322. <a href="http://www.doxygen.org/index.html">
  323. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  324. </ul>
  325. </div>
  326. </body>
  327. </html>