refactor(get_lrc, get_node): use numpy methods, add examples #1591
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.
This PR replaces internal processing of
get_lrc
andget_node
to use NumPy'sunravel_index
andravel_multi_index
. There is a minor speed bump, and the methods also check the bounds of the inputs, raising ValueError if they are outside the L/R/C/node range.Also add docstring examples and minor formatting to adhere to the numpydoc style guide.