@stdlib/math-base-special-sinpi

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!

sinpi

Compute the sine of a number times π.

Installation

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

Usage

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

sinpi( x )

Computes sin(πx) more accurately than sin(pi*x), especially for large x.

var y = sinpi( 0.0 );
// returns 0.0

y = sinpi( 0.5 );
// returns 1.0

y = sinpi( 0.9 );
// returns ~0.309

y = sinpi( NaN );
// returns NaN

Examples

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

var x = linspace( -100.0, 100.0, 100 );

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

---

C APIs

Usage

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

stdlib_base_sinpi( x )

Computes sin(πx) more accurately than sin(pi*x), especially for large x.

double y = stdlib_base_sinpi( 0.5 );
// returns 1.0

The function accepts the following arguments:

• x: [in] double input value.

double stdlib_base_sinpi( const double x );

Examples

#include "stdlib/math/base/special/sinpi.h"
#include <stdio.h>

int main( void ) {
    const double x[] = { 0.0, 0.523, 0.785, 1.047, 3.14 };

    double y;
    int i;
    for ( i = 0; i < 5; i++ ) {
        y = stdlib_base_sinpi( x[ i ] );
        printf( "sinpi(%lf) = %lf\n", x[ i ], y );
    }
}

---

See Also

• @stdlib/math-base/special/sin: compute the sine of a number.

---

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.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Changelog

0.3.0 (2024-07-28)

<section class="features">

Features

• d6c4251 - add C implementation for math/base/special/sinpi (#2610)

</section> <!-- /.features --> <section class="commits">

Commits

<details>

• 272ae7a - docs: remove comment (by Athan Reines)
• 3e05048 - docs: remove comment (by Athan Reines)
• 2777e4b - bench: resolve lint errors in benchmarks (by Athan Reines)
• ead1c3b - chore: update package meta data (#2640) (by stdlib-bot, Athan Reines)
• d6c4251 - feat: add C implementation for math/base/special/sinpi (#2610) (by Gunj Joshi)
• 41d41e9 - test: include trailing newlines in Julia-generated JSON fixtures (by Philipp Burckhardt)

</details> </section> <!-- /.commits --> <section class="contributors">

Contributors

A total of 3 people contributed to this release. Thank you to the following contributors:

• Athan Reines
• Gunj Joshi
• Philipp Burckhardt

</section> <!-- /.contributors --> </section> <!-- /.release --> <section class="release" id="v0.2.1">