SynAPSE  0.6.0
Synergistic Analysis of Phase Space Evolution
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
Bin.hh
1 #ifndef BIN_HH
2 #define BIN_HH
3 
4 // C++ includes
5 #include <stdlib.h>
6 #include <vector>
7 #include <cmath>
8 
14 class Bin {
15  public:
17  Bin();
18 
26  Bin(const std::vector<size_t>& indices,
27  const std::vector<double>& lower,
28  const std::vector<double>& upper,
29  const double& content);
30 
32  Bin(const Bin& bin);
33 
35  Bin& operator=(const Bin& bin);
36 
38  ~Bin();
39 
41  const size_t& GetDimension() const { return _dim; }
42 
44  const std::vector<size_t>& GetIndices() const { return _indices; }
45 
47  const size_t& GetIndex(const size_t i) const { return _indices[i]; }
48 
50  const std::vector<double>& GetLowerBoundArray() const { return _lower; }
51 
53  const double& GetLowerBound(const size_t i) const { return _lower[i]; }
54 
56  const std::vector<double>& GetUpperBoundArray() const { return _upper; }
57 
59  const double& GetUpperBound(const size_t i) const { return _upper[i]; }
60 
62  const double& GetContent() const { return _content; }
63 
65  std::vector<double> GetBarycentre() const;
66 
68  double GetCentre(const size_t i) const;
69 
71  double GetVolume() const;
72 
74  double GetWidth(const size_t i) const;
75 
76  private:
77  size_t _dim;
78  std::vector<size_t> _indices;
79  std::vector<double> _lower;
80  std::vector<double> _upper;
81  double _content;
82 };
83 
84 #endif
double GetCentre(const size_t i) const
Returns the centre of the bin on the ith axis.
Definition: Bin.cc:43
const size_t & GetDimension() const
Returns the dimension of the space in which the bin lies.
Definition: Bin.hh:41
const std::vector< double > & GetLowerBoundArray() const
Returns the array of lower bounds in each dimension.
Definition: Bin.hh:50
Bin()
Default constructor, initilizes everything to 0.
Definition: Bin.cc:3
double GetVolume() const
Returns the volume of the bin.
Definition: Bin.cc:48
std::vector< double > _upper
Upper boundaries of the bin.
Definition: Bin.hh:80
std::vector< double > GetBarycentre() const
Returns the barycentre of the bin.
Definition: Bin.cc:33
Bin & operator=(const Bin &bin)
Equality operator.
Definition: Bin.cc:18
const double & GetLowerBound(const size_t i) const
Returns the lower bound in dimension i.
Definition: Bin.hh:53
Defines the most general n-dimensional bin.
Definition: Bin.hh:14
const std::vector< double > & GetUpperBoundArray() const
Returns the array of upper bounds in each dimension.
Definition: Bin.hh:56
size_t _dim
Dimension of the space.
Definition: Bin.hh:77
std::vector< double > _lower
Lower boundaries of the bin.
Definition: Bin.hh:79
double _content
Content of the bin.
Definition: Bin.hh:81
const double & GetContent() const
Returns the content of the bin.
Definition: Bin.hh:62
const size_t & GetIndex(const size_t i) const
Returns the bin index in dimension i.
Definition: Bin.hh:47
const std::vector< size_t > & GetIndices() const
Returns the bin indices.
Definition: Bin.hh:44
double GetWidth(const size_t i) const
Returns the width of the bin in a particular dimension.
Definition: Bin.cc:58
~Bin()
Destructor.
Definition: Bin.cc:31
std::vector< size_t > _indices
Indices of the bin in the histogram.
Definition: Bin.hh:78
const double & GetUpperBound(const size_t i) const
Returns the upper bound in dimension i.
Definition: Bin.hh:59