From 2cbed941cac1ced53343c6ba81265643c418dbb6 Mon Sep 17 00:00:00 2001
From: ralfulrich <ralf.ulrich@kit.edu>
Date: Tue, 7 Aug 2018 14:57:51 +0200
Subject: [PATCH] better comments
---
Framework/ParticleStack/StackOne.h | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/Framework/ParticleStack/StackOne.h b/Framework/ParticleStack/StackOne.h
index 6245994ce..cff3779bd 100644
--- a/Framework/ParticleStack/StackOne.h
+++ b/Framework/ParticleStack/StackOne.h
@@ -33,12 +33,13 @@ namespace stack {
/**
- Definition of one most simple particle stack object.
+ Memory implementation of the most simple particle stack object.
*/
class StackOneImpl
{
private:
+ /// the actual memory to store particle data
std::vector<int> fId;
std::vector<double> fData;
@@ -47,14 +48,16 @@ namespace stack {
int GetSize() const { return fData.size(); }
int GetCapacity() const { return fData.size(); }
-
-
+
void SetId(const int i, const int id) { fId[i] = id; }
void SetEnergy(const int i, const double e) { fData[i] = e; }
const int GetId(const int i) const { return fId[i]; }
const double GetEnergy(const int i) const { return fData[i]; }
-
+
+ /**
+ Function to copy particle at location i2 in stack to i1
+ */
void Copy(const int i1, const int i2) {
fData[i2] = fData[i1];
fId[i2] = fId[i1];
--
GitLab