/doc/tagger.Tag-class.html

http://github.com/apresta/tagger · HTML · 282 lines · 238 code · 23 blank · 21 comment · 0 complexity · 2783dcdae64e180e0c3ab5f412be87a4 MD5 · raw file

  1. <?xml version="1.0" encoding="ascii"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  3. "DTD/xhtml1-transitional.dtd">
  4. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  5. <head>
  6. <title>tagger.Tag</title>
  7. <link rel="stylesheet" href="epydoc.css" type="text/css" />
  8. <script type="text/javascript" src="epydoc.js"></script>
  9. </head>
  10. <body bgcolor="white" text="black" link="blue" vlink="#204080"
  11. alink="#204080">
  12. <!-- ==================== NAVIGATION BAR ==================== -->
  13. <table class="navbar" border="0" width="100%" cellpadding="0"
  14. bgcolor="#a0c0ff" cellspacing="0">
  15. <tr valign="middle">
  16. <!-- Tree link -->
  17. <th>&nbsp;&nbsp;&nbsp;<a
  18. href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  19. <!-- Index link -->
  20. <th>&nbsp;&nbsp;&nbsp;<a
  21. href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
  22. <!-- Help link -->
  23. <th>&nbsp;&nbsp;&nbsp;<a
  24. href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
  25. <!-- Project homepage -->
  26. <th class="navbar" align="right" width="100%">
  27. <table border="0" cellpadding="0" cellspacing="0">
  28. <tr><th class="navbar" align="center"
  29. ><a class="navbar" target="_top" href="http://github.com/apresta/tagger">tagger</a></th>
  30. </tr></table></th>
  31. </tr>
  32. </table>
  33. <table width="100%" cellpadding="0" cellspacing="0">
  34. <tr valign="top">
  35. <td width="100%">
  36. <span class="breadcrumbs">
  37. <a href="tagger-module.html">Module&nbsp;tagger</a> ::
  38. Class&nbsp;Tag
  39. </span>
  40. </td>
  41. <td>
  42. <table cellpadding="0" cellspacing="0">
  43. <!-- hide/show private -->
  44. <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
  45. onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
  46. <tr><td align="right"><span class="options"
  47. >[<a href="frames.html" target="_top">frames</a
  48. >]&nbsp;|&nbsp;<a href="tagger.Tag-class.html"
  49. target="_top">no&nbsp;frames</a>]</span></td></tr>
  50. </table>
  51. </td>
  52. </tr>
  53. </table>
  54. <!-- ==================== CLASS DESCRIPTION ==================== -->
  55. <h1 class="epydoc">Class Tag</h1><p class="nomargin-top"><span class="codelink"><a href="tagger-pysrc.html#Tag">source&nbsp;code</a></span></p>
  56. <center>
  57. <center> <map id="class_hierarchy_for_tag" name="class_hierarchy_for_tag">
  58. <area shape="rect" id="node1" href="tagger.MultiTag-class.html" title="MultiTag" alt="" coords="5,61,80,88"/>
  59. <area shape="rect" id="node2" href="tagger.Tag-class.html" title="Tag" alt="" coords="20,5,65,32"/>
  60. </map>
  61. <img src="class_hierarchy_for_tag.gif" alt='' usemap="#class_hierarchy_for_tag" ismap="ismap" class="graph-without-title" />
  62. </center>
  63. </center>
  64. <hr />
  65. <p>General class for tags (small units of text)</p>
  66. <!-- ==================== INSTANCE METHODS ==================== -->
  67. <a name="section-InstanceMethods"></a>
  68. <table class="summary" border="1" cellpadding="3"
  69. cellspacing="0" width="100%" bgcolor="white">
  70. <tr bgcolor="#70b0f0" class="table-header">
  71. <td colspan="2" class="table-header">
  72. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  73. <tr valign="top">
  74. <td align="left"><span class="table-header">Instance Methods</span></td>
  75. <td align="right" valign="top"
  76. ><span class="options">[<a href="#section-InstanceMethods"
  77. class="privatelink" onclick="toggle_private();"
  78. >hide private</a>]</span></td>
  79. </tr>
  80. </table>
  81. </td>
  82. </tr>
  83. <tr>
  84. <td width="15%" align="right" valign="top" class="summary">
  85. <span class="summary-type">&nbsp;</span>
  86. </td><td class="summary">
  87. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  88. <tr>
  89. <td><span class="summary-sig"><a href="tagger.Tag-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
  90. <span class="summary-sig-arg">string</span>,
  91. <span class="summary-sig-arg">stem</span>=<span class="summary-sig-default">None</span>,
  92. <span class="summary-sig-arg">rating</span>=<span class="summary-sig-default">1.0</span>,
  93. <span class="summary-sig-arg">proper</span>=<span class="summary-sig-default">False</span>,
  94. <span class="summary-sig-arg">terminal</span>=<span class="summary-sig-default">False</span>)</span><br />
  95. Returns:
  96. a new <a href="tagger.Tag-class.html" class="link">Tag</a> object</td>
  97. <td align="right" valign="top">
  98. <span class="codelink"><a href="tagger-pysrc.html#Tag.__init__">source&nbsp;code</a></span>
  99. </td>
  100. </tr>
  101. </table>
  102. </td>
  103. </tr>
  104. <tr>
  105. <td width="15%" align="right" valign="top" class="summary">
  106. <span class="summary-type">&nbsp;</span>
  107. </td><td class="summary">
  108. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  109. <tr>
  110. <td><span class="summary-sig"><a name="__eq__"></a><span class="summary-sig-name">__eq__</span>(<span class="summary-sig-arg">self</span>,
  111. <span class="summary-sig-arg">other</span>)</span></td>
  112. <td align="right" valign="top">
  113. <span class="codelink"><a href="tagger-pysrc.html#Tag.__eq__">source&nbsp;code</a></span>
  114. </td>
  115. </tr>
  116. </table>
  117. </td>
  118. </tr>
  119. <tr>
  120. <td width="15%" align="right" valign="top" class="summary">
  121. <span class="summary-type">&nbsp;</span>
  122. </td><td class="summary">
  123. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  124. <tr>
  125. <td><span class="summary-sig"><a name="__repr__"></a><span class="summary-sig-name">__repr__</span>(<span class="summary-sig-arg">self</span>)</span></td>
  126. <td align="right" valign="top">
  127. <span class="codelink"><a href="tagger-pysrc.html#Tag.__repr__">source&nbsp;code</a></span>
  128. </td>
  129. </tr>
  130. </table>
  131. </td>
  132. </tr>
  133. <tr>
  134. <td width="15%" align="right" valign="top" class="summary">
  135. <span class="summary-type">&nbsp;</span>
  136. </td><td class="summary">
  137. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  138. <tr>
  139. <td><span class="summary-sig"><a name="__lt__"></a><span class="summary-sig-name">__lt__</span>(<span class="summary-sig-arg">self</span>,
  140. <span class="summary-sig-arg">other</span>)</span></td>
  141. <td align="right" valign="top">
  142. <span class="codelink"><a href="tagger-pysrc.html#Tag.__lt__">source&nbsp;code</a></span>
  143. </td>
  144. </tr>
  145. </table>
  146. </td>
  147. </tr>
  148. <tr>
  149. <td width="15%" align="right" valign="top" class="summary">
  150. <span class="summary-type">&nbsp;</span>
  151. </td><td class="summary">
  152. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  153. <tr>
  154. <td><span class="summary-sig"><a name="__hash__"></a><span class="summary-sig-name">__hash__</span>(<span class="summary-sig-arg">self</span>)</span></td>
  155. <td align="right" valign="top">
  156. <span class="codelink"><a href="tagger-pysrc.html#Tag.__hash__">source&nbsp;code</a></span>
  157. </td>
  158. </tr>
  159. </table>
  160. </td>
  161. </tr>
  162. </table>
  163. <!-- ==================== METHOD DETAILS ==================== -->
  164. <a name="section-MethodDetails"></a>
  165. <table class="details" border="1" cellpadding="3"
  166. cellspacing="0" width="100%" bgcolor="white">
  167. <tr bgcolor="#70b0f0" class="table-header">
  168. <td colspan="2" class="table-header">
  169. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  170. <tr valign="top">
  171. <td align="left"><span class="table-header">Method Details</span></td>
  172. <td align="right" valign="top"
  173. ><span class="options">[<a href="#section-MethodDetails"
  174. class="privatelink" onclick="toggle_private();"
  175. >hide private</a>]</span></td>
  176. </tr>
  177. </table>
  178. </td>
  179. </tr>
  180. </table>
  181. <a name="__init__"></a>
  182. <div>
  183. <table class="details" border="1" cellpadding="3"
  184. cellspacing="0" width="100%" bgcolor="white">
  185. <tr><td>
  186. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  187. <tr valign="top"><td>
  188. <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
  189. <span class="sig-arg">string</span>,
  190. <span class="sig-arg">stem</span>=<span class="sig-default">None</span>,
  191. <span class="sig-arg">rating</span>=<span class="sig-default">1.0</span>,
  192. <span class="sig-arg">proper</span>=<span class="sig-default">False</span>,
  193. <span class="sig-arg">terminal</span>=<span class="sig-default">False</span>)</span>
  194. <br /><em class="fname">(Constructor)</em>
  195. </h3>
  196. </td><td align="right" valign="top"
  197. ><span class="codelink"><a href="tagger-pysrc.html#Tag.__init__">source&nbsp;code</a></span>&nbsp;
  198. </td>
  199. </tr></table>
  200. <dl class="fields">
  201. <dt>Parameters:</dt>
  202. <dd><ul class="nomargin-top">
  203. <li><strong class="pname"><code>string</code></strong> - the actual representation of the tag</li>
  204. <li><strong class="pname"><code>stem</code></strong> - the internal (usually stemmed) representation; tags with the same
  205. stem are regarded as equal</li>
  206. <li><strong class="pname"><code>rating</code></strong> - a measure of the tag's relevance in the interval [0,1]</li>
  207. <li><strong class="pname"><code>proper</code></strong> - whether the tag is a proper noun</li>
  208. <li><strong class="pname"><code>terminal</code></strong> - set to True if the tag is at the end of a phrase (or anyway it
  209. cannot be logically merged to the following one)</li>
  210. </ul></dd>
  211. <dt>Returns:</dt>
  212. <dd>a new <a href="tagger.Tag-class.html" class="link">Tag</a> object</dd>
  213. </dl>
  214. </td></tr></table>
  215. </div>
  216. <br />
  217. <!-- ==================== NAVIGATION BAR ==================== -->
  218. <table class="navbar" border="0" width="100%" cellpadding="0"
  219. bgcolor="#a0c0ff" cellspacing="0">
  220. <tr valign="middle">
  221. <!-- Tree link -->
  222. <th>&nbsp;&nbsp;&nbsp;<a
  223. href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  224. <!-- Index link -->
  225. <th>&nbsp;&nbsp;&nbsp;<a
  226. href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
  227. <!-- Help link -->
  228. <th>&nbsp;&nbsp;&nbsp;<a
  229. href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
  230. <!-- Project homepage -->
  231. <th class="navbar" align="right" width="100%">
  232. <table border="0" cellpadding="0" cellspacing="0">
  233. <tr><th class="navbar" align="center"
  234. ><a class="navbar" target="_top" href="http://github.com/apresta/tagger">tagger</a></th>
  235. </tr></table></th>
  236. </tr>
  237. </table>
  238. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
  239. <tr>
  240. <td align="left" class="footer">
  241. Generated by Epydoc 3.0.1 on Fri May 13 11:13:08 2011
  242. </td>
  243. <td align="right" class="footer">
  244. <a target="mainFrame" href="http://epydoc.sourceforge.net"
  245. >http://epydoc.sourceforge.net</a>
  246. </td>
  247. </tr>
  248. </table>
  249. <script type="text/javascript">
  250. <!--
  251. // Private objects are initially displayed (because if
  252. // javascript is turned off then we want them to be
  253. // visible); but by default, we want to hide them. So hide
  254. // them unless we have a cookie that says to show them.
  255. checkCookie();
  256. // -->
  257. </script>
  258. </body>
  259. </html>