time-to-botec

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

README.md (2521B)

      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 # sincospi
     22 
     23 > Simultaneously compute the [sine][@stdlib/math/base/special/sin] and [cosine][@stdlib/math/base/special/cos] of a number times [π][@stdlib/constants/float64/pi].
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var sincospi = require( '@stdlib/math/base/special/sincospi' );
     31 ```
     32 
     33 #### sincospi( \[out,] x )
     34 
     35 Simultaneously computes the [sine][@stdlib/math/base/special/sin] and [cosine][@stdlib/math/base/special/cos] of a `number` times [π][@stdlib/constants/float64/pi] more accurately than `sincos(pi*x)`, especially for large `x`.
     36 
     37 ```javascript
     38 var v = sincospi( 0.0 );
     39 // returns [ 0.0, 1.0 ]
     40 
     41 v = sincospi( 0.5 );
     42 // returns [ 1.0, 0.0 ]
     43 
     44 v = sincospi( 0.1 );
     45 // returns [ ~0.309, ~0.951 ]
     46 
     47 v = sincospi( NaN );
     48 // returns [ NaN, NaN ]
     49 ```
     50 
     51 By default, the function returns a two-element `array` containing `sin(πx)` and `cos(πx)`. To avoid extra 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 = sincospi( out, 0.0 );
     59 // returns <Float64Array>[ 0.0, 1.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 linspace = require( '@stdlib/array/linspace' );
     77 var sincospi = require( '@stdlib/math/base/special/sincospi' );
     78 
     79 var x = linspace( 0.0, 2.0, 101 );
     80 var i;
     81 
     82 for ( i = 0; i < x.length; i++ ) {
     83     console.log( sincospi( x[ i ] ) );
     84 }
     85 ```
     86 
     87 </section>
     88 
     89 <!-- /.examples -->
     90 
     91 <section class="links">
     92 
     93 [@stdlib/math/base/special/sin]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/special/sin
     94 
     95 [@stdlib/math/base/special/cos]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/special/cos
     96 
     97 [@stdlib/constants/float64/pi]: https://www.npmjs.com/package/@stdlib/constants-float64-pi
     98 
     99 </section>
    100 
    101 <!-- /.links -->