eval_equation and tests #74
Open
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #74 +/- ##
==========================================
+ Coverage 95.56% 95.64% +0.07%
==========================================
Files 14 14
Lines 2189 2203 +14
==========================================
+ Hits 2092 2107 +15
+ Misses 97 96 -1 ☔ View full report in Codecov by Sentry. |
bbejanov
approved these changes
Oct 9, 2024
Comment on lines
+515
to
+518
| function eval_equation(model::AbstractModel, eqn::AbstractEquation, sim_data::AbstractMatrix{Float64}, rng::UnitRange{Int64} = 1:size(sim_data,1)) | ||
| # Check bounds | ||
| @assert rng[begin] >= 1 && rng[end] <= size(sim_data, 1) "Error: The range specified is out of bounds. Ensure that the range starts from 1 or higher and ends within the size of the data." | ||
|
|
There was a problem hiding this comment.
Two comments about @assert
- As a general rule I wouldn't use an assertion to check validity of input arguments. I use assertions to confirm that something I assume is actually true. I think throwing an
ArgumentErroris more appropriate when input arguments are not valid. ABoundsErrorwould be okay here too, since this is a bounds check. - On the other hand, in this function we return
NaNat indexes ofreswhich depend on rows ofsim_datathat are out of bounds. So this function doesn't actually fail ifrngis "not valid", it just fills those locations withNaNs. So why bother with a bounds check at all.
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.
We add a function to evaluate the residuals of an equation:
eval_equation().