Update C++ docstrings for extended histentry #3234
Open
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
clinssen
added
S: Normal
jstapmanns
approved these changes
Jul 1, 2024
There was a problem hiding this comment.
Thank you, @clinssen, for updating the documentation. It is much more helpful now.
nestkernel/histentry.h
Outdated
| class histentry_extended | ||
| { | ||
| public: | ||
| histentry_extended( double t, double dw, size_t access_counter ); | ||
|
|
||
| double t_; //!< point in time when spike occurred (in ms) | ||
| double t_; //!< point in time for the history entry spike occurred (in ms) |
There was a problem hiding this comment.
I think, the words "spike occurred" can be removed in this comment since it seems to be a remnant from the stdp documentation from where I copied it. Maybe one can refer to t_ as "time stamp of the entry".
|
Could you please provide a short description for this PR? |
heplesser
requested review from
otcathatsya
and removed request for
abigailm
otcathatsya
suggested changes
Sep 9, 2024
models/clopath_synapse.h
Outdated
| @@ -247,16 +247,17 @@ clopath_synapse< targetidentifierT >::send( Event& e, size_t t, const CommonSyna | |||
| std::deque< histentry_extended >::iterator start; | |||
| std::deque< histentry_extended >::iterator finish; | |||
|
|
|||
| // facilitation due to postsynaptic activity since last pre-synaptic spike | |||
There was a problem hiding this comment.
maybe move this comment down to the facilitate call to match the depress() one?
nestkernel/histentry.h
Outdated
| @@ -40,20 +40,25 @@ class histentry | |||
| double t_; //!< point in time when spike occurred (in ms) | |||
| double Kminus_; //!< value of Kminus at that time | |||
| double Kminus_triplet_; //!< value of triplet STDP Kminus at that time | |||
| size_t access_counter_; //!< access counter to enable removal of the entry, once all neurons read it | |||
| size_t | |||
| access_counter_; //! how often this entry was accessed (to enable removal, once read by all synapses which need it) | |||
nestkernel/histentry.h
Outdated
| //! how often this entry was accessed (to enable removal, once read by all | ||
| //! neurons which need it) | ||
| size_t access_counter_; | ||
| size_t |
otcathatsya
approved these changes
Sep 9, 2024
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.
Update C++ docstrings for extended histentry.