cabsf

Compute the absolute value of a single-precision complex floating-point number.

The absolute value of a complex number is defined as

which corresponds to the length of a vector from the origin to a complex value plotted in the complex plane.

Installation

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

Usage

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

cabsf( z )

Computes an absolute value of a single-precision complex floating-point number.

var Complex64 = require( '@stdlib/complex-float32-ctor' );

var y = cabsf( new Complex64( 5.0, 3.0 ) );
// returns ~5.83

Examples

var Complex64 = require( '@stdlib/complex-float32-ctor' );
var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory;
var cabsf = require( '@stdlib/math-base-special-cabsf' );

// Create a PRNG to generate uniformly distributed pseudorandom integers:
var rand = discreteUniform( -50, 50 );

// Compute the absolute value for a set of random numbers...
var z;
var i;
for ( i = 0; i < 100; i++ ) {
    z = new Complex64( rand(), rand() );
    console.log( 'cabsf(%s) = %d', z.toString(), cabsf( z ) );
}

C APIs

Usage

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

stdlib_base_cabsf( z )

Computes an absolute value of a single-precision complex floating-point number.

#include <complex.h>

float y = stdlib_base_cabsf( 5.0+3.0*I );
// returns ~5.83f

The function accepts the following arguments:

• z: [in] float complex input value.

float stdlib_base_cabsf( const float complex z );

Examples

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

int main( void ) {
    const float complex x[] = { 3.14f+1.0f*I, -3.14f-1.0f*I, 0.0f+0.0f*I, 0.0f/0.0f+0.0f/0.0f*I };

    float complex v;
    float y;
    int i;
    for ( i = 0; i < 4; i++ ) {
        v = x[ i ];
        y = stdlib_base_cabsf( v );
        printf( "f(%f + %f) = %f\n", crealf( v ), cimagf( v ), y );
    }
}

See Also

• @stdlib/math-base/special/cabs: compute the absolute value of a double-precision complex floating-point number.
• @stdlib/math-base/special/cabs2f: compute the squared absolute value of a single-precision complex floating-point number.
• @stdlib/math-base/special/absf: compute the absolute value 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.