Provide ParameterCollection.where for efficient conditional iteration of parameters #1899
+130
−3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Allows selective iteration of parameters that meet, by their definition
not their value, meet a certain condition. This would be useful to
iterate over all parameters on a ``Block`` that are relevant for
neutronics calculations with
```python
for p in block.p.where(lambda pd: "neutronics" in pd.categories):
...
```
The argument is a function that should return true for a given parameter
and can be complicated
```python
block.p.where(
lambda pd: (
pd.atLocation(ParamLocation.EDGES) or
pd.atLocation(ParamLocation.CORNERS)
)
)
```
Closes #1898
(cherry picked from commit 4162cd7)
| >>> pdef = block.p.paramDefs | ||
| >>> for param in pdef.where(lambda pd: pd.atLocation(ParamLocation.EDGES)): | ||
| ... print(param.name, block.p[param.name]) | ||
|
|
There was a problem hiding this comment.
UNIMPORTANT
I see you put these empty lines at the end of a about half your docstrings. I just checked, the RST renders fine without this.
Comment on lines
+553
to
+554
| pc: typing.ClassVar[parameters.ParameterCollection] | ||
|
|
There was a problem hiding this comment.
Suggested change
| pc: typing.ClassVar[parameters.ParameterCollection] |
There was a problem hiding this comment.
Up to you, but I believe this line is unneeded. The setupClass() method handles this for you.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is the change?
Provide ParameterCollection.where for better iteration of parameters
Allows selective iteration of parameters that meet, by their definition
not their value, meet a certain condition. This would be useful to
iterate over all parameters on a
Blockthat are relevant forneutronics calculations with
The argument is a function that should return true for a given parameter
and can be complicated
Why is the change being made?
Inspired by
HexBlockrotation where we need to do stuff for parameters that meet certain criteria.Closes #1898
Checklist
docfolder.pyproject.toml.