Skip to content

feat!: migrate math/base/special/cidentityf to complex/float32/base/identity #6165

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
Merged
merged 4 commits into from
Mar 19, 2025
Merged

feat!: migrate math/base/special/cidentityf to complex/float32/base/identity #6165

merged 4 commits into from
Mar 19, 2025

Conversation

gururaj1512
Copy link
Member

Progresses #2261.

Description

What is the purpose of this pull request?

This pull request:

  • feat!: migrate math/base/special/cidentityf to complex/float32/base/identity

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

@gururaj1512
feat: add complex/float32/base/identity
723f4ad 
Ref: stdlib-js#2261

---
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: passed
  - task: lint_repl_help
    status: passed
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: passed
  - task: lint_javascript_tests
    status: passed
  - task: lint_javascript_benchmarks
    status: passed
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: missing_dependencies
  - task: lint_c_examples
    status: missing_dependencies
  - task: lint_c_benchmarks
    status: missing_dependencies
  - 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
---
@gururaj1512
remove: remove cidentityf from namespace
eb18db1 
This commit removes the `cidentityf` symbol from the `@stdlib/math/base/special`
namespace due to a package migration.

BREAKING CHANGE: remove `cidentityf`

To migrate, users should access the same symbol via the
`@stdlib/complex/float32/base` namespace.

---
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: passed
  - 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: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
@gururaj1512
refactor: update paths
a11e8f6 
Ref: stdlib-js#2261

---
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: passed
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: passed
  - task: lint_javascript_tests
    status: passed
  - task: lint_javascript_benchmarks
    status: passed
  - 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: na
  - task: lint_license_headers
    status: passed
---
@gururaj1512
remove: remove math/base/special/cidentityf
264ce06 
This commit removes `@stdlib/math/base/special/cidentityf` in favor of
`@stdlib/complex/float32/base/identity`.

BREAKING CHANGE: remove `math/base/special/cidentityf`

To migrate, users should update their require/import paths to use
`@stdlib/complex/float32/base/identity` which provides the same API and
implementation.

Ref: stdlib-js#2261

---
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: 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 the Needs Review A pull request which needs code review. label Mar 18, 2025
@gururaj1512 gururaj1512 added release: Major Breaking change requiring a new major release. Math Issue or pull request specific to math functionality. labels Mar 18, 2025
@kgryte kgryte removed the Needs Review A pull request which needs code review. label Mar 19, 2025
kgryte
kgryte reviewed Mar 19, 2025
View reviewed changes
lib/node_modules/@stdlib/complex/float32/base/identity/src/main.c
* @example
* float complex y = stdlib_base_complex64_identity( 3.0f+3.0f*I );
*/
float complex stdlib_base_complex64_identity( const float complex z ) {
Copy link
Member

Choose a reason for hiding this comment

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

Note to self: we should be using stdlib_complex64_t. This package needs updating after merging.

kgryte
kgryte approved these changes Mar 19, 2025
View reviewed changes
Copy link
Member

@kgryte kgryte left a comment

Choose a reason for hiding this comment

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

LGTM

@kgryte
Copy link
Member

kgryte commented Mar 19, 2025

As the CI failure seems unrelated to the changes introduced in this PR, I'll go ahead and merge.

@kgryte kgryte merged commit 2dcec61 into stdlib-js:develop Mar 19, 2025
63 of 64 checks passed
@gururaj1512 gururaj1512 deleted the migrate-math-base-special-cidentityf branch April 21, 2025 19:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kgryte kgryte kgryte approved these changes

Assignees

No one assigned

Labels

Math Issue or pull request specific to math functionality. release: Major Breaking change requiring a new major release.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@gururaj1512 @kgryte @stdlib-bot