@stdlib/math-base-special-heaviside
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.6 • Public • Published

    Heaviside Function

    NPM version Build Status Coverage Status dependencies

    Evaluate the Heaviside function.

    The Heaviside function is defined as

    Heaviside function.

    and is discontinuous at 0. Depending on the context, the Heaviside function may be defined as a continuous function. To define the Heaviside function such that the function has rotational symmetry,

    Heaviside function half-maximum.

    To define the Heaviside function as a left-continuous function,

    Heaviside function left-continuous.

    To define the Heaviside function as a right-continuous function,

    Heaviside function right-continuous.

    Installation

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

    Usage

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

    heaviside( x[, continuity] )

    Evaluates the Heaviside function.

    var v = heaviside( 3.14 );
    // returns 1.0
    
    v = heaviside( -3.14 );
    // returns 0.0
    
    v = heaviside( NaN );
    // returns NaN

    The continuity parameter may be one of the following values:

    • 'half-maximum': if x == 0, the function returns 0.5.
    • 'left-continuous': if x == 0, the function returns 0.0.
    • 'right-continuous': if x == 0, the function returns 1.0.

    By default, the function is discontinuous at 0.

    var v = heaviside( 0.0 );
    // returns NaN

    To define the Heaviside function as a continuous function, set the continuity parameter.

    var v = heaviside( 0.0, 'half-maximum' );
    // returns 0.5
    
    v = heaviside( 0.0, 'left-continuous' );
    // returns 0.0
    
    v = heaviside( 0.0, 'right-continuous' );
    // returns 1.0

    Examples

    var linspace = require( '@stdlib/array-linspace' );
    var heaviside = require( '@stdlib/math-base-special-heaviside' );
    
    var x = linspace( -10.0, 10.0, 101 );
    var i;
    
    for ( i = 0; i < x.length; i++ ) {
        console.log( 'H(%d) = %d', x[ i ], heaviside( x[ i ] ) );
    }

    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

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2021. The Stdlib Authors.

    Install

    npm i @stdlib/math-base-special-heaviside

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    0

    Version

    0.0.6

    License

    Apache-2.0

    Unpacked Size

    75.9 kB

    Total Files

    13

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser