CppCheck expm1 log1p HeatRecovery

[rraustad]

Pull request overview

• Fixes expm1 and log1p suggestions
• Use CppCheck as guide

NOTE: ENHANCEMENTS MUST FOLLOW A SUBMISSION PROCESS INCLUDING A FEATURE PROPOSAL AND DESIGN DOCUMENT PRIOR TO SUBMITTING CODE

Pull Request Author

Add to this list or remove from it as applicable. This is a simple templated set of guidelines.

• Title of PR should be user-synopsis style (clearly understandable in a standalone changelog context)
• Label the PR with at least one of: Defect, Refactoring, NewFeature, Performance, and/or DoNoPublish
• Pull requests that impact EnergyPlus code must also include unit tests to cover enhancement or defect repair
• Author should provide a "walkthrough" of relevant code changes using a GitHub code review comment process
• If any diffs are expected, author must demonstrate they are justified using plots and descriptions
• If changes fix a defect, the fix should be demonstrated in plots and descriptions
• If any defect files are updated to a more recent version, upload new versions here or on DevSupport
• If IDD requires transition, transition source, rules, ExpandObjects, and IDFs must be updated, and add IDDChange label
• If structural output changes, add to output rules file and add OutputChange label
• If adding/removing any LaTeX docs or figures, update that document's CMakeLists file dependencies

Reviewer

This will not be exhaustively relevant to every PR.

• Perform a Code Review on GitHub
• If branch is behind develop, merge develop and build locally to check for side effects of the merge
• If defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
• If feature, test running new feature, try creative ways to break it
• CI status: all green or justified
• Check that performance is not impacted (CI Linux results include performance check)
• Run Unit Test(s) locally
• Check any new function arguments for performance impacts
• Verify IDF naming conventions and styles, memos and notes and defaults
• If new idf included, locally check the err file and other outputs

[github-actions]

⚠️ Regressions detected on macos-14 for commit 394d5d7

Regression Summary

• ESO Small Diffs: 2
• MTR Small Diffs: 2
• EIO: 1
• Table Small Diffs: 1

• View Results
• Download Regressions

[Myoldmopar]

I've looked multiple times, and this does seem like the correct changes. It's annoying that this small tweak causes diffs, but it's fine. I may wait until a few more no diff PRs merge before dropping these PRs in together, but otherwise any thoughts anyone?

[Myoldmopar]

It's mildly confusing to me that

expm1(n) is the same as exp(n) - 1

but

log1p(n) is the same as log(n + 1).

I understand the difference, but at first glance I thought maybe that was the cause of diffs here.

[rraustad]

These are supposed to be more precise. So consider these improvements that could possibly change the answer slightly.

log1p(n) = log(1 + n)

I did these individually by module because there were diffs when I combined them all in 1 branch and I wanted to be sure which change caused which diffs.

[Myoldmopar]

Indeed it all makes sense. And it really can't be worth the time to investigate the diffs further. You've done a great job already, I feel comfortable merging the three log/exp branches, as it is crystal clear that they are just precision improvements.

[Myoldmopar]

So we'll start with this one, and I'll look over the others and try to merge all three in short order.