You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

index.html 13 kB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549
  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <link rel="canonical" href="https://openblas.net/docs/extensions/">
  7. <link rel="prev" href="../user_manual/">
  8. <link rel="next" href="../developers/">
  9. <link rel="icon" href="../logo.svg">
  10. <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.22">
  11. <title>Extensions - OpenBLAS</title>
  12. <link rel="stylesheet" href="../assets/stylesheets/main.732c4fb1.min.css">
  13. <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
  14. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  15. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
  16. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  17. <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  18. </head>
  19. <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="grey" data-md-color-accent="indigo">
  20. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  21. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  22. <label class="md-overlay" for="__drawer"></label>
  23. <div data-md-component="skip">
  24. </div>
  25. <div data-md-component="announce">
  26. </div>
  27. <header class="md-header md-header--shadow" data-md-component="header">
  28. <nav class="md-header__inner md-grid" aria-label="Header">
  29. <a href=".." title="OpenBLAS" class="md-header__button md-logo" aria-label="OpenBLAS" data-md-component="logo">
  30. <img src="../logo.svg" alt="logo">
  31. </a>
  32. <label class="md-header__button md-icon" for="__drawer">
  33. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
  34. </label>
  35. <div class="md-header__title" data-md-component="header-title">
  36. <div class="md-header__ellipsis">
  37. <div class="md-header__topic">
  38. <span class="md-ellipsis">
  39. OpenBLAS
  40. </span>
  41. </div>
  42. <div class="md-header__topic" data-md-component="header-topic">
  43. <span class="md-ellipsis">
  44. Extensions
  45. </span>
  46. </div>
  47. </div>
  48. </div>
  49. <label class="md-header__button md-icon" for="__search">
  50. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
  51. </label>
  52. <div class="md-search" data-md-component="search" role="dialog">
  53. <label class="md-search__overlay" for="__search"></label>
  54. <div class="md-search__inner" role="search">
  55. <form class="md-search__form" name="search">
  56. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
  57. <label class="md-search__icon md-icon" for="__search">
  58. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
  59. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
  60. </label>
  61. <nav class="md-search__options" aria-label="Search">
  62. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  63. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
  64. </button>
  65. </nav>
  66. </form>
  67. <div class="md-search__output">
  68. <div class="md-search__scrollwrap" data-md-scrollfix>
  69. <div class="md-search-result" data-md-component="search-result">
  70. <div class="md-search-result__meta">
  71. Initializing search
  72. </div>
  73. <ol class="md-search-result__list" role="presentation"></ol>
  74. </div>
  75. </div>
  76. </div>
  77. </div>
  78. </div>
  79. </nav>
  80. </header>
  81. <div class="md-container" data-md-component="container">
  82. <main class="md-main" data-md-component="main">
  83. <div class="md-main__inner md-grid">
  84. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  85. <div class="md-sidebar__scrollwrap">
  86. <div class="md-sidebar__inner">
  87. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  88. <label class="md-nav__title" for="__drawer">
  89. <a href=".." title="OpenBLAS" class="md-nav__button md-logo" aria-label="OpenBLAS" data-md-component="logo">
  90. <img src="../logo.svg" alt="logo">
  91. </a>
  92. OpenBLAS
  93. </label>
  94. <ul class="md-nav__list" data-md-scrollfix>
  95. <li class="md-nav__item">
  96. <a href=".." class="md-nav__link">
  97. <span class="md-ellipsis">
  98. Home
  99. </span>
  100. </a>
  101. </li>
  102. <li class="md-nav__item">
  103. <a href="../install/" class="md-nav__link">
  104. <span class="md-ellipsis">
  105. Install OpenBLAS
  106. </span>
  107. </a>
  108. </li>
  109. <li class="md-nav__item">
  110. <a href="../user_manual/" class="md-nav__link">
  111. <span class="md-ellipsis">
  112. User manual
  113. </span>
  114. </a>
  115. </li>
  116. <li class="md-nav__item md-nav__item--active">
  117. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  118. <a href="./" class="md-nav__link md-nav__link--active">
  119. <span class="md-ellipsis">
  120. Extensions
  121. </span>
  122. </a>
  123. </li>
  124. <li class="md-nav__item">
  125. <a href="../developers/" class="md-nav__link">
  126. <span class="md-ellipsis">
  127. Developer manual
  128. </span>
  129. </a>
  130. </li>
  131. <li class="md-nav__item">
  132. <a href="../build_system/" class="md-nav__link">
  133. <span class="md-ellipsis">
  134. Build system
  135. </span>
  136. </a>
  137. </li>
  138. <li class="md-nav__item">
  139. <a href="../distributing/" class="md-nav__link">
  140. <span class="md-ellipsis">
  141. Redistributing OpenBLAS
  142. </span>
  143. </a>
  144. </li>
  145. <li class="md-nav__item">
  146. <a href="../ci/" class="md-nav__link">
  147. <span class="md-ellipsis">
  148. CI jobs
  149. </span>
  150. </a>
  151. </li>
  152. <li class="md-nav__item">
  153. <a href="../about/" class="md-nav__link">
  154. <span class="md-ellipsis">
  155. About
  156. </span>
  157. </a>
  158. </li>
  159. <li class="md-nav__item">
  160. <a href="../faq/" class="md-nav__link">
  161. <span class="md-ellipsis">
  162. FAQ
  163. </span>
  164. </a>
  165. </li>
  166. </ul>
  167. </nav>
  168. </div>
  169. </div>
  170. </div>
  171. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  172. <div class="md-sidebar__scrollwrap">
  173. <div class="md-sidebar__inner">
  174. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  175. </nav>
  176. </div>
  177. </div>
  178. </div>
  179. <div class="md-content" data-md-component="content">
  180. <article class="md-content__inner md-typeset">
  181. <h1>Extensions</h1>
  182. <ul>
  183. <li>BLAS-like extensions</li>
  184. </ul>
  185. <table>
  186. <thead>
  187. <tr>
  188. <th>Routine</th>
  189. <th style="text-align: left;">Data Types</th>
  190. <th style="text-align: left;">Description</th>
  191. </tr>
  192. </thead>
  193. <tbody>
  194. <tr>
  195. <td>?axpby</td>
  196. <td style="text-align: left;">s,d,c,z</td>
  197. <td style="text-align: left;">like axpy with a multiplier for y</td>
  198. </tr>
  199. <tr>
  200. <td>?gemm3m</td>
  201. <td style="text-align: left;">c,z</td>
  202. <td style="text-align: left;">gemm3m</td>
  203. </tr>
  204. <tr>
  205. <td>?imatcopy</td>
  206. <td style="text-align: left;">s,d,c,z</td>
  207. <td style="text-align: left;">in-place transpositon/copying</td>
  208. </tr>
  209. <tr>
  210. <td>?omatcopy</td>
  211. <td style="text-align: left;">s,d,c,z</td>
  212. <td style="text-align: left;">out-of-place transpositon/copying</td>
  213. </tr>
  214. <tr>
  215. <td>?geadd</td>
  216. <td style="text-align: left;">s,d,c,z</td>
  217. <td style="text-align: left;">matrix add</td>
  218. </tr>
  219. <tr>
  220. <td>?gemmt</td>
  221. <td style="text-align: left;">s,d,c,z</td>
  222. <td style="text-align: left;">gemm but only a triangular part updated</td>
  223. </tr>
  224. </tbody>
  225. </table>
  226. <ul>
  227. <li>BLAS-like and Conversion functions for bfloat16 (available when OpenBLAS was compiled with BUILD_BFLOAT16=1)</li>
  228. <li><code>void cblas_sbstobf16</code> converts a float array to an array of bfloat16 values by rounding</li>
  229. <li><code>void cblas_sbdtobf16</code> converts a double array to an array of bfloat16 values by rounding</li>
  230. <li><code>void cblas_sbf16tos</code> converts a bfloat16 array to an array of floats</li>
  231. <li><code>void cblas_dbf16tod</code> converts a bfloat16 array to an array of doubles</li>
  232. <li><code>float cblas_sbdot</code> computes the dot product of two bfloat16 arrays</li>
  233. <li><code>void cblas_sbgemv</code> performs the matrix-vector operations of GEMV with the input matrix and X vector as bfloat16 </li>
  234. <li>
  235. <p><code>void cblas_sbgemm</code> performs the matrix-matrix operations of GEMM with both input arrays containing bfloat16</p>
  236. </li>
  237. <li>
  238. <p>Utility functions</p>
  239. </li>
  240. <li>openblas_get_num_threads</li>
  241. <li>openblas_set_num_threads</li>
  242. <li><code>int openblas_get_num_procs(void)</code> returns the number of processors available on the system (may include "hyperthreading cores")</li>
  243. <li><code>int openblas_get_parallel(void)</code> returns 0 for sequential use, 1 for platform-based threading and 2 for OpenMP-based threading</li>
  244. <li><code>char * openblas_get_config()</code> returns the options OpenBLAS was built with, something like <code>NO_LAPACKE DYNAMIC_ARCH NO_AFFINITY Haswell</code></li>
  245. <li><code>int openblas_set_affinity(int thread_index, size_t cpusetsize, cpu_set_t *cpuset)</code> sets the cpu affinity mask of the given thread to the provided cpuset. (Only available under Linux, with semantics identical to pthread_setaffinity_np)</li>
  246. </ul>
  247. </article>
  248. </div>
  249. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  250. </div>
  251. </main>
  252. <footer class="md-footer">
  253. <div class="md-footer-meta md-typeset">
  254. <div class="md-footer-meta__inner md-grid">
  255. <div class="md-copyright">
  256. Made with
  257. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  258. Material for MkDocs
  259. </a>
  260. </div>
  261. </div>
  262. </div>
  263. </footer>
  264. </div>
  265. <div class="md-dialog" data-md-component="dialog">
  266. <div class="md-dialog__inner md-typeset"></div>
  267. </div>
  268. <script id="__config" type="application/json">{"base": "..", "features": [], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
  269. <script src="../assets/javascripts/bundle.5cfa9459.min.js"></script>
  270. </body>
  271. </html>

OpenBLAS is an optimized BLAS library based on GotoBLAS2 1.13 BSD version.