From 4207555d35a9b4f86a741f4c3f6763d46732d7e6 Mon Sep 17 00:00:00 2001
From: ralfulrich <ralf.ulrich@kit.edu>
Date: Tue, 21 Aug 2018 10:12:27 +0200
Subject: [PATCH] added stack
---
Framework/StackInterface/Stack.h | 12 ++++++++++--
Framework/StackInterface/StackIterator.h | 17 ++++++++++++++---
2 files changed, 24 insertions(+), 5 deletions(-)
diff --git a/Framework/StackInterface/Stack.h b/Framework/StackInterface/Stack.h
index 570603c11..9b9065d7e 100644
--- a/Framework/StackInterface/Stack.h
+++ b/Framework/StackInterface/Stack.h
@@ -3,10 +3,16 @@
#include <StackInterface/StackIterator.h> // to help application programmres
+/**
+ All classes around management of particles on a stack.
+ */
+
namespace stack {
/**
- Interface definition of a Stack object.
+ Interface definition of a Stack object. The Stack implements the
+ std-type begin/end function to allow integration in normal for
+ loops etc.
*/
template<typename DataImpl, typename Particle>
@@ -35,8 +41,10 @@ namespace stack {
const_iterator cbegin() const { return const_iterator(*this, 0); }
const_iterator cend() const { return const_iterator(*this, GetSize()); }
const_iterator clast() const { return const_iterator(*this, GetSize()-1); }
-
+
+ /// increase stack size, create new particle at end of stack
iterator NewParticle() { IncrementSize(); return iterator(*this, GetSize()-1); }
+ /// delete last particle on stack by decrementing stack size
void DeleteLast() { DecrementSize(); }
};
diff --git a/Framework/StackInterface/StackIterator.h b/Framework/StackInterface/StackIterator.h
index fdc67bf00..b2e9a8b6c 100644
--- a/Framework/StackInterface/StackIterator.h
+++ b/Framework/StackInterface/StackIterator.h
@@ -10,7 +10,7 @@ namespace stack {
template<class Stack, class Particle> class StackIteratorInfo;
/**
- \class StackIterator
+ @class StackIterator
The StackIterator is the main interface to iterator over
particles on a stack. At the same time StackIterator is a
@@ -20,7 +20,17 @@ namespace stack {
This allows to write code like
\verbatim
for (auto& p : theStack) { p.SetEnergy(newEnergy); }
- \endverbatim
+ \endverbatim
+
+ The template argument Stack determines the type of Stack object
+ the data is stored in. A pointer to the Stack object is part of
+ the StackIterator. In addition to Stack the iterator only knows
+ the index fIndex in the Stack data.
+
+ The template argument Particles acts as a policy to provide
+ readout function of Particle data from the stack. The Particle
+ class must know how to retrieve information from the Stack data
+ for a particle entry at any index fIndex.
*/
template<typename Stack, typename Particle>
@@ -62,8 +72,9 @@ namespace stack {
/**
- \class StackIteratorInfo
+ @class StackIteratorInfo
+ This is the class where custom ...
Internal helper class for StackIterator. Document better...
*/
--
GitLab