@stdlib/math-base-special-rsqrtf
v0.2.2
Published
Compute the reciprocal square root of a single-precision floating-point number.
Downloads
119
Readme
Reciprocal Square Root
Compute the reciprocal of the principal square root of a single-precision floating-point number.
The reciprocal of the principal square root is defined as
Installation
npm install @stdlib/math-base-special-rsqrtf
Usage
var rsqrtf = require( '@stdlib/math-base-special-rsqrtf' );
rsqrtf( x )
Computes the reciprocal (inverse) square root of a single-precision floating-point number.
var v = rsqrtf( 1.0 );
// returns 1.0
v = rsqrtf( 4.0 );
// returns 0.5
v = rsqrtf( 0.0 );
// returns Infinity
v = rsqrtf( NaN );
// returns NaN
v = rsqrtf( Infinity );
// returns 0.0
For negative numbers, the reciprocal square root is not defined.
var v = rsqrtf( -4.0 );
// returns NaN
Examples
var randu = require( '@stdlib/random-base-randu' );
var round = require( '@stdlib/math-base-special-round' );
var rsqrtf = require( '@stdlib/math-base-special-rsqrtf' );
var x;
var i;
for ( i = 0; i < 100; i++ ) {
x = round( randu() * 100.0 );
console.log( 'rsqrt(%d) = %d', x, rsqrtf( x ) );
}
C APIs
Usage
#include "stdlib/math/base/special/rsqrtf.h"
stdlib_base_rsqrtf( x )
Computes the reciprocal (inverse) square root of a single-precision floating-point number.
float y = stdlib_base_rsqrtf( 4.0 );
// returns 0.5
The function accepts the following arguments:
- x:
[in] float
input value.
float stdlib_base_rsqrtf( const float x );
Examples
#include "stdlib/math/base/special/rsqrtf.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_rsqrtf( x[ i ] );
printf( "rsqrt(%f) = %f\n", x[ i ], y );
}
}
See Also
@stdlib/math-base/special/rsqrt
: compute the reciprocal square root of a double-precision floating-point number.@stdlib/math-base/special/sqrtf
: compute the principal square root of a single-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.