Altered IRR function to accept 2D-array #122
Merged
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
Created function to store default selection logic to allow user to insert their own selection logic for more than 1 real solution
Documented addition of IRR selection logic function. The new function contains default logic for selection of IRR Values. User may enter their own function with custom logic if required.
When attempting to push changes to GitHub, tests returned a "757:89: E501 Line too long (90 > 88)" error. Line 757 was shortened in this update.
WHen attemping to commit a change, a "Line too long" error occured. Line 757 has been shortened.
IRR function was changed to accept 2D-arrays as input. A for-loop was included to iterate over each row of the array, generate an IRR, and append its value to a results array.
Bug was found upon commit in IRR function. Logic was incorrect and returning an out of index error. Conditional statement was fixed to overcome this.
Altered structure of IRR function to utilise a np.array to store IRR calculated, rather than a list. Also made small fixes in indentation.
Comment in Irr selection logic was altered to be formated as a docstring. An example was included in the documentation containing a 2D-array input.
Kai-Striega
requested changes
Apr 26, 2024
We only need to check the 2d case. As this will never be a 1d array as ``np.atleast_2d`` was used.
Kai-Striega
approved these changes
May 7, 2024
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.
IRR function was changed to accept 2D-arrays as input. A for-loop was included to iterate over
each row of the array, generate an IRR, and append its value to a results array.