/apidocs/pyechonest.artist.SimilarDocumentSet-class.html

http://echo-nest-remix.googlecode.com/ · HTML · 379 lines · 328 code · 29 blank · 22 comment · 0 complexity · 27b1d31cdc49732f0f3467d4403c2e39 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>pyechonest.artist.SimilarDocumentSet</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://code.google.com/p/echo-nest-remix/">The Echo Nest Remix API, SVN Revision: 448</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.         <a href="pyechonest-module.html">Package&nbsp;pyechonest</a> ::
    43. 

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

  44.         Class&nbsp;SimilarDocumentSet
    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="pyechonest.artist.SimilarDocumentSet-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 SimilarDocumentSet</h1><p class="nomargin-top"><span class="codelink"><a href="pyechonest.artist-pysrc.html#SimilarDocumentSet">source&nbsp;code</a></span></p>
    62. 

  62. <center>
    63. 

  63. 

  64. </center>
    65. 

  65. <hr />
    66. 

  66. <!-- ==================== INSTANCE METHODS ==================== -->
    67. 

  67. <a name="section-InstanceMethods"></a>
    68. 

  68. <table class="summary" border="1" cellpadding="3"
    69. 

  69.        cellspacing="0" width="100%" bgcolor="white">
    70. 

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

  71.   <td colspan="2" class="table-header">
    72. 

  72.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    73. 

  73.       <tr valign="top">
    74. 

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

  75.         <td align="right" valign="top"
    76. 

  76.          ><span class="options">[<a href="#section-InstanceMethods"
    77. 

  77.          class="privatelink" onclick="toggle_private();"
    78. 

  78.          >hide private</a>]</span></td>
    79. 

  79.       </tr>
    80. 

  80.     </table>
    81. 

  81.   </td>
    82. 

  82. </tr>
    83. 

  83. <tr>
    84. 

  84.     <td width="15%" align="right" valign="top" class="summary">
    85. 

  85.       <span class="summary-type">&nbsp;</span>
    86. 

  86.     </td><td class="summary">
    87. 

  87.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    88. 

  88.         <tr>
    89. 

  89.           <td><span class="summary-sig"><a href="pyechonest.artist.SimilarDocumentSet-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
    90. 

  90.         <span class="summary-sig-arg">identifier</span>)</span><br />
    91. 

  91.       x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
    92. 

  92.           <td align="right" valign="top">
    93. 

  93.             <span class="codelink"><a href="pyechonest.artist-pysrc.html#SimilarDocumentSet.__init__">source&nbsp;code</a></span>
    94. 

  94.             
    95. 

  95.           </td>
    96. 

  96.         </tr>
    97. 

  97.       </table>
    98. 

  98.       
    99. 

  99.     </td>
    100. 

  100.   </tr>
    101. 

  101. <tr>
    102. 

  102.     <td width="15%" align="right" valign="top" class="summary">
    103. 

  103.       <span class="summary-type">&nbsp;</span>
    104. 

  104.     </td><td class="summary">
    105. 

  105.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    106. 

  106.         <tr>
    107. 

  107.           <td><span class="summary-sig"><a href="pyechonest.artist.SimilarDocumentSet-class.html#__len__" class="summary-sig-name">__len__</a>(<span class="summary-sig-arg">self</span>)</span></td>
    108. 

  108.           <td align="right" valign="top">
    109. 

  109.             <span class="codelink"><a href="pyechonest.artist-pysrc.html#SimilarDocumentSet.__len__">source&nbsp;code</a></span>
    110. 

  110.             
    111. 

  111.           </td>
    112. 

  112.         </tr>
    113. 

  113.       </table>
    114. 

  114.       
    115. 

  115.     </td>
    116. 

  116.   </tr>
    117. 

  117. <tr>
    118. 

  118.     <td width="15%" align="right" valign="top" class="summary">
    119. 

  119.       <span class="summary-type">&nbsp;</span>
    120. 

  120.     </td><td class="summary">
    121. 

  121.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    122. 

  122.         <tr>
    123. 

  123.           <td><span class="summary-sig"><a href="pyechonest.artist.SimilarDocumentSet-class.html#__getitem__" class="summary-sig-name">__getitem__</a>(<span class="summary-sig-arg">self</span>,
    124. 

  124.         <span class="summary-sig-arg">k</span>)</span></td>
    125. 

  125.           <td align="right" valign="top">
    126. 

  126.             <span class="codelink"><a href="pyechonest.artist-pysrc.html#SimilarDocumentSet.__getitem__">source&nbsp;code</a></span>
    127. 

  127.             
    128. 

  128.           </td>
    129. 

  129.         </tr>
    130. 

  130.       </table>
    131. 

  131.       
    132. 

  132.     </td>
    133. 

  133.   </tr>
    134. 

  134. <tr>
    135. 

  135.     <td width="15%" align="right" valign="top" class="summary">
    136. 

  136.       <span class="summary-type">&nbsp;</span>
    137. 

  137.     </td><td class="summary">
    138. 

  138.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    139. 

  139.         <tr>
    140. 

  140.           <td><span class="summary-sig"><a name="chunk_magic"></a><span class="summary-sig-name">chunk_magic</span>(<span class="summary-sig-arg">self</span>,
    141. 

  141.         <span class="summary-sig-arg">k</span>)</span></td>
    142. 

  142.           <td align="right" valign="top">
    143. 

  143.             <span class="codelink"><a href="pyechonest.artist-pysrc.html#SimilarDocumentSet.chunk_magic">source&nbsp;code</a></span>
    144. 

  144.             
    145. 

  145.           </td>
    146. 

  146.         </tr>
    147. 

  147.       </table>
    148. 

  148.       
    149. 

  149.     </td>
    150. 

  150.   </tr>
    151. 

  151. <tr class="private">
    152. 

  152.     <td width="15%" align="right" valign="top" class="summary">
    153. 

  153.       <span class="summary-type">&nbsp;</span>
    154. 

  154.     </td><td class="summary">
    155. 

  155.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    156. 

  156.         <tr>
    157. 

  157.           <td><span class="summary-sig"><a href="pyechonest.artist.SimilarDocumentSet-class.html#_parse_element" class="summary-sig-name" onclick="show_private();">_parse_element</a>(<span class="summary-sig-arg">self</span>,
    158. 

  158.         <span class="summary-sig-arg">element</span>)</span></td>
    159. 

  159.           <td align="right" valign="top">
    160. 

  160.             <span class="codelink"><a href="pyechonest.artist-pysrc.html#SimilarDocumentSet._parse_element">source&nbsp;code</a></span>
    161. 

  161.             
    162. 

  162.           </td>
    163. 

  163.         </tr>
    164. 

  164.       </table>
    165. 

  165.       
    166. 

  166.     </td>
    167. 

  167.   </tr>
    168. 

  168.   <tr>
    169. 

  169.     <td colspan="2" class="summary">
    170. 

  170.     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="pyechonest.document.DocumentSet-class.html">document.DocumentSet</a></code></b>:
    171. 

  171.       <code><a href="pyechonest.document.DocumentSet-class.html#__iter__">__iter__</a></code>
    172. 

  172.       </p>
    173. 

  173.     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
    174. 

  174.       <code>__delattr__</code>,
    175. 

  175.       <code>__format__</code>,
    176. 

  176.       <code>__getattribute__</code>,
    177. 

  177.       <code>__hash__</code>,
    178. 

  178.       <code>__new__</code>,
    179. 

  179.       <code>__reduce__</code>,
    180. 

  180.       <code>__reduce_ex__</code>,
    181. 

  181.       <code>__repr__</code>,
    182. 

  182.       <code>__setattr__</code>,
    183. 

  183.       <code>__sizeof__</code>,
    184. 

  184.       <code>__str__</code>,
    185. 

  185.       <code>__subclasshook__</code>
    186. 

  186.       </p>
    187. 

  187.     </td>
    188. 

  188.   </tr>
    189. 

  189. </table>
    190. 

  190. <!-- ==================== PROPERTIES ==================== -->
    191. 

  191. <a name="section-Properties"></a>
    192. 

  192. <table class="summary" border="1" cellpadding="3"
    193. 

  193.        cellspacing="0" width="100%" bgcolor="white">
    194. 

  194. <tr bgcolor="#70b0f0" class="table-header">
    195. 

  195.   <td colspan="2" class="table-header">
    196. 

  196.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    197. 

  197.       <tr valign="top">
    198. 

  198.         <td align="left"><span class="table-header">Properties</span></td>
    199. 

  199.         <td align="right" valign="top"
    200. 

  200.          ><span class="options">[<a href="#section-Properties"
    201. 

  201.          class="privatelink" onclick="toggle_private();"
    202. 

  202.          >hide private</a>]</span></td>
    203. 

  203.       </tr>
    204. 

  204.     </table>
    205. 

  205.   </td>
    206. 

  206. </tr>
    207. 

  207.   <tr>
    208. 

  208.     <td colspan="2" class="summary">
    209. 

  209.     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
    210. 

  210.       <code>__class__</code>
    211. 

  211.       </p>
    212. 

  212.     </td>
    213. 

  213.   </tr>
    214. 

  214. </table>
    215. 

  215. <!-- ==================== METHOD DETAILS ==================== -->
    216. 

  216. <a name="section-MethodDetails"></a>
    217. 

  217. <table class="details" border="1" cellpadding="3"
    218. 

  218.        cellspacing="0" width="100%" bgcolor="white">
    219. 

  219. <tr bgcolor="#70b0f0" class="table-header">
    220. 

  220.   <td colspan="2" class="table-header">
    221. 

  221.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    222. 

  222.       <tr valign="top">
    223. 

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

  224.         <td align="right" valign="top"
    225. 

  225.          ><span class="options">[<a href="#section-MethodDetails"
    226. 

  226.          class="privatelink" onclick="toggle_private();"
    227. 

  227.          >hide private</a>]</span></td>
    228. 

  228.       </tr>
    229. 

  229.     </table>
    230. 

  230.   </td>
    231. 

  231. </tr>
    232. 

  232. </table>
    233. 

  233. <a name="__init__"></a>
    234. 

  234. <div>
    235. 

  235. <table class="details" border="1" cellpadding="3"
    236. 

  236.        cellspacing="0" width="100%" bgcolor="white">
    237. 

  237. <tr><td>
    238. 

  238.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    239. 

  239.   <tr valign="top"><td>
    240. 

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

  241.         <span class="sig-arg">identifier</span>)</span>
    242. 

  242.     <br /><em class="fname">(Constructor)</em>
    243. 

  243.   </h3>
    244. 

  244.   </td><td align="right" valign="top"
    245. 

  245.     ><span class="codelink"><a href="pyechonest.artist-pysrc.html#SimilarDocumentSet.__init__">source&nbsp;code</a></span>&nbsp;
    246. 

  246.     </td>
    247. 

  247.   </tr></table>
    248. 

  248.   
    249. 

  249.   <pre class="literalblock">
    250. 

  250. x.__init__(...) initializes x; see x.__class__.__doc__ for signature
    251. 

  251. 

  252. </pre>
    253. 

  253.   <dl class="fields">
    254. 

  254.     <dt>Overrides:
    255. 

  255.         object.__init__
    256. 

  256.         <dd><em class="note">(inherited documentation)</em></dd>
    257. 

  257.     </dt>
    258. 

  258.   </dl>
    259. 

  259. </td></tr></table>
    260. 

  260. </div>
    261. 

  261. <a name="__len__"></a>
    262. 

  262. <div>
    263. 

  263. <table class="details" border="1" cellpadding="3"
    264. 

  264.        cellspacing="0" width="100%" bgcolor="white">
    265. 

  265. <tr><td>
    266. 

  266.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    267. 

  267.   <tr valign="top"><td>
    268. 

  268.   <h3 class="epydoc"><span class="sig"><span class="sig-name">__len__</span>(<span class="sig-arg">self</span>)</span>
    269. 

  269.     <br /><em class="fname">(Length operator)</em>
    270. 

  270.   </h3>
    271. 

  271.   </td><td align="right" valign="top"
    272. 

  272.     ><span class="codelink"><a href="pyechonest.artist-pysrc.html#SimilarDocumentSet.__len__">source&nbsp;code</a></span>&nbsp;
    273. 

  273.     </td>
    274. 

  274.   </tr></table>
    275. 

  275.   
    276. 

  276.   
    277. 

  277.   <dl class="fields">
    278. 

  278.     <dt>Overrides:
    279. 

  279.         <a href="pyechonest.document.DocumentSet-class.html#__len__">document.DocumentSet.__len__</a>
    280. 

  280.     </dt>
    281. 

  281.   </dl>
    282. 

  282. </td></tr></table>
    283. 

  283. </div>
    284. 

  284. <a name="__getitem__"></a>
    285. 

  285. <div>
    286. 

  286. <table class="details" border="1" cellpadding="3"
    287. 

  287.        cellspacing="0" width="100%" bgcolor="white">
    288. 

  288. <tr><td>
    289. 

  289.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    290. 

  290.   <tr valign="top"><td>
    291. 

  291.   <h3 class="epydoc"><span class="sig"><span class="sig-name">__getitem__</span>(<span class="sig-arg">self</span>,
    292. 

  292.         <span class="sig-arg">k</span>)</span>
    293. 

  293.     <br /><em class="fname">(Indexing operator)</em>
    294. 

  294.   </h3>
    295. 

  295.   </td><td align="right" valign="top"
    296. 

  296.     ><span class="codelink"><a href="pyechonest.artist-pysrc.html#SimilarDocumentSet.__getitem__">source&nbsp;code</a></span>&nbsp;
    297. 

  297.     </td>
    298. 

  298.   </tr></table>
    299. 

  299.   
    300. 

  300.   
    301. 

  301.   <dl class="fields">
    302. 

  302.     <dt>Overrides:
    303. 

  303.         <a href="pyechonest.document.DocumentSet-class.html#__getitem__">document.DocumentSet.__getitem__</a>
    304. 

  304.     </dt>
    305. 

  305.   </dl>
    306. 

  306. </td></tr></table>
    307. 

  307. </div>
    308. 

  308. <a name="_parse_element"></a>
    309. 

  309. <div class="private">
    310. 

  310. <table class="details" border="1" cellpadding="3"
    311. 

  311.        cellspacing="0" width="100%" bgcolor="white">
    312. 

  312. <tr><td>
    313. 

  313.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    314. 

  314.   <tr valign="top"><td>
    315. 

  315.   <h3 class="epydoc"><span class="sig"><span class="sig-name">_parse_element</span>(<span class="sig-arg">self</span>,
    316. 

  316.         <span class="sig-arg">element</span>)</span>
    317. 

  317.   </h3>
    318. 

  318.   </td><td align="right" valign="top"
    319. 

  319.     ><span class="codelink"><a href="pyechonest.artist-pysrc.html#SimilarDocumentSet._parse_element">source&nbsp;code</a></span>&nbsp;
    320. 

  320.     </td>
    321. 

  321.   </tr></table>
    322. 

  322.   
    323. 

  323.   
    324. 

  324.   <dl class="fields">
    325. 

  325.     <dt>Overrides:
    326. 

  326.         <a href="pyechonest.document.DocumentSet-class.html#_parse_element" onclick="show_private();">document.DocumentSet._parse_element</a>
    327. 

  327.     </dt>
    328. 

  328.   </dl>
    329. 

  329. </td></tr></table>
    330. 

  330. </div>
    331. 

  331. <br />
    332. 

  332. <!-- ==================== NAVIGATION BAR ==================== -->
    333. 

  333. <table class="navbar" border="0" width="100%" cellpadding="0"
    334. 

  334.        bgcolor="#a0c0ff" cellspacing="0">
    335. 

  335.   <tr valign="middle">
    336. 

  336. 

  337.   <!-- Tree link -->
    338. 

  338.       <th>&nbsp;&nbsp;&nbsp;<a
    339. 

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

  340. 

  341.   <!-- Index link -->
    342. 

  342.       <th>&nbsp;&nbsp;&nbsp;<a
    343. 

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

  344. 

  345.   <!-- Help link -->
    346. 

  346.       <th>&nbsp;&nbsp;&nbsp;<a
    347. 

  347.         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    348. 

  348. 

  349.   <!-- Project homepage -->
    350. 

  350.       <th class="navbar" align="right" width="100%">
    351. 

  351.         <table border="0" cellpadding="0" cellspacing="0">
    352. 

  352.           <tr><th class="navbar" align="center"
    353. 

  353.             ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">The Echo Nest Remix API, SVN Revision: 448</a></th>
    354. 

  354.           </tr></table></th>
    355. 

  355.   </tr>
    356. 

  356. </table>
    357. 

  357. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
    358. 

  358.   <tr>
    359. 

  359.     <td align="left" class="footer">
    360. 

  360.     Generated by Epydoc 3.0.1 on Wed May 26 12:18:01 2010
    361. 

  361.     </td>
    362. 

  362.     <td align="right" class="footer">
    363. 

  363.       <a target="mainFrame" href="http://epydoc.sourceforge.net"
    364. 

  364.         >http://epydoc.sourceforge.net</a>
    365. 

  365.     </td>
    366. 

  366.   </tr>
    367. 

  367. </table>
    368. 

  368. 

  369. <script type="text/javascript">
    370. 

  370.   <!--
    371. 

  371.   // Private objects are initially displayed (because if
    372. 

  372.   // javascript is turned off then we want them to be
    373. 

  373.   // visible); but by default, we want to hide them.  So hide
    374. 

  374.   // them unless we have a cookie that says to show them.
    375. 

  375.   checkCookie();
    376. 

  376.   // -->
    377. 

  377. </script>
    378. 

  378. </body>
    379. 

  379. </html>
    380.