[skip-ci][hist] Document architecture for initial set of classes #19295
Conversation
This file contains hidden or 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
hahnjo
commented
Jul 7, 2025
jblomer
approved these changes
Jul 8, 2025
hageboeck
reviewed
Jul 9, 2025
To enable incremental review, the start of this architecture document is provided upfront. Further classes will be added when implemented.
pcanal
reviewed
Jul 16, 2025
| ```c++ | ||
| RLinearizedIndex ComputeLinearizedIndex(double x); | ||
| ``` | ||
| The `bool` is used to indicate if the return value is valid. |
There was a problem hiding this comment.
Since the switch from pair<size_t,bool> to RLinearizedIndex and with RLinearizedIndex not being described (at that point of reading). This sentence ("The bool ..") is lacking a bit of context.
pcanal
reviewed
Jul 16, 2025
| For example, the argument may be outside the axis with the underflow and overflow bins disabled. | ||
| `RLinearizedIndex` is a simple struct with a `std::size_t index` and `bool valid`. | ||
| It is chosen over `std::optional` because it unifies the return value construction: | ||
| If outside the axis, the validity is just determined by the member property `fEnableFlowBins`. |
There was a problem hiding this comment.
If outside the axis, the validity is still valid if flow bins have been enabled (as recorded by the member property `fEnableFlowBins`).
pcanal
reviewed
Jul 16, 2025
| RLinearizedIndex ComputeGlobalIndex(const std::tuple<A...> &args) const; | ||
| ``` | ||
| that dispatches arguments to the individual `ComputeLinearizedIndex` and combines the results. | ||
| If any of the linearized indices is invalid, so will be the combination. |
There was a problem hiding this comment.
If any of the linearized indices is invalid, so is the combination.
maybe ... to match tenses.
pcanal
reviewed
Jul 16, 2025
|
|
||
| This class combines an `RAxes` object and storage of bin contents in a `std::vector`. | ||
| During `Fill`, it calls `RAxes::ComputeLinearizedIndex` and then updates the bin content. | ||
| In contrast to `RHist`, this class supports direct concurrent filling via `FillAtomic`. |
There was a problem hiding this comment.
This could use some more context and justification. (i.e. why this contrast/difference?).
pcanal
reviewed
Jul 16, 2025
|
|
||
| ### `RBinIndex` | ||
|
|
||
| A single bin index, which is just an integer for normal bins. |
There was a problem hiding this comment.
What is the relation ship with RLinearizedIndex?
pcanal
reviewed
Jul 16, 2025
| ### `RBinIndex` | ||
|
|
||
| A single bin index, which is just an integer for normal bins. | ||
| `Underflow()` and `Overflow()` are special values and not ordered with respect to others. |
There was a problem hiding this comment.
not ordered with respect to others.
Why not? and/or why is it important?
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.
To enable incremental review, the start of this architecture document is provided upfront. Further classes will be added when implemented.