@stdlib/stats-base-dists-cosine-mode
v0.3.1TypeScript
Raised cosine distribution mode.
0/weekUpdated 3 days agoApache-2.0Unpacked: 40.4 KB
Published by The Stdlib Authors
npm install @stdlib/stats-base-dists-cosine-modeWe 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...
Mode
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> [Raised cosine][cosine-distribution] distribution [mode][mode].
The [mode][mode] for a [raised cosine][cosine-distribution] random variable with location parameter mu and scale parameter s is
Installation
``bash`
npm install @stdlib/stats-base-dists-cosine-mode
Usage
`javascript`
var mode = require( '@stdlib/stats-base-dists-cosine-mode' );
#### mode( mu, s )
Returns the [mode][mode] for a [raised cosine][cosine-distribution] distribution with location parameter mu and scale parameter s.
`javascript
var y = mode( 2.0, 1.0 );
// returns 2.0
y = mode( 0.0, 1.0 );
// returns 0.0
y = mode( -1.0, 4.0 );
// returns -1.0
`
If provided NaN as any argument, the function returns NaN.
`javascript
var y = mode( NaN, 1.0 );
// returns NaN
y = mode( 0.0, NaN );
// returns NaN
`
If provided s <= 0, the function returns NaN.
`javascript
var y = mode( 0.0, 0.0 );
// returns NaN
y = mode( 0.0, -1.0 );
// returns NaN
`
Examples
`javascript
var uniform = require( '@stdlib/random-array-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var mode = require( '@stdlib/stats-base-dists-cosine-mode' );
var opts = {
'dtype': 'float64'
};
var mu = uniform( 10, -5.0, 5.0, opts );
var s = uniform( 10, 0.0, 20.0, opts );
logEachMap( 'µ: %0.4f, s: %0.4f, mode(X;µ,s): %0.4f', mu, s, mode );
`
*
C APIs
$3
`c`
#include "stdlib/stats/base/dists/cosine/mode.h"
#### stdlib_base_dists_cosine_mode( mu, s )
Returns the [mode][mode] for a [raised cosine][cosine-distribution] distribution with location parameter mu and scale parameter s.
`c`
double out = stdlib_base_dists_cosine_mode( 0.0, 1.0 );
// returns 0.0
The function accepts the following arguments:
- mu: [in] double location parameter.[in] double
- s: scale parameter.
`c`
double stdlib_base_dists_cosine_mode( const double mu, const double s );
$3
`c
#include "stdlib/stats/base/dists/cosine/mode.h"
#include "stdlib/constants/float64/eps.h"
#include
#include
static double random_uniform( const double min, const double max ) {
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
return min + ( v * (max - min) );
}
int main( void ) {
double mu;
double s;
double y;
int i;
for ( i = 0; i < 10; i++ ) {
mu = random_uniform( -50.0, 50.0 );
s = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 );
y = stdlib_base_dists_cosine_mode( mu, s );
printf( "µ: %lf, s: %lf, mode(X;µ,s): %lf\n", mu, s, y );
}
return 0;
}
`
*
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/stats-base-dists-cosine-mode.svg
[npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-cosine-mode
[test-image]: https://github.com/stdlib-js/stats-base-dists-cosine-mode/actions/workflows/test.yml/badge.svg?branch=v0.3.1
[test-url]: https://github.com/stdlib-js/stats-base-dists-cosine-mode/actions/workflows/test.yml?query=branch:v0.3.1
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-cosine-mode/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-cosine-mode?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/stats-base-dists-cosine-mode/tree/deno
[deno-readme]: https://github.com/stdlib-js/stats-base-dists-cosine-mode/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/stats-base-dists-cosine-mode/tree/umd
[umd-readme]: https://github.com/stdlib-js/stats-base-dists-cosine-mode/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/stats-base-dists-cosine-mode/tree/esm
[esm-readme]: https://github.com/stdlib-js/stats-base-dists-cosine-mode/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/stats-base-dists-cosine-mode/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-dists-cosine-mode/main/LICENSE
[cosine-distribution]: https://en.wikipedia.org/wiki/Raised_cosine_distribution
[mode]: https://en.wikipedia.org/wiki/Mode_%28statistics%29