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

Strong types #1309

Open
wants to merge 23 commits into
base: main
Choose a base branch
from
Open

Strong types #1309

wants to merge 23 commits into from

Conversation

Davknapp
Copy link
Collaborator

Following our discussion in the C++-Meeting I started to implement strong types.

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 Makefiles

  • The code is well documented

  • 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

Github action

  • The code compiles without warning in debugging and release mode, with and without MPI (this should be executed automatically in a github action)

  • All tests pass (in various configurations, this should be executed automatically in a github action)

    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/tutorial and a Wiki article.

License

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

@Davknapp Davknapp added enhancement Enhances already existing code C++ priority: medium Should be solved within half a year workload: medium Would take a week or less labels Nov 21, 2024
Copy link
Collaborator

@sandro-elsweijer sandro-elsweijer left a comment

Choose a reason for hiding this comment

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

Preliminary review

Comment on lines 34 to 54
/**
* \brief The CRTP pattern for operators.
*
* \tparam T
* \tparam crtpType
*/
template <typename T, template <typename> class crtpType>
struct crtp
{
T&
underlying ()
{
return static_cast<T&> (*this);
}

T const&
underlying () const
{
return static_cast<T const&> (*this);
}
};
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we combine this with src/t8_schemes/t8_crtp.hxx?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thaught about it and had a short look into it. But this struct has an additional template argument than your implementation and I think that this is a detail that matters.

src/t8_types/t8_operators.hxx Outdated Show resolved Hide resolved
src/t8_types/t8_operators.hxx Outdated Show resolved Hide resolved
src/t8_types/t8_operators.hxx Outdated Show resolved Hide resolved
src/t8_types/t8_operators.hxx Outdated Show resolved Hide resolved
src/t8_types/t8_operators.hxx Outdated Show resolved Hide resolved
src/t8_types/t8_operators.hxx Outdated Show resolved Hide resolved
src/t8_types/t8_operators.hxx Outdated Show resolved Hide resolved
src/t8_types/t8_operators.hxx Outdated Show resolved Hide resolved
src/t8_types/t8_operators.hxx Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C++ enhancement Enhances already existing code priority: medium Should be solved within half a year workload: medium Would take a week or less
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants