time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

README.md (2849B)

      1 <!--
      2 
      3 @license Apache-2.0
      4 
      5 Copyright (c) 2021 The Stdlib Authors.
      6 
      7 Licensed under the Apache License, Version 2.0 (the "License");
      8 you may not use this file except in compliance with the License.
      9 You may obtain a copy of the License at
     10 
     11    http://www.apache.org/licenses/LICENSE-2.0
     12 
     13 Unless required by applicable law or agreed to in writing, software
     14 distributed under the License is distributed on an "AS IS" BASIS,
     15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     16 See the License for the specific language governing permissions and
     17 limitations under the License.
     18 
     19 -->
     20 
     21 # Operators
     22 
     23 > Standard library base math operators.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var ns = require( '@stdlib/math/base/ops' );
     31 ```
     32 
     33 #### ns
     34 
     35 Standard library base math operators.
     36 
     37 ```javascript
     38 var operators = ns;
     39 // returns {...}
     40 ```
     41 
     42 The namespace contains the following functions:
     43 
     44 <!-- <toc pattern="*"> -->
     45 
     46 <div class="namespace-toc">
     47 
     48 -   <span class="signature">[`cadd( [out,] re1, im1, re2, im2 )`][@stdlib/math/base/ops/cadd]</span><span class="delimiter">: </span><span class="description">add two complex numbers.</span>
     49 -   <span class="signature">[`cdiv( [out,] re1, im1, re2, im2 )`][@stdlib/math/base/ops/cdiv]</span><span class="delimiter">: </span><span class="description">divide two complex numbers.</span>
     50 -   <span class="signature">[`cmul( [out,] re1, im1, re2, im2 )`][@stdlib/math/base/ops/cmul]</span><span class="delimiter">: </span><span class="description">multiply two complex numbers.</span>
     51 -   <span class="signature">[`cneg( [out,] re, im )`][@stdlib/math/base/ops/cneg]</span><span class="delimiter">: </span><span class="description">negate a complex number.</span>
     52 -   <span class="signature">[`csub( [out,] re1, im1, re2, im2 )`][@stdlib/math/base/ops/csub]</span><span class="delimiter">: </span><span class="description">subtract two complex numbers.</span>
     53 
     54 </div>
     55 
     56 <!-- </toc> -->
     57 
     58 </section>
     59 
     60 <!-- /.usage -->
     61 
     62 <section class="examples">
     63 
     64 ## Examples
     65 
     66 <!-- TODO: better examples -->
     67 
     68 <!-- eslint no-undef: "error" -->
     69 
     70 ```javascript
     71 var objectKeys = require( '@stdlib/utils/keys' );
     72 var ns = require( '@stdlib/math/base/ops' );
     73 
     74 console.log( objectKeys( ns ) );
     75 ```
     76 
     77 </section>
     78 
     79 <!-- /.examples -->
     80 
     81 <section class="links">
     82 
     83 <!-- <toc-links> -->
     84 
     85 [@stdlib/math/base/ops/cadd]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/ops/cadd
     86 
     87 [@stdlib/math/base/ops/cdiv]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/ops/cdiv
     88 
     89 [@stdlib/math/base/ops/cmul]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/ops/cmul
     90 
     91 [@stdlib/math/base/ops/cneg]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/ops/cneg
     92 
     93 [@stdlib/math/base/ops/csub]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/ops/csub
     94 
     95 <!-- </toc-links> -->
     96 
     97 </section>
     98 
     99 <!-- /.links -->