@stdlib/math-base-special-sqrt
v0.2.3TypeScript
Compute the principal square root of a double-precision floating-point number.
0/weekUpdated 4 days agoApache-2.0Unpacked: 38.0 KB
Published by The Stdlib Authors
npm install @stdlib/math-base-special-sqrtWe 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!
About stdlib...
Square Root
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Compute the principal [square root][square-root] of a double-precision floating-point number.
The principal [square root][square-root] is defined as
Installation
``bash`
npm install @stdlib/math-base-special-sqrt
Usage
`javascript`
var sqrt = require( '@stdlib/math-base-special-sqrt' );
#### sqrt( x )
Computes the principal [square root][square-root] of a double-precision floating-point number.
`javascript
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][square-root] is not defined.
`javascript`
var v = sqrt( -4.0 );
// returns NaN
Examples
`javascript
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var sqrt = require( '@stdlib/math-base-special-sqrt' );
var opts = {
'dtype': 'float64'
};
var x = discreteUniform( 100, 0, 100, opts );
logEachMap( 'sqrt(%d) = %0.4f', x, sqrt );
`
*
C APIs
$3
`c`
#include "stdlib/math/base/special/sqrt.h"
#### stdlib_base_sqrt( x )
Computes the principal [square root][square-root] of a double-precision floating-point number.
`c`
double y = stdlib_base_sqrt( 9.0 );
// returns 3.0
The function accepts the following arguments:
- x: [in] double input value.
`c`
double stdlib_base_sqrt( const double x );
$3
`c
#include "stdlib/math/base/special/sqrt.h"
#include
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 );
}
}
`
*
See Also
- [@stdlib/math-base/special/cbrt][@stdlib/math/base/special/cbrt]: compute the cube root of a double-precision floating-point number.
- [@stdlib/math-base/special/rsqrt][@stdlib/math/base/special/rsqrt]: compute the reciprocal square root of a double-precision floating-point number.
*
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-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-special-sqrt.svg
[npm-url]: https://npmjs.org/package/@stdlib/math-base-special-sqrt
[test-image]: https://github.com/stdlib-js/math-base-special-sqrt/actions/workflows/test.yml/badge.svg?branch=v0.2.3
[test-url]: https://github.com/stdlib-js/math-base-special-sqrt/actions/workflows/test.yml?query=branch:v0.2.3
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-sqrt/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-sqrt?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[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-sqrt/tree/deno
[deno-readme]: https://github.com/stdlib-js/math-base-special-sqrt/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/math-base-special-sqrt/tree/umd
[umd-readme]: https://github.com/stdlib-js/math-base-special-sqrt/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/math-base-special-sqrt/tree/esm
[esm-readme]: https://github.com/stdlib-js/math-base-special-sqrt/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/math-base-special-sqrt/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-special-sqrt/main/LICENSE
[square-root]: https://en.wikipedia.org/wiki/Square_root
[@stdlib/math/base/special/cbrt]: https://www.npmjs.com/package/@stdlib/math-base-special-cbrt
[@stdlib/math/base/special/rsqrt]: https://www.npmjs.com/package/@stdlib/math-base-special-rsqrt