testHistogram.cc

Go to the documentation of this file.

#include <iostream>
#include <utl/Histogram.h>
#include <utl/CountedObject.h>
#include <utl/CountedObjectRegistry.h>

#include <tst/Verify.h>
#include <cppunit/extensions/HelperMacros.h>

using namespace std;
using namespace utl;
using namespace tst;

#define ASSERT_EQUAL(x, y) CPPUNIT_ASSERT(Verify<Equal>(x, y))
#define ASSERT_CLOSE(x, y) CPPUNIT_ASSERT(Verify<CloseTo>(x, y))

#define ASSERT_OBJECT_COUNTS(o, c, d) \
  ASSERT_EQUAL(CountedObject<o>::GetObjectsCreated(), c); \
  ASSERT_EQUAL(CountedObject<o>::GetObjectsDestroyed(), d)

#define ASSERT_EXTENDED_OBJECT_COUNTS(o, c, d, cp, a) \
  ASSERT_OBJECT_COUNTS(o, c, d); \
  ASSERT_EQUAL(CountedObject<o>::GetObjectsCopied(), cp); \
  ASSERT_EQUAL(CountedObject<o>::GetObjectsAssigned(), a)


class HistogramTest : public CppUnit::TestFixture {

  CPPUNIT_TEST_SUITE(HistogramTest);
  CPPUNIT_TEST(testEqualBinning);
  CPPUNIT_TEST(testVariableBinning);
  CPPUNIT_TEST(testSharedBinning);
  CPPUNIT_TEST(testHistogramWrap);
  CPPUNIT_TEST(testBinEdges);
  CPPUNIT_TEST_SUITE_END();

public:
  void setUp() { }

  void tearDown() { }

  void
  testEqualBinning()
  {
    const double eps = 1e-9;

    Histogram<double> h1(10, 0, 1);

    ASSERT_EQUAL(h1.GetNBins(), size_t(10));
    ASSERT_EQUAL(h1.GetStart(), 0.);
    ASSERT_EQUAL(h1.GetStop(), 1.);
    ASSERT_EQUAL(h1.GetBinIndex(-eps), size_t(Histogram<double>::eUnderflow));
    ASSERT_EQUAL(h1.GetBinIndex(0.), size_t(0));
    for (int i = 1; i < 10; ++i) {
      ASSERT_EQUAL(h1.GetBinIndex(i/10. - eps), size_t(i-1));
      ASSERT_EQUAL(h1.GetBinIndex(i/10. + eps), size_t(i));
    }
    ASSERT_EQUAL(h1.GetBinIndex(1 - eps), size_t(9));
    ASSERT_EQUAL(h1.GetBinIndex(1.), size_t(Histogram<double>::eOverflow));
    for (int i = 0; i < 10; ++i)
      ASSERT_EQUAL(h1.GetBin(i), 0.);

    h1.Fill(0.45);
    ASSERT_EQUAL(h1.GetBin(4), 1.);

    const double some = 123;
    vector<double> dataBins(10, some);

    Histogram<double> h2(0, 1, dataBins);

    ASSERT_EQUAL(h2.GetNBins(), size_t(10));
    ASSERT_EQUAL(h2.GetStart(), 0.);
    ASSERT_EQUAL(h2.GetStop(), 1.);
    // check it is really a copy
    for (int i = 0; i < 10; ++i) {
      ASSERT_EQUAL(h2.GetBin(i), some);
      dataBins[i] = 0;
      ASSERT_EQUAL(h2.GetBin(i), some);
    }
  }

  void
  testVariableBinning()
  {
    const double eps = 1e-9;

    vector<double> binEdges;
    for (int i = 0; i <= 10; ++i)
      binEdges.push_back(i/10.);

    VariableBinHistogram<double> h1(binEdges);

    ASSERT_EQUAL(h1.GetNBins(), size_t(10));
    ASSERT_EQUAL(h1.GetStart(), 0.);
    ASSERT_EQUAL(h1.GetStop(), 1.);
    ASSERT_EQUAL(h1.GetBinIndex(-eps), size_t(Histogram<double>::eUnderflow));
    ASSERT_EQUAL(h1.GetBinIndex(0.), size_t(0));
    for (int i = 1; i < 10; ++i) {
      ASSERT_EQUAL(h1.GetBinIndex(i/10. - eps), size_t(i-1));
      ASSERT_EQUAL(h1.GetBinIndex(i/10. + eps), size_t(i));
    }
    ASSERT_EQUAL(h1.GetBinIndex(1 - eps), size_t(9));
    ASSERT_EQUAL(h1.GetBinIndex(1.), size_t(Histogram<double>::eOverflow));
    // check it is really a copy
    for (int i = 0; i <= 10; ++i) {
      ASSERT_CLOSE(h1.GetBinLowerEdges()[i], i/10.);
      binEdges[i] = 0;
      ASSERT_CLOSE(h1.GetBinLowerEdges()[i], i/10.);
      binEdges[i] = i/10.;
    }

    const double some = 123;
    vector<double> dataBins(10, some);

    VariableBinHistogram<double, double> h2(binEdges, dataBins);

    ASSERT_EQUAL(h2.GetNBins(), size_t(10));
    ASSERT_EQUAL(h2.GetStart(), 0.);
    ASSERT_EQUAL(h2.GetStop(), 1.);
    // check it is really a copy
    for (int i = 0; i <= 10; ++i) {
      ASSERT_CLOSE(h2.GetBinLowerEdges()[i], i/10.);
      binEdges[i] = 0;
      ASSERT_CLOSE(h2.GetBinLowerEdges()[i], i/10.);
      if (i < 10) {
        ASSERT_EQUAL(h2.GetBin(i), some);
        dataBins[i] = 0;
        ASSERT_EQUAL(h2.GetBin(i), some);
      }
    }
  }

  void
  testSharedBinning()
  {
    vector<int> edges(10);
    for (int i = 0; i < 10; ++i)
      edges[i] = i*i;

    SharedBinHistogram<int> h(edges);

    ASSERT_EQUAL(h.GetNBins(), size_t(9));
    ASSERT_EQUAL(h.GetStart(), 0);
    ASSERT_EQUAL(h.GetStop(), 9*9);
    ASSERT_EQUAL(h.GetBinLowerEdge(0), 0);
    ASSERT_EQUAL(h.GetBinLowerEdge(1), 1);
    ASSERT_EQUAL(h.GetBinLowerEdge(2), 4);

    // check it is a reference
    edges[0] = edges[1] = edges[2] = 13;
    ASSERT_EQUAL(h.GetBinLowerEdge(0), 13);
    ASSERT_EQUAL(h.GetBinLowerEdge(1), 13);
    ASSERT_EQUAL(h.GetBinLowerEdge(2), 13);
    ASSERT_EQUAL(h.GetBinLowerEdge(3), 9);
  }

  void
  testHistogramWrap()
  {
    const int n = 120;
    vector<char> x(n+1);
    vector<unsigned short int> y(n);
    for (int i = 0; i < n; ++i) {
      x[i] = i;
      y[i] = i;
    }
    x[n] = n;

    HistogramWrap<unsigned short int> hw(0, 1, y);

    ASSERT_EQUAL(hw.GetNBins(), size_t(n));
    ASSERT_EQUAL(hw.GetStart(), 0.);
    ASSERT_EQUAL(hw.GetStop(), 1.);
    ASSERT_EQUAL(hw.GetBin(10), (unsigned short int)(10));
    // check for reference
    y[0] = 13;
    ASSERT_EQUAL(hw.GetBin(0), (unsigned short int)(13));

    VariableBinHistogramWrap<char, unsigned short int> vhw(x, y);

    ASSERT_EQUAL(vhw.GetNBins(), size_t(n));
    ASSERT_EQUAL(vhw.GetStart(), char(0));
    ASSERT_EQUAL(vhw.GetStop(), char(n));
    ASSERT_EQUAL(vhw.GetBin(0), (unsigned short int)(13));
    ASSERT_EQUAL(vhw.GetBin(10), (unsigned short int)(10));
    ASSERT_EQUAL(vhw.GetBinLowerEdge(0), char(0));
    ASSERT_EQUAL(vhw.GetBinUpperEdge(0), char(1));
    ASSERT_EQUAL(vhw.GetBinLowerEdge(1), char(1));
    ASSERT_EQUAL(vhw.GetBinUpperEdge(1), char(2));
    ASSERT_EQUAL(vhw.GetBinLowerEdge(2), char(2));
    ASSERT_EQUAL(vhw.GetBinUpperEdge(2), char(3));
    // test for reference
    x[0] = 13;
    ASSERT_EQUAL(vhw.GetBinLowerEdge(0), char(13));
    y[0] = 666;
    ASSERT_EQUAL(hw.GetBin(0), (unsigned short int)(666));
  }

  void
  testBinEdges()
  {
    Histogram<double> h(10, 0, 10);

    h.Fill(-0.001);
    h.Fill(10);
    for (int i = 0; i < 10; ++i)
      h.Fill(i);

    for (int i = 0; i < 10; ++i)
      ASSERT_EQUAL(h.GetBin(i), 1.);
  }

};


CPPUNIT_TEST_SUITE_REGISTRATION(HistogramTest);


// Configure (x)emacs for this file ...
// Local Variables:
// mode: c++
// End: