deprecate write_tree_flag in favor of direct method arguments #163
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- now takes a parameter `require_tree` instead of `tree` - prints and returns false if APR data group does not exist - prints and returns false if `require_tree=true` but tree group does not exist - if tree data exists, it is opened regardless of `require_tree` - refactor usages (this change should not break anything)
Deprecate use of write_tree_flag and related methods. Note that a side effect of this is that in order to write an APR file without the tree data, one has to specify t and channel_name, due to the order of arguments
NOTE: this change affects read times since read_apr now initializes the tree structure
…:total_number_tree_particles
Merged
Merged
krzysg
reviewed
Apr 21, 2022
krzysg
reviewed
Apr 21, 2022
|
I do not have more specific comments. I do not really like how APR.hpp looks but** it is not connected to this specific changes but in general it ... screams for big refactoring which is not (and should not be) part of this PR. |
krzysg
approved these changes
Apr 21, 2022
|
Good points. I think large parts of the library need a major cleanup -- not just removing unused and deprecated code, but also restructuring and rethinking some classes. I will merge this for now though |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolve some of the issues discussed in #160 and fixes current errors with examples (#162, but testing examples is still a good idea). Notable changes:
write_tree_flagand mark the set/get methods as deprecatedwrite_aprnow takes fourth argument:bool write_apr(APR& apr,uint64_t t = 0,std::string channel_name = "t", bool write_tree = true);read_aprreads the APR and tries to read the tree. If the tree does not exist,it initializes it from the APR structureit is left uninitialized until required by other methods.apr_or_treeargumentThe new behavior of
read_aprhas some performance implications. Reading the tree is quite fast (adds ~5-15% to overall read time),but initializing the tree from the APR is significantly slower (makes overall read time up to 7 times longer). Perhaps the default behavior if the tree data is not on file should be to leave it uninitialized.What do you think @cheesema?