@stdlib/math-base-special-cabs2

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!

cabs2

Compute the squared absolute value of a double-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-cabs2

Usage

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

cabs2( z )

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

var Complex128 = require( '@stdlib/complex-float64-ctor' );

var y = cabs2( new Complex128( 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 cabs2() over cabs().

Examples

var Complex128 = require( '@stdlib/complex-float64-ctor' );
var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory;
var cabs2 = require( '@stdlib/math-base-special-cabs2' );

// 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 Complex128( rand(), rand() );
    console.log( 'cabs2(%s) = %d', z.toString(), cabs2( z ) );
}

---

C APIs

Usage

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

stdlib_base_cabs2( z )

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

#include "stdlib/complex/float64/ctor.h"

stdlib_complex128_t z = stdlib_complex128( 5.0, 3.0 );

double y = stdlib_base_cabs2( z );
// returns 34.0

The function accepts the following arguments:

• z: [in] stdlib_complex128_t input value.

double stdlib_base_cabs2( const stdlib_complex128_t z );

Examples

#include "stdlib/math/base/special/cabs2.h"
#include "stdlib/complex/float64/ctor.h"
#include "stdlib/complex/float64/reim.h"
#include <stdio.h>

int main( void ) {
    const stdlib_complex128_t x[] = {
        stdlib_complex128( 3.14, 1.0 ),
        stdlib_complex128( -3.14, -1.0 ),
        stdlib_complex128( 0.0, 0.0 ),
        stdlib_complex128( 0.0/0.0, 0.0/0.0 )
    };

    stdlib_complex128_t v;
    double re;
    double im;
    double y;
    int i;
    for ( i = 0; i < 4; i++ ) {
        v = x[ i ];
        y = stdlib_base_cabs2( v );
        stdlib_complex128_reim( v, &re, &im );
        printf( "f(%lf + %lf) = %lf\n", re, im, y );
    }
}

---

See Also

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

Changelog

0.2.2 (2024-07-28)

<section class="bug-fixes">

Bug Fixes

• cf3f92e - update include paths

</section> <!-- /.bug-fixes --> <section class="commits">

Commits

<details>

• 32bbcb3 - refactor: update paths (by Athan Reines)
• ed9c0a5 - refactor: update paths (by Athan Reines)
• 8908bda - refactor: update paths (by Athan Reines)
• 3a3b1e0 - docs: update package URLs (#2269) (by stdlib-bot)
• 8089b88 - docs: update paths (by Athan Reines)
• 038b199 - docs: update paths (by Athan Reines)
• cf3f92e - fix: update include paths (by Athan Reines)
• 75d4f83 - refactor: update require and include paths (by Athan Reines)
• 41d41e9 - test: include trailing newlines in Julia-generated JSON fixtures (by Philipp Burckhardt)
• 9ed7d0e - chore: add missing trailing newlines (by Philipp Burckhardt)

</details> </section> <!-- /.commits --> <section class="contributors">

Contributors

A total of 2 people contributed to this release. Thank you to the following contributors:

• Athan Reines
• Philipp Burckhardt

</section> <!-- /.contributors --> </section> <!-- /.release --> <section class="release" id="v0.2.1">