Sk.builtin.bool.html 32 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: bool</title>
  6. <script src="scripts/prettify/prettify.js"> </script>
  7. <script src="scripts/prettify/lang-css.js"> </script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  12. <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">Class: bool</h1>
  17. <section>
  18. <header>
  19. <h2>
  20. <span class="ancestors"><a href="Sk.html">Sk</a><a href="Sk.builtin.html">.builtin</a>.</span>
  21. bool
  22. </h2>
  23. </header>
  24. <article>
  25. <div class="container-overview">
  26. <h4 class="name" id="bool"><span class="type-signature"></span>new bool<span class="signature">(x)</span><span class="type-signature"> &rarr; {<a href="Sk.builtin.bool.html">Sk.builtin.bool</a>}</span></h4>
  27. <div class="description">
  28. <p>Constructor for Python bool. Also used for builtin bool() function.</p>
  29. <p>Where possible, do not create a new instance but use the constants
  30. Sk.builtin.bool.true$ or Sk.builtin.bool.false$. These are defined in src/constant.js</p>
  31. </div>
  32. <h5>Parameters:</h5>
  33. <table class="params">
  34. <thead>
  35. <tr>
  36. <th>Name</th>
  37. <th>Type</th>
  38. <th class="last">Description</th>
  39. </tr>
  40. </thead>
  41. <tbody>
  42. <tr>
  43. <td class="name"><code>x</code></td>
  44. <td class="type">
  45. <span class="param-type">Object</span>
  46. |
  47. <span class="param-type">number</span>
  48. |
  49. <span class="param-type">boolean</span>
  50. </td>
  51. <td class="description last"><p>Value to evaluate as true or false</p></td>
  52. </tr>
  53. </tbody>
  54. </table>
  55. <dl class="details">
  56. <dt class="tag-source">Source:</dt>
  57. <dd class="tag-source"><ul class="dummy"><li>
  58. <a href="bool.js.html">bool.js</a>, <a href="bool.js.html#line1">line 1</a>
  59. </li></ul></dd>
  60. </dl>
  61. <h5>Returns:</h5>
  62. <div class="param-desc">
  63. <p>Sk.builtin.bool.true$ if x is true, Sk.builtin.bool.false$ otherwise</p>
  64. </div>
  65. <dl>
  66. <dt>
  67. Type
  68. </dt>
  69. <dd>
  70. <span class="param-type"><a href="Sk.builtin.bool.html">Sk.builtin.bool</a></span>
  71. </dd>
  72. </dl>
  73. </div>
  74. <h3 class="subsection-title">Extends</h3>
  75. <ul>
  76. <li><a href="Sk.builtin.object.html">Sk.builtin.object</a></li>
  77. </ul>
  78. <h3 class="subsection-title">Members</h3>
  79. <h4 class="name" id=".false$"><span class="type-signature">(static) </span>false$<span class="type-signature"> :<a href="Sk.builtin.bool.html">Sk.builtin.bool</a></span></h4>
  80. <div class="description">
  81. <p>Python bool False constant.</p>
  82. </div>
  83. <h5>Type:</h5>
  84. <ul>
  85. <li>
  86. <span class="param-type"><a href="Sk.builtin.bool.html">Sk.builtin.bool</a></span>
  87. </li>
  88. </ul>
  89. <dl class="details">
  90. <dt class="tag-source">Source:</dt>
  91. <dd class="tag-source"><ul class="dummy"><li>
  92. <a href="constants.js.html">constants.js</a>, <a href="constants.js.html#line15">line 15</a>
  93. </li></ul></dd>
  94. </dl>
  95. <h4 class="name" id=".true$"><span class="type-signature">(static) </span>true$<span class="type-signature"> :<a href="Sk.builtin.bool.html">Sk.builtin.bool</a></span></h4>
  96. <div class="description">
  97. <p>Python bool True constant.</p>
  98. </div>
  99. <h5>Type:</h5>
  100. <ul>
  101. <li>
  102. <span class="param-type"><a href="Sk.builtin.bool.html">Sk.builtin.bool</a></span>
  103. </li>
  104. </ul>
  105. <dl class="details">
  106. <dt class="tag-source">Source:</dt>
  107. <dd class="tag-source"><ul class="dummy"><li>
  108. <a href="constants.js.html">constants.js</a>, <a href="constants.js.html#line8">line 8</a>
  109. </li></ul></dd>
  110. </dl>
  111. <h4 class="name" id="$r"><span class="type-signature"></span>$r<span class="type-signature"></span></h4>
  112. <div class="description">
  113. <p>Return the string representation of this instance.</p>
  114. <p>Javascript function, returns Python object.</p>
  115. </div>
  116. <dl class="details">
  117. <dt class="inherited-from">Inherited From:</dt>
  118. <dd class="inherited-from"><ul class="dummy"><li>
  119. <a href="Sk.builtin.object.html#$r">Sk.builtin.object#$r</a>
  120. </li></ul></dd>
  121. <dt class="tag-source">Source:</dt>
  122. <dd class="tag-source"><ul class="dummy"><li>
  123. <a href="object.js.html">object.js</a>, <a href="object.js.html#line253">line 253</a>
  124. </li></ul></dd>
  125. </dl>
  126. <h4 class="name" id="__eq__"><span class="type-signature"></span>__eq__<span class="type-signature"></span></h4>
  127. <div class="description">
  128. <p>Python wrapper for <code>__eq__</code> method.</p>
  129. </div>
  130. <dl class="details">
  131. <dt class="inherited-from">Inherited From:</dt>
  132. <dd class="inherited-from"><ul class="dummy"><li>
  133. <a href="Sk.builtin.object.html#__eq__">Sk.builtin.object#__eq__</a>
  134. </li></ul></dd>
  135. <dt class="tag-source">Source:</dt>
  136. <dd class="tag-source"><ul class="dummy"><li>
  137. <a href="object.js.html">object.js</a>, <a href="object.js.html#line179">line 179</a>
  138. </li></ul></dd>
  139. </dl>
  140. <h4 class="name" id="__ge__"><span class="type-signature"></span>__ge__<span class="type-signature"></span></h4>
  141. <div class="description">
  142. <p>Python wrapper for <code>__ge__</code> method.</p>
  143. </div>
  144. <dl class="details">
  145. <dt class="inherited-from">Inherited From:</dt>
  146. <dd class="inherited-from"><ul class="dummy"><li>
  147. <a href="Sk.builtin.object.html#__ge__">Sk.builtin.object#__ge__</a>
  148. </li></ul></dd>
  149. <dt class="tag-source">Source:</dt>
  150. <dd class="tag-source"><ul class="dummy"><li>
  151. <a href="object.js.html">object.js</a>, <a href="object.js.html#line239">line 239</a>
  152. </li></ul></dd>
  153. </dl>
  154. <h4 class="name" id="__gt__"><span class="type-signature"></span>__gt__<span class="type-signature"></span></h4>
  155. <div class="description">
  156. <p>Python wrapper for <code>__gt__</code> method.</p>
  157. </div>
  158. <dl class="details">
  159. <dt class="inherited-from">Inherited From:</dt>
  160. <dd class="inherited-from"><ul class="dummy"><li>
  161. <a href="Sk.builtin.object.html#__gt__">Sk.builtin.object#__gt__</a>
  162. </li></ul></dd>
  163. <dt class="tag-source">Source:</dt>
  164. <dd class="tag-source"><ul class="dummy"><li>
  165. <a href="object.js.html">object.js</a>, <a href="object.js.html#line227">line 227</a>
  166. </li></ul></dd>
  167. </dl>
  168. <h4 class="name" id="__hash__"><span class="type-signature"></span>__hash__<span class="type-signature"></span></h4>
  169. <div class="description">
  170. <p>Python wrapper for <code>__hash__</code> method.</p>
  171. </div>
  172. <dl class="details">
  173. <dt class="inherited-from">Inherited From:</dt>
  174. <dd class="inherited-from"><ul class="dummy"><li>
  175. <a href="Sk.builtin.object.html#__hash__">Sk.builtin.object#__hash__</a>
  176. </li></ul></dd>
  177. <dt class="tag-source">Source:</dt>
  178. <dd class="tag-source"><ul class="dummy"><li>
  179. <a href="object.js.html">object.js</a>, <a href="object.js.html#line167">line 167</a>
  180. </li></ul></dd>
  181. </dl>
  182. <h4 class="name" id="__le__"><span class="type-signature"></span>__le__<span class="type-signature"></span></h4>
  183. <div class="description">
  184. <p>Python wrapper for <code>__le__</code> method.</p>
  185. </div>
  186. <dl class="details">
  187. <dt class="inherited-from">Inherited From:</dt>
  188. <dd class="inherited-from"><ul class="dummy"><li>
  189. <a href="Sk.builtin.object.html#__le__">Sk.builtin.object#__le__</a>
  190. </li></ul></dd>
  191. <dt class="tag-source">Source:</dt>
  192. <dd class="tag-source"><ul class="dummy"><li>
  193. <a href="object.js.html">object.js</a>, <a href="object.js.html#line215">line 215</a>
  194. </li></ul></dd>
  195. </dl>
  196. <h4 class="name" id="__lt__"><span class="type-signature"></span>__lt__<span class="type-signature"></span></h4>
  197. <div class="description">
  198. <p>Python wrapper for <code>__lt__</code> method.</p>
  199. </div>
  200. <dl class="details">
  201. <dt class="inherited-from">Inherited From:</dt>
  202. <dd class="inherited-from"><ul class="dummy"><li>
  203. <a href="Sk.builtin.object.html#__lt__">Sk.builtin.object#__lt__</a>
  204. </li></ul></dd>
  205. <dt class="tag-source">Source:</dt>
  206. <dd class="tag-source"><ul class="dummy"><li>
  207. <a href="object.js.html">object.js</a>, <a href="object.js.html#line203">line 203</a>
  208. </li></ul></dd>
  209. </dl>
  210. <h4 class="name" id="__ne__"><span class="type-signature"></span>__ne__<span class="type-signature"></span></h4>
  211. <div class="description">
  212. <p>Python wrapper for <code>__ne__</code> method.</p>
  213. </div>
  214. <dl class="details">
  215. <dt class="inherited-from">Inherited From:</dt>
  216. <dd class="inherited-from"><ul class="dummy"><li>
  217. <a href="Sk.builtin.object.html#__ne__">Sk.builtin.object#__ne__</a>
  218. </li></ul></dd>
  219. <dt class="tag-source">Source:</dt>
  220. <dd class="tag-source"><ul class="dummy"><li>
  221. <a href="object.js.html">object.js</a>, <a href="object.js.html#line191">line 191</a>
  222. </li></ul></dd>
  223. </dl>
  224. <h4 class="name" id="__repr__"><span class="type-signature"></span>__repr__<span class="type-signature"></span></h4>
  225. <div class="description">
  226. <p>Python wrapper for <code>__repr__</code> method.</p>
  227. </div>
  228. <dl class="details">
  229. <dt class="inherited-from">Inherited From:</dt>
  230. <dd class="inherited-from"><ul class="dummy"><li>
  231. <a href="Sk.builtin.object.html#__repr__">Sk.builtin.object#__repr__</a>
  232. </li></ul></dd>
  233. <dt class="tag-source">Source:</dt>
  234. <dd class="tag-source"><ul class="dummy"><li>
  235. <a href="object.js.html">object.js</a>, <a href="object.js.html#line143">line 143</a>
  236. </li></ul></dd>
  237. </dl>
  238. <h4 class="name" id="__str__"><span class="type-signature"></span>__str__<span class="type-signature"></span></h4>
  239. <div class="description">
  240. <p>Python wrapper for <code>__str__</code> method.</p>
  241. </div>
  242. <dl class="details">
  243. <dt class="inherited-from">Inherited From:</dt>
  244. <dd class="inherited-from"><ul class="dummy"><li>
  245. <a href="Sk.builtin.object.html#__str__">Sk.builtin.object#__str__</a>
  246. </li></ul></dd>
  247. <dt class="tag-source">Source:</dt>
  248. <dd class="tag-source"><ul class="dummy"><li>
  249. <a href="object.js.html">object.js</a>, <a href="object.js.html#line155">line 155</a>
  250. </li></ul></dd>
  251. </dl>
  252. <h4 class="name" id="ob$type"><span class="type-signature"></span>ob$type<span class="type-signature"> :Sk.builtin.type</span></h4>
  253. <div class="description">
  254. <p>The type object of this class.</p>
  255. </div>
  256. <h5>Type:</h5>
  257. <ul>
  258. <li>
  259. <span class="param-type">Sk.builtin.type</span>
  260. </li>
  261. </ul>
  262. <dl class="details">
  263. <dt class="inherited-from">Inherited From:</dt>
  264. <dd class="inherited-from"><ul class="dummy"><li>
  265. <a href="Sk.builtin.object.html#ob$type">Sk.builtin.object#ob$type</a>
  266. </li></ul></dd>
  267. <dt class="tag-source">Source:</dt>
  268. <dd class="tag-source"><ul class="dummy"><li>
  269. <a href="object.js.html">object.js</a>, <a href="object.js.html#line138">line 138</a>
  270. </li></ul></dd>
  271. </dl>
  272. <h4 class="name" id="tp$name"><span class="type-signature"></span>tp$name<span class="type-signature"> :string</span></h4>
  273. <div class="description">
  274. <p>The name of this class.</p>
  275. </div>
  276. <h5>Type:</h5>
  277. <ul>
  278. <li>
  279. <span class="param-type">string</span>
  280. </li>
  281. </ul>
  282. <dl class="details">
  283. <dt class="inherited-from">Inherited From:</dt>
  284. <dd class="inherited-from"><ul class="dummy"><li>
  285. <a href="Sk.builtin.object.html#tp$name">Sk.builtin.object#tp$name</a>
  286. </li></ul></dd>
  287. <dt class="tag-source">Source:</dt>
  288. <dd class="tag-source"><ul class="dummy"><li>
  289. <a href="object.js.html">object.js</a>, <a href="object.js.html#line132">line 132</a>
  290. </li></ul></dd>
  291. </dl>
  292. <h3 class="subsection-title">Methods</h3>
  293. <h4 class="name" id="GenericGetAttr"><span class="type-signature"></span>GenericGetAttr<span class="signature">()</span><span class="type-signature"> &rarr; {undefined}</span></h4>
  294. <dl class="details">
  295. <dt class="inherited-from">Inherited From:</dt>
  296. <dd class="inherited-from"><ul class="dummy"><li>
  297. <a href="Sk.builtin.object.html#GenericGetAttr">Sk.builtin.object#GenericGetAttr</a>
  298. </li></ul></dd>
  299. <dt class="tag-source">Source:</dt>
  300. <dd class="tag-source"><ul class="dummy"><li>
  301. <a href="object.js.html">object.js</a>, <a href="object.js.html#line26">line 26</a>
  302. </li></ul></dd>
  303. </dl>
  304. <h5>Returns:</h5>
  305. <dl>
  306. <dt>
  307. Type
  308. </dt>
  309. <dd>
  310. <span class="param-type">undefined</span>
  311. </dd>
  312. </dl>
  313. <h4 class="name" id="ob$eq"><span class="type-signature"></span>ob$eq<span class="signature">(other)</span><span class="type-signature"> &rarr; {<a href="Sk.builtin.bool.html">Sk.builtin.bool</a>|<a href="Sk.builtin.NotImplemented.html">Sk.builtin.NotImplemented</a>}</span></h4>
  314. <div class="description">
  315. <p>Perform equality check between this instance and a Python object (i.e. this == other).</p>
  316. <p>Implements <code>__eq__</code> dunder method.</p>
  317. <p>Javascript function, returns Python object.</p>
  318. </div>
  319. <h5>Parameters:</h5>
  320. <table class="params">
  321. <thead>
  322. <tr>
  323. <th>Name</th>
  324. <th>Type</th>
  325. <th class="last">Description</th>
  326. </tr>
  327. </thead>
  328. <tbody>
  329. <tr>
  330. <td class="name"><code>other</code></td>
  331. <td class="type">
  332. <span class="param-type">Object</span>
  333. </td>
  334. <td class="description last"><p>The Python object to check for equality.</p></td>
  335. </tr>
  336. </tbody>
  337. </table>
  338. <dl class="details">
  339. <dt class="inherited-from">Inherited From:</dt>
  340. <dd class="inherited-from"><ul class="dummy"><li>
  341. <a href="Sk.builtin.object.html#ob$eq">Sk.builtin.object#ob$eq</a>
  342. </li></ul></dd>
  343. <dt class="tag-source">Source:</dt>
  344. <dd class="tag-source"><ul class="dummy"><li>
  345. <a href="object.js.html">object.js</a>, <a href="object.js.html#line293">line 293</a>
  346. </li></ul></dd>
  347. </dl>
  348. <h5>Returns:</h5>
  349. <div class="param-desc">
  350. <p>true if equal, false otherwise</p>
  351. </div>
  352. <dl>
  353. <dt>
  354. Type
  355. </dt>
  356. <dd>
  357. <span class="param-type"><a href="Sk.builtin.bool.html">Sk.builtin.bool</a></span>
  358. |
  359. <span class="param-type"><a href="Sk.builtin.NotImplemented.html">Sk.builtin.NotImplemented</a></span>
  360. </dd>
  361. </dl>
  362. <h4 class="name" id="ob$ge"><span class="type-signature"></span>ob$ge<span class="signature">(other)</span><span class="type-signature"> &rarr; {<a href="Sk.builtin.bool.html">Sk.builtin.bool</a>|<a href="Sk.builtin.NotImplemented.html">Sk.builtin.NotImplemented</a>}</span></h4>
  363. <div class="description">
  364. <p>Determine if this instance is greater than or equal to a Python object (i.e. this &gt;= other).</p>
  365. <p>Implements <code>__ge__</code> dunder method.</p>
  366. <p>Javascript function, returns Python object.</p>
  367. </div>
  368. <h5>Parameters:</h5>
  369. <table class="params">
  370. <thead>
  371. <tr>
  372. <th>Name</th>
  373. <th>Type</th>
  374. <th class="last">Description</th>
  375. </tr>
  376. </thead>
  377. <tbody>
  378. <tr>
  379. <td class="name"><code>other</code></td>
  380. <td class="type">
  381. <span class="param-type">Object</span>
  382. </td>
  383. <td class="description last"><p>The Python object to compare.</p></td>
  384. </tr>
  385. </tbody>
  386. </table>
  387. <dl class="details">
  388. <dt class="inherited-from">Inherited From:</dt>
  389. <dd class="inherited-from"><ul class="dummy"><li>
  390. <a href="Sk.builtin.object.html#ob$ge">Sk.builtin.object#ob$ge</a>
  391. </li></ul></dd>
  392. <dt class="tag-source">Source:</dt>
  393. <dd class="tag-source"><ul class="dummy"><li>
  394. <a href="object.js.html">object.js</a>, <a href="object.js.html#line371">line 371</a>
  395. </li></ul></dd>
  396. </dl>
  397. <h5>Returns:</h5>
  398. <div class="param-desc">
  399. <p>true if this &gt;= other, false otherwise</p>
  400. </div>
  401. <dl>
  402. <dt>
  403. Type
  404. </dt>
  405. <dd>
  406. <span class="param-type"><a href="Sk.builtin.bool.html">Sk.builtin.bool</a></span>
  407. |
  408. <span class="param-type"><a href="Sk.builtin.NotImplemented.html">Sk.builtin.NotImplemented</a></span>
  409. </dd>
  410. </dl>
  411. <h4 class="name" id="ob$gt"><span class="type-signature"></span>ob$gt<span class="signature">(other)</span><span class="type-signature"> &rarr; {<a href="Sk.builtin.bool.html">Sk.builtin.bool</a>|<a href="Sk.builtin.NotImplemented.html">Sk.builtin.NotImplemented</a>}</span></h4>
  412. <div class="description">
  413. <p>Determine if this instance is greater than a Python object (i.e. this &gt; other).</p>
  414. <p>Implements <code>__gt__</code> dunder method.</p>
  415. <p>Javascript function, returns Python object.</p>
  416. </div>
  417. <h5>Parameters:</h5>
  418. <table class="params">
  419. <thead>
  420. <tr>
  421. <th>Name</th>
  422. <th>Type</th>
  423. <th class="last">Description</th>
  424. </tr>
  425. </thead>
  426. <tbody>
  427. <tr>
  428. <td class="name"><code>other</code></td>
  429. <td class="type">
  430. <span class="param-type">Object</span>
  431. </td>
  432. <td class="description last"><p>The Python object to compare.</p></td>
  433. </tr>
  434. </tbody>
  435. </table>
  436. <dl class="details">
  437. <dt class="inherited-from">Inherited From:</dt>
  438. <dd class="inherited-from"><ul class="dummy"><li>
  439. <a href="Sk.builtin.object.html#ob$gt">Sk.builtin.object#ob$gt</a>
  440. </li></ul></dd>
  441. <dt class="tag-source">Source:</dt>
  442. <dd class="tag-source"><ul class="dummy"><li>
  443. <a href="object.js.html">object.js</a>, <a href="object.js.html#line357">line 357</a>
  444. </li></ul></dd>
  445. </dl>
  446. <h5>Returns:</h5>
  447. <div class="param-desc">
  448. <p>true if this &gt; other, false otherwise</p>
  449. </div>
  450. <dl>
  451. <dt>
  452. Type
  453. </dt>
  454. <dd>
  455. <span class="param-type"><a href="Sk.builtin.bool.html">Sk.builtin.bool</a></span>
  456. |
  457. <span class="param-type"><a href="Sk.builtin.NotImplemented.html">Sk.builtin.NotImplemented</a></span>
  458. </dd>
  459. </dl>
  460. <h4 class="name" id="ob$le"><span class="type-signature"></span>ob$le<span class="signature">(other)</span><span class="type-signature"> &rarr; {<a href="Sk.builtin.bool.html">Sk.builtin.bool</a>|<a href="Sk.builtin.NotImplemented.html">Sk.builtin.NotImplemented</a>}</span></h4>
  461. <div class="description">
  462. <p>Determine if this instance is less than or equal to a Python object (i.e. this &lt;= other).</p>
  463. <p>Implements <code>__le__</code> dunder method.</p>
  464. <p>Javascript function, returns Python object.</p>
  465. </div>
  466. <h5>Parameters:</h5>
  467. <table class="params">
  468. <thead>
  469. <tr>
  470. <th>Name</th>
  471. <th>Type</th>
  472. <th class="last">Description</th>
  473. </tr>
  474. </thead>
  475. <tbody>
  476. <tr>
  477. <td class="name"><code>other</code></td>
  478. <td class="type">
  479. <span class="param-type">Object</span>
  480. </td>
  481. <td class="description last"><p>The Python object to compare.</p></td>
  482. </tr>
  483. </tbody>
  484. </table>
  485. <dl class="details">
  486. <dt class="inherited-from">Inherited From:</dt>
  487. <dd class="inherited-from"><ul class="dummy"><li>
  488. <a href="Sk.builtin.object.html#ob$le">Sk.builtin.object#ob$le</a>
  489. </li></ul></dd>
  490. <dt class="tag-source">Source:</dt>
  491. <dd class="tag-source"><ul class="dummy"><li>
  492. <a href="object.js.html">object.js</a>, <a href="object.js.html#line343">line 343</a>
  493. </li></ul></dd>
  494. </dl>
  495. <h5>Returns:</h5>
  496. <div class="param-desc">
  497. <p>true if this &lt;= other, false otherwise</p>
  498. </div>
  499. <dl>
  500. <dt>
  501. Type
  502. </dt>
  503. <dd>
  504. <span class="param-type"><a href="Sk.builtin.bool.html">Sk.builtin.bool</a></span>
  505. |
  506. <span class="param-type"><a href="Sk.builtin.NotImplemented.html">Sk.builtin.NotImplemented</a></span>
  507. </dd>
  508. </dl>
  509. <h4 class="name" id="ob$lt"><span class="type-signature"></span>ob$lt<span class="signature">(other)</span><span class="type-signature"> &rarr; {<a href="Sk.builtin.bool.html">Sk.builtin.bool</a>|<a href="Sk.builtin.NotImplemented.html">Sk.builtin.NotImplemented</a>}</span></h4>
  510. <div class="description">
  511. <p>Determine if this instance is less than a Python object (i.e. this &lt; other).</p>
  512. <p>Implements <code>__lt__</code> dunder method.</p>
  513. <p>Javascript function, returns Python object.</p>
  514. </div>
  515. <h5>Parameters:</h5>
  516. <table class="params">
  517. <thead>
  518. <tr>
  519. <th>Name</th>
  520. <th>Type</th>
  521. <th class="last">Description</th>
  522. </tr>
  523. </thead>
  524. <tbody>
  525. <tr>
  526. <td class="name"><code>other</code></td>
  527. <td class="type">
  528. <span class="param-type">Object</span>
  529. </td>
  530. <td class="description last"><p>The Python object to compare.</p></td>
  531. </tr>
  532. </tbody>
  533. </table>
  534. <dl class="details">
  535. <dt class="inherited-from">Inherited From:</dt>
  536. <dd class="inherited-from"><ul class="dummy"><li>
  537. <a href="Sk.builtin.object.html#ob$lt">Sk.builtin.object#ob$lt</a>
  538. </li></ul></dd>
  539. <dt class="tag-source">Source:</dt>
  540. <dd class="tag-source"><ul class="dummy"><li>
  541. <a href="object.js.html">object.js</a>, <a href="object.js.html#line329">line 329</a>
  542. </li></ul></dd>
  543. </dl>
  544. <h5>Returns:</h5>
  545. <div class="param-desc">
  546. <p>true if this &lt; other, false otherwise</p>
  547. </div>
  548. <dl>
  549. <dt>
  550. Type
  551. </dt>
  552. <dd>
  553. <span class="param-type"><a href="Sk.builtin.bool.html">Sk.builtin.bool</a></span>
  554. |
  555. <span class="param-type"><a href="Sk.builtin.NotImplemented.html">Sk.builtin.NotImplemented</a></span>
  556. </dd>
  557. </dl>
  558. <h4 class="name" id="ob$ne"><span class="type-signature"></span>ob$ne<span class="signature">(other)</span><span class="type-signature"> &rarr; {<a href="Sk.builtin.bool.html">Sk.builtin.bool</a>|<a href="Sk.builtin.NotImplemented.html">Sk.builtin.NotImplemented</a>}</span></h4>
  559. <div class="description">
  560. <p>Perform non-equality check between this instance and a Python object (i.e. this != other).</p>
  561. <p>Implements <code>__ne__</code> dunder method.</p>
  562. <p>Javascript function, returns Python object.</p>
  563. </div>
  564. <h5>Parameters:</h5>
  565. <table class="params">
  566. <thead>
  567. <tr>
  568. <th>Name</th>
  569. <th>Type</th>
  570. <th class="last">Description</th>
  571. </tr>
  572. </thead>
  573. <tbody>
  574. <tr>
  575. <td class="name"><code>other</code></td>
  576. <td class="type">
  577. <span class="param-type">Object</span>
  578. </td>
  579. <td class="description last"><p>The Python object to check for non-equality.</p></td>
  580. </tr>
  581. </tbody>
  582. </table>
  583. <dl class="details">
  584. <dt class="inherited-from">Inherited From:</dt>
  585. <dd class="inherited-from"><ul class="dummy"><li>
  586. <a href="Sk.builtin.object.html#ob$ne">Sk.builtin.object#ob$ne</a>
  587. </li></ul></dd>
  588. <dt class="tag-source">Source:</dt>
  589. <dd class="tag-source"><ul class="dummy"><li>
  590. <a href="object.js.html">object.js</a>, <a href="object.js.html#line311">line 311</a>
  591. </li></ul></dd>
  592. </dl>
  593. <h5>Returns:</h5>
  594. <div class="param-desc">
  595. <p>true if not equal, false otherwise</p>
  596. </div>
  597. <dl>
  598. <dt>
  599. Type
  600. </dt>
  601. <dd>
  602. <span class="param-type"><a href="Sk.builtin.bool.html">Sk.builtin.bool</a></span>
  603. |
  604. <span class="param-type"><a href="Sk.builtin.NotImplemented.html">Sk.builtin.NotImplemented</a></span>
  605. </dd>
  606. </dl>
  607. <h4 class="name" id="tp$hash"><span class="type-signature"></span>tp$hash<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="Sk.builtin.int_.html">Sk.builtin.int_</a>}</span></h4>
  608. <div class="description">
  609. <p>Return the hash value of this instance.</p>
  610. <p>Javascript function, returns Python object.</p>
  611. </div>
  612. <dl class="details">
  613. <dt class="tag-overrides">Overrides:</dt>
  614. <dd class="tag-overrides"><ul class="dummy"><li>
  615. <a href="Sk.builtin.object.html#tp$hash">Sk.builtin.object#tp$hash</a>
  616. </li></ul></dd>
  617. <dt class="tag-source">Source:</dt>
  618. <dd class="tag-source"><ul class="dummy"><li>
  619. <a href="object.js.html">object.js</a>, <a href="object.js.html#line275">line 275</a>
  620. </li></ul></dd>
  621. </dl>
  622. <h5>Returns:</h5>
  623. <div class="param-desc">
  624. <p>The hash value</p>
  625. </div>
  626. <dl>
  627. <dt>
  628. Type
  629. </dt>
  630. <dd>
  631. <span class="param-type"><a href="Sk.builtin.int_.html">Sk.builtin.int_</a></span>
  632. </dd>
  633. </dl>
  634. </article>
  635. </section>
  636. </div>
  637. <nav>
  638. <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Sk.abstr.iter-seqIter.html">seqIter</a></li><li><a href="Sk.builtin.bool.html">bool</a></li><li><a href="Sk.builtin.float_.html">float_</a></li><li><a href="Sk.builtin.func.html">func</a></li><li><a href="Sk.builtin.int_.html">int_</a></li><li><a href="Sk.builtin.none.html">none</a></li><li><a href="Sk.builtin.NotImplemented.html">NotImplemented</a></li><li><a href="Sk.builtin.numtype.html">numtype</a></li><li><a href="Sk.builtin.object.html">object</a></li><li><a href="Sk.builtin.seqtype.html">seqtype</a></li><li><a href="Sk.misceval.Suspension.html">Suspension</a></li></ul><h3>Namespaces</h3><ul><li><a href="Sk.html">Sk</a></li><li><a href="Sk.abstr.html">abstr</a></li><li><a href="Sk.builtin.html">builtin</a></li><li><a href="Sk.ffi.html">ffi</a></li><li><a href="Sk.misceval.html">misceval</a></li></ul>
  639. </nav>
  640. <br class="clear">
  641. <footer>
  642. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0</a> on Thu Aug 13 2015 08:14:27 GMT-0500 (CDT)
  643. </footer>
  644. <script> prettyPrint(); </script>
  645. <script src="scripts/linenumber.js"> </script>
  646. </body>
  647. </html>