Package Exports
- @stdlib/math-base-special-sqrt
- @stdlib/math-base-special-sqrt/dist
- @stdlib/math-base-special-sqrt/dist/index.js
- @stdlib/math-base-special-sqrt/lib/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/math-base-special-sqrt) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
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!
Square Root
Compute the principal square root of a double-precision floating-point number.
The principal square root is defined as
Installation
npm install @stdlib/math-base-special-sqrtUsage
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 NaNFor negative numbers, the principal square root is not defined.
var v = sqrt( -4.0 );
// returns NaNExamples
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
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.0The function accepts the following arguments:
- x:
[in] doubleinput value.
double stdlib_base_sqrt( const double x );Examples
#include "stdlib/math/base/special/sqrt.h"
#include <stdio.h>
int main( void ) {
const 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
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.