Skip to content
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

Fix KnotVector to numpy array conversion #453

Merged
merged 2 commits into from
Aug 22, 2024
Merged

Fix KnotVector to numpy array conversion #453

merged 2 commits into from
Aug 22, 2024

Conversation

j042
Copy link
Member

@j042 j042 commented Aug 21, 2024

Overview

Since numpy 2.0, a copy kwarg was added to numpy.ndarray.__array__. This PR adds **kwargs to __array__ function. It is ignored, since we always return a copy.

Addressed issues

Checklists

  • Documentations are up-to-date.
  • Added example(s)
  • Added test(s)

Summary by CodeRabbit

  • New Features
    • Enhanced the flexibility of the __array__ method in the KnotVector class to accept additional keyword arguments, preparing for future enhancements.
  • Updates
    • Updated the pybind11 dependency to a newer commit, potentially introducing bug fixes and performance improvements.

Copy link

coderabbitai bot commented Aug 21, 2024

Walkthrough

The recent updates enhance the KnotVector class by modifying the __array__ method to accept an additional, optional keyword argument. This change maintains existing functionality while preparing the method for potential future enhancements. Additionally, the pybind11 dependency has been updated to a new commit, ensuring the project benefits from the latest improvements and fixes from the library.

Changes

Files Change Summary
src/py/py_knot_vector.cpp Modified the __array__ method in the KnotVector class to include an unused copy_ignored parameter.
third_party/pybind11 Updated the subproject commit reference to a newer version, ensuring integration of the latest changes.

Poem

🐰 In the code where knots entwine,
A change so slight, yet so divine.
With extra args, we leap and bound,
Enhancing flows where joy is found!
Let's hop with glee, our future's bright,
For every change brings pure delight! 🌼


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 2bcf806 and 3342296.

Files selected for processing (2)
  • src/py/py_knot_vector.cpp (1 hunks)
  • third_party/pybind11 (1 hunks)
Additional comments not posted (2)
third_party/pybind11 (1)

1-1: Dependency update acknowledged.

The subproject commit update for pybind11 ensures the project benefits from the latest improvements and fixes from the library. Ensure compatibility with the rest of the codebase.

src/py/py_knot_vector.cpp (1)

173-175: Update to __array__ method acknowledged.

The addition of copy_ignored as a keyword argument aligns with the changes in numpy 2.0. The function's logic remains unchanged, maintaining compatibility with numpy's interface.

Ensure that the usage of this method is consistent across the codebase.

Run the following script to verify the function usage:

Verification successful

No additional calls to __array__ method found.

The __array__ method is not called elsewhere in the codebase, so there are no inconsistencies in its usage. The implementation in src/py/py_knot_vector.cpp is the only occurrence.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all function calls to `__array__` method in the codebase.

# Test: Search for the function usage. Expect: Only occurrences of the new signature.
rg --type cpp -A 5 $'__array__'

Length of output: 483


Script:

#!/bin/bash
# Description: Search for calls to the `__array__` method in the codebase to ensure consistent usage of the new signature.

# Test: Search for calls to the `__array__` method. Expect: Consistent usage with the new signature.
rg --type cpp '__array__'

Length of output: 74

@j042 j042 requested a review from clemens-fricke August 22, 2024 07:03
@clemens-fricke
Copy link
Contributor

Thanks for the quick fix. Tests now work again. Looks good to me.

@clemens-fricke
Copy link
Contributor

I also checked the examples, and they are still working as expected. So there is no impact there either.

@j042 j042 changed the base branch from main to develop August 22, 2024 12:12
@j042 j042 merged commit 853ba8b into develop Aug 22, 2024
21 checks passed
@j042 j042 deleted the bf-kv2array branch August 22, 2024 12:14
@coderabbitai coderabbitai bot mentioned this pull request Sep 9, 2024
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants