Skip to content

Conversation

@lukasdreyer
Copy link
Collaborator

@lukasdreyer lukasdreyer commented Oct 22, 2025

Closes #1911

Describe your changes here:

All these boxes must be checked by the AUTHOR before requesting review:

  • The PR is small enough to be reviewed easily. If not, consider splitting up the changes in multiple PRs.
  • The title starts with one of the following prefixes: Documentation:, Bugfix:, Feature:, Improvement: or Other:.
  • If the PR is related to an issue, make sure to link it.
  • The author made sure that, as a reviewer, he/she would check all boxes below.

All these boxes must be checked by the REVIEWERS before merging the pull request:

As a reviewer please read through all the code lines and make sure that the code is fully understood, bug free, well-documented and well-structured.

General

  • The reviewer executed the new code features at least once and checked the results manually.
  • The code follows the t8code coding guidelines.
  • New source/header files are properly added to the CMake files.
  • The code is well documented. In particular, all function declarations, structs/classes and their members have a proper doxygen documentation.
  • All new algorithms and data structures are sufficiently optimal in terms of memory and runtime (If this should be merged, but there is still potential for optimization, create a new issue).

Tests

  • The code is covered in an existing or new test case using Google Test.
  • The code coverage of the project (reported in the CI) should not decrease. If coverage is decreased, make sure that this is reasonable and acceptable.
  • Valgrind doesn't find any bugs in the new code. This script can be used to check for errors; see also this wiki article.

If the Pull request introduces code that is not covered by the github action (for example coupling with a new library):

  • Should this use case be added to the github action?
  • If not, does the specific use case compile and all tests pass (check manually).

Scripts and Wiki

  • If a new directory with source files is added, it must be covered by the script/find_all_source_files.scp to check the indentation of these files.
  • If this PR introduces a new feature, it must be covered in an example or tutorial and a Wiki article.

License

  • The author added a BSD statement to doc/ (or already has one).

@lukasdreyer lukasdreyer force-pushed the enhancement-search_timing branch from 916d880 to 19c4bc6 Compare October 22, 2025 13:57
@codecov
Copy link

codecov bot commented Oct 22, 2025

Codecov Report

❌ Patch coverage is 18.60465% with 35 lines in your changes missing coverage. Please review.
✅ Project coverage is 75.64%. Comparing base (4702303) to head (98ed04c).
⚠️ Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
src/t8_forest/t8_forest.cxx 0.00% 24 Missing ⚠️
...rc/t8_forest/t8_forest_search/t8_forest_search.cxx 42.10% 11 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1909      +/-   ##
==========================================
- Coverage   75.77%   75.64%   -0.13%     
==========================================
  Files         103      103              
  Lines       19230    19273      +43     
==========================================
+ Hits        14572    14580       +8     
- Misses       4658     4693      +35     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Collaborator

@holke holke left a comment

Choose a reason for hiding this comment

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

Nice addition.

Looks good to me.

The comments got messed up and some new lines were missing.

return forest->profile->search_check_element_time;
}
return 0;
}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
}
}

return forest->profile->search_check_query_time;
}
return 0;
}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
}
}

return forest->profile->search_split_array_time;
}
return 0;
}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
}
}

* \see t8_forest_set_profiling
*/
double
t8_forest_profile_get_search_check_element_runtime (t8_forest_t forest);
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
t8_forest_profile_get_search_check_element_runtime (t8_forest_t forest);
t8_forest_profile_get_search_check_element_runtime (t8_forest_t forest);

* \see t8_forest_set_profiling
*/
double
t8_forest_profile_get_search_check_query_runtime (t8_forest_t forest);
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
t8_forest_profile_get_search_check_query_runtime (t8_forest_t forest);
t8_forest_profile_get_search_check_query_runtime (t8_forest_t forest);

* \see t8_forest_set_profiling
*/
double
t8_forest_profile_get_search_split_array_runtime (t8_forest_t forest);
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
t8_forest_profile_get_search_split_array_runtime (t8_forest_t forest);
t8_forest_profile_get_search_split_array_runtime (t8_forest_t forest);

* \see t8_forest_set_profiling
*/
double
t8_forest_profile_get_search_check_element_runtime (t8_forest_t forest);
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
t8_forest_profile_get_search_check_element_runtime (t8_forest_t forest);
t8_forest_profile_get_search_check_element_runtime (t8_forest_t forest);

double
t8_forest_profile_get_first_descendant_runtime (t8_forest_t forest);

/** Get the sum of the runtimes of the last calls to \ref check_element in search.
Copy link
Collaborator

Choose a reason for hiding this comment

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

All comments do not match the actual function. Please re-edit them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add timing for search

3 participants