Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/math-base-special-ramp
Evaluate the ramp function.
https://github.com/stdlib-js/math-base-special-ramp
digital-signal-processing dsp heaviside javascript math mathematics max maximum node node-js nodejs nonnegative ramp stdlib
Last synced: 1 day ago
JSON representation
Evaluate the ramp function.
- Host: GitHub
- URL: https://github.com/stdlib-js/math-base-special-ramp
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-14T16:37:07.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-24T00:20:01.000Z (about 1 month ago)
- Last Synced: 2024-12-24T00:28:39.661Z (about 1 month ago)
- Topics: digital-signal-processing, dsp, heaviside, javascript, math, mathematics, max, maximum, node, node-js, nodejs, nonnegative, ramp, stdlib
- Language: Python
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 459 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
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!
# Ramp Function
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Evaluate the [ramp function][ramp-function].
The [ramp function][ramp-function] is defined as
```math
R(x) = \begin{cases} x & \textrm{if}\ x \geq 0 \\ 0 & \textrm{if}\ x \lt 0\end{cases}
```
or, alternatively, in terms of the `max` function
```math
R(x) = \mathop{\mathrm{max}}( x, 0 )
```
## Installation
```bash
npm install @stdlib/math-base-special-ramp
```
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 ramp = require( '@stdlib/math-base-special-ramp' );
```
#### ramp( x )
Evaluates the [ramp function][ramp-function].
```javascript
var v = ramp( 3.14 );
// returns 3.14
v = ramp( -3.14 );
// returns 0.0
v = ramp( NaN );
// returns NaN
```
## Examples
```javascript
var linspace = require( '@stdlib/array-base-linspace' );
var ramp = require( '@stdlib/math-base-special-ramp' );
var x = linspace( -10.0, 10.0, 101 );
var i;
for ( i = 0; i < x.length; i++ ) {
console.log( 'R(%d) = %d', x[ i ], ramp( x[ i ] ) );
}
```
* * *
## C APIs
### Usage
```c
#include "stdlib/math/base/special/ramp.h"
```
#### stdlib_base_ramp( x )
Evaluates the ramp function.
```c
double y = stdlib_base_ramp( 3.0 );
// returns 3.0
```
The function accepts the following arguments:
- **x**: `[in] double` input value.
```c
double stdlib_base_ramp( const double x );
```
### Examples
```c
#include "stdlib/math/base/special/ramp.h"
#include
int main( void ) {
const double x[] = { 3.14, -3.14, 0.0, 0.0/0.0 };
double y;
int i;
for ( i = 0; i < 4; i++ ) {
y = stdlib_base_ramp( x[ i ] );
printf( "R(%lf) = %lf\n", x[ i ], y );
}
}
```
* * *
## See Also
- [`@stdlib/math-base/special/heaviside`][@stdlib/math/base/special/heaviside]: evaluate the Heaviside function.
* * *
## 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-ramp.svg
[npm-url]: https://npmjs.org/package/@stdlib/math-base-special-ramp
[test-image]: https://github.com/stdlib-js/math-base-special-ramp/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/math-base-special-ramp/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-ramp/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-ramp?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-ramp/tree/deno
[deno-readme]: https://github.com/stdlib-js/math-base-special-ramp/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/math-base-special-ramp/tree/umd
[umd-readme]: https://github.com/stdlib-js/math-base-special-ramp/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/math-base-special-ramp/tree/esm
[esm-readme]: https://github.com/stdlib-js/math-base-special-ramp/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/math-base-special-ramp/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-special-ramp/main/LICENSE
[ramp-function]: https://en.wikipedia.org/wiki/Ramp_function
[@stdlib/math/base/special/heaviside]: https://github.com/stdlib-js/math-base-special-heaviside