Nominating Presidential Muppets

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

    0.0.7 • Public • Published

    Square Root

    NPM version Build Status Coverage Status dependencies

    Compute the principal square root of a double-precision floating-point number.

    The principal square root is defined as

    Principal square root

    Installation

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

    Usage

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

    sqrt( x )

    Computes the principal square root of a double-precision floating-point number.

    var v = sqrt( 4.0 );
    // returns 2.0
    
    v = sqrt( 9.0 );
    // returns 3.0
    
    v = sqrt( 0.0 );
    // returns 0.0
    
    v = sqrt( NaN );
    // returns NaN

    For negative numbers, the principal square root is not defined.

    var v = sqrt( -4.0 );
    // returns NaN

    Examples

    var randu = require( '@stdlib/random-base-randu' );
    var round = require( '@stdlib/math-base-special-round' );
    var sqrt = require( '@stdlib/math-base-special-sqrt' );
    
    var x;
    var i;
    
    for ( i = 0; i < 100; i++ ) {
        x = round( randu() * 100.0 );
        console.log( 'sqrt(%d) = %d', x, sqrt( x ) );
    }

    C APIs

    Installation

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

    Usage

    #include "stdlib/math/base/special/sqrt.h"

    stdlib_base_sqrt( x )

    Computes the principal square root of a double-precision floating-point number.

    double y = stdlib_base_sqrt( 9.0 );
    // returns 3.0

    The function accepts the following arguments:

    • x: [in] double input value.
    double stdlib_base_sqrt( const double x );

    Examples

    #include "stdlib/math/base/special/sqrt.h"
    #include <stdio.h>
    
    int main() {
        double x[] = { 3.14, 9.0, 0.0, 0.0/0.0 };
    
        double y;
        int i;
        for ( i = 0; i < 4; i++ ) {
            y = stdlib_base_sqrt( x[ i ] );
            printf( "sqrt(%lf) = %lf\n", x[ i ], y );
        }
    }

    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-sqrt

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    4,441

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    54.5 kB

    Total Files

    17

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser