[c40e15d] | 1 | /*
|
---|
| 2 | * Summation.hpp
|
---|
| 3 | *
|
---|
| 4 | * Created on: Jun 30, 2012
|
---|
| 5 | * Author: heber
|
---|
| 6 | */
|
---|
| 7 |
|
---|
| 8 | #ifndef SUMMATION_HPP_
|
---|
| 9 | #define SUMMATION_HPP_
|
---|
| 10 |
|
---|
| 11 |
|
---|
| 12 | // include config.h
|
---|
| 13 | #ifdef HAVE_CONFIG_H
|
---|
| 14 | #include <config.h>
|
---|
| 15 | #endif
|
---|
| 16 |
|
---|
| 17 | #include <map>
|
---|
| 18 |
|
---|
| 19 | #include "SetValue.hpp"
|
---|
| 20 | #include "SubsetMap.hpp"
|
---|
| 21 | #include "SetValueMap.hpp"
|
---|
| 22 |
|
---|
| 23 | /** Summation is a functor executing a simple summation of SetValue's
|
---|
| 24 | * that are each associated to a certain IndexSet whose union is a SetOfIndexSets.
|
---|
| 25 | *
|
---|
| 26 | * This is kept in signature alike to OrthogonalSummation.
|
---|
| 27 | *
|
---|
| 28 | * For the given class we require the following functions:
|
---|
| 29 | * -# operator=(): assignment operator for placement in vector
|
---|
| 30 | * -# operator+=(): addition operator for adding one instance from another
|
---|
| 31 | * -# operator-=(): subtraction operator for subtracting one instance from another
|
---|
| 32 | * -# operator<<(): output operator
|
---|
| 33 | */
|
---|
| 34 | template <class T>
|
---|
| 35 | class Summation
|
---|
| 36 | {
|
---|
| 37 | public:
|
---|
| 38 | typedef std::vector< IndexSet::ptr > InputSets_t;
|
---|
| 39 | typedef std::vector< T > InputValues_t;
|
---|
| 40 | Summation(InputSets_t &indices, InputValues_t& values, SubsetMap::ptr _subsetmap = SubsetMap::ptr());
|
---|
| 41 |
|
---|
| 42 | /** Performs the summation and returns result.
|
---|
| 43 | *
|
---|
[ff9963] | 44 | * @param level sum up to this level
|
---|
[c40e15d] | 45 | * @return resulting value
|
---|
| 46 | */
|
---|
[ff9963] | 47 | T operator()(const size_t level) const;
|
---|
[c40e15d] | 48 |
|
---|
[3102010] | 49 | /** Returns const reference to internal setvalues.
|
---|
| 50 | *
|
---|
| 51 | * @return const reference to internal setvalues.
|
---|
| 52 | */
|
---|
| 53 | const SetValueMap<T> & getSetValues() const {
|
---|
| 54 | return setvalues;
|
---|
| 55 | }
|
---|
| 56 |
|
---|
[ff7ac6] | 57 | /** Setter for the zero instance to use as the base in summation.
|
---|
| 58 | *
|
---|
| 59 | * This may be used to force some parameters in the summation. We
|
---|
| 60 | * will use this value to set the initial value and all contributions
|
---|
| 61 | * are added via operator+(). E.g. In summing SamplingGrid (charge
|
---|
| 62 | * grids) we may use this instance to enforce a smaller grid size
|
---|
| 63 | * in the summation of the contributions if fragments have been
|
---|
| 64 | * calculated at a much higher grid level.
|
---|
| 65 | *
|
---|
| 66 | * \param _zeroinstance
|
---|
| 67 | */
|
---|
| 68 | void setZeroInstance(const T &_zeroinstance)
|
---|
| 69 | {
|
---|
| 70 | zeroinstance = _zeroinstance;
|
---|
| 71 | }
|
---|
| 72 |
|
---|
[c40e15d] | 73 | private:
|
---|
[ff9963] | 74 | T Sum(const size_t level) const;
|
---|
[c40e15d] | 75 |
|
---|
| 76 | private:
|
---|
| 77 | //!> SubsetTree with the tree-like structure of subsets
|
---|
| 78 | SubsetMap::ptr subsetmap;
|
---|
| 79 | //!> set of all subset values
|
---|
| 80 | SetValueMap<T> setvalues;
|
---|
[ff7ac6] | 81 | //!> base/"zero" instance to sum upon, defaults to ZeroInstance<T>
|
---|
| 82 | T zeroinstance;
|
---|
[c40e15d] | 83 | };
|
---|
| 84 |
|
---|
| 85 | #include "Summation_impl.hpp"
|
---|
| 86 |
|
---|
| 87 | #endif /* SUMMATION_HPP_ */
|
---|