Package Exports

@stdlib/math-base-special-sincos

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/math-base-special-sincos) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

sincos

$NPM version$ $Build Status$ $Coverage Status$ $dependencies$

Simultaneously compute the sine and cosine of a number.

Installation

npm install @stdlib/math-base-special-sincos

Usage

var sincos = require( '@stdlib/math-base-special-sincos' );

sincos( [out,] x )

Simultaneously computes the sine and cosine of a number (in radians).

var v = sincos( 0.0 );
// returns [ ~0.0, ~1.0 ]

v = sincos( 3.141592653589793/2.0 );
// returns [ ~1.0, ~0.0 ]

v = sincos( -3.141592653589793/6.0 );
// returns [ ~-0.5, ~0.866 ]

By default, the function returns the sine and cosine as a two-element array. To avoid extra memory allocation, the function supports providing an output (destination) object.

var Float64Array = require( '@stdlib/array-float64' );

var out = new Float64Array( 2 );

var v = sincos( out, 0.0 );
// returns <Float64Array>[ ~0.0, ~1.0 ]

var bool = ( v === out );
// returns true

Examples

var linspace = require( '@stdlib/array-linspace' );
var TWO_PI = require( '@stdlib/constants-float64-two-pi' );
var sincos = require( '@stdlib/math-base-special-sincos' );

var x = linspace( 0.0, TWO_PI, 100 );
var i;

for ( i = 0; i < x.length; i++ ) {
    console.log( sincos( x[ i ] ) );
}

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

@stdlib/math-base-special-sincos