Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: reduce complexity of highly nested blocks #3633

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

AJPfleger
Copy link
Contributor

No description provided.

@AJPfleger AJPfleger added this to the next milestone Sep 19, 2024
@github-actions github-actions bot added Component - Core Affects the Core module Component - Examples Affects the Examples module Component - Plugins Affects one or more Plugins Track Finding labels Sep 19, 2024
Copy link

📊: Physics performance monitoring for 375edfa

Full contents

physmon summary

Copy link

Comment on lines +56 to +57

return;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick: void return at the end of the function

}
}

return;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment as @andiwand gave above

return true;
}

for (int j = -m_cfg.localMaxWindowSize; j <= m_cfg.localMaxWindowSize; j++) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is our test coverage high enough to be able to see if this is equivalent? /cc @goblirsc

Comment on lines +297 to 338
if (m_cfg.localMaxWindowSize == 0) {
return true;
}

for (int j = -m_cfg.localMaxWindowSize; j <= m_cfg.localMaxWindowSize; j++) {
if (y + j >= m_cfg.houghHistSize_y) {
continue;
}

for (int i = -m_cfg.localMaxWindowSize; i <= m_cfg.localMaxWindowSize;
i++) {
if (i == 0 && j == 0) {
continue;
}

if (x + i >= m_cfg.houghHistSize_x) {
continue;
}

if (houghHist.atLocalBins({y + j, x + i}).first <
houghHist.atLocalBins({y, x}).first) {
continue;
}

if (houghHist.atLocalBins({y + j, x + i}).first >
houghHist.atLocalBins({y, x}).first) {
return false;
}

if (houghHist.atLocalBins({y + j, x + i}).second.size() <
houghHist.atLocalBins({y, x}).second.size()) {
continue;
}

if (houghHist.atLocalBins({y + j, x + i}).second.size() >
houghHist.atLocalBins({y, x}).second.size()) {
return false;
}

if (j <= 0 && i <= 0) {
return false; // favor bottom-left (low phi, low neg q/pt)
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a case where I am really not sure if the right hand side is actually more readable than the left hand side. The mental load of tracking early returns and continues is quite significant.

Comment on lines +81 to 84
if (!accept) {
break;
}
for (auto y : std::vector<double>{-dy, dy}) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is so you abort earlier. However, this is not at all performance critical code, so readability might be preferable over an earlier abort.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since the loops seem independent something like a product iteration like in python might be nice. then the control flow is easier to handle with a single break. otherwise I agree with paul that the additional looping is not in a critical path so the old version might be preferable

Comment on lines +208 to +238
if (axisTypeA == AxisType::Equidistant &&
axisTypeB == AxisType::Equidistant) {
auto [rangeA, binsA] = eqExtractor(jAxisA);
auto [rangeB, binsB] = eqExtractor(jAxisB);
EqBoundEqClosed ebecAG{rangeA, binsA, rangeB, binsB};
auto grid = GridJsonConverter::fromJson<EqBoundEqClosed, ValueType>(
jGrid, ebecAG);

return generator.createUpdater(std::move(grid), {bValueA, bValueB},
transform);
}

if (axisTypeA == AxisType::Equidistant) {
auto [rangeA, binsA] = eqExtractor(jAxisA);
EqBoundVarClosed ebvcAG{rangeA, binsA, vExtractor(jAxisB)};
auto grid = GridJsonConverter::fromJson<EqBoundVarClosed, ValueType>(
jGrid, ebvcAG);

return generator.createUpdater(std::move(grid), {bValueA, bValueB},
transform);
}

if (axisTypeB == AxisType::Equidistant) {
auto [rangeB, binsB] = eqExtractor(jAxisB);
VarBoundEqClosed vbecAG{vExtractor(jAxisA), rangeB, binsB};
auto grid = GridJsonConverter::fromJson<VarBoundEqClosed, ValueType>(
jGrid, vbecAG);

return generator.createUpdater(std::move(grid), {bValueA, bValueB},
transform);
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be an else-if construction.

Comment on lines +81 to +91
if (!accept) {
break;
}
for (auto y : std::vector<double>{-dy, dy}) {
if (!accept) {
break;
}
for (auto z : std::vector<double>{-dz, dz}) {
Vector3 edge = etrf * Vector3(x, y, z);
for (auto& check : options.parseRanges) {
double val = VectorHelpers::cast(edge, check.first);
if (val < check.second.first || val > check.second.second) {
if (!accept) {
break;
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't these breaks be put at the end of the inner loop body?

Comment on lines +519 to +539

if (a.direction() == direction) {
std::size_t nBinsA = locBinsA.at(0);
std::size_t nBinsB = locBinsB.at(0);
std::size_t nBinsCommon = locBinsB.at(1);

for (std::size_t i = 1; i <= nBinsA; ++i) {
for (std::size_t j = 1; j <= nBinsCommon; ++j) {
merged.atLocalBins({i, j}) = a.atLocalBins({i, j});
}
}

for (std::size_t i = 1; i <= nBinsCommon; ++i) {
for (std::size_t j = 1; j <= nBinsB; ++j) {
std::size_t tj = j + nBinsA;
merged.atLocalBins({i, tj}) = b.atLocalBins({i, j});
}
for (std::size_t i = 1; i <= nBinsB; ++i) {
for (std::size_t j = 1; j <= nBinsCommon; ++j) {
std::size_t ti = i + nBinsA;
merged.atLocalBins({ti, j}) = b.atLocalBins({i, j});
}
}

return;
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could be an else-if construct, avoiding an early return.

@stephenswat
Copy link
Member

Regarding this use of continue and return statements I would like to refer to EWD215 by our lord and saviour Edsger Wybe Dijkstra: https://www.cs.utexas.edu/~EWD/ewd02xx/EWD215.PDF

@github-actions github-actions bot added the Stale label Oct 20, 2024
@github-actions github-actions bot removed the Stale label Oct 30, 2024
@github-actions github-actions bot added the Stale label Nov 29, 2024
Copy link

coderabbitai bot commented Nov 29, 2024

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot removed the Stale label Dec 2, 2024
@github-actions github-actions bot added the Stale label Jan 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Core Affects the Core module Component - Examples Affects the Examples module Component - Plugins Affects one or more Plugins Stale Track Finding
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants