Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/math-base-special-sincospi

Simultaneously compute the sine and cosine of a number times π.
https://github.com/stdlib-js/math-base-special-sincospi

angle cos cosine cospi javascript math mathematics node node-js nodejs radians sin sincospi sine sinpi stdlib trig trigonometry

Last synced: about 2 months ago
JSON representation

Simultaneously compute the sine and cosine of a number times π.

Awesome Lists containing this project

README 

        



  

    About stdlib...

  

  
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.


  
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.


  
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.


  
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!



# sincospi



[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 



> Simultaneously compute the [sine][@stdlib/math/base/special/sin] and [cosine][@stdlib/math/base/special/cos] of a number times [π][@stdlib/constants/float64/pi].



## Installation



```bash

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

```



Alternatively,



-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).

-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).

-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).



The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.



To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.



## Usage



```javascript

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

```



#### sincospi( x )



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`.



```javascript

var v = sincospi( 0.0 );

// returns [ 0.0, 1.0 ]



v = sincospi( 0.5 );

// returns [ 1.0, 0.0 ]



v = sincospi( 0.1 );

// returns [ ~0.309, ~0.951 ]



v = sincospi( NaN );

// returns [ NaN, NaN ]

```



#### sincospi( x, out, stride, offset )



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`, and assigns results to a provided output array.



```javascript

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



var out = new Float64Array( 2 );



var v = sincospi.assign( 0.0, out, 1, 0 );

// returns [ 0.0, 1.0 ]



var bool = ( v === out );

// returns true

```



## Examples



```javascript

var linspace = require( '@stdlib/array-base-linspace' );

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



var x = linspace( 0.0, 2.0, 101 );



var i;

for ( i = 0; i < x.length; i++ ) {

    console.log( sincospi( x[ i ] ) );

}

```



* * *



## C APIs



### Usage



```c

#include "stdlib/math/base/special/sincospi.h"

```



#### stdlib_base_sincospi( x, &sine, &cosine )



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`.



```c

double cosine;

double sine;



stdlib_base_sincospi( 4.0, &sine, &cosine );

```



The function accepts the following arguments:



-   **x**:      `[in] double` input value.

-   **sine**:   `[out] double*` destination for the sine.

-   **cosine**: `[out] double*` destination for the cosine.



```c

void stdlib_base_sincospi( const double x, double *sine, double *cosine );

```



### Examples



```c

#include "stdlib/math/base/special/sincospi.h"

#include 



int main( void ) {

    const double x[] = { 0.0, 1.57, 3.14, 6.28 };



    double cosine;

    double sine;

    int i;

    for ( i = 0; i < 4; i++ ) {

        stdlib_base_sincospi( x[ i ], &sine, &cosine );

        printf( "x: %lf => sine: %lf, cosine: %lf\n", x[ i ], sine, cosine );

    }

}

```



* * *



## See Also



-   [`@stdlib/math-base/special/cospi`][@stdlib/math/base/special/cospi]: compute cos(πx).

-   [`@stdlib/math-base/special/sincos`][@stdlib/math/base/special/sincos]: simultaneously compute the sine and cosine of a number.

-   [`@stdlib/math-base/special/sinpi`][@stdlib/math/base/special/sinpi]: compute sin(πx).



* * *



## Notice



This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].



#### Community



[![Chat][chat-image]][chat-url]



---



## License



See [LICENSE][stdlib-license].



## Copyright



Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].



[npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-special-sincospi.svg

[npm-url]: https://npmjs.org/package/@stdlib/math-base-special-sincospi



[test-image]: https://github.com/stdlib-js/math-base-special-sincospi/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/math-base-special-sincospi/actions/workflows/test.yml?query=branch:main



[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-sincospi/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-sincospi?branch=main



[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im



[stdlib]: https://github.com/stdlib-js/stdlib



[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors



[umd]: https://github.com/umdjs/umd

[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules



[deno-url]: https://github.com/stdlib-js/math-base-special-sincospi/tree/deno

[deno-readme]: https://github.com/stdlib-js/math-base-special-sincospi/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/math-base-special-sincospi/tree/umd

[umd-readme]: https://github.com/stdlib-js/math-base-special-sincospi/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/math-base-special-sincospi/tree/esm

[esm-readme]: https://github.com/stdlib-js/math-base-special-sincospi/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/math-base-special-sincospi/blob/main/branches.md



[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-special-sincospi/main/LICENSE



[@stdlib/math/base/special/sin]: https://github.com/stdlib-js/math-base-special-sin



[@stdlib/math/base/special/cos]: https://github.com/stdlib-js/math-base-special-cos



[@stdlib/constants/float64/pi]: https://github.com/stdlib-js/constants-float64-pi



[@stdlib/math/base/special/cospi]: https://github.com/stdlib-js/math-base-special-cospi



[@stdlib/math/base/special/sincos]: https://github.com/stdlib-js/math-base-special-sincos



[@stdlib/math/base/special/sinpi]: https://github.com/stdlib-js/math-base-special-sinpi