Compute the absolute value and the phase of a single-precision complex floating-point number.
npm install @stdlib/math-base-special-cpolarfWe 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!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Compute the [absolute value][@stdlib/math/base/special/cabsf] and [phase][@stdlib/math/base/special/cphasef] of a single-precision complex floating-point number.
``bash`
npm install @stdlib/math-base-special-cpolarf
`javascript`
var cpolarf = require( '@stdlib/math-base-special-cpolarf' );
#### cpolarf( z )
Computes the [absolute value][@stdlib/math/base/special/cabsf] and [phase][@stdlib/math/base/special/cphasef] of a single-precision complex floating-point number.
`javascript
var Complex64 = require( '@stdlib/complex-float32-ctor' );
var o = cpolarf( new Complex64( 5.0, 3.0 ) );
// returns [ ~5.83, ~0.5404 ]
`
#### cpolarf.assign( z, out, stride, offset )
Computes the [absolute value][@stdlib/math/base/special/cabsf] and [phase][@stdlib/math/base/special/cphasef] of a single-precision complex floating-point number and assigns results to a provided output array.
`javascript
var Complex64 = require( '@stdlib/complex-float32-ctor' );
var Float32Array = require( '@stdlib/array-float32' );
var out = new Float32Array( 2 );
var v = cpolarf.assign( new Complex64( 5.0, 3.0 ), out, 1, 0 );
// returns
var bool = ( v === out );
// returns true
`
`javascript
var Complex64Array = require( '@stdlib/array-complex64' );
var uniform = require( '@stdlib/random-array-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var cpolarf = require( '@stdlib/math-base-special-cpolarf' );
// Create an array of random numbers:
var opts = {
'dtype': 'float32'
};
var arr = new Complex64Array( uniform( 200, -100.0, 100.0, opts ) );
// Compute the polar form of each number in the array:
logEachMap( 'cpolarf(%s) = [%s]', arr, cpolarf );
`
*
`c`
#include "stdlib/math/base/special/cpolarf.h"
#### stdlib_base_cpolarf( z, cabsf, cphasef )
Computes the [absolute value][@stdlib/math/base/special/cabsf] and [phase][@stdlib/math/base/special/cphasef] of a single-precision complex floating-point number.
`c
#include "stdlib/complex/float32/ctor.h"
#include "stdlib/complex/float32/real.h"
#include "stdlib/complex/float32/imag.h"
stdlib_complex64_t z = stdlib_complex64( 5.0f, 3.0f );
float cabsf;
float cphasef;
stdlib_base_cpolarf( z, &cabsf, &cphasef );
`
The function accepts the following arguments:
- z: [in] stdlib_complex64_t input value.[out] float*
- cabsf: destination for the absolute value.[out] float*
- cphasef: destination for the phase value in radians.
`c`
void stdlib_base_cpolarf( const stdlib_complex64_t z, float cabsf, float cphasef );
`c
#include "stdlib/math/base/special/cpolarf.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 )
};
float cphasef;
float cabsf;
float re;
float im;
int i;
for ( i = 0; i < 4; i++ ) {
stdlib_base_cpolarf( x[i], &cabsf, &cphasef );
stdlib_complex64_reim( x[i], &re, &im );
printf( "cpolarf(%f + %fi) => cabsf: %f, cphasef: %f\n", re, im, cabsf, cphasef );
}
}
`
*
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]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-special-cpolarf.svg
[npm-url]: https://npmjs.org/package/@stdlib/math-base-special-cpolarf
[test-image]: https://github.com/stdlib-js/math-base-special-cpolarf/actions/workflows/test.yml/badge.svg?branch=v0.1.1
[test-url]: https://github.com/stdlib-js/math-base-special-cpolarf/actions/workflows/test.yml?query=branch:v0.1.1
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-cpolarf/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-cpolarf?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-cpolarf/tree/deno
[deno-readme]: https://github.com/stdlib-js/math-base-special-cpolarf/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/math-base-special-cpolarf/tree/umd
[umd-readme]: https://github.com/stdlib-js/math-base-special-cpolarf/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/math-base-special-cpolarf/tree/esm
[esm-readme]: https://github.com/stdlib-js/math-base-special-cpolarf/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/math-base-special-cpolarf/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-special-cpolarf/main/LICENSE
[@stdlib/math/base/special/cabsf]: https://www.npmjs.com/package/@stdlib/math-base-special-cabsf
[@stdlib/math/base/special/cphasef]: https://www.npmjs.com/package/@stdlib/math-base-special-cphasef