Skip to content

docs: change examples for complex/float64/base/add #7177

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.

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

Merged
merged 3 commits into from
Jun 2, 2025

Conversation

ShabiShett07
Copy link
Contributor


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

none

Description

What is the purpose of this pull request?

This pull request:

  • change the implementation of javascript example

Related Issues

Does this pull request have any related issues?

This pull request:

  • none

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

---
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
---
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Jun 2, 2025
@stdlib-bot
Copy link
Contributor

stdlib-bot commented Jun 2, 2025

Coverage Report

Package Statements Branches Functions Lines
complex/float64/base/add $\color{green}293/293$
$\color{green}+100.00\%$
$\color{green}9/9$
$\color{green}+100.00\%$
$\color{green}4/4$
$\color{green}+100.00\%$
$\color{green}293/293$
$\color{green}+100.00\%$

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

Signed-off-by: Shabareesh Shetty <[email protected]>
Signed-off-by: Shabareesh Shetty <[email protected]>
@Planeshifter Planeshifter added the Ready To Merge A pull request which is ready to be merged. label Jun 2, 2025
@stdlib-bot
Copy link
Contributor

PR Commit Message

docs: change examples for `complex/float64/base/add`

PR-URL: https://github.com/stdlib-js/stdlib/pull/7177

Co-authored-by: ShabiShett07 <[email protected]>
Reviewed-by: Philipp Burckhardt <[email protected]>
Signed-off-by: Shabareesh Shetty <[email protected]>

Please review the above commit message and make any necessary adjustments.

@stdlib-bot stdlib-bot removed the Needs Review A pull request which needs code review. label Jun 2, 2025
@Planeshifter Planeshifter merged commit 01fbdab into stdlib-js:develop Jun 2, 2025
28 checks passed
var z1 = new Complex128Array( discreteUniform( 200, -50, 50 ) );
var z2 = new Complex128Array( discreteUniform( 200, -50, 50 ) );

// Perform multiplication on each element of arrays:
Copy link
Member

Choose a reason for hiding this comment

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

@Planeshifter Please perform more careful reviews. This comment is clearly incorrect.

z3 = add( z1, z2 );
console.log( '(%s) + (%s) = %s', z1.toString(), z2.toString(), z3.toString() );
}
// Scale each by a scalar constant:
Copy link
Member

Choose a reason for hiding this comment

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

@Planeshifter Same comment.

console.log( '(%s) + (%s) = %s', z1.toString(), z2.toString(), z3.toString() );
}
// Scale each by a scalar constant:
logEachMap( '(%s) * (%s) = %s', z1, z2, add );
Copy link
Member

Choose a reason for hiding this comment

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

This is incorrect. The operation is addition not multiplication.

var z2 = new Complex128Array( discreteUniform( 200, -50, 50 ) );

// Perform multiplication on each element of arrays:
logEachMap( '(%s) * (%s) = %s', z1, z2, add );
Copy link
Member

Choose a reason for hiding this comment

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

This is incorrect.

anandkaranubc pushed a commit to anandkaranubc/stdlib that referenced this pull request Jun 3, 2025
PR-URL: stdlib-js#7177

Reviewed-by: Philipp Burckhardt <[email protected]>
Signed-off-by: Shabareesh Shetty <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Ready To Merge A pull request which is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants