time-to-botec

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

README.md (2366B)

      1 <!--
      2 
      3 @license Apache-2.0
      4 
      5 Copyright (c) 2018 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 # Round
     22 
     23 > Round a complex number to the nearest integer.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var cround = require( '@stdlib/math/base/special/cround' );
     31 ```
     32 
     33 #### cround( \[out,] re, im )
     34 
     35 Rounds a `complex` number comprised of a **real** component `re` and an **imaginary** component `im` to the nearest integer.
     36 
     37 ```javascript
     38 var v = cround( -4.2, 5.5 );
     39 // returns [ -4.0, 6.0 ]
     40 
     41 v = cround( 9.99999, 0.1 );
     42 // returns [ 10.0, 0.0 ]
     43 
     44 v = cround( 0.0, 0.0 );
     45 // returns [ 0.0, 0.0 ]
     46 
     47 v = cround( NaN, NaN );
     48 // returns [ NaN, NaN ]
     49 ```
     50 
     51 By default, the function returns real and imaginary components as a two-element `array`. To avoid unnecessary memory allocation, the function supports providing an output (destination) object.
     52 
     53 ```javascript
     54 var Float64Array = require( '@stdlib/array/float64' );
     55 
     56 var out = new Float64Array( 2 );
     57 
     58 var v = cround( out, -4.2, 5.5 );
     59 // returns <Float64Array>[ -4.0, 6.0 ]
     60 
     61 var bool = ( v === out );
     62 // returns true
     63 ```
     64 
     65 </section>
     66 
     67 <!-- /.usage -->
     68 
     69 <section class="examples">
     70 
     71 ## Examples
     72 
     73 <!-- eslint no-undef: "error" -->
     74 
     75 ```javascript
     76 var Complex128 = require( '@stdlib/complex/float64' );
     77 var randu = require( '@stdlib/random/base/randu' );
     78 var real = require( '@stdlib/complex/real' );
     79 var imag = require( '@stdlib/complex/imag' );
     80 var cround = require( '@stdlib/math/base/special/cround' );
     81 
     82 var re;
     83 var im;
     84 var z;
     85 var o;
     86 var w;
     87 var i;
     88 
     89 for ( i = 0; i < 100; i++ ) {
     90     re = ( randu()*100.0 ) - 50.0;
     91     im = ( randu()*100.0 ) - 50.0;
     92     z = new Complex128( re, im );
     93     o = cround( real(z), imag(z) );
     94     w = new Complex128( o[ 0 ], o[ 1 ] );
     95     console.log( 'round(%s) = %s', z.toString(), w.toString() );
     96 }
     97 ```
     98 
     99 </section>
    100 
    101 <!-- /.examples -->
    102 
    103 <section class="links">
    104 
    105 </section>
    106 
    107 <!-- /.links -->