histogramdata.h

Go to the documentation of this file.

// Copyright 2017-2020, Schlumberger
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
//Adapted from: Zgy/UtilityLib/HistogramData
#pragma once
 
#include "../declspec.h"
#include "roundandclip.h"
 
#include <memory>
#include <math.h>
#include <cmath>
 
namespace InternalZGY {
#if 0
}
#endif
 
class OPENZGY_TEST_API HistogramData
{
public:
  typedef std::int32_t size_type;
  typedef std::int64_t count_type;
 
  HistogramData(size_type _nbins, double _min, double _max);
  HistogramData(const count_type* bins, int nbins, double min, double max);
  HistogramData(const HistogramData& other);
  HistogramData& operator=(const HistogramData& other);
  HistogramData& operator+=(const HistogramData& other);
  HistogramData& operator-=(const HistogramData& other);
  HistogramData& operator*=(count_type factor);
  bool operator==(const HistogramData& other) const;
  bool operator!=(const HistogramData& other) const;
 
  // Queries
  size_type getsize()              const { return nbins_; }      
  const count_type* getbins()      const { return bins_.get(); } 
  double     getmin()              const { return min_; }        
  double     getmax()              const { return max_; }        
  double     getsmallestbinwidth() const { return 0.125; }       
  count_type get(double value)     const;                        
  count_type getcount()            const;                        
  // Operations
  void scale(double oldmin, double oldmax, double newmin, double newmax);
 
  // Internal, to be called from HistogramBuilder only.
public:
  void clear();
  static void getLinearTransform(double *offset, double *scale, double oldmin, double oldmax, double newmin, double newmax);
  void calculateConversionFactors(double* A, double* B) const; // Called from get(), AddBins(), TryAdd().
  void addToBinNumberUNSAFE(size_type binno) { bins_[binno] += 1; } 
private:
  void addBins(const count_type* bins, int nbins, double min, double max, bool add); // Called from +=, -=.
  inline void addOne(double value, count_type factor, double A, double B); // Called from AddBins() only.
  bool compare(const HistogramData& other) const; // Called from operator== and operator!=.
 
private:
  double            min_;       
  double            max_;       
  size_type         nbins_;     
  std::unique_ptr<count_type[]> bins_;
};
 
inline void HistogramData::addOne(double value, count_type factor, double A, double B)
{
  if (std::isfinite(value)) {
 
    // calculate bin index.
    // This is based on number of bins and the min/max range,
    // but the caller has precalculated the linear conversion
    // implied by those numbers.
    int n(RoundD2I(A + B*value));
 
    // if (n>=0 && n<nbins_) performance tweak. We know nbins_ is positive.
    if (static_cast<unsigned int>(n) < static_cast<unsigned int>(nbins_))
      bins_[n] += factor;
  }
}
 
} // end namespace