{"id":29871459,"url":"https://github.com/stdlib-js/math-base-special-cpolarf","last_synced_at":"2026-04-13T11:01:20.177Z","repository":{"id":305777566,"uuid":"1022889675","full_name":"stdlib-js/math-base-special-cpolarf","owner":"stdlib-js","description":"Compute the absolute value and the phase of a single-precision complex floating-point number.","archived":false,"fork":false,"pushed_at":"2026-02-23T04:25:21.000Z","size":260,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-28T12:43:10.146Z","etag":null,"topics":["abs","absolute","angle","arg","argument","cabsf","carg","cphasef","distance","javascript","magnitude","math","mathematics","modulus","node","node-js","nodejs","phase","polar","stdlib"],"latest_commit_sha":null,"homepage":"https://github.com/stdlib-js/stdlib","language":"Python","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stdlib-js.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":"NOTICE","maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":["stdlib-js"],"open_collective":"stdlib","tidelift":"npm/@stdlib/stdlib"}},"created_at":"2025-07-20T04:16:55.000Z","updated_at":"2026-02-23T02:00:19.000Z","dependencies_parsed_at":"2025-07-22T01:25:53.738Z","dependency_job_id":"728ed627-0ead-4940-aab4-4d47df5bd3a3","html_url":"https://github.com/stdlib-js/math-base-special-cpolarf","commit_stats":null,"previous_names":["stdlib-js/math-base-special-cpolarf"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/stdlib-js/math-base-special-cpolarf","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fmath-base-special-cpolarf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fmath-base-special-cpolarf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fmath-base-special-cpolarf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fmath-base-special-cpolarf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/math-base-special-cpolarf/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fmath-base-special-cpolarf/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31749763,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-13T09:16:15.125Z","status":"ssl_error","status_checked_at":"2026-04-13T09:16:05.023Z","response_time":93,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["abs","absolute","angle","arg","argument","cabsf","carg","cphasef","distance","javascript","magnitude","math","mathematics","modulus","node","node-js","nodejs","phase","polar","stdlib"],"created_at":"2025-07-30T19:46:30.357Z","updated_at":"2026-04-13T11:01:20.169Z","avatar_url":"https://github.com/stdlib-js.png","language":"Python","readme":"\u003c!--\n\n@license Apache-2.0\n\nCopyright (c) 2025 The Stdlib Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n--\u003e\n\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    About stdlib...\n  \u003c/summary\u003e\n  \u003cp\u003eWe 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.\u003c/p\u003e\n  \u003cp\u003eThe 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.\u003c/p\u003e\n  \u003cp\u003eWhen 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.\u003c/p\u003e\n  \u003cp\u003eTo join us in bringing numerical computing to the web, get started by checking us out on \u003ca href=\"https://github.com/stdlib-js/stdlib\"\u003eGitHub\u003c/a\u003e, and please consider \u003ca href=\"https://opencollective.com/stdlib\"\u003efinancially supporting stdlib\u003c/a\u003e. We greatly appreciate your continued support!\u003c/p\u003e\n\u003c/details\u003e\n\n# cpolarf\n\n[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] \u003c!-- [![dependencies][dependencies-image]][dependencies-url] --\u003e\n\n\u003e Compute the [absolute value][@stdlib/math/base/special/cabsf] and [phase][@stdlib/math/base/special/cphasef] of a single-precision complex floating-point number.\n\n\u003csection class=\"intro\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.intro --\u003e\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\n```bash\nnpm install @stdlib/math-base-special-cpolarf\n```\n\nAlternatively,\n\n-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).\n-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).\n-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).\n\nThe [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.\n\nTo 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.\n\n\u003c/section\u003e\n\n\u003csection class=\"usage\"\u003e\n\n## Usage\n\n```javascript\nvar cpolarf = require( '@stdlib/math-base-special-cpolarf' );\n```\n\n#### cpolarf( z )\n\nComputes the [absolute value][@stdlib/math/base/special/cabsf] and [phase][@stdlib/math/base/special/cphasef] of a single-precision complex floating-point number.\n\n```javascript\nvar Complex64 = require( '@stdlib/complex-float32-ctor' );\n\nvar o = cpolarf( new Complex64( 5.0, 3.0 ) );\n// returns [ ~5.83, ~0.5404 ]\n```\n\n#### cpolarf.assign( z, out, stride, offset )\n\nComputes 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.\n\n```javascript\nvar Complex64 = require( '@stdlib/complex-float32-ctor' );\nvar Float32Array = require( '@stdlib/array-float32' );\n\nvar out = new Float32Array( 2 );\n\nvar v = cpolarf.assign( new Complex64( 5.0, 3.0 ), out, 1, 0 );\n// returns \u003cFloat32Array\u003e[ ~5.83, ~0.5404 ]\n\nvar bool = ( v === out );\n// returns true\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n## Examples\n\n\u003c!-- eslint no-undef: \"error\" --\u003e\n\n```javascript\nvar Complex64Array = require( '@stdlib/array-complex64' );\nvar uniform = require( '@stdlib/random-array-uniform' );\nvar logEachMap = require( '@stdlib/console-log-each-map' );\nvar cpolarf = require( '@stdlib/math-base-special-cpolarf' );\n\n// Create an array of random numbers:\nvar opts = {\n    'dtype': 'float32'\n};\nvar arr = new Complex64Array( uniform( 200, -100.0, 100.0, opts ) );\n\n// Compute the polar form of each number in the array:\nlogEachMap( 'cpolarf(%s) = [%s]', arr, cpolarf );\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n\u003c!-- C interface documentation. --\u003e\n\n* * *\n\n\u003csection class=\"c\"\u003e\n\n## C APIs\n\n\u003c!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"intro\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.intro --\u003e\n\n\u003c!-- C usage documentation. --\u003e\n\n\u003csection class=\"usage\"\u003e\n\n### Usage\n\n```c\n#include \"stdlib/math/base/special/cpolarf.h\"\n```\n\n#### stdlib_base_cpolarf( z, cabsf, cphasef )\n\nComputes the [absolute value][@stdlib/math/base/special/cabsf] and [phase][@stdlib/math/base/special/cphasef] of a single-precision complex floating-point number.\n\n```c\n#include \"stdlib/complex/float32/ctor.h\"\n#include \"stdlib/complex/float32/real.h\"\n#include \"stdlib/complex/float32/imag.h\"\n\nstdlib_complex64_t z = stdlib_complex64( 5.0f, 3.0f );\nfloat cabsf;\nfloat cphasef;\nstdlib_base_cpolarf( z, \u0026cabsf, \u0026cphasef );\n```\n\nThe function accepts the following arguments:\n\n-   **z**: `[in] stdlib_complex64_t` input value.\n-   **cabsf**: `[out] float*` destination for the absolute value.\n-   **cphasef**: `[out] float*` destination for the phase value in radians.\n\n```c\nvoid stdlib_base_cpolarf( const stdlib_complex64_t z, float *cabsf, float *cphasef );\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003c!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003c!-- C API usage examples. --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n### Examples\n\n```c\n#include \"stdlib/math/base/special/cpolarf.h\"\n#include \"stdlib/complex/float32/ctor.h\"\n#include \"stdlib/complex/float32/reim.h\"\n#include \u003cstdio.h\u003e\n\nint main( void ) {\n    const stdlib_complex64_t x[] = {\n        stdlib_complex64( 3.14f, 1.0f ),\n        stdlib_complex64( -3.14f, -1.0f ),\n        stdlib_complex64( 0.0f, 0.0f ),\n        stdlib_complex64( 0.0f/0.0f, 0.0f/0.0f )\n    };\n\n    float cphasef;\n    float cabsf;\n    float re;\n    float im;\n    int i;\n    for ( i = 0; i \u003c 4; i++ ) {\n        stdlib_base_cpolarf( x[i], \u0026cabsf, \u0026cphasef );\n        stdlib_complex64_reim( x[i], \u0026re, \u0026im );\n        printf( \"cpolarf(%f + %fi) =\u003e cabsf: %f, cphasef: %f\\n\", re, im, cabsf, cphasef );\n    }\n}\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.c --\u003e\n\n\u003c!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --\u003e\n\n\u003csection class=\"related\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.related --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\n\u003csection class=\"main-repo\" \u003e\n\n* * *\n\n## Notice\n\nThis 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.\n\nFor 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].\n\n#### Community\n\n[![Chat][chat-image]][chat-url]\n\n---\n\n## License\n\nSee [LICENSE][stdlib-license].\n\n\n## Copyright\n\nCopyright \u0026copy; 2016-2026. The Stdlib [Authors][stdlib-authors].\n\n\u003c/section\u003e\n\n\u003c!-- /.stdlib --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"links\"\u003e\n\n[npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-special-cpolarf.svg\n[npm-url]: https://npmjs.org/package/@stdlib/math-base-special-cpolarf\n\n[test-image]: https://github.com/stdlib-js/math-base-special-cpolarf/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/math-base-special-cpolarf/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-cpolarf/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-cpolarf?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/math-base-special-cpolarf.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/math-base-special-cpolarf/main\n\n--\u003e\n\n[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg\n[chat-url]: https://stdlib.zulipchat.com\n\n[stdlib]: https://github.com/stdlib-js/stdlib\n\n[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors\n\n[umd]: https://github.com/umdjs/umd\n[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules\n\n[deno-url]: https://github.com/stdlib-js/math-base-special-cpolarf/tree/deno\n[deno-readme]: https://github.com/stdlib-js/math-base-special-cpolarf/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/math-base-special-cpolarf/tree/umd\n[umd-readme]: https://github.com/stdlib-js/math-base-special-cpolarf/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/math-base-special-cpolarf/tree/esm\n[esm-readme]: https://github.com/stdlib-js/math-base-special-cpolarf/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/math-base-special-cpolarf/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-special-cpolarf/main/LICENSE\n\n[@stdlib/math/base/special/cabsf]: https://github.com/stdlib-js/math-base-special-cabsf\n\n[@stdlib/math/base/special/cphasef]: https://github.com/stdlib-js/math-base-special-cphasef\n\n\u003c!-- \u003crelated-links\u003e --\u003e\n\n\u003c!-- \u003c/related-links\u003e --\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.links --\u003e\n","funding_links":["https://github.com/sponsors/stdlib-js","https://opencollective.com/stdlib","https://tidelift.com/funding/github/npm/@stdlib/stdlib"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fmath-base-special-cpolarf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Fmath-base-special-cpolarf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fmath-base-special-cpolarf/lists"}