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

Return occupied booleans in retrieve #414

Merged
merged 6 commits into from Nov 11, 2023
Merged

Return occupied booleans in retrieve #414

merged 6 commits into from Nov 11, 2023

Conversation

btjanaka
Copy link
Member

@btjanaka btjanaka commented Nov 11, 2023

Description

Previously, we relied on sentinel values to indicate whether a given cell was occupied. Since it is entirely possible that users want to use these sentinel values in their fields, we now return a separate occupied array that indicates which cells are occupied.

Considerations:

  • Chose not to support additional return types like tuple and pandas for now, as such flexibility is less essential in retrieve, and this feature can be added fairly easily later on
  • We still set the sentinel values depending on the field type since it may be confusing to see arbitrary values for a given field without seeing the occupied array.
  • the threshold field is now included in outputs from retrieve()

TODO

  • Implement new retrieve and retrieve_single methods
  • Fix tests
  • Fix usage in tutorials

Questions

Status

  • I have read the guidelines in
    CONTRIBUTING.md
  • I have formatted my code using yapf
  • I have tested my code by running pytest
  • I have linted my code with pylint
  • I have added a one-line description of my change to the changelog in
    HISTORY.md
  • This PR is ready to go

@btjanaka btjanaka merged commit f1da318 into master Nov 11, 2023
17 checks passed
@btjanaka btjanaka deleted the retrieve branch November 11, 2023 02:42
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.

None yet

1 participant