-
Notifications
You must be signed in to change notification settings - Fork 54
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
Pack/Unpack data for user-data #1224
base: main
Are you sure you want to change the base?
Conversation
and pack and unpack without prefix for the size
Co-authored-by: David Knapp <[email protected]>
Co-authored-by: David Knapp <[email protected]>
add placeholder for internal data handling
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe its just a pet peeve of mine, but none of your docstrings is indented
A C-interface will be implemented in #1357 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor comments about the docstring style
* \class t8_single_data_handler | ||
* \brief A template specialisation for handling single enlarged ints (int plus an additional int, this |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* \class t8_single_data_handler | |
* \brief A template specialisation for handling single enlarged ints (int plus an additional int, this | |
* A template specialisation for handling single enlarged ints (int plus an additional int, this |
*/ | ||
|
||
/** | ||
* \brief pseudo_types for testing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* \brief pseudo_types for testing | |
* pseudo_types for testing |
* \class t8_single_data_handler | ||
* \brief A template class for handling single data items. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* \class t8_single_data_handler | |
* \brief A template class for handling single data items. | |
* Template class for handling single data items. |
|
||
private: | ||
/** | ||
* \brief A shared pointer to a vector of data. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* \brief A shared pointer to a vector of data. | |
* A shared pointer to a vector of data. |
*/ | ||
std::shared_ptr<std::vector<TType>> m_data; | ||
/** | ||
* \brief A single data handler for the data type T. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* \brief A single data handler for the data type T. | |
* A single data handler for the data type T. |
} | ||
|
||
/** | ||
* \brief Get the data. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* \brief Get the data. | |
* Get the data. |
* \class t8_data_handler | ||
* \brief A template class for handling data in a distributed environment. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* \class t8_data_handler | |
* \brief A template class for handling data in a distributed environment. | |
* A template class for handling data in a distributed environment. |
An interface for arbitrary data.
For new user-data it suffies to implement how a single element should be packed/unpacked.
The routines for vectors of user-data make use of this routine and pack/unpack the data accordingly.
Furthermore it provides a wrapper around the send/recv routine from MPI for to avoid code duplication and easy usage. This part of the interface should be extended in the future to other MPI send/recv routines.
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
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):
Scripts and Wiki
script/find_all_source_files.scp
to check the indentation of these files.Licence
doc/
(or already has one)