@stdlib/math-base-special-sinc
v0.3.1TypeScript
Compute the normalized cardinal sine of a number.
380/weekUpdated yesterdayApache-2.0Unpacked: 45.4 KB
Published by The Stdlib Authors
npm install @stdlib/math-base-special-sincWe 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...
sinc
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Compute the [cardinal sine][sinc] of a number.
The normalized [cardinal sine][sinc] function is defined as
for any real number x.
Installation
``bash`
npm install @stdlib/math-base-special-sinc
Usage
`javascript`
var sinc = require( '@stdlib/math-base-special-sinc' );
#### sinc( x )
Computes the normalized [cardinal sine][sinc] of a number.
`javascript
var v = sinc( 0.5 );
// returns ~0.637
v = sinc( -1.2 );
// returns ~-0.156
v = sinc( 0.0 );
// returns 1.0
v = sinc( NaN );
// returns NaN
`
Examples
`javascript
var uniform = require( '@stdlib/random-array-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var sinc = require( '@stdlib/math-base-special-sinc' );
var opts = {
'dtype': 'float64'
};
var x = uniform( 100, -5.0, 5.0, opts );
logEachMap( 'sinc( %0.4f ) = %0.4f', x, sinc );
`
*
C APIs
$3
`c`
#include "stdlib/math/base/special/sinc.h"
#### stdlib_base_sinc( x )
Computes the normalized [cardinal sine][sinc] of a number.
`c`
double y = stdlib_base_sinc( 0.5 );
// returns ~0.637
The function accepts the following arguments:
- x: [in] double input value.
`c`
double stdlib_base_sinc( const double x );
$3
`c
#include "stdlib/math/base/special/sinc.h"
#include
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_sinc( x[ i ] );
printf( "sinc(%lf) = %lf\n", x[ i ], y );
}
}
`
*
See Also
- [@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]
---
License
See [LICENSE][stdlib-license].
Copyright
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-special-sinc.svg
[npm-url]: https://npmjs.org/package/@stdlib/math-base-special-sinc
[test-image]: https://github.com/stdlib-js/math-base-special-sinc/actions/workflows/test.yml/badge.svg?branch=v0.3.1
[test-url]: https://github.com/stdlib-js/math-base-special-sinc/actions/workflows/test.yml?query=branch:v0.3.1
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-sinc/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-sinc?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-sinc/tree/deno
[deno-readme]: https://github.com/stdlib-js/math-base-special-sinc/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/math-base-special-sinc/tree/umd
[umd-readme]: https://github.com/stdlib-js/math-base-special-sinc/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/math-base-special-sinc/tree/esm
[esm-readme]: https://github.com/stdlib-js/math-base-special-sinc/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/math-base-special-sinc/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-special-sinc/main/LICENSE
[sinc]: https://en.wikipedia.org/wiki/Sinc_function
[@stdlib/math/base/special/sin]: https://www.npmjs.com/package/@stdlib/math-base-special-sin