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][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]

> Compute the [absolute value][absolute-value] of a single-precision [complex][@stdlib/complex/float32/ctor] floating-point number.

The [absolute value][absolute-value] of a [complex][@stdlib/complex/float32/ctor] 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

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

`Usage`

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

#### cabsf( z )

Computes the [absolute value][absolute-value] of a single-precision [complex][@stdlib/complex/float32/ctor] floating-point number.

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

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

`Examples`

`javascript 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`

`$3`

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

#### stdlib_base_cabsf( z )

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

`c #include "stdlib/complex/float32/ctor.h"

stdlib_complex64_t z = stdlib_complex64( 5.0f, 3.0f );

float y = stdlib_base_cabsf( z ); // returns ~5.83f`

The function accepts the following arguments:

- z: [in] stdlib_complex64_t input value.

`c float stdlib_base_cabsf( const stdlib_complex64_t z );`

`$3`

`c #include "stdlib/math/base/special/cabsf.h" #include "stdlib/complex/float32/ctor.h" #include "stdlib/complex/float32/reim.h" #include

int main( void ) { const stdlib_complex64_t x[] = { stdlib_complex64( 3.14f, 1.0f ), stdlib_complex64( -3.14f, -1.0f ), stdlib_complex64( 0.0f, 0.0f ), stdlib_complex64( 0.0f/0.0f, 0.0f/0.0f ) };

stdlib_complex64_t v; float re; float im; float y; int i; for ( i = 0; i < 4; i++ ) { v = x[ i ]; y = stdlib_base_cabsf( v ); stdlib_complex64_reim( v, &re, &im ); printf( "f(%f + %f) = %f\n", re, im, y ); } }`

*

`Notice`

This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].

#### Community

[![Chat][chat-image]][chat-url]

---

`License`

See [LICENSE][stdlib-license].

`Copyright`

[npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-special-cabsf.svg [npm-url]: https://npmjs.org/package/@stdlib/math-base-special-cabsf

[test-image]: https://github.com/stdlib-js/math-base-special-cabsf/actions/workflows/test.yml/badge.svg?branch=v0.3.1 [test-url]: https://github.com/stdlib-js/math-base-special-cabsf/actions/workflows/test.yml?query=branch:v0.3.1

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-cabsf/main.svg [coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-cabsf?branch=main

[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg [chat-url]: https://stdlib.zulipchat.com

[stdlib]: https://github.com/stdlib-js/stdlib

[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors

[umd]: https://github.com/umdjs/umd [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules

[deno-url]: https://github.com/stdlib-js/math-base-special-cabsf/tree/deno [deno-readme]: https://github.com/stdlib-js/math-base-special-cabsf/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/math-base-special-cabsf/tree/umd [umd-readme]: https://github.com/stdlib-js/math-base-special-cabsf/blob/umd/README.md [esm-url]: https://github.com/stdlib-js/math-base-special-cabsf/tree/esm [esm-readme]: https://github.com/stdlib-js/math-base-special-cabsf/blob/esm/README.md [branches-url]: https://github.com/stdlib-js/math-base-special-cabsf/blob/main/branches.md

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-special-cabsf/main/LICENSE

[absolute-value]: https://en.wikipedia.org/wiki/Absolute_value

[@stdlib/complex/float32/ctor]: https://www.npmjs.com/package/@stdlib/complex-float32-ctor

[@stdlib/math/base/special/cabs]: https://www.npmjs.com/package/@stdlib/math-base-special-cabs

[@stdlib/math/base/special/cabs2f]: https://www.npmjs.com/package/@stdlib/math-base-special-cabs2f

[@stdlib/math/base/special/absf]: https://www.npmjs.com/package/@stdlib/math-base-special-absf


  
    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][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]

> Compute the [absolute value][absolute-value] of a single-precision [complex][@stdlib/complex/float32/ctor] floating-point number.

The [absolute value][absolute-value] of a [complex][@stdlib/complex/float32/ctor] 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`

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

`Usage`

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

#### cabsf( z )

Computes the [absolute value][absolute-value] of a single-precision [complex][@stdlib/complex/float32/ctor] floating-point number.

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

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

`Examples`

`javascript 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`

`$3`

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

#### stdlib_base_cabsf( z )

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

`c #include "stdlib/complex/float32/ctor.h"

stdlib_complex64_t z = stdlib_complex64( 5.0f, 3.0f );

float y = stdlib_base_cabsf( z ); // returns ~5.83f `

The function accepts the following arguments:

- z: [in] stdlib_complex64_t input value.

`c float stdlib_base_cabsf( const stdlib_complex64_t z ); `

`$3`

`c #include "stdlib/math/base/special/cabsf.h" #include "stdlib/complex/float32/ctor.h" #include "stdlib/complex/float32/reim.h" #include

int main( void ) { const stdlib_complex64_t x[] = { stdlib_complex64( 3.14f, 1.0f ), stdlib_complex64( -3.14f, -1.0f ), stdlib_complex64( 0.0f, 0.0f ), stdlib_complex64( 0.0f/0.0f, 0.0f/0.0f ) };

stdlib_complex64_t v; float re; float im; float y; int i; for ( i = 0; i < 4; i++ ) { v = x[ i ]; y = stdlib_base_cabsf( v ); stdlib_complex64_reim( v, &re, &im ); printf( "f(%f + %f) = %f\n", re, im, y ); } } `