/doc/tagger.tagger.MultiTag-class.html
HTML | 267 lines | 228 code | 18 blank | 21 comment | 0 complexity | 40d7f95f060700e83fbf7aff545a328d 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.tagger.MultiTag</title> 7 <link rel="stylesheet" href="epydoc.css" type="text/css" /> 8 <script type="text/javascript" src="epydoc.js"></script> 9</head> 10 11<body bgcolor="white" text="black" link="blue" vlink="#204080" 12 alink="#204080"> 13<!-- ==================== NAVIGATION BAR ==================== --> 14<table class="navbar" border="0" width="100%" cellpadding="0" 15 bgcolor="#a0c0ff" cellspacing="0"> 16 <tr valign="middle"> 17 18 <!-- Tree link --> 19 <th> <a 20 href="module-tree.html">Trees</a> </th> 21 22 <!-- Index link --> 23 <th> <a 24 href="identifier-index.html">Indices</a> </th> 25 26 <!-- Help link --> 27 <th> <a 28 href="help.html">Help</a> </th> 29 30 <!-- Project homepage --> 31 <th class="navbar" align="right" width="100%"> 32 <table border="0" cellpadding="0" cellspacing="0"> 33 <tr><th class="navbar" align="center" 34 ><a class="navbar" target="_top" href="http://github.com/apresta/tagger">tagger</a></th> 35 </tr></table></th> 36 </tr> 37</table> 38<table width="100%" cellpadding="0" cellspacing="0"> 39 <tr valign="top"> 40 <td width="100%"> 41 <span class="breadcrumbs"> 42 Package tagger :: 43 <a href="tagger.tagger-module.html">Module tagger</a> :: 44 Class MultiTag 45 </span> 46 </td> 47 <td> 48 <table cellpadding="0" cellspacing="0"> 49 <!-- hide/show private --> 50 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" 51 onclick="toggle_private();">hide private</a>]</span></td></tr> 52 <tr><td align="right"><span class="options" 53 >[<a href="frames.html" target="_top">frames</a 54 >] | <a href="tagger.tagger.MultiTag-class.html" 55 target="_top">no frames</a>]</span></td></tr> 56 </table> 57 </td> 58 </tr> 59</table> 60<!-- ==================== CLASS DESCRIPTION ==================== --> 61<h1 class="epydoc">Class MultiTag</h1><p class="nomargin-top"><span class="codelink"><a href="tagger.tagger-pysrc.html#MultiTag">source code</a></span></p> 62<center> 63<center> <map id="class_hierarchy_for_multitag" name="class_hierarchy_for_multitag"> 64<area shape="rect" id="node1" href="tagger.tagger.MultiTag-class.html" title="MultiTag" alt="" coords="5,61,88,88"/> 65<area shape="rect" id="node2" href="tagger.tagger.Tag-class.html" title="Tag" alt="" coords="23,5,71,32"/> 66</map> 67 <img src="class_hierarchy_for_multitag.gif" alt='' usemap="#class_hierarchy_for_multitag" ismap="ismap" class="graph-without-title" /> 68</center> 69</center> 70<hr /> 71<p>Class for aggregates of tags (usually next to each other in the 72 document)</p> 73 74<!-- ==================== INSTANCE METHODS ==================== --> 75<a name="section-InstanceMethods"></a> 76<table class="summary" border="1" cellpadding="3" 77 cellspacing="0" width="100%" bgcolor="white"> 78<tr bgcolor="#70b0f0" class="table-header"> 79 <td colspan="2" class="table-header"> 80 <table border="0" cellpadding="0" cellspacing="0" width="100%"> 81 <tr valign="top"> 82 <td align="left"><span class="table-header">Instance Methods</span></td> 83 <td align="right" valign="top" 84 ><span class="options">[<a href="#section-InstanceMethods" 85 class="privatelink" onclick="toggle_private();" 86 >hide private</a>]</span></td> 87 </tr> 88 </table> 89 </td> 90</tr> 91<tr> 92 <td width="15%" align="right" valign="top" class="summary"> 93 <span class="summary-type"> </span> 94 </td><td class="summary"> 95 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 96 <tr> 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 <span class="summary-sig-arg">tail</span>, 99 <span class="summary-sig-arg">head</span>=<span class="summary-sig-default">None</span>)</span><br /> 100 Returns: 101 a new <a href="tagger.tagger.MultiTag-class.html" 102 class="link">MultiTag</a> object</td> 103 <td align="right" valign="top"> 104 <span class="codelink"><a href="tagger.tagger-pysrc.html#MultiTag.__init__">source code</a></span> 105 106 </td> 107 </tr> 108 </table> 109 110 </td> 111 </tr> 112<tr> 113 <td width="15%" align="right" valign="top" class="summary"> 114 <span class="summary-type"> </span> 115 </td><td class="summary"> 116 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 117 <tr> 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 Method that computes the multitag's rating from the ratings of unit 120 subtags</td> 121 <td align="right" valign="top"> 122 <span class="codelink"><a href="tagger.tagger-pysrc.html#MultiTag.combined_rating">source code</a></span> 123 124 </td> 125 </tr> 126 </table> 127 128 </td> 129 </tr> 130 <tr> 131 <td colspan="2" class="summary"> 132 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="tagger.tagger.Tag-class.html">Tag</a></code></b>: 133 <code><a href="tagger.tagger.Tag-class.html#__eq__">__eq__</a></code>, 134 <code><a href="tagger.tagger.Tag-class.html#__hash__">__hash__</a></code>, 135 <code><a href="tagger.tagger.Tag-class.html#__lt__">__lt__</a></code>, 136 <code><a href="tagger.tagger.Tag-class.html#__repr__">__repr__</a></code> 137 </p> 138 </td> 139 </tr> 140</table> 141<!-- ==================== METHOD DETAILS ==================== --> 142<a name="section-MethodDetails"></a> 143<table class="details" border="1" cellpadding="3" 144 cellspacing="0" width="100%" bgcolor="white"> 145<tr bgcolor="#70b0f0" class="table-header"> 146 <td colspan="2" class="table-header"> 147 <table border="0" cellpadding="0" cellspacing="0" width="100%"> 148 <tr valign="top"> 149 <td align="left"><span class="table-header">Method Details</span></td> 150 <td align="right" valign="top" 151 ><span class="options">[<a href="#section-MethodDetails" 152 class="privatelink" onclick="toggle_private();" 153 >hide private</a>]</span></td> 154 </tr> 155 </table> 156 </td> 157</tr> 158</table> 159<a name="__init__"></a> 160<div> 161<table class="details" border="1" cellpadding="3" 162 cellspacing="0" width="100%" bgcolor="white"> 163<tr><td> 164 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 165 <tr valign="top"><td> 166 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, 167 <span class="sig-arg">tail</span>, 168 <span class="sig-arg">head</span>=<span class="sig-default">None</span>)</span> 169 <br /><em class="fname">(Constructor)</em> 170 </h3> 171 </td><td align="right" valign="top" 172 ><span class="codelink"><a href="tagger.tagger-pysrc.html#MultiTag.__init__">source code</a></span> 173 </td> 174 </tr></table> 175 176 177 <dl class="fields"> 178 <dt>Parameters:</dt> 179 <dd><ul class="nomargin-top"> 180 <li><strong class="pname"><code>tail</code></strong> - the <a href="tagger.tagger.Tag-class.html" class="link">Tag</a> 181 object to add to the first part (head)</li> 182 <li><strong class="pname"><code>head</code></strong> - the (eventually absent) <a 183 href="tagger.tagger.MultiTag-class.html" 184 class="link">MultiTag</a> to be extended</li> 185 </ul></dd> 186 <dt>Returns:</dt> 187 <dd>a new <a href="tagger.tagger.MultiTag-class.html" 188 class="link">MultiTag</a> object</dd> 189 <dt>Overrides: 190 <a href="tagger.tagger.Tag-class.html#__init__">Tag.__init__</a> 191 </dt> 192 </dl> 193</td></tr></table> 194</div> 195<a name="combined_rating"></a> 196<div> 197<table class="details" border="1" cellpadding="3" 198 cellspacing="0" width="100%" bgcolor="white"> 199<tr><td> 200 <table width="100%" cellpadding="0" cellspacing="0" border="0"> 201 <tr valign="top"><td> 202 <h3 class="epydoc"><span class="sig"><span class="sig-name">combined_rating</span>(<span class="sig-arg">self</span>)</span> 203 </h3> 204 </td><td align="right" valign="top" 205 ><span class="codelink"><a href="tagger.tagger-pysrc.html#MultiTag.combined_rating">source code</a></span> 206 </td> 207 </tr></table> 208 209 <p>Method that computes the multitag's rating from the ratings of unit 210 subtags</p> 211 <p>(the default implementation uses the geometric mean - with a special 212 treatment for proper nouns - but this method can be overridden)</p> 213 <dl class="fields"> 214 <dt>Returns:</dt> 215 <dd>the rating of the multitag</dd> 216 </dl> 217</td></tr></table> 218</div> 219<br /> 220<!-- ==================== NAVIGATION BAR ==================== --> 221<table class="navbar" border="0" width="100%" cellpadding="0" 222 bgcolor="#a0c0ff" cellspacing="0"> 223 <tr valign="middle"> 224 225 <!-- Tree link --> 226 <th> <a 227 href="module-tree.html">Trees</a> </th> 228 229 <!-- Index link --> 230 <th> <a 231 href="identifier-index.html">Indices</a> </th> 232 233 <!-- Help link --> 234 <th> <a 235 href="help.html">Help</a> </th> 236 237 <!-- Project homepage --> 238 <th class="navbar" align="right" width="100%"> 239 <table border="0" cellpadding="0" cellspacing="0"> 240 <tr><th class="navbar" align="center" 241 ><a class="navbar" target="_top" href="http://github.com/apresta/tagger">tagger</a></th> 242 </tr></table></th> 243 </tr> 244</table> 245<table border="0" cellpadding="0" cellspacing="0" width="100%%"> 246 <tr> 247 <td align="left" class="footer"> 248 Generated by Epydoc 3.0.1 on Wed Jun 8 01:57:45 2011 249 </td> 250 <td align="right" class="footer"> 251 <a target="mainFrame" href="http://epydoc.sourceforge.net" 252 >http://epydoc.sourceforge.net</a> 253 </td> 254 </tr> 255</table> 256 257<script type="text/javascript"> 258 <!-- 259 // Private objects are initially displayed (because if 260 // javascript is turned off then we want them to be 261 // visible); but by default, we want to hide them. So hide 262 // them unless we have a cookie that says to show them. 263 checkCookie(); 264 // --> 265</script> 266</body> 267</html>