Skip to content

Feature: strong type conversion [1/2]#1662

Merged
Davknapp merged 2 commits intomainfrom
feature-strong_type_conversion
May 20, 2025
Merged

Feature: strong type conversion [1/2]#1662
Davknapp merged 2 commits intomainfrom
feature-strong_type_conversion

Conversation

@holke
Copy link
Collaborator

@holke holke commented May 19, 2025

Closes #1664

Describe your changes here:

Added implicit type conversion to base type to our strong types.

Marked [1/2] since it has to be merged before #1656 which uses this feature.

Why?
In some scenarios, in particular when we want to print out values for our strong types, we need to cast them back into their base type.
For example when strong types are used in GoogleTest assertion, GoogleTest requires the "<<" operator to work.
It happened to me when switching to a strong type for geometry hash usage (see #1656) and a part of the code was doing
t8_debug_f ("Hash %lu not found\n", hash); which did not compile since "hash" as a strong type was not convertible to "long unsigned".

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.
  • 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).

@holke holke requested a review from Davknapp May 19, 2025 20:22
@holke holke added enhancement Enhances already existing code priority:medium Should be solved within half a year workload:low Would take half a day or less labels May 19, 2025
@Davknapp Davknapp added this pull request to the merge queue May 20, 2025
Merged via the queue into main with commit 41f24fe May 20, 2025
47 checks passed
@Davknapp Davknapp deleted the feature-strong_type_conversion branch May 20, 2025 07:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement Enhances already existing code priority:medium Should be solved within half a year workload:low Would take half a day or less

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feature: strong type conversion [1/2]

2 participants