| [5c867e] | 1 | /*
 | 
|---|
 | 2 |  * Eigenvalues.hpp
 | 
|---|
 | 3 |  *
 | 
|---|
 | 4 |  *  Created on: Mar 8, 2013
 | 
|---|
 | 5 |  *      Author: heber
 | 
|---|
 | 6 |  */
 | 
|---|
 | 7 | 
 | 
|---|
 | 8 | #ifndef EIGENVALUES_HPP_
 | 
|---|
 | 9 | #define EIGENVALUES_HPP_
 | 
|---|
 | 10 | 
 | 
|---|
 | 11 | // include config.h
 | 
|---|
 | 12 | #ifdef HAVE_CONFIG_H
 | 
|---|
 | 13 | #include <config.h>
 | 
|---|
 | 14 | #endif
 | 
|---|
 | 15 | 
 | 
|---|
 | 16 | #include <iosfwd>
 | 
|---|
 | 17 | #include <set>
 | 
|---|
 | 18 | #include <vector>
 | 
|---|
 | 19 | 
 | 
|---|
 | 20 | class Eigenvalues
 | 
|---|
 | 21 | {
 | 
|---|
| [955051] | 22 |   //!> grant unit test access to private parts
 | 
|---|
 | 23 |   friend class EigenvaluesTest;
 | 
|---|
 | 24 |   //!> grant output operator access
 | 
|---|
 | 25 |   friend std::ostream & operator<<(std::ostream &ost, const Eigenvalues &eigenvalues);
 | 
|---|
| [5c867e] | 26 | public:
 | 
|---|
 | 27 |   //!> named type for a vector of sample values
 | 
|---|
 | 28 |   typedef std::vector<double> samples_t;
 | 
|---|
 | 29 | public:
 | 
|---|
 | 30 |   /** Default constructor for class Eigenvalues.
 | 
|---|
 | 31 |    *
 | 
|---|
 | 32 |    */
 | 
|---|
 | 33 |   Eigenvalues()
 | 
|---|
 | 34 |   {}
 | 
|---|
 | 35 | 
 | 
|---|
 | 36 |   /** Constructor with a given vector of eigenvalues.
 | 
|---|
 | 37 |    *
 | 
|---|
 | 38 |    * \param _samples set of eigenvalues
 | 
|---|
 | 39 |    */
 | 
|---|
 | 40 |   Eigenvalues(const samples_t &_samples)
 | 
|---|
 | 41 |   {
 | 
|---|
| [eb32b6] | 42 |     addedsamples.insert(_samples.begin(), _samples.end());
 | 
|---|
| [5c867e] | 43 |   }
 | 
|---|
 | 44 | 
 | 
|---|
 | 45 |   /** Default destructor for Eigenvalues.
 | 
|---|
 | 46 |    *
 | 
|---|
 | 47 |    */
 | 
|---|
 | 48 |   ~Eigenvalues()
 | 
|---|
 | 49 |   {}
 | 
|---|
 | 50 | 
 | 
|---|
 | 51 |   /** Adding another set of eigenvalues onto this one.
 | 
|---|
 | 52 |    *
 | 
|---|
 | 53 |    *
 | 
|---|
 | 54 |    * @param other other Eigenvalues
 | 
|---|
 | 55 |    * @return ref to this instance
 | 
|---|
 | 56 |    */
 | 
|---|
| [eb32b6] | 57 |   Eigenvalues& operator+=(const Eigenvalues &other)
 | 
|---|
 | 58 |   {
 | 
|---|
 | 59 |     addedsamples.insert(other.addedsamples.begin(), other.addedsamples.end());
 | 
|---|
 | 60 |     subtractedsamples.insert(other.subtractedsamples.begin(), other.subtractedsamples.end());
 | 
|---|
| [5c867e] | 61 |     return *this;
 | 
|---|
 | 62 |   }
 | 
|---|
 | 63 | 
 | 
|---|
 | 64 |   /** Subtracting another set of eigenvalues from this one.
 | 
|---|
 | 65 |    *
 | 
|---|
 | 66 |    * @param other other Eigenvalues
 | 
|---|
 | 67 |    * @return ref to this instance
 | 
|---|
 | 68 |    */
 | 
|---|
| [eb32b6] | 69 |   Eigenvalues& operator-=(const Eigenvalues &other);
 | 
|---|
 | 70 | //  {
 | 
|---|
 | 71 | //    subtractedsamples.insert(other.addedsamples.begin(), other.addedsamples.end());
 | 
|---|
 | 72 | //    return *this;
 | 
|---|
 | 73 | //  }
 | 
|---|
| [5c867e] | 74 | 
 | 
|---|
| [955051] | 75 |   /** Equality operator.
 | 
|---|
 | 76 |    *
 | 
|---|
 | 77 |    * @param other other instance to check against
 | 
|---|
 | 78 |    * @return true - both are equal, false - some eigenvalues differ
 | 
|---|
 | 79 |    */
 | 
|---|
 | 80 |   bool operator==(const Eigenvalues& other) const;
 | 
|---|
 | 81 | 
 | 
|---|
 | 82 |   bool operator!=(const Eigenvalues& other) const
 | 
|---|
 | 83 |   {
 | 
|---|
 | 84 |     return (!(*this == other));
 | 
|---|
 | 85 |   }
 | 
|---|
 | 86 | 
 | 
|---|
| [5c867e] | 87 | private:
 | 
|---|
 | 88 |   //!> typedef for the internal container format
 | 
|---|
 | 89 |   typedef std::set<double> sorted_samples_t;
 | 
|---|
 | 90 |   //!> internally we store a set of sorted samples
 | 
|---|
| [eb32b6] | 91 |   sorted_samples_t addedsamples;
 | 
|---|
 | 92 |   sorted_samples_t subtractedsamples;
 | 
|---|
| [5c867e] | 93 | };
 | 
|---|
 | 94 | 
 | 
|---|
 | 95 | /** Function to print eigenvalues to ostream.
 | 
|---|
 | 96 |  *
 | 
|---|
 | 97 |  * @param ost output stream
 | 
|---|
 | 98 |  * @param eigenvalues set of eigenvalues to print
 | 
|---|
 | 99 |  * @return ref to given ostream for concatenation
 | 
|---|
 | 100 |  */
 | 
|---|
 | 101 | std::ostream & operator<<(std::ostream &ost, const Eigenvalues &eigenvalues);
 | 
|---|
 | 102 | 
 | 
|---|
 | 103 | template<typename T> T ZeroInstance();
 | 
|---|
 | 104 | template<> Eigenvalues ZeroInstance<Eigenvalues>();
 | 
|---|
 | 105 | 
 | 
|---|
 | 106 | #endif /* EIGENVALUES_HPP_ */
 | 
|---|