/doc/tagger.tagger.MultiTag-class.html

http://github.com/apresta/tagger · HTML · 267 lines · 228 code · 18 blank · 21 comment · 0 complexity · 40d7f95f060700e83fbf7aff545a328d MD5 · raw file 

    

  1. <?xml version="1.0" encoding="ascii"?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    3. 

  3.           "DTD/xhtml1-transitional.dtd">
    4. 

  4. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    5. 

  5. <head>
    6. 

  6.   <title>tagger.tagger.MultiTag</title>
    7. 

  7.   <link rel="stylesheet" href="epydoc.css" type="text/css" />
    8. 

  8.   <script type="text/javascript" src="epydoc.js"></script>
    9. 

  9. </head>
    10. 

  10. 

  11. <body bgcolor="white" text="black" link="blue" vlink="#204080"
    12. 

  12.       alink="#204080">
    13. 

  13. <!-- ==================== NAVIGATION BAR ==================== -->
    14. 

  14. <table class="navbar" border="0" width="100%" cellpadding="0"
    15. 

  15.        bgcolor="#a0c0ff" cellspacing="0">
    16. 

  16.   <tr valign="middle">
    17. 

  17. 

  18.   <!-- Tree link -->
    19. 

  19.       <th>&nbsp;&nbsp;&nbsp;<a
    20. 

  20.         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    21. 

  21. 

  22.   <!-- Index link -->
    23. 

  23.       <th>&nbsp;&nbsp;&nbsp;<a
    24. 

  24.         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
    25. 

  25. 

  26.   <!-- Help link -->
    27. 

  27.       <th>&nbsp;&nbsp;&nbsp;<a
    28. 

  28.         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    29. 

  29. 

  30.   <!-- Project homepage -->
    31. 

  31.       <th class="navbar" align="right" width="100%">
    32. 

  32.         <table border="0" cellpadding="0" cellspacing="0">
    33. 

  33.           <tr><th class="navbar" align="center"
    34. 

  34.             ><a class="navbar" target="_top" href="http://github.com/apresta/tagger">tagger</a></th>
    35. 

  35.           </tr></table></th>
    36. 

  36.   </tr>
    37. 

  37. </table>
    38. 

  38. <table width="100%" cellpadding="0" cellspacing="0">
    39. 

  39.   <tr valign="top">
    40. 

  40.     <td width="100%">
    41. 

  41.       <span class="breadcrumbs">
    42. 

  42.         Package&nbsp;tagger ::
    43. 

  43.         <a href="tagger.tagger-module.html">Module&nbsp;tagger</a> ::
    44. 

  44.         Class&nbsp;MultiTag
    45. 

  45.       </span>
    46. 

  46.     </td>
    47. 

  47.     <td>
    48. 

  48.       <table cellpadding="0" cellspacing="0">
    49. 

  49.         <!-- hide/show private -->
    50. 

  50.         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    51. 

  51.     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
    52. 

  52.         <tr><td align="right"><span class="options"
    53. 

  53.             >[<a href="frames.html" target="_top">frames</a
    54. 

  54.             >]&nbsp;|&nbsp;<a href="tagger.tagger.MultiTag-class.html"
    55. 

  55.             target="_top">no&nbsp;frames</a>]</span></td></tr>
    56. 

  56.       </table>
    57. 

  57.     </td>
    58. 

  58.   </tr>
    59. 

  59. </table>
    60. 

  60. <!-- ==================== CLASS DESCRIPTION ==================== -->
    61. 

  61. <h1 class="epydoc">Class MultiTag</h1><p class="nomargin-top"><span class="codelink"><a href="tagger.tagger-pysrc.html#MultiTag">source&nbsp;code</a></span></p>
    62. 

  62. <center>
    63. 

  63. <center>  <map id="class_hierarchy_for_multitag" name="class_hierarchy_for_multitag">
    64. 

  64. <area shape="rect" id="node1" href="tagger.tagger.MultiTag-class.html" title="MultiTag" alt="" coords="5,61,88,88"/>
    65. 

  65. <area shape="rect" id="node2" href="tagger.tagger.Tag-class.html" title="Tag" alt="" coords="23,5,71,32"/>
    66. 

  66. </map>
    67. 

  67.   <img src="class_hierarchy_for_multitag.gif" alt='' usemap="#class_hierarchy_for_multitag" ismap="ismap" class="graph-without-title" />
    68. 

  68. </center>
    69. 

  69. </center>
    70. 

  70. <hr />
    71. 

  71. <p>Class for aggregates of tags (usually next to each other in the 
    72. 

  72.   document)</p>
    73. 

  73. 

  74. <!-- ==================== INSTANCE METHODS ==================== -->
    75. 

  75. <a name="section-InstanceMethods"></a>
    76. 

  76. <table class="summary" border="1" cellpadding="3"
    77. 

  77.        cellspacing="0" width="100%" bgcolor="white">
    78. 

  78. <tr bgcolor="#70b0f0" class="table-header">
    79. 

  79.   <td colspan="2" class="table-header">
    80. 

  80.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    81. 

  81.       <tr valign="top">
    82. 

  82.         <td align="left"><span class="table-header">Instance Methods</span></td>
    83. 

  83.         <td align="right" valign="top"
    84. 

  84.          ><span class="options">[<a href="#section-InstanceMethods"
    85. 

  85.          class="privatelink" onclick="toggle_private();"
    86. 

  86.          >hide private</a>]</span></td>
    87. 

  87.       </tr>
    88. 

  88.     </table>
    89. 

  89.   </td>
    90. 

  90. </tr>
    91. 

  91. <tr>
    92. 

  92.     <td width="15%" align="right" valign="top" class="summary">
    93. 

  93.       <span class="summary-type">&nbsp;</span>
    94. 

  94.     </td><td class="summary">
    95. 

  95.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    96. 

  96.         <tr>
    97. 

  97.           <td><span class="summary-sig"><a href="tagger.tagger.MultiTag-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
    98. 

  98.         <span class="summary-sig-arg">tail</span>,
    99. 

  99.         <span class="summary-sig-arg">head</span>=<span class="summary-sig-default">None</span>)</span><br />
    100. 

  100.       Returns:
    101. 

  101.       a new <a href="tagger.tagger.MultiTag-class.html" 
    102. 

  102.       class="link">MultiTag</a> object</td>
    103. 

  103.           <td align="right" valign="top">
    104. 

  104.             <span class="codelink"><a href="tagger.tagger-pysrc.html#MultiTag.__init__">source&nbsp;code</a></span>
    105. 

  105.             
    106. 

  106.           </td>
    107. 

  107.         </tr>
    108. 

  108.       </table>
    109. 

  109.       
    110. 

  110.     </td>
    111. 

  111.   </tr>
    112. 

  112. <tr>
    113. 

  113.     <td width="15%" align="right" valign="top" class="summary">
    114. 

  114.       <span class="summary-type">&nbsp;</span>
    115. 

  115.     </td><td class="summary">
    116. 

  116.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    117. 

  117.         <tr>
    118. 

  118.           <td><span class="summary-sig"><a href="tagger.tagger.MultiTag-class.html#combined_rating" class="summary-sig-name">combined_rating</a>(<span class="summary-sig-arg">self</span>)</span><br />
    119. 

  119.       Method that computes the multitag's rating from the ratings of unit 
    120. 

  120.       subtags</td>
    121. 

  121.           <td align="right" valign="top">
    122. 

  122.             <span class="codelink"><a href="tagger.tagger-pysrc.html#MultiTag.combined_rating">source&nbsp;code</a></span>
    123. 

  123.             
    124. 

  124.           </td>
    125. 

  125.         </tr>
    126. 

  126.       </table>
    127. 

  127.       
    128. 

  128.     </td>
    129. 

  129.   </tr>
    130. 

  130.   <tr>
    131. 

  131.     <td colspan="2" class="summary">
    132. 

  132.     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="tagger.tagger.Tag-class.html">Tag</a></code></b>:
    133. 

  133.       <code><a href="tagger.tagger.Tag-class.html#__eq__">__eq__</a></code>,
    134. 

  134.       <code><a href="tagger.tagger.Tag-class.html#__hash__">__hash__</a></code>,
    135. 

  135.       <code><a href="tagger.tagger.Tag-class.html#__lt__">__lt__</a></code>,
    136. 

  136.       <code><a href="tagger.tagger.Tag-class.html#__repr__">__repr__</a></code>
    137. 

  137.       </p>
    138. 

  138.     </td>
    139. 

  139.   </tr>
    140. 

  140. </table>
    141. 

  141. <!-- ==================== METHOD DETAILS ==================== -->
    142. 

  142. <a name="section-MethodDetails"></a>
    143. 

  143. <table class="details" border="1" cellpadding="3"
    144. 

  144.        cellspacing="0" width="100%" bgcolor="white">
    145. 

  145. <tr bgcolor="#70b0f0" class="table-header">
    146. 

  146.   <td colspan="2" class="table-header">
    147. 

  147.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    148. 

  148.       <tr valign="top">
    149. 

  149.         <td align="left"><span class="table-header">Method Details</span></td>
    150. 

  150.         <td align="right" valign="top"
    151. 

  151.          ><span class="options">[<a href="#section-MethodDetails"
    152. 

  152.          class="privatelink" onclick="toggle_private();"
    153. 

  153.          >hide private</a>]</span></td>
    154. 

  154.       </tr>
    155. 

  155.     </table>
    156. 

  156.   </td>
    157. 

  157. </tr>
    158. 

  158. </table>
    159. 

  159. <a name="__init__"></a>
    160. 

  160. <div>
    161. 

  161. <table class="details" border="1" cellpadding="3"
    162. 

  162.        cellspacing="0" width="100%" bgcolor="white">
    163. 

  163. <tr><td>
    164. 

  164.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    165. 

  165.   <tr valign="top"><td>
    166. 

  166.   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
    167. 

  167.         <span class="sig-arg">tail</span>,
    168. 

  168.         <span class="sig-arg">head</span>=<span class="sig-default">None</span>)</span>
    169. 

  169.     <br /><em class="fname">(Constructor)</em>
    170. 

  170.   </h3>
    171. 

  171.   </td><td align="right" valign="top"
    172. 

  172.     ><span class="codelink"><a href="tagger.tagger-pysrc.html#MultiTag.__init__">source&nbsp;code</a></span>&nbsp;
    173. 

  173.     </td>
    174. 

  174.   </tr></table>
    175. 

  175.   
    176. 

  176.   
    177. 

  177.   <dl class="fields">
    178. 

  178.     <dt>Parameters:</dt>
    179. 

  179.     <dd><ul class="nomargin-top">
    180. 

  180.         <li><strong class="pname"><code>tail</code></strong> - the <a href="tagger.tagger.Tag-class.html" class="link">Tag</a> 
    181. 

  181.           object to add to the first part (head)</li>
    182. 

  182.         <li><strong class="pname"><code>head</code></strong> - the (eventually absent) <a 
    183. 

  183.           href="tagger.tagger.MultiTag-class.html" 
    184. 

  184.           class="link">MultiTag</a> to be extended</li>
    185. 

  185.     </ul></dd>
    186. 

  186.     <dt>Returns:</dt>
    187. 

  187.         <dd>a new <a href="tagger.tagger.MultiTag-class.html" 
    188. 

  188.           class="link">MultiTag</a> object</dd>
    189. 

  189.     <dt>Overrides:
    190. 

  190.         <a href="tagger.tagger.Tag-class.html#__init__">Tag.__init__</a>
    191. 

  191.     </dt>
    192. 

  192.   </dl>
    193. 

  193. </td></tr></table>
    194. 

  194. </div>
    195. 

  195. <a name="combined_rating"></a>
    196. 

  196. <div>
    197. 

  197. <table class="details" border="1" cellpadding="3"
    198. 

  198.        cellspacing="0" width="100%" bgcolor="white">
    199. 

  199. <tr><td>
    200. 

  200.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    201. 

  201.   <tr valign="top"><td>
    202. 

  202.   <h3 class="epydoc"><span class="sig"><span class="sig-name">combined_rating</span>(<span class="sig-arg">self</span>)</span>
    203. 

  203.   </h3>
    204. 

  204.   </td><td align="right" valign="top"
    205. 

  205.     ><span class="codelink"><a href="tagger.tagger-pysrc.html#MultiTag.combined_rating">source&nbsp;code</a></span>&nbsp;
    206. 

  206.     </td>
    207. 

  207.   </tr></table>
    208. 

  208.   
    209. 

  209.   <p>Method that computes the multitag's rating from the ratings of unit 
    210. 

  210.   subtags</p>
    211. 

  211.   <p>(the default implementation uses the geometric mean - with a special 
    212. 

  212.   treatment for proper nouns - but this method can be overridden)</p>
    213. 

  213.   <dl class="fields">
    214. 

  214.     <dt>Returns:</dt>
    215. 

  215.         <dd>the rating of the multitag</dd>
    216. 

  216.   </dl>
    217. 

  217. </td></tr></table>
    218. 

  218. </div>
    219. 

  219. <br />
    220. 

  220. <!-- ==================== NAVIGATION BAR ==================== -->
    221. 

  221. <table class="navbar" border="0" width="100%" cellpadding="0"
    222. 

  222.        bgcolor="#a0c0ff" cellspacing="0">
    223. 

  223.   <tr valign="middle">
    224. 

  224. 

  225.   <!-- Tree link -->
    226. 

  226.       <th>&nbsp;&nbsp;&nbsp;<a
    227. 

  227.         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    228. 

  228. 

  229.   <!-- Index link -->
    230. 

  230.       <th>&nbsp;&nbsp;&nbsp;<a
    231. 

  231.         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
    232. 

  232. 

  233.   <!-- Help link -->
    234. 

  234.       <th>&nbsp;&nbsp;&nbsp;<a
    235. 

  235.         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    236. 

  236. 

  237.   <!-- Project homepage -->
    238. 

  238.       <th class="navbar" align="right" width="100%">
    239. 

  239.         <table border="0" cellpadding="0" cellspacing="0">
    240. 

  240.           <tr><th class="navbar" align="center"
    241. 

  241.             ><a class="navbar" target="_top" href="http://github.com/apresta/tagger">tagger</a></th>
    242. 

  242.           </tr></table></th>
    243. 

  243.   </tr>
    244. 

  244. </table>
    245. 

  245. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
    246. 

  246.   <tr>
    247. 

  247.     <td align="left" class="footer">
    248. 

  248.     Generated by Epydoc 3.0.1 on Wed Jun  8 01:57:45 2011
    249. 

  249.     </td>
    250. 

  250.     <td align="right" class="footer">
    251. 

  251.       <a target="mainFrame" href="http://epydoc.sourceforge.net"
    252. 

  252.         >http://epydoc.sourceforge.net</a>
    253. 

  253.     </td>
    254. 

  254.   </tr>
    255. 

  255. </table>
    256. 

  256. 

  257. <script type="text/javascript">
    258. 

  258.   <!--
    259. 

  259.   // Private objects are initially displayed (because if
    260. 

  260.   // javascript is turned off then we want them to be
    261. 

  261.   // visible); but by default, we want to hide them.  So hide
    262. 

  262.   // them unless we have a cookie that says to show them.
    263. 

  263.   checkCookie();
    264. 

  264.   // -->
    265. 

  265. </script>
    266. 

  266. </body>
    267. 

  267. </html>
    268.