-
Notifications
You must be signed in to change notification settings - Fork 19
feat: Data history storage (for averaging) #2206
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| // SPDX-License-Identifier: GPL-3.0-or-later | ||
| // Copyright (c) 2025 Team Dissolve and contributors | ||
|
|
||
| #pragma once | ||
|
|
||
| #include "base/serialiser.h" | ||
| #include <memory> | ||
| #include <vector> | ||
|
|
||
| // Data History | ||
| template <class T> class History | ||
| { | ||
| private: | ||
| // Stored historical data | ||
| std::vector<std::unique_ptr<T>> history_; | ||
|
|
||
| public: | ||
| // Update history with supplied data and return current average | ||
| T average(const T ¤tData, int averagingLength) | ||
| { | ||
| // Push the current data onto the history stack | ||
| history_.emplace_back(std::make_unique<T>(currentData)); | ||
|
|
||
| // Prune old data to get to the averagingLength | ||
| while (history_.size() > averagingLength) | ||
| history_.erase(history_.begin()); | ||
|
|
||
| // Perform averaging of the datasets that we have | ||
| T averaged; | ||
| auto weight = 1.0 / history_.size(); | ||
| for (auto &data : history_) | ||
| averaged += *data * weight; | ||
|
|
||
| return averaged; | ||
| }; | ||
| // Express data as a serialisable value | ||
| SerialisedValue serialise() | ||
| requires(std::is_base_of_v<Serialisable<>, T>) | ||
| { | ||
| SerialisedValue result; | ||
| result["size"] = history_.size(); | ||
| Serialisable<>::fromVectorToTable(history_, "data", result); | ||
| return result; | ||
| } | ||
| }; | ||
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
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
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
Oops, something went wrong.
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.
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.
This is an alternate implementation that doesn't lose history. This would allow us to look at multiple averaging lengths simultaneously (the current implementation essentially locks you into the shortest length). The disadvantage is that it can grow without bound, though that could be fixed by replacing the vector with a ring buffer.
This isn't a necessary change - just a suggestion.
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.
Interesting thought. While I like the idea, my concern is that this could add a lot of bloat as many of the objects being stored here are pretty chunky (I'm looking at you,
PartialSet). As such, I would prefer to stick to the ultra-simple, shortest-length version for the time being.