Skip to content

feat: add math/base/special/cpolarf #7342

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 8 commits into
base: develop
Choose a base branch
from
Open

feat: add math/base/special/cpolarf #7342

wants to merge 8 commits into from
+2,232 −0

Conversation

anandkaranubc
Copy link
Contributor

Progresses #649

Description

What is the purpose of this pull request?

This pull request:

  • Adds the complete implementation for math/base/special/cpolarf

Related Issues

Does this pull request have any related issues?

This pull request:

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

@stdlib-js/reviewers

@anandkaranubc
feat: temp commit
2f2dd8f
@anandkaranubc
Merge branch 'develop' into feat/cpolarf
2c58cce
@anandkaranubc
feat: add math/base/special/cpolarf
53c811f
@anandkaranubc
Merge branch 'develop' into feat/cpolarf
bb0345e
@anandkaranubc
bench: use random_uniform
3e135f3 
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: passed
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: na
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
@anandkaranubc
docs: fix examples
bff28a2 
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: passed
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: na
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
@anandkaranubc
Merge branch 'develop' into feat/cpolarf
6a7c919
@anandkaranubc
chore: minor clean-up
7413030 
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: passed
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: na
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
@stdlib-bot stdlib-bot added Math Issue or pull request specific to math functionality. Needs Review A pull request which needs code review. labels Jun 13, 2025
anandkaranubc
anandkaranubc commented Jun 13, 2025
View reviewed changes
lib/node_modules/@stdlib/math/base/special/cpolarf/examples/index.js
z = new Complex64( re, im );
o = cpolarf( z );
z = z.toString();
console.log( 'absf(%s) = %d. argf(%s) = %d', z, o[ 0 ], z, o[ 1 ] );
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The reason why it doesn't have the same words as cpolarf, cphasef and cabsf in here and in README, is because they cause a cs-spell-checker lint error.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As compared to the example.c file

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The lint rule's behavior is configured in https://github.com/stdlib-js/stdlib/blob/0da78b462b0783c2d7d145d477b20c8750ed8486/etc/eslint/rules/spellcheck.js. Would be good to add exceptions there.

@stdlib-bot
Copy link
Contributor

Coverage Report

Package Statements Branches Functions Lines
math/base/special/cpolarf $\color{green}212/212$
$\color{green}+100.00\%$ 		$\color{green}7/7$
$\color{green}+100.00\%$ 		$\color{green}3/3$
$\color{green}+100.00\%$ 		$\color{green}212/212$
$\color{green}+100.00\%$

The above coverage report was generated for the changes in this PR.

@anandkaranubc anandkaranubc added Feature Issue or pull request for adding a new feature. JavaScript Issue involves or relates to JavaScript. C Issue involves or relates to C. GSoC Google Summer of Code. gsoc: 2025 Google Summer of Code (2025). labels Jun 13, 2025
Planeshifter
Planeshifter reviewed Jun 13, 2025
View reviewed changes
lib/node_modules/@stdlib/math/base/special/cpolarf/README.md
- **cphasef**: `[out] float*` destination for the phase value in radians.

```c
float stdlib_base_cpolarf( const stdlib_complex64_t z, float *cabsf, float *cphasef );
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
float stdlib_base_cpolarf( const stdlib_complex64_t z, float *cabsf, float *cphasef );
void stdlib_base_cpolarf( const stdlib_complex64_t z, float *cabsf, float *cphasef );

Planeshifter
Planeshifter reviewed Jun 13, 2025
View reviewed changes
lib/node_modules/@stdlib/math/base/special/cpolarf/docs/types/index.d.ts
* var v = cpolarf( new Complex64( 5.0, 3.0 ) );
* // returns [ ~5.83, ~0.5404 ]
*/
( z: Complex64 ): Array<number>;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same question of whether we should return a tuple here, which would be slightly more type-safe:

Suggested change
( z: Complex64 ): Array<number>;
( z: Complex64 ): [ number, number ];

Planeshifter
Planeshifter requested changes Jun 13, 2025
View reviewed changes
Copy link
Member

@Planeshifter Planeshifter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be ready once updating return type and fixing function signature.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Planeshifter Planeshifter Planeshifter requested changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
C Issue involves or relates to C. Feature Issue or pull request for adding a new feature. GSoC Google Summer of Code. gsoc: 2025 Google Summer of Code (2025). JavaScript Issue involves or relates to JavaScript. Math Issue or pull request specific to math functionality. Needs Review A pull request which needs code review.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@anandkaranubc @stdlib-bot @Planeshifter