time-to-botec/squiggle/node_modules/@stdlib/math/base/special/cbrtf/README.md
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

2.9 KiB

Cube Root

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

Usage

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

cbrtf( x )

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

var v = cbrtf( 64.0 );
// returns 4.0

v = cbrtf( 27.0 );
// returns 3.0

v = cbrtf( 0.0 );
// returns 0.0

v = cbrtf( -0.0 );
// returns -0.0

v = cbrtf( -9.0 );
// returns ~-2.08

v = cbrtf( NaN );
// returns NaN

Examples

var randu = require( '@stdlib/random/base/randu' );
var cbrtf = require( '@stdlib/math/base/special/cbrtf' );

var x;
var i;

for ( i = 0; i < 100; i++ ) {
    x = (randu()*200.0) - 100.0;
    console.log( 'cbrt(%d) = %d', x, cbrtf( x ) );
}

C APIs

Usage

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

stdlib_base_cbrtf( x )

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

float y = stdlib_base_cbrtf( 27.0f );
// returns 3.0f

The function accepts the following arguments:

  • x: [in] float input value.
float stdlib_base_cbrtf( const float x );

Examples

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

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

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