@stdlib/math-base-special-kernel-sin
v0.2.4TypeScript
Compute the sine of a double-precision floating-point number on [-π/4, π/4].
0/weekUpdated 4 days agoApache-2.0Unpacked: 50.8 KB
Published by The Stdlib Authors
npm install @stdlib/math-base-special-kernel-sinWe 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!
About stdlib...
kernelSin
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Compute the [sine][sine] of a double-precision floating-point number on [-π/4, π/4].
Installation
``bash`
npm install @stdlib/math-base-special-kernel-sin
Usage
`javascript`
var kernelSin = require( '@stdlib/math-base-special-kernel-sin' );
#### kernelSin( x, y )
Computes the [sine][sine] of a double-precision floating-point number on [-π/4, π/4].
`javascript
var v = kernelSin( 0.0, 0.0 );
// returns ~0.0
v = kernelSin( 3.141592653589793/6.0, 0.0 );
// returns ~0.5
v = kernelSin( 0.619, 9.279e-18 );
// returns ~0.58
v = kernelSin( NaN, 0.0 );
// returns NaN
v = kernelSin( 3.0, NaN );
// returns NaN
v = kernelSin( NaN, NaN );
// returns NaN
`
Notes
- For increased accuracy, the number for which the [sine][sine] should be evaluated can be supplied as a [double-double number][double-double-arithmetic] (i.e., a non-evaluated sum of two [double-precision floating-point numbers][ieee754] x and y).
- As components of a [double-double number][double-double-arithmetic], the two [double-precision floating-point numbers][ieee754] x and y must satisfy
where ulp stands for [units in the last place][ulp].
Examples
`javascript
var uniform = require( '@stdlib/random-array-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var PI = require( '@stdlib/constants-float64-pi' );
var kernelSin = require( '@stdlib/math-base-special-kernel-sin' );
var opts = {
'dtype': 'float64'
};
var x = uniform( 100, -PI/4.0, PI/4.0, opts );
logEachMap( 'sine(%0.4f, %0.4f) = %0.4f', x, 0.0, kernelSin );
`
*
C APIs
$3
`c`
#include "stdlib/math/base/special/kernel_sin.h"
#### stdlib_base_kernel_sin( x, y )
Computes the [sine][sine] of a double-precision floating-point number on [-π/4, π/4].
`c
double out = stdlib_base_kernel_sin( 0.0, 0.0 );
// returns ~0.0
out = stdlib_base_kernel_sin( 0.619, 9.279e-18 );
// returns ~0.58
`
The function accepts the following arguments:
- x: [in] double input value (in radians, assumed to be bounded by ~pi/4 in magnitude).[in] double
- y: tail of x.
`c`
double stdlib_base_kernel_sin( const double x, const double y );
$3
- For increased accuracy, the number for which the [sine][sine] should be evaluated can be supplied as a [double-double number][double-double-arithmetic] (i.e., a non-evaluated sum of two [double-precision floating-point numbers][ieee754] x and y).
$3
`c
#include "stdlib/math/base/special/kernel_sin.h"
#include
int main( void ) {
const double x[] = { -0.7853981633974483, -0.6108652381980153, -0.4363323129985824, -0.26179938779914946, -0.08726646259971649, 0.08726646259971649, 0.26179938779914935, 0.43633231299858233, 0.6108652381980153, 0.7853981633974483 };
double out;
int i;
for ( i = 0; i < 10; i++ ) {
out = stdlib_base_kernel_sin( x[ i ], 0.0 );
printf ( "x: %lf, y: %lf, out: %lf\n", x[ i ], 0.0, out );
}
}
`
*
See Also
- [@stdlib/math-base/special/kernel-cos][@stdlib/math/base/special/kernel-cos]: compute the cosine of a double-precision floating-point number on \[-π/4, π/4].
- [@stdlib/math-base/special/kernel-tan][@stdlib/math/base/special/kernel-tan]: compute the tangent of a double-precision floating-point number on \[-π/4, π/4].
- [@stdlib/math-base/special/sin][@stdlib/math/base/special/sin]: compute the sine of a number.
*
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]
---
Copyright
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-special-kernel-sin.svg
[npm-url]: https://npmjs.org/package/@stdlib/math-base-special-kernel-sin
[test-image]: https://github.com/stdlib-js/math-base-special-kernel-sin/actions/workflows/test.yml/badge.svg?branch=v0.2.4
[test-url]: https://github.com/stdlib-js/math-base-special-kernel-sin/actions/workflows/test.yml?query=branch:v0.2.4
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-kernel-sin/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-kernel-sin?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[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-kernel-sin/tree/deno
[deno-readme]: https://github.com/stdlib-js/math-base-special-kernel-sin/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/math-base-special-kernel-sin/tree/umd
[umd-readme]: https://github.com/stdlib-js/math-base-special-kernel-sin/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/math-base-special-kernel-sin/tree/esm
[esm-readme]: https://github.com/stdlib-js/math-base-special-kernel-sin/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/math-base-special-kernel-sin/blob/main/branches.md
[sine]: https://en.wikipedia.org/wiki/Sine
[double-double-arithmetic]: https://en.wikipedia.org/wiki/Quadruple-precision_floating-point_format#Double-double_arithmetic
[ieee754]: https://en.wikipedia.org/wiki/IEEE_floating_point
[ulp]: https://en.wikipedia.org/wiki/Unit_in_the_last_place
[@stdlib/math/base/special/kernel-cos]: https://www.npmjs.com/package/@stdlib/math-base-special-kernel-cos
[@stdlib/math/base/special/kernel-tan]: https://www.npmjs.com/package/@stdlib/math-base-special-kernel-tan
[@stdlib/math/base/special/sin]: https://www.npmjs.com/package/@stdlib/math-base-special-sin