histogram.h

Go to the documentation of this file.

// Copyright 2007, Massachusetts Institute of Technology.
// The use of this code is permitted for research only. There is
// absolutely no warranty for this software.
//
// Author: John Lee (jjl@mit.edu)
//
#ifndef HISTOGRAMS_HISTOGRAM_H
#define HISTOGRAMS_HISTOGRAM_H

#include <string>
#include <iostream>
#include "histograms/bin.h"

using namespace std;

namespace libpmk {

class Histogram {
public:
  Histogram();
  ~Histogram();


  Bin* add_bin(const Bin& new_bin);


  void SortBins() const;

  int size() const;


  const Bin* bin(int ii);


  const Bin* bin(const LargeIndex& index);


  const Bin* bin(const LargeIndex& index, int finger);

  // We pass pointers instead of const references, since this function has
  // the capability to modify the histograms themselves (by sorting their
  // contents).
  static double ComputeIntersection(Histogram* first, Histogram* second);


  static void WriteToStream(ostream& output_stream,
                            const vector<Histogram*>& histograms);


  static void WriteSingleHistogramToStream(ostream& output_stream,
                                           Histogram* h);



  static vector<Histogram*> ReadFromStream(istream& input_stream);


  static Histogram* ReadSingleHistogramFromStream(istream& input_stream);

private:
  // Disallow evil constructors
  Histogram(const Histogram&);
  Histogram& operator=(const Histogram&);

  mutable vector<Bin*> bins_;
  mutable bool is_sorted_;
};
}  // namespace libpmk

#endif  // HISTOGRAMS_HISTOGRAM_H

---