@stdlib/math-base-special-cabs2f
TypeScript icon, indicating that this package has built-in type declarations

0.2.1 • Public • Published
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!

cabs2f

NPM version Build Status Coverage Status

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

The absolute value of a complex number is defined as

Absolute value

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-cabs2f

Usage

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

cabs2f( z )

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

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

var y = cabs2f( new Complex64( 5.0, 3.0 ) );
// returns 34.0

Notes

  • Be careful to avoid overflow and underflow.
  • Depending on the environment, this function may have better performance than computing the absolute value of a complex number and then squaring. Hence, where appropriate, consider using cabs2f() over cabsf().

Examples

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

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

// Compute the squared 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( 'cabs2f(%s) = %d', z.toString(), cabs2f( z ) );
}

C APIs

Usage

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

stdlib_base_cabs2f( z )

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

#include <complex.h>

float y = stdlib_base_cabs2f( 5.0+3.0*I );
// returns 34.0f

The function accepts the following arguments:

  • z: [in] float complex input value.
float stdlib_base_cabs2f( const float complex z );

Examples

#include "stdlib/math/base/special/cabs2f.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_cabs2f( 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.

Package Sidebar

Install

npm i @stdlib/math-base-special-cabs2f

Homepage

stdlib.io

Weekly Downloads

13

Version

0.2.1

License

Apache-2.0

Unpacked Size

36.5 kB

Total Files

15

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser