complex.html 114 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <!-- This file is generated by Nim. -->
  4. <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
  5. <head>
  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  8. <title>std/complex</title>
  9. <!-- Google fonts -->
  10. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
  11. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
  12. <!-- Favicon -->
  13. <link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
  14. <link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
  15. <!-- CSS -->
  16. <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
  17. <!-- JS -->
  18. <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
  19. </head>
  20. <body>
  21. <div class="document" id="documentId">
  22. <div class="container">
  23. <h1 class="title">std/complex</h1>
  24. <div class="row">
  25. <div class="three columns">
  26. <div class="theme-select-wrapper">
  27. <label for="theme-select">Theme:&nbsp;</label>
  28. <select id="theme-select" onchange="setTheme(this.value)">
  29. <option value="auto">🌗 Match OS</option>
  30. <option value="dark">🌑 Dark</option>
  31. <option value="light">🌕 Light</option>
  32. </select>
  33. </div>
  34. <div id="global-links">
  35. <ul class="simple-boot">
  36. <li><a href="manual.html">Manual</a></li>
  37. <li><a href="lib.html">Standard library</a></li>
  38. <li> <a id="indexLink" href="theindex.html">Index</a></li>
  39. <li><a href="compiler/theindex.html">Compiler docs</a></li>
  40. <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
  41. <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
  42. </ul>
  43. </div>
  44. <div id="searchInputDiv">
  45. Search: <input type="search" id="searchInput"
  46. oninput="search()" />
  47. </div>
  48. <ul class="simple simple-toc" id="toc-list">
  49. <li>
  50. <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
  51. </li>
  52. <li>
  53. <details open>
  54. <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
  55. <ul class="simple simple-toc-section">
  56. <li><a class="reference" href="#Complex" title="Complex[T] = object
  57. re*, im*: T">Complex</a></li>
  58. <li><a class="reference" href="#Complex32" title="Complex32 = Complex[float32]">Complex32</a></li>
  59. <li><a class="reference" href="#Complex64" title="Complex64 = Complex[float64]">Complex64</a></li>
  60. </ul>
  61. </details>
  62. </li>
  63. <li>
  64. <details open>
  65. <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
  66. <ul class="simple simple-toc-section">
  67. <ul class="simple nested-toc-section">$
  68. <li><a class="reference" href="#%24%2CComplex" title="`$`(z: Complex): string">`$`(z: Complex): string</a></li>
  69. </ul>
  70. <ul class="simple nested-toc-section">*
  71. <li><a class="reference" href="#%2A%2CComplex%5BT%5D%2CComplex%5BT%5D" title="`*`[T](x, y: Complex[T]): Complex[T]">`*`[T](x, y: Complex[T]): Complex[T]</a></li>
  72. <li><a class="reference" href="#%2A%2CComplex%5BT%5D%2CT" title="`*`[T](x: Complex[T]; y: T): Complex[T]">`*`[T](x: Complex[T]; y: T): Complex[T]</a></li>
  73. <li><a class="reference" href="#%2A%2CT%2CComplex%5BT%5D" title="`*`[T](x: T; y: Complex[T]): Complex[T]">`*`[T](x: T; y: Complex[T]): Complex[T]</a></li>
  74. </ul>
  75. <ul class="simple nested-toc-section">*=
  76. <li><a class="reference" href="#%2A%3D%2CComplex%5BT%5D%2CComplex%5BT%5D" title="`*=`[T](x: var Complex[T]; y: Complex[T])">`*=`[T](x: var Complex[T]; y: Complex[T])</a></li>
  77. </ul>
  78. <ul class="simple nested-toc-section">+
  79. <li><a class="reference" href="#%2B%2CComplex%5BT%5D%2CComplex%5BT%5D" title="`+`[T](x, y: Complex[T]): Complex[T]">`+`[T](x, y: Complex[T]): Complex[T]</a></li>
  80. <li><a class="reference" href="#%2B%2CComplex%5BT%5D%2CT" title="`+`[T](x: Complex[T]; y: T): Complex[T]">`+`[T](x: Complex[T]; y: T): Complex[T]</a></li>
  81. <li><a class="reference" href="#%2B%2CT%2CComplex%5BT%5D" title="`+`[T](x: T; y: Complex[T]): Complex[T]">`+`[T](x: T; y: Complex[T]): Complex[T]</a></li>
  82. </ul>
  83. <ul class="simple nested-toc-section">+=
  84. <li><a class="reference" href="#%2B%3D%2CComplex%5BT%5D%2CComplex%5BT%5D" title="`+=`[T](x: var Complex[T]; y: Complex[T])">`+=`[T](x: var Complex[T]; y: Complex[T])</a></li>
  85. </ul>
  86. <ul class="simple nested-toc-section">-
  87. <li><a class="reference" href="#-%2CComplex%5BT%5D%2CComplex%5BT%5D" title="`-`[T](x, y: Complex[T]): Complex[T]">`-`[T](x, y: Complex[T]): Complex[T]</a></li>
  88. <li><a class="reference" href="#-%2CComplex%5BT%5D%2CT" title="`-`[T](x: Complex[T]; y: T): Complex[T]">`-`[T](x: Complex[T]; y: T): Complex[T]</a></li>
  89. <li><a class="reference" href="#-%2CT%2CComplex%5BT%5D" title="`-`[T](x: T; y: Complex[T]): Complex[T]">`-`[T](x: T; y: Complex[T]): Complex[T]</a></li>
  90. <li><a class="reference" href="#-%2CComplex%5BT%5D" title="`-`[T](z: Complex[T]): Complex[T]">`-`[T](z: Complex[T]): Complex[T]</a></li>
  91. </ul>
  92. <ul class="simple nested-toc-section">-=
  93. <li><a class="reference" href="#-%3D%2CComplex%5BT%5D%2CComplex%5BT%5D" title="`-=`[T](x: var Complex[T]; y: Complex[T])">`-=`[T](x: var Complex[T]; y: Complex[T])</a></li>
  94. </ul>
  95. <ul class="simple nested-toc-section">/
  96. <li><a class="reference" href="#%2F%2CComplex%5BT%5D%2CComplex%5BT%5D" title="`/`[T](x, y: Complex[T]): Complex[T]">`/`[T](x, y: Complex[T]): Complex[T]</a></li>
  97. <li><a class="reference" href="#%2F%2CComplex%5BT%5D%2CT" title="`/`[T](x: Complex[T]; y: T): Complex[T]">`/`[T](x: Complex[T]; y: T): Complex[T]</a></li>
  98. <li><a class="reference" href="#%2F%2CT%2CComplex%5BT%5D" title="`/`[T](x: T; y: Complex[T]): Complex[T]">`/`[T](x: T; y: Complex[T]): Complex[T]</a></li>
  99. </ul>
  100. <ul class="simple nested-toc-section">/=
  101. <li><a class="reference" href="#%2F%3D%2CComplex%5BT%5D%2CComplex%5BT%5D" title="`/=`[T](x: var Complex[T]; y: Complex[T])">`/=`[T](x: var Complex[T]; y: Complex[T])</a></li>
  102. </ul>
  103. <ul class="simple nested-toc-section">==
  104. <li><a class="reference" href="#%3D%3D%2CComplex%5BT%5D%2CComplex%5BT%5D" title="`==`[T](x, y: Complex[T]): bool">`==`[T](x, y: Complex[T]): bool</a></li>
  105. </ul>
  106. <ul class="simple nested-toc-section">abs
  107. <li><a class="reference" href="#abs%2CComplex%5BT%5D" title="abs[T](z: Complex[T]): T">abs[T](z: Complex[T]): T</a></li>
  108. </ul>
  109. <ul class="simple nested-toc-section">abs2
  110. <li><a class="reference" href="#abs2%2CComplex%5BT%5D" title="abs2[T](z: Complex[T]): T">abs2[T](z: Complex[T]): T</a></li>
  111. </ul>
  112. <ul class="simple nested-toc-section">almostEqual
  113. <li><a class="reference" href="#almostEqual%2CComplex%5BT%3A%20SomeFloat%5D%2CComplex%5BT%3A%20SomeFloat%5D%2CNatural" title="almostEqual[T: SomeFloat](x, y: Complex[T]; unitsInLastPlace: Natural = 4): bool">almostEqual[T: SomeFloat](x, y: Complex[T]; unitsInLastPlace: Natural = 4): bool</a></li>
  114. </ul>
  115. <ul class="simple nested-toc-section">arccos
  116. <li><a class="reference" href="#arccos%2CComplex%5BT%5D" title="arccos[T](z: Complex[T]): Complex[T]">arccos[T](z: Complex[T]): Complex[T]</a></li>
  117. </ul>
  118. <ul class="simple nested-toc-section">arccosh
  119. <li><a class="reference" href="#arccosh%2CComplex%5BT%5D" title="arccosh[T](z: Complex[T]): Complex[T]">arccosh[T](z: Complex[T]): Complex[T]</a></li>
  120. </ul>
  121. <ul class="simple nested-toc-section">arccot
  122. <li><a class="reference" href="#arccot%2CComplex%5BT%5D" title="arccot[T](z: Complex[T]): Complex[T]">arccot[T](z: Complex[T]): Complex[T]</a></li>
  123. </ul>
  124. <ul class="simple nested-toc-section">arccoth
  125. <li><a class="reference" href="#arccoth%2CComplex%5BT%5D" title="arccoth[T](z: Complex[T]): Complex[T]">arccoth[T](z: Complex[T]): Complex[T]</a></li>
  126. </ul>
  127. <ul class="simple nested-toc-section">arccsc
  128. <li><a class="reference" href="#arccsc%2CComplex%5BT%5D" title="arccsc[T](z: Complex[T]): Complex[T]">arccsc[T](z: Complex[T]): Complex[T]</a></li>
  129. </ul>
  130. <ul class="simple nested-toc-section">arccsch
  131. <li><a class="reference" href="#arccsch%2CComplex%5BT%5D" title="arccsch[T](z: Complex[T]): Complex[T]">arccsch[T](z: Complex[T]): Complex[T]</a></li>
  132. </ul>
  133. <ul class="simple nested-toc-section">arcsec
  134. <li><a class="reference" href="#arcsec%2CComplex%5BT%5D" title="arcsec[T](z: Complex[T]): Complex[T]">arcsec[T](z: Complex[T]): Complex[T]</a></li>
  135. </ul>
  136. <ul class="simple nested-toc-section">arcsech
  137. <li><a class="reference" href="#arcsech%2CComplex%5BT%5D" title="arcsech[T](z: Complex[T]): Complex[T]">arcsech[T](z: Complex[T]): Complex[T]</a></li>
  138. </ul>
  139. <ul class="simple nested-toc-section">arcsin
  140. <li><a class="reference" href="#arcsin%2CComplex%5BT%5D" title="arcsin[T](z: Complex[T]): Complex[T]">arcsin[T](z: Complex[T]): Complex[T]</a></li>
  141. </ul>
  142. <ul class="simple nested-toc-section">arcsinh
  143. <li><a class="reference" href="#arcsinh%2CComplex%5BT%5D" title="arcsinh[T](z: Complex[T]): Complex[T]">arcsinh[T](z: Complex[T]): Complex[T]</a></li>
  144. </ul>
  145. <ul class="simple nested-toc-section">arctan
  146. <li><a class="reference" href="#arctan%2CComplex%5BT%5D" title="arctan[T](z: Complex[T]): Complex[T]">arctan[T](z: Complex[T]): Complex[T]</a></li>
  147. </ul>
  148. <ul class="simple nested-toc-section">arctanh
  149. <li><a class="reference" href="#arctanh%2CComplex%5BT%5D" title="arctanh[T](z: Complex[T]): Complex[T]">arctanh[T](z: Complex[T]): Complex[T]</a></li>
  150. </ul>
  151. <ul class="simple nested-toc-section">complex
  152. <li><a class="reference" href="#complex%2CT%2CT" title="complex[T: SomeFloat](re: T; im: T = 0.0): Complex[T]">complex[T: SomeFloat](re: T; im: T = 0.0): Complex[T]</a></li>
  153. </ul>
  154. <ul class="simple nested-toc-section">complex32
  155. <li><a class="reference" href="#complex32%2Cfloat32%2Cfloat32" title="complex32(re: float32; im: float32 = 0.0): Complex32">complex32(re: float32; im: float32 = 0.0): Complex32</a></li>
  156. </ul>
  157. <ul class="simple nested-toc-section">complex64
  158. <li><a class="reference" href="#complex64%2Cfloat64%2Cfloat64" title="complex64(re: float64; im: float64 = 0.0): Complex64">complex64(re: float64; im: float64 = 0.0): Complex64</a></li>
  159. </ul>
  160. <ul class="simple nested-toc-section">conjugate
  161. <li><a class="reference" href="#conjugate%2CComplex%5BT%5D" title="conjugate[T](z: Complex[T]): Complex[T]">conjugate[T](z: Complex[T]): Complex[T]</a></li>
  162. </ul>
  163. <ul class="simple nested-toc-section">cos
  164. <li><a class="reference" href="#cos%2CComplex%5BT%5D" title="cos[T](z: Complex[T]): Complex[T]">cos[T](z: Complex[T]): Complex[T]</a></li>
  165. </ul>
  166. <ul class="simple nested-toc-section">cosh
  167. <li><a class="reference" href="#cosh%2CComplex%5BT%5D" title="cosh[T](z: Complex[T]): Complex[T]">cosh[T](z: Complex[T]): Complex[T]</a></li>
  168. </ul>
  169. <ul class="simple nested-toc-section">cot
  170. <li><a class="reference" href="#cot%2CComplex%5BT%5D" title="cot[T](z: Complex[T]): Complex[T]">cot[T](z: Complex[T]): Complex[T]</a></li>
  171. </ul>
  172. <ul class="simple nested-toc-section">coth
  173. <li><a class="reference" href="#coth%2CComplex%5BT%5D" title="coth[T](z: Complex[T]): Complex[T]">coth[T](z: Complex[T]): Complex[T]</a></li>
  174. </ul>
  175. <ul class="simple nested-toc-section">csc
  176. <li><a class="reference" href="#csc%2CComplex%5BT%5D" title="csc[T](z: Complex[T]): Complex[T]">csc[T](z: Complex[T]): Complex[T]</a></li>
  177. </ul>
  178. <ul class="simple nested-toc-section">csch
  179. <li><a class="reference" href="#csch%2CComplex%5BT%5D" title="csch[T](z: Complex[T]): Complex[T]">csch[T](z: Complex[T]): Complex[T]</a></li>
  180. </ul>
  181. <ul class="simple nested-toc-section">exp
  182. <li><a class="reference" href="#exp%2CComplex%5BT%5D" title="exp[T](z: Complex[T]): Complex[T]">exp[T](z: Complex[T]): Complex[T]</a></li>
  183. </ul>
  184. <ul class="simple nested-toc-section">formatValue
  185. <li><a class="reference" href="#formatValue%2Cstring%2CComplex%2Cstring" title="formatValue(result: var string; value: Complex; specifier: string)">formatValue(result: var string; value: Complex; specifier: string)</a></li>
  186. </ul>
  187. <ul class="simple nested-toc-section">inv
  188. <li><a class="reference" href="#inv%2CComplex%5BT%5D" title="inv[T](z: Complex[T]): Complex[T]">inv[T](z: Complex[T]): Complex[T]</a></li>
  189. </ul>
  190. <ul class="simple nested-toc-section">ln
  191. <li><a class="reference" href="#ln%2CComplex%5BT%5D" title="ln[T](z: Complex[T]): Complex[T]">ln[T](z: Complex[T]): Complex[T]</a></li>
  192. </ul>
  193. <ul class="simple nested-toc-section">log2
  194. <li><a class="reference" href="#log2%2CComplex%5BT%5D" title="log2[T](z: Complex[T]): Complex[T]">log2[T](z: Complex[T]): Complex[T]</a></li>
  195. </ul>
  196. <ul class="simple nested-toc-section">log10
  197. <li><a class="reference" href="#log10%2CComplex%5BT%5D" title="log10[T](z: Complex[T]): Complex[T]">log10[T](z: Complex[T]): Complex[T]</a></li>
  198. </ul>
  199. <ul class="simple nested-toc-section">phase
  200. <li><a class="reference" href="#phase%2CComplex%5BT%5D" title="phase[T](z: Complex[T]): T">phase[T](z: Complex[T]): T</a></li>
  201. </ul>
  202. <ul class="simple nested-toc-section">polar
  203. <li><a class="reference" href="#polar%2CComplex%5BT%5D" title="polar[T](z: Complex[T]): tuple[r, phi: T]">polar[T](z: Complex[T]): tuple[r, phi: T]</a></li>
  204. </ul>
  205. <ul class="simple nested-toc-section">pow
  206. <li><a class="reference" href="#pow%2CComplex%5BT%5D%2CComplex%5BT%5D" title="pow[T](x, y: Complex[T]): Complex[T]">pow[T](x, y: Complex[T]): Complex[T]</a></li>
  207. <li><a class="reference" href="#pow%2CComplex%5BT%5D%2CT" title="pow[T](x: Complex[T]; y: T): Complex[T]">pow[T](x: Complex[T]; y: T): Complex[T]</a></li>
  208. </ul>
  209. <ul class="simple nested-toc-section">rect
  210. <li><a class="reference" href="#rect%2CT%2CT" title="rect[T](r, phi: T): Complex[T]">rect[T](r, phi: T): Complex[T]</a></li>
  211. </ul>
  212. <ul class="simple nested-toc-section">sec
  213. <li><a class="reference" href="#sec%2CComplex%5BT%5D" title="sec[T](z: Complex[T]): Complex[T]">sec[T](z: Complex[T]): Complex[T]</a></li>
  214. </ul>
  215. <ul class="simple nested-toc-section">sech
  216. <li><a class="reference" href="#sech%2CComplex%5BT%5D" title="sech[T](z: Complex[T]): Complex[T]">sech[T](z: Complex[T]): Complex[T]</a></li>
  217. </ul>
  218. <ul class="simple nested-toc-section">sgn
  219. <li><a class="reference" href="#sgn%2CComplex%5BT%5D" title="sgn[T](z: Complex[T]): Complex[T]">sgn[T](z: Complex[T]): Complex[T]</a></li>
  220. </ul>
  221. <ul class="simple nested-toc-section">sin
  222. <li><a class="reference" href="#sin%2CComplex%5BT%5D" title="sin[T](z: Complex[T]): Complex[T]">sin[T](z: Complex[T]): Complex[T]</a></li>
  223. </ul>
  224. <ul class="simple nested-toc-section">sinh
  225. <li><a class="reference" href="#sinh%2CComplex%5BT%5D" title="sinh[T](z: Complex[T]): Complex[T]">sinh[T](z: Complex[T]): Complex[T]</a></li>
  226. </ul>
  227. <ul class="simple nested-toc-section">sqrt
  228. <li><a class="reference" href="#sqrt%2CComplex%5BT%5D" title="sqrt[T](z: Complex[T]): Complex[T]">sqrt[T](z: Complex[T]): Complex[T]</a></li>
  229. </ul>
  230. <ul class="simple nested-toc-section">tan
  231. <li><a class="reference" href="#tan%2CComplex%5BT%5D" title="tan[T](z: Complex[T]): Complex[T]">tan[T](z: Complex[T]): Complex[T]</a></li>
  232. </ul>
  233. <ul class="simple nested-toc-section">tanh
  234. <li><a class="reference" href="#tanh%2CComplex%5BT%5D" title="tanh[T](z: Complex[T]): Complex[T]">tanh[T](z: Complex[T]): Complex[T]</a></li>
  235. </ul>
  236. </ul>
  237. </details>
  238. </li>
  239. <li>
  240. <details open>
  241. <summary><a class="reference reference-toplevel" href="#18" id="68">Templates</a></summary>
  242. <ul class="simple simple-toc-section">
  243. <ul class="simple nested-toc-section">im
  244. <li><a class="reference" href="#im.t%2Cfloat32" title="im(arg: float32): Complex32">im(arg: float32): Complex32</a></li>
  245. <li><a class="reference" href="#im.t%2Cfloat64" title="im(arg: float64): Complex64">im(arg: float64): Complex64</a></li>
  246. <li><a class="reference" href="#im.t%2Ctypedesc%5Bfloat32%5D" title="im(arg: typedesc[float32]): Complex32">im(arg: typedesc[float32]): Complex32</a></li>
  247. <li><a class="reference" href="#im.t%2Ctypedesc%5Bfloat64%5D" title="im(arg: typedesc[float64]): Complex64">im(arg: typedesc[float64]): Complex64</a></li>
  248. </ul>
  249. </ul>
  250. </details>
  251. </li>
  252. </ul>
  253. </div>
  254. <div class="nine columns" id="content">
  255. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  256. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  257. <div id="tocRoot"></div>
  258. <p class="module-desc"><p>This module implements complex numbers and basic mathematical operations on them.</p>
  259. <p>Complex numbers are currently generic over 64-bit or 32-bit floats.</p>
  260. <p><strong class="examples_text">Example:</strong></p>
  261. <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">complex</span>
  262. <span class="Keyword">from</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">math</span> <span class="Keyword">import</span> <span class="Identifier">almostEqual</span><span class="Punctuation">,</span> <span class="Identifier">sqrt</span>
  263. <span class="Keyword">let</span>
  264. <span class="Identifier">z1</span> <span class="Operator">=</span> <span class="Identifier">complex</span><span class="Punctuation">(</span><span class="FloatNumber">1.0</span><span class="Punctuation">,</span> <span class="FloatNumber">2.0</span><span class="Punctuation">)</span>
  265. <span class="Identifier">z2</span> <span class="Operator">=</span> <span class="Identifier">complex</span><span class="Punctuation">(</span><span class="FloatNumber">3.0</span><span class="Punctuation">,</span> <span class="Operator">-</span><span class="FloatNumber">4.0</span><span class="Punctuation">)</span>
  266. <span class="Identifier">assert</span> <span class="Identifier">almostEqual</span><span class="Punctuation">(</span><span class="Identifier">z1</span> <span class="Operator">+</span> <span class="Identifier">z2</span><span class="Punctuation">,</span> <span class="Identifier">complex</span><span class="Punctuation">(</span><span class="FloatNumber">4.0</span><span class="Punctuation">,</span> <span class="Operator">-</span><span class="FloatNumber">2.0</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
  267. <span class="Identifier">assert</span> <span class="Identifier">almostEqual</span><span class="Punctuation">(</span><span class="Identifier">z1</span> <span class="Operator">-</span> <span class="Identifier">z2</span><span class="Punctuation">,</span> <span class="Identifier">complex</span><span class="Punctuation">(</span><span class="Operator">-</span><span class="FloatNumber">2.0</span><span class="Punctuation">,</span> <span class="FloatNumber">6.0</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
  268. <span class="Identifier">assert</span> <span class="Identifier">almostEqual</span><span class="Punctuation">(</span><span class="Identifier">z1</span> <span class="Operator">*</span> <span class="Identifier">z2</span><span class="Punctuation">,</span> <span class="Identifier">complex</span><span class="Punctuation">(</span><span class="FloatNumber">11.0</span><span class="Punctuation">,</span> <span class="FloatNumber">2.0</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
  269. <span class="Identifier">assert</span> <span class="Identifier">almostEqual</span><span class="Punctuation">(</span><span class="Identifier">z1</span> <span class="Operator">/</span> <span class="Identifier">z2</span><span class="Punctuation">,</span> <span class="Identifier">complex</span><span class="Punctuation">(</span><span class="Operator">-</span><span class="FloatNumber">0.2</span><span class="Punctuation">,</span> <span class="FloatNumber">0.4</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
  270. <span class="Identifier">assert</span> <span class="Identifier">almostEqual</span><span class="Punctuation">(</span><span class="Identifier">abs</span><span class="Punctuation">(</span><span class="Identifier">z1</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Identifier">sqrt</span><span class="Punctuation">(</span><span class="FloatNumber">5.0</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
  271. <span class="Identifier">assert</span> <span class="Identifier">almostEqual</span><span class="Punctuation">(</span><span class="Identifier">conjugate</span><span class="Punctuation">(</span><span class="Identifier">z1</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Identifier">complex</span><span class="Punctuation">(</span><span class="FloatNumber">1.0</span><span class="Punctuation">,</span> <span class="Operator">-</span><span class="FloatNumber">2.0</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
  272. <span class="Keyword">let</span> <span class="Punctuation">(</span><span class="Identifier">r</span><span class="Punctuation">,</span> <span class="Identifier">phi</span><span class="Punctuation">)</span> <span class="Operator">=</span> <span class="Identifier">z1</span><span class="Operator">.</span><span class="Identifier">polar</span>
  273. <span class="Identifier">assert</span> <span class="Identifier">almostEqual</span><span class="Punctuation">(</span><span class="Identifier">rect</span><span class="Punctuation">(</span><span class="Identifier">r</span><span class="Punctuation">,</span> <span class="Identifier">phi</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Identifier">z1</span><span class="Punctuation">)</span></pre></p>
  274. <div class="section" id="6">
  275. <h1><a class="toc-backref" href="#6">Imports</a></h1>
  276. <dl class="item">
  277. <a class="reference external" href="math.html">math</a>, <a class="reference external" href="strformat.html">strformat</a>, <a class="reference external" href="strutils.html">strutils</a>
  278. </dl>
  279. </div>
  280. <div class="section" id="7">
  281. <h1><a class="toc-backref" href="#7">Types</a></h1>
  282. <dl class="item">
  283. <div id="Complex">
  284. <dt><pre><a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> <span class="Other">=</span> <span class="Keyword">object</span>
  285. <span class="Identifier">re</span><span class="Operator">*</span><span class="Other">,</span> <span class="Identifier">im</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">T</span></pre></dt>
  286. <dd>
  287. A complex number, consisting of a real and an imaginary part.
  288. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L39" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  289. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L39" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  290. </dd>
  291. </div>
  292. <div id="Complex32">
  293. <dt><pre><a href="complex.html#Complex32"><span class="Identifier">Complex32</span></a> <span class="Other">=</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><a href="system.html#float32"><span class="Identifier">float32</span></a><span class="Other">]</span></pre></dt>
  294. <dd>
  295. Alias for a complex number using 32-bit floats.
  296. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L44" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  297. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L44" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  298. </dd>
  299. </div>
  300. <div id="Complex64">
  301. <dt><pre><a href="complex.html#Complex64"><span class="Identifier">Complex64</span></a> <span class="Other">=</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><a href="system.html#float64"><span class="Identifier">float64</span></a><span class="Other">]</span></pre></dt>
  302. <dd>
  303. Alias for a complex number using 64-bit floats.
  304. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L42" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  305. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L42" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  306. </dd>
  307. </div>
  308. </dl>
  309. </div>
  310. <div class="section" id="12">
  311. <h1><a class="toc-backref" href="#12">Procs</a></h1>
  312. <dl class="item">
  313. <div id="$-procs-all">
  314. <div id="$,Complex">
  315. <dt><pre><span class="Keyword">func</span> <a href="#%24%2CComplex"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
  316. <dd>
  317. Returns <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>'s string representation as <tt class="docutils literal"><span class="pre"><span class="StringLit">&quot;(re, im)&quot;</span></span></tt>.
  318. <p><strong class="examples_text">Example:</strong></p>
  319. <pre class="listing"><span class="Identifier">doAssert</span> <span class="Operator">$</span><span class="Identifier">complex</span><span class="Punctuation">(</span><span class="FloatNumber">1.0</span><span class="Punctuation">,</span> <span class="FloatNumber">2.0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">&quot;(1.0, 2.0)&quot;</span></pre>
  320. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L410" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  321. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L410" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  322. </dd>
  323. </div>
  324. </div>
  325. <div id="*-procs-all">
  326. <div id="*,Complex[T],Complex[T]">
  327. <dt><pre><span class="Keyword">func</span> <a href="#%2A%2CComplex%5BT%5D%2CComplex%5BT%5D"><span class="Identifier">`*`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  328. <dd>
  329. Multiplies two complex numbers.
  330. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L136" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  331. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L136" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  332. </dd>
  333. </div>
  334. <div id="*,Complex[T],T">
  335. <dt><pre><span class="Keyword">func</span> <a href="#%2A%2CComplex%5BT%5D%2CT"><span class="Identifier">`*`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  336. <dd>
  337. Multiplies a complex number with a real number.
  338. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L132" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  339. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L132" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  340. </dd>
  341. </div>
  342. <div id="*,T,Complex[T]">
  343. <dt><pre><span class="Keyword">func</span> <a href="#%2A%2CT%2CComplex%5BT%5D"><span class="Identifier">`*`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  344. <dd>
  345. Multiplies a real number with a complex number.
  346. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L128" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  347. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L128" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  348. </dd>
  349. </div>
  350. </div>
  351. <div id="*=-procs-all">
  352. <div id="*=,Complex[T],Complex[T]">
  353. <dt><pre><span class="Keyword">func</span> <a href="#%2A%3D%2CComplex%5BT%5D%2CComplex%5BT%5D"><span class="Identifier">`*=`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span></pre></dt>
  354. <dd>
  355. Multiplies <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> by <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.
  356. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L163" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  357. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L163" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  358. </dd>
  359. </div>
  360. </div>
  361. <div id="+-procs-all">
  362. <div id="+,Complex[T],Complex[T]">
  363. <dt><pre><span class="Keyword">func</span> <a href="#%2B%2CComplex%5BT%5D%2CComplex%5BT%5D"><span class="Identifier">`+`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  364. <dd>
  365. Adds two complex numbers.
  366. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L108" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  367. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L108" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  368. </dd>
  369. </div>
  370. <div id="+,Complex[T],T">
  371. <dt><pre><span class="Keyword">func</span> <a href="#%2B%2CComplex%5BT%5D%2CT"><span class="Identifier">`+`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  372. <dd>
  373. Adds a complex number to a real number.
  374. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L104" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  375. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L104" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  376. </dd>
  377. </div>
  378. <div id="+,T,Complex[T]">
  379. <dt><pre><span class="Keyword">func</span> <a href="#%2B%2CT%2CComplex%5BT%5D"><span class="Identifier">`+`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  380. <dd>
  381. Adds a real number to a complex number.
  382. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L100" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  383. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L100" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  384. </dd>
  385. </div>
  386. </div>
  387. <div id="+=-procs-all">
  388. <div id="+=,Complex[T],Complex[T]">
  389. <dt><pre><span class="Keyword">func</span> <a href="#%2B%3D%2CComplex%5BT%5D%2CComplex%5BT%5D"><span class="Identifier">`+=`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span></pre></dt>
  390. <dd>
  391. Adds <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.
  392. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L153" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  393. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L153" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  394. </dd>
  395. </div>
  396. </div>
  397. <div id="--procs-all">
  398. <div id="-,Complex[T],Complex[T]">
  399. <dt><pre><span class="Keyword">func</span> <a href="#-%2CComplex%5BT%5D%2CComplex%5BT%5D"><span class="Identifier">`-`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  400. <dd>
  401. Subtracts two complex numbers.
  402. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L124" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  403. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L124" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  404. </dd>
  405. </div>
  406. <div id="-,Complex[T],T">
  407. <dt><pre><span class="Keyword">func</span> <a href="#-%2CComplex%5BT%5D%2CT"><span class="Identifier">`-`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  408. <dd>
  409. Subtracts a real number from a complex number.
  410. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L120" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  411. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L120" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  412. </dd>
  413. </div>
  414. <div id="-,T,Complex[T]">
  415. <dt><pre><span class="Keyword">func</span> <a href="#-%2CT%2CComplex%5BT%5D"><span class="Identifier">`-`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  416. <dd>
  417. Subtracts a complex number from a real number.
  418. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L116" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  419. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L116" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  420. </dd>
  421. </div>
  422. <div id="-,Complex[T]">
  423. <dt><pre><span class="Keyword">func</span> <a href="#-%2CComplex%5BT%5D"><span class="Identifier">`-`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  424. <dd>
  425. Unary minus for complex numbers.
  426. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L112" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  427. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L112" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  428. </dd>
  429. </div>
  430. </div>
  431. <div id="-=-procs-all">
  432. <div id="-=,Complex[T],Complex[T]">
  433. <dt><pre><span class="Keyword">func</span> <a href="#-%3D%2CComplex%5BT%5D%2CComplex%5BT%5D"><span class="Identifier">`-=`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span></pre></dt>
  434. <dd>
  435. Subtracts <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> from <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.
  436. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L158" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  437. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L158" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  438. </dd>
  439. </div>
  440. </div>
  441. <div id="/-procs-all">
  442. <div id="/,Complex[T],Complex[T]">
  443. <dt><pre><span class="Keyword">func</span> <a href="#%2F%2CComplex%5BT%5D%2CComplex%5BT%5D"><span class="Identifier">`/`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  444. <dd>
  445. Divides two complex numbers.
  446. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L149" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  447. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L149" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  448. </dd>
  449. </div>
  450. <div id="/,Complex[T],T">
  451. <dt><pre><span class="Keyword">func</span> <a href="#%2F%2CComplex%5BT%5D%2CT"><span class="Identifier">`/`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  452. <dd>
  453. Divides a complex number by a real number.
  454. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L141" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  455. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L141" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  456. </dd>
  457. </div>
  458. <div id="/,T,Complex[T]">
  459. <dt><pre><span class="Keyword">func</span> <a href="#%2F%2CT%2CComplex%5BT%5D"><span class="Identifier">`/`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  460. <dd>
  461. Divides a real number by a complex number.
  462. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L145" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  463. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L145" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  464. </dd>
  465. </div>
  466. </div>
  467. <div id="/=-procs-all">
  468. <div id="/=,Complex[T],Complex[T]">
  469. <dt><pre><span class="Keyword">func</span> <a href="#%2F%3D%2CComplex%5BT%5D%2CComplex%5BT%5D"><span class="Identifier">`/=`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span></pre></dt>
  470. <dd>
  471. Divides <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> by <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> in place.
  472. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L169" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  473. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L169" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  474. </dd>
  475. </div>
  476. </div>
  477. <div id="==-procs-all">
  478. <div id="==,Complex[T],Complex[T]">
  479. <dt><pre><span class="Keyword">func</span> <a href="#%3D%3D%2CComplex%5BT%5D%2CComplex%5BT%5D"><span class="Identifier">`==`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a></pre></dt>
  480. <dd>
  481. Compares two complex numbers for equality.
  482. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L96" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  483. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L96" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  484. </dd>
  485. </div>
  486. </div>
  487. <div id="abs-procs-all">
  488. <div id="abs,Complex[T]">
  489. <dt><pre><span class="Keyword">func</span> <a href="#abs%2CComplex%5BT%5D"><span class="Identifier">abs</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span></pre></dt>
  490. <dd>
  491. Returns the absolute value of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>, that is the distance from (0, 0) to <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.
  492. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L68" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  493. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L68" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  494. </dd>
  495. </div>
  496. </div>
  497. <div id="abs2-procs-all">
  498. <div id="abs2,Complex[T]">
  499. <dt><pre><span class="Keyword">func</span> <a href="#abs2%2CComplex%5BT%5D"><span class="Identifier">abs2</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span></pre></dt>
  500. <dd>
  501. Returns the squared absolute value of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>, that is the squared distance from (0, 0) to <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>. This is more efficient than <tt class="docutils literal"><span class="pre"><span class="Identifier">abs</span><span class="Punctuation">(</span><span class="Identifier">z</span><span class="Punctuation">)</span> <span class="Operator">^</span> <span class="DecNumber">2</span></span></tt>.
  502. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L73" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  503. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L73" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  504. </dd>
  505. </div>
  506. </div>
  507. <div id="almostEqual-procs-all">
  508. <div id="almostEqual,Complex[T: SomeFloat],Complex[T: SomeFloat],Natural">
  509. <dt><pre><span class="Keyword">func</span> <a href="#almostEqual%2CComplex%5BT%3A%20SomeFloat%5D%2CComplex%5BT%3A%20SomeFloat%5D%2CNatural"><span class="Identifier">almostEqual</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#SomeFloat"><span class="Identifier">SomeFloat</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">unitsInLastPlace</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a> <span class="Other">=</span> <span class="DecNumber">4</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a></pre></dt>
  510. <dd>
  511. <p>Checks if two complex values are almost equal, using the <a class="reference external" href="https://en.wikipedia.org/wiki/Machine_epsilon">machine epsilon</a>.</p>
  512. <p>Two complex values are considered almost equal if their real and imaginary components are almost equal.</p>
  513. <p><tt class="docutils literal"><span class="pre"><span class="Identifier">unitsInLastPlace</span></span></tt> is the max number of <a class="reference external" href="https://en.wikipedia.org/wiki/Unit_in_the_last_place">units in the last place</a> difference tolerated when comparing two numbers. The larger the value, the more error is allowed. A <tt class="docutils literal"><span class="pre"><span class="DecNumber">0</span></span></tt> value means that two numbers must be exactly the same to be considered equal.</p>
  514. <p>The machine epsilon has to be scaled to the magnitude of the values used and multiplied by the desired precision in ULPs unless the difference is subnormal.</p>
  515. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L391" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  516. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L391" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  517. </dd>
  518. </div>
  519. </div>
  520. <div id="arccos-procs-all">
  521. <div id="arccos,Complex[T]">
  522. <dt><pre><span class="Keyword">func</span> <a href="#arccos%2CComplex%5BT%5D"><span class="Identifier">arccos</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  523. <dd>
  524. Returns the inverse cosine of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.
  525. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L281" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  526. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L281" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  527. </dd>
  528. </div>
  529. </div>
  530. <div id="arccosh-procs-all">
  531. <div id="arccosh,Complex[T]">
  532. <dt><pre><span class="Keyword">func</span> <a href="#arccosh%2CComplex%5BT%5D"><span class="Identifier">arccosh</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  533. <dd>
  534. Returns the inverse hyperbolic cosine of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.
  535. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L329" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  536. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L329" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  537. </dd>
  538. </div>
  539. </div>
  540. <div id="arccot-procs-all">
  541. <div id="arccot,Complex[T]">
  542. <dt><pre><span class="Keyword">func</span> <a href="#arccot%2CComplex%5BT%5D"><span class="Identifier">arccot</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  543. <dd>
  544. Returns the inverse cotangent of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.
  545. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L297" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  546. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L297" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  547. </dd>
  548. </div>
  549. </div>
  550. <div id="arccoth-procs-all">
  551. <div id="arccoth,Complex[T]">
  552. <dt><pre><span class="Keyword">func</span> <a href="#arccoth%2CComplex%5BT%5D"><span class="Identifier">arccoth</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  553. <dd>
  554. Returns the inverse hyperbolic cotangent of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.
  555. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L345" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  556. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L345" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  557. </dd>
  558. </div>
  559. </div>
  560. <div id="arccsc-procs-all">
  561. <div id="arccsc,Complex[T]">
  562. <dt><pre><span class="Keyword">func</span> <a href="#arccsc%2CComplex%5BT%5D"><span class="Identifier">arccsc</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  563. <dd>
  564. Returns the inverse cosecant of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.
  565. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L313" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  566. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L313" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  567. </dd>
  568. </div>
  569. </div>
  570. <div id="arccsch-procs-all">
  571. <div id="arccsch,Complex[T]">
  572. <dt><pre><span class="Keyword">func</span> <a href="#arccsch%2CComplex%5BT%5D"><span class="Identifier">arccsch</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  573. <dd>
  574. Returns the inverse hyperbolic cosecant of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.
  575. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L361" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  576. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L361" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  577. </dd>
  578. </div>
  579. </div>
  580. <div id="arcsec-procs-all">
  581. <div id="arcsec,Complex[T]">
  582. <dt><pre><span class="Keyword">func</span> <a href="#arcsec%2CComplex%5BT%5D"><span class="Identifier">arcsec</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  583. <dd>
  584. Returns the inverse secant of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.
  585. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L305" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  586. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L305" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  587. </dd>
  588. </div>
  589. </div>
  590. <div id="arcsech-procs-all">
  591. <div id="arcsech,Complex[T]">
  592. <dt><pre><span class="Keyword">func</span> <a href="#arcsech%2CComplex%5BT%5D"><span class="Identifier">arcsech</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  593. <dd>
  594. Returns the inverse hyperbolic secant of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.
  595. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L353" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  596. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L353" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  597. </dd>
  598. </div>
  599. </div>
  600. <div id="arcsin-procs-all">
  601. <div id="arcsin,Complex[T]">
  602. <dt><pre><span class="Keyword">func</span> <a href="#arcsin%2CComplex%5BT%5D"><span class="Identifier">arcsin</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  603. <dd>
  604. Returns the inverse sine of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.
  605. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L271" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  606. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L271" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  607. </dd>
  608. </div>
  609. </div>
  610. <div id="arcsinh-procs-all">
  611. <div id="arcsinh,Complex[T]">
  612. <dt><pre><span class="Keyword">func</span> <a href="#arcsinh%2CComplex%5BT%5D"><span class="Identifier">arcsinh</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  613. <dd>
  614. Returns the inverse hyperbolic sine of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.
  615. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L321" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  616. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L321" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  617. </dd>
  618. </div>
  619. </div>
  620. <div id="arctan-procs-all">
  621. <div id="arctan,Complex[T]">
  622. <dt><pre><span class="Keyword">func</span> <a href="#arctan%2CComplex%5BT%5D"><span class="Identifier">arctan</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  623. <dd>
  624. Returns the inverse tangent of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.
  625. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L289" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  626. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L289" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  627. </dd>
  628. </div>
  629. </div>
  630. <div id="arctanh-procs-all">
  631. <div id="arctanh,Complex[T]">
  632. <dt><pre><span class="Keyword">func</span> <a href="#arctanh%2CComplex%5BT%5D"><span class="Identifier">arctanh</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  633. <dd>
  634. Returns the inverse hyperbolic tangent of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.
  635. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L337" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  636. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L337" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  637. </dd>
  638. </div>
  639. </div>
  640. <div id="complex-procs-all">
  641. <div id="complex,T,T">
  642. <dt><pre><span class="Keyword">func</span> <a href="#complex%2CT%2CT"><span class="Identifier">complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#SomeFloat"><span class="Identifier">SomeFloat</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">re</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">im</span><span class="Other">:</span> <span class="Identifier">T</span> <span class="Other">=</span> <span class="FloatNumber">0.0</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  643. <dd>
  644. Returns a <tt class="docutils literal"><span class="pre"><span class="Identifier">Complex</span><span class="Punctuation">[</span><span class="Identifier">T</span><span class="Punctuation">]</span></span></tt> with real part <tt class="docutils literal"><span class="pre"><span class="Identifier">re</span></span></tt> and imaginary part <tt class="docutils literal"><span class="pre"><span class="Identifier">im</span></span></tt>.
  645. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L47" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  646. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L47" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  647. </dd>
  648. </div>
  649. </div>
  650. <div id="complex32-procs-all">
  651. <div id="complex32,float32,float32">
  652. <dt><pre><span class="Keyword">func</span> <a href="#complex32%2Cfloat32%2Cfloat32"><span class="Identifier">complex32</span></a><span class="Other">(</span><span class="Identifier">re</span><span class="Other">:</span> <a href="system.html#float32"><span class="Identifier">float32</span></a><span class="Other">;</span> <span class="Identifier">im</span><span class="Other">:</span> <a href="system.html#float32"><span class="Identifier">float32</span></a> <span class="Other">=</span> <span class="FloatNumber">0.0</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex32"><span class="Identifier">Complex32</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
  653. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  654. <dd>
  655. Returns a <tt class="docutils literal"><span class="pre"><span class="Identifier">Complex32</span></span></tt> with real part <tt class="docutils literal"><span class="pre"><span class="Identifier">re</span></span></tt> and imaginary part <tt class="docutils literal"><span class="pre"><span class="Identifier">im</span></span></tt>.
  656. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L51" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  657. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L51" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  658. </dd>
  659. </div>
  660. </div>
  661. <div id="complex64-procs-all">
  662. <div id="complex64,float64,float64">
  663. <dt><pre><span class="Keyword">func</span> <a href="#complex64%2Cfloat64%2Cfloat64"><span class="Identifier">complex64</span></a><span class="Other">(</span><span class="Identifier">re</span><span class="Other">:</span> <a href="system.html#float64"><span class="Identifier">float64</span></a><span class="Other">;</span> <span class="Identifier">im</span><span class="Other">:</span> <a href="system.html#float64"><span class="Identifier">float64</span></a> <span class="Other">=</span> <span class="FloatNumber">0.0</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex64"><span class="Identifier">Complex64</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
  664. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  665. <dd>
  666. Returns a <tt class="docutils literal"><span class="pre"><span class="Identifier">Complex64</span></span></tt> with real part <tt class="docutils literal"><span class="pre"><span class="Identifier">re</span></span></tt> and imaginary part <tt class="docutils literal"><span class="pre"><span class="Identifier">im</span></span></tt>.
  667. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L55" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  668. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L55" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  669. </dd>
  670. </div>
  671. </div>
  672. <div id="conjugate-procs-all">
  673. <div id="conjugate,Complex[T]">
  674. <dt><pre><span class="Keyword">func</span> <a href="#conjugate%2CComplex%5BT%5D"><span class="Identifier">conjugate</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  675. <dd>
  676. Returns the complex conjugate of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt> (<tt class="docutils literal"><span class="pre"><span class="Identifier">complex</span><span class="Punctuation">(</span><span class="Identifier">z</span><span class="Operator">.</span><span class="Identifier">re</span><span class="Punctuation">,</span> <span class="Operator">-</span><span class="Identifier">z</span><span class="Operator">.</span><span class="Identifier">im</span><span class="Punctuation">)</span></span></tt>).
  677. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L88" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  678. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L88" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  679. </dd>
  680. </div>
  681. </div>
  682. <div id="cos-procs-all">
  683. <div id="cos,Complex[T]">
  684. <dt><pre><span class="Keyword">func</span> <a href="#cos%2CComplex%5BT%5D"><span class="Identifier">cos</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  685. <dd>
  686. Returns the cosine of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.
  687. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L275" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  688. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L275" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  689. </dd>
  690. </div>
  691. </div>
  692. <div id="cosh-procs-all">
  693. <div id="cosh,Complex[T]">
  694. <dt><pre><span class="Keyword">func</span> <a href="#cosh%2CComplex%5BT%5D"><span class="Identifier">cosh</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  695. <dd>
  696. Returns the hyperbolic cosine of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.
  697. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L325" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  698. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L325" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  699. </dd>
  700. </div>
  701. </div>
  702. <div id="cot-procs-all">
  703. <div id="cot,Complex[T]">
  704. <dt><pre><span class="Keyword">func</span> <a href="#cot%2CComplex%5BT%5D"><span class="Identifier">cot</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  705. <dd>
  706. Returns the cotangent of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.
  707. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L293" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  708. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L293" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  709. </dd>
  710. </div>
  711. </div>
  712. <div id="coth-procs-all">
  713. <div id="coth,Complex[T]">
  714. <dt><pre><span class="Keyword">func</span> <a href="#coth%2CComplex%5BT%5D"><span class="Identifier">coth</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  715. <dd>
  716. Returns the hyperbolic cotangent of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.
  717. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L341" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  718. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L341" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  719. </dd>
  720. </div>
  721. </div>
  722. <div id="csc-procs-all">
  723. <div id="csc,Complex[T]">
  724. <dt><pre><span class="Keyword">func</span> <a href="#csc%2CComplex%5BT%5D"><span class="Identifier">csc</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  725. <dd>
  726. Returns the cosecant of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.
  727. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L309" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  728. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L309" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  729. </dd>
  730. </div>
  731. </div>
  732. <div id="csch-procs-all">
  733. <div id="csch,Complex[T]">
  734. <dt><pre><span class="Keyword">func</span> <a href="#csch%2CComplex%5BT%5D"><span class="Identifier">csch</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  735. <dd>
  736. Returns the hyperbolic cosecant of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.
  737. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L357" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  738. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L357" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  739. </dd>
  740. </div>
  741. </div>
  742. <div id="exp-procs-all">
  743. <div id="exp,Complex[T]">
  744. <dt><pre><span class="Keyword">func</span> <a href="#exp%2CComplex%5BT%5D"><span class="Identifier">exp</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  745. <dd>
  746. Computes the exponential function (<tt class="docutils literal"><span class="pre"><span class="Identifier">e</span><span class="Operator">^</span><span class="Identifier">z</span></span></tt>).
  747. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L198" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  748. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L198" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  749. </dd>
  750. </div>
  751. </div>
  752. <div id="formatValue-procs-all">
  753. <div id="formatValue,string,Complex,string">
  754. <dt><pre><span class="Keyword">proc</span> <a href="#formatValue%2Cstring%2CComplex%2Cstring"><span class="Identifier">formatValue</span></a><span class="Other">(</span><span class="Identifier">result</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">value</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">;</span> <span class="Identifier">specifier</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span></pre></dt>
  755. <dd>
  756. Standard format implementation for <tt class="docutils literal"><span class="pre"><span class="Identifier">Complex</span></span></tt>. It makes little sense to call this directly, but it is required to exist by the <tt class="docutils literal"><span class="pre"><span class="Operator">&amp;</span></span></tt> macro. For complex numbers, we add a specific 'j' specifier, which formats the value as (A+Bj) like in mathematics.
  757. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L439" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  758. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L439" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  759. </dd>
  760. </div>
  761. </div>
  762. <div id="inv-procs-all">
  763. <div id="inv,Complex[T]">
  764. <dt><pre><span class="Keyword">func</span> <a href="#inv%2CComplex%5BT%5D"><span class="Identifier">inv</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  765. <dd>
  766. Returns the multiplicative inverse of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt> (<tt class="docutils literal"><span class="pre"><span class="DecNumber">1</span><span class="Operator">/</span><span class="Identifier">z</span></span></tt>).
  767. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L92" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  768. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L92" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  769. </dd>
  770. </div>
  771. </div>
  772. <div id="ln-procs-all">
  773. <div id="ln,Complex[T]">
  774. <dt><pre><span class="Keyword">func</span> <a href="#ln%2CComplex%5BT%5D"><span class="Identifier">ln</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  775. <dd>
  776. Returns the (<a class="reference external" href="https://en.wikipedia.org/wiki/Complex_logarithm#Principal_value">principal value</a> of the) natural logarithm of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.
  777. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L205" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  778. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L205" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  779. </dd>
  780. </div>
  781. </div>
  782. <div id="log2-procs-all">
  783. <div id="log2,Complex[T]">
  784. <dt><pre><span class="Keyword">func</span> <a href="#log2%2CComplex%5BT%5D"><span class="Identifier">log2</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  785. <dd>
  786. <p>Returns the logarithm base 2 of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.</p>
  787. <p><strong>See also:</strong></p>
  788. <ul class="simple"><li><a class="reference external" href="#ln,Complex[T]">ln func</a></li>
  789. </ul>
  790. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L218" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  791. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L218" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  792. </dd>
  793. </div>
  794. </div>
  795. <div id="log10-procs-all">
  796. <div id="log10,Complex[T]">
  797. <dt><pre><span class="Keyword">func</span> <a href="#log10%2CComplex%5BT%5D"><span class="Identifier">log10</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  798. <dd>
  799. <p>Returns the logarithm base 10 of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.</p>
  800. <p><strong>See also:</strong></p>
  801. <ul class="simple"><li><a class="reference external" href="#ln,Complex[T]">ln func</a></li>
  802. </ul>
  803. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L211" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  804. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L211" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  805. </dd>
  806. </div>
  807. </div>
  808. <div id="phase-procs-all">
  809. <div id="phase,Complex[T]">
  810. <dt><pre><span class="Keyword">func</span> <a href="#phase%2CComplex%5BT%5D"><span class="Identifier">phase</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span></pre></dt>
  811. <dd>
  812. Returns the phase (or argument) of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>, that is the angle in polar representation.<p><tt class="docutils literal"><span class="pre"><span class="Identifier">result</span> <span class="Operator">=</span> <span class="Identifier">arctan2</span><span class="Punctuation">(</span><span class="Identifier">z</span><span class="Operator">.</span><span class="Identifier">im</span><span class="Punctuation">,</span> <span class="Identifier">z</span><span class="Operator">.</span><span class="Identifier">re</span><span class="Punctuation">)</span></span></tt><br/></p>
  813. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L365" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  814. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L365" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  815. </dd>
  816. </div>
  817. </div>
  818. <div id="polar-procs-all">
  819. <div id="polar,Complex[T]">
  820. <dt><pre><span class="Keyword">func</span> <a href="#polar%2CComplex%5BT%5D"><span class="Identifier">polar</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">r</span><span class="Other">,</span> <span class="Identifier">phi</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  821. <dd>
  822. Returns <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt> in polar coordinates.<p><tt class="docutils literal"><span class="pre"><span class="Identifier">result</span><span class="Operator">.</span><span class="Identifier">r</span> <span class="Operator">=</span> <span class="Identifier">abs</span><span class="Punctuation">(</span><span class="Identifier">z</span><span class="Punctuation">)</span></span></tt><br/><tt class="docutils literal"><span class="pre"><span class="Identifier">result</span><span class="Operator">.</span><span class="Identifier">phi</span> <span class="Operator">=</span> <span class="Identifier">phase</span><span class="Punctuation">(</span><span class="Identifier">z</span><span class="Punctuation">)</span></span></tt><br/></p><p><strong>See also:</strong></p>
  823. <ul class="simple"><li><a class="reference external" href="#rect,T,T">rect func</a> for the inverse operation</li>
  824. </ul>
  825. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L371" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  826. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L371" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  827. </dd>
  828. </div>
  829. </div>
  830. <div id="pow-procs-all">
  831. <div id="pow,Complex[T],Complex[T]">
  832. <dt><pre><span class="Keyword">func</span> <a href="#pow%2CComplex%5BT%5D%2CComplex%5BT%5D"><span class="Identifier">pow</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  833. <dd>
  834. <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> raised to the power of <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.
  835. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L225" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  836. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L225" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  837. </dd>
  838. </div>
  839. <div id="pow,Complex[T],T">
  840. <dt><pre><span class="Keyword">func</span> <a href="#pow%2CComplex%5BT%5D%2CT"><span class="Identifier">pow</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  841. <dd>
  842. The complex number <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> raised to the power of the real number <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.
  843. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L263" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  844. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L263" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  845. </dd>
  846. </div>
  847. </div>
  848. <div id="rect-procs-all">
  849. <div id="rect,T,T">
  850. <dt><pre><span class="Keyword">func</span> <a href="#rect%2CT%2CT"><span class="Identifier">rect</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">r</span><span class="Other">,</span> <span class="Identifier">phi</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  851. <dd>
  852. Returns the complex number with polar coordinates <tt class="docutils literal"><span class="pre"><span class="Identifier">r</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">phi</span></span></tt>.<p><tt class="docutils literal"><span class="pre"><span class="Identifier">result</span><span class="Operator">.</span><span class="Identifier">re</span> <span class="Operator">=</span> <span class="Identifier">r</span> <span class="Operator">*</span> <span class="Identifier">cos</span><span class="Punctuation">(</span><span class="Identifier">phi</span><span class="Punctuation">)</span></span></tt><br/><tt class="docutils literal"><span class="pre"><span class="Identifier">result</span><span class="Operator">.</span><span class="Identifier">im</span> <span class="Operator">=</span> <span class="Identifier">r</span> <span class="Operator">*</span> <span class="Identifier">sin</span><span class="Punctuation">(</span><span class="Identifier">phi</span><span class="Punctuation">)</span></span></tt><br/></p><p><strong>See also:</strong></p>
  853. <ul class="simple"><li><a class="reference external" href="#polar,Complex[T]">polar func</a> for the inverse operation</li>
  854. </ul>
  855. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L381" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  856. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L381" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  857. </dd>
  858. </div>
  859. </div>
  860. <div id="sec-procs-all">
  861. <div id="sec,Complex[T]">
  862. <dt><pre><span class="Keyword">func</span> <a href="#sec%2CComplex%5BT%5D"><span class="Identifier">sec</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  863. <dd>
  864. Returns the secant of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.
  865. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L301" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  866. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L301" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  867. </dd>
  868. </div>
  869. </div>
  870. <div id="sech-procs-all">
  871. <div id="sech,Complex[T]">
  872. <dt><pre><span class="Keyword">func</span> <a href="#sech%2CComplex%5BT%5D"><span class="Identifier">sech</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  873. <dd>
  874. Returns the hyperbolic secant of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.
  875. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L349" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  876. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L349" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  877. </dd>
  878. </div>
  879. </div>
  880. <div id="sgn-procs-all">
  881. <div id="sgn,Complex[T]">
  882. <dt><pre><span class="Keyword">func</span> <a href="#sgn%2CComplex%5BT%5D"><span class="Identifier">sgn</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  883. <dd>
  884. Returns the phase of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt> as a unit complex number, or 0 if <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt> is 0.
  885. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L79" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  886. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L79" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  887. </dd>
  888. </div>
  889. </div>
  890. <div id="sin-procs-all">
  891. <div id="sin,Complex[T]">
  892. <dt><pre><span class="Keyword">func</span> <a href="#sin%2CComplex%5BT%5D"><span class="Identifier">sin</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  893. <dd>
  894. Returns the sine of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.
  895. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L267" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  896. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L267" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  897. </dd>
  898. </div>
  899. </div>
  900. <div id="sinh-procs-all">
  901. <div id="sinh,Complex[T]">
  902. <dt><pre><span class="Keyword">func</span> <a href="#sinh%2CComplex%5BT%5D"><span class="Identifier">sinh</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  903. <dd>
  904. Returns the hyperbolic sine of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.
  905. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L317" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  906. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L317" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  907. </dd>
  908. </div>
  909. </div>
  910. <div id="sqrt-procs-all">
  911. <div id="sqrt,Complex[T]">
  912. <dt><pre><span class="Keyword">func</span> <a href="#sqrt%2CComplex%5BT%5D"><span class="Identifier">sqrt</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  913. <dd>
  914. Computes the (<a class="reference external" href="https://en.wikipedia.org/wiki/Square_root#Principal_square_root_of_a_complex_number">principal</a>) square root of a complex number <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.
  915. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L174" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  916. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L174" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  917. </dd>
  918. </div>
  919. </div>
  920. <div id="tan-procs-all">
  921. <div id="tan,Complex[T]">
  922. <dt><pre><span class="Keyword">func</span> <a href="#tan%2CComplex%5BT%5D"><span class="Identifier">tan</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  923. <dd>
  924. Returns the tangent of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.
  925. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L285" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  926. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L285" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  927. </dd>
  928. </div>
  929. </div>
  930. <div id="tanh-procs-all">
  931. <div id="tanh,Complex[T]">
  932. <dt><pre><span class="Keyword">func</span> <a href="#tanh%2CComplex%5BT%5D"><span class="Identifier">tanh</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">z</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex"><span class="Identifier">Complex</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
  933. <dd>
  934. Returns the hyperbolic tangent of <tt class="docutils literal"><span class="pre"><span class="Identifier">z</span></span></tt>.
  935. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L333" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  936. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L333" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  937. </dd>
  938. </div>
  939. </div>
  940. </dl>
  941. </div>
  942. <div class="section" id="18">
  943. <h1><a class="toc-backref" href="#18">Templates</a></h1>
  944. <dl class="item">
  945. <div id="im-templates-all">
  946. <div id="im.t,float32">
  947. <dt><pre><span class="Keyword">template</span> <a href="#im.t%2Cfloat32"><span class="Identifier">im</span></a><span class="Other">(</span><span class="Identifier">arg</span><span class="Other">:</span> <a href="system.html#float32"><span class="Identifier">float32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex32"><span class="Identifier">Complex32</span></a></pre></dt>
  948. <dd>
  949. Returns <tt class="docutils literal"><span class="pre"><span class="Identifier">arg</span></span></tt> as an imaginary number (<tt class="docutils literal"><span class="pre"><span class="Identifier">complex32</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">,</span> <span class="Identifier">arg</span><span class="Punctuation">)</span></span></tt>).
  950. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L63" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  951. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L63" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  952. </dd>
  953. </div>
  954. <div id="im.t,float64">
  955. <dt><pre><span class="Keyword">template</span> <a href="#im.t%2Cfloat64"><span class="Identifier">im</span></a><span class="Other">(</span><span class="Identifier">arg</span><span class="Other">:</span> <a href="system.html#float64"><span class="Identifier">float64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex64"><span class="Identifier">Complex64</span></a></pre></dt>
  956. <dd>
  957. Returns <tt class="docutils literal"><span class="pre"><span class="Identifier">arg</span></span></tt> as an imaginary number (<tt class="docutils literal"><span class="pre"><span class="Identifier">complex64</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">,</span> <span class="Identifier">arg</span><span class="Punctuation">)</span></span></tt>).
  958. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L65" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  959. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L65" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  960. </dd>
  961. </div>
  962. <div id="im.t,typedesc[float32]">
  963. <dt><pre><span class="Keyword">template</span> <a href="#im.t%2Ctypedesc%5Bfloat32%5D"><span class="Identifier">im</span></a><span class="Other">(</span><span class="Identifier">arg</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><a href="system.html#float32"><span class="Identifier">float32</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex32"><span class="Identifier">Complex32</span></a></pre></dt>
  964. <dd>
  965. Returns the imaginary unit (<tt class="docutils literal"><span class="pre"><span class="Identifier">complex32</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">)</span></span></tt>).
  966. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L59" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  967. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L59" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  968. </dd>
  969. </div>
  970. <div id="im.t,typedesc[float64]">
  971. <dt><pre><span class="Keyword">template</span> <a href="#im.t%2Ctypedesc%5Bfloat64%5D"><span class="Identifier">im</span></a><span class="Other">(</span><span class="Identifier">arg</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><a href="system.html#float64"><span class="Identifier">float64</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="complex.html#Complex64"><span class="Identifier">Complex64</span></a></pre></dt>
  972. <dd>
  973. Returns the imaginary unit (<tt class="docutils literal"><span class="pre"><span class="Identifier">complex64</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">)</span></span></tt>).
  974. <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/complex.nim#L61" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
  975. <a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/complex.nim#L61" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;
  976. </dd>
  977. </div>
  978. </div>
  979. </dl>
  980. </div>
  981. </div>
  982. </div>
  983. <div class="twelve-columns footer">
  984. <span class="nim-sprite"></span>
  985. <br>
  986. <small style="color: var(--hint);">Made with Nim. Generated: 2025-03-15 14:13:19 UTC</small>
  987. </div>
  988. </div>
  989. </div>
  990. <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
  991. </body>
  992. </html>