Skip to content

Latest commit

 

History

History
327 lines (199 loc) · 10.4 KB

README.md

File metadata and controls

327 lines (199 loc) · 10.4 KB
Raw
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!

cabsf

NPM version Build Status Coverage Status

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

The absolute value of a complex number is defined as

$$|a + bi| = \sqrt{a^2 + b^2}$$

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

Alternatively,

  • To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
  • If you are using Deno, visit the deno branch (see README for usage intructions).
  • For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

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

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

Chat

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.