+2,216 −0

Conversation

anandkaranubc

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-botstdlib-bot added MathIssue or pull request specific to math functionality.Needs ReviewA 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 Outdated
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://.com/stdlib-js/stdlib/blob/0da78b462b0783c2d7d145d477b20c8750ed8486/etc/eslint/rules/spellcheck.js. Would be good to add exceptions there.

@stdlib-bot

Coverage Report

PackageStatementsBranchesFunctionsLines
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.

@anandkaranubcanandkaranubc added FeatureIssue or pull request for adding a new feature.JavaScriptIssue involves or relates to JavaScript.CIssue involves or relates to C.GSoCGoogle Summer of Code.gsoc: 2025Google Summer of Code (2025).labels Jun 13, 2025
Planeshifter
Planeshifter reviewed Jun 13, 2025
View reviewed changes
Planeshifter
Planeshifter requested changes Jun 13, 2025
View reviewed changes

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.

@anandkaranubc
Merge branch 'develop' into feat/cpolarf
25aa71e
@anandkaranubc
chore: apply suggestions from review
64f1566
---
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: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---
anandkaranubc
anandkaranubc commented Jun 14, 2025
View reviewed changes
lib/node_modules/@stdlib/math/base/special/cpolarf/examples/index.js
Comment on lines +21 to +30
var Complex64Array = require( '@stdlib/array/complex64' );
var uniform = require( '@stdlib/random/array/uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var cpolarf = require( './../lib' );

// Create an array of random numbers:
var arr = new Complex64Array( uniform( 200, -100.0, 100.0 ) );

// Compute the polar form of each number in the array:
logEachMap( 'cpolarf(%s) = [%s]', arr, cpolarf );
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Planeshifter If this refactoring looks good, I will also apply that to cpolar.

One caveat: it is slightly different from the C examples.

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

@Planeshifter Planeshifter Planeshifter requested changes

Requested changes must be addressed to merge this pull request.

No one assigned
CIssue involves or relates to C.FeatureIssue or pull request for adding a new feature.GSoCGoogle Summer of Code.gsoc: 2025Google Summer of Code (2025).JavaScriptIssue involves or relates to JavaScript.MathIssue or pull request specific to math functionality.Needs ReviewA pull request which needs code review.
None yet
No milestone

Successfully merging this pull request may close these issues.