Square Root

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

The principal square root is defined as

Installation

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

Usage

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

sqrtf( x )

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

var v = sqrtf( 4.0 );
// returns 2.0

v = sqrtf( 9.0 );
// returns 3.0

v = sqrtf( 0.0 );
// returns 0.0

v = sqrtf( NaN );
// returns NaN

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

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

Examples

var randu = require( '@stdlib/random-base-randu' );
var round = require( '@stdlib/math-base-special-round' );
var sqrtf = require( '@stdlib/math-base-special-sqrtf' );

var x;
var i;

for ( i = 0; i < 100; i++ ) {
    x = round( randu() * 100.0 );
    console.log( 'sqrt(%d) = %d', x, sqrtf( x ) );
}

C APIs

Usage

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

stdlib_base_sqrtf( x )

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

float y = stdlib_base_sqrtf( 9.0f );
// returns 3.0f

The function accepts the following arguments:

• x: [in] float input value.

float stdlib_base_sqrtf( const float x );

Examples

#include "stdlib/math/base/special/sqrtf.h"
#include <stdio.h>

int main( void ) {
    const float x[] = { 3.14f, 9.0f, 0.0f, 0.0f/0.0f };

    float y;
    int i;
    for ( i = 0; i < 4; i++ ) {
        y = stdlib_base_sqrtf( x[ i ] );
        printf( "sqrt(%f) = %f\n", x[ i ], y );
    }
}

See Also

• @stdlib/math-base/special/cbrtf: compute the cube root of a single-precision floating-point number.
• @stdlib/math-base/special/rsqrtf: compute the reciprocal square root of a single-precision floating-point number.
• @stdlib/math-base/special/sqrt: compute the principal square root of a double-precision floating-point number.

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

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.