HcalInterpolatedTableFunctor Class Reference

#include <HcalInterpolatedTableFunctor.h>

Inheritance diagram for HcalInterpolatedTableFunctor:

Public Member Functions
	HcalInterpolatedTableFunctor ()
	HcalInterpolatedTableFunctor (const std::vector< double > &values, double xmin, double xmax, bool leftExtrapolationLinear, bool rightExtrapolationLinear)
HcalPiecewiseLinearFunctor	inverse () const
bool	isStrictlyMonotonous () const
double	operator() (double x) const override
double	xmax () const override
double	xmin () const override
	~HcalInterpolatedTableFunctor () override
Public Member Functions inherited from AbsHcalFunctor
bool	operator!= (const AbsHcalFunctor &r) const
bool	operator== (const AbsHcalFunctor &r) const
virtual	~AbsHcalFunctor ()

Protected Member Functions
bool	isEqual (const AbsHcalFunctor &other) const override

Private Member Functions
template<class Archive >
void	serialize (Archive &ar, unsigned)

Private Attributes
bool	leftExtrapolationLinear_
bool	rightExtrapolationLinear_
std::vector< double >	values_
double	xmax_
double	xmin_

Friends
class	boost::serialization::access

Additional Inherited Members
Static Protected Member Functions inherited from AbsHcalFunctor
template<class Iter >
static bool	isStrictlyDecreasing (Iter begin, Iter const end)
template<class Iter >
static bool	isStrictlyIncreasing (Iter begin, Iter const end)

Detailed Description

Definition at line 10 of file HcalInterpolatedTableFunctor.h.

Constructor & Destructor Documentation

HcalInterpolatedTableFunctor::HcalInterpolatedTableFunctor

(

)

Definition at line 11 of file HcalInterpolatedTableFunctor.cc.

    : xmin_(0.), xmax_(0.), leftExtrapolationLinear_(false), rightExtrapolationLinear_(false) {}

HcalInterpolatedTableFunctor::HcalInterpolatedTableFunctor	(	const std::vector< double > &	values,
		double	xmin,
		double	xmax,
		bool	leftExtrapolationLinear,
		bool	rightExtrapolationLinear
	)

Definition at line 14 of file HcalInterpolatedTableFunctor.cc.

References Exception, values_, xmax_, and xmin_.

    : values_(values),
      xmin_(ixmin),
      xmax_(ixmax),
      leftExtrapolationLinear_(leftExtrapolationLinear),
      rightExtrapolationLinear_(rightExtrapolationLinear) {
  if (values_.size() < 2)
    throw cms::Exception(
        "In HcalInterpolatedTableFunctor constructor:"
        " insufficient number of points");
  if (xmin_ >= xmax_)
    throw cms::Exception(
        "In HcalInterpolatedTableFunctor constructor:"
        " invalid min and/or max coordinates");
}

HcalInterpolatedTableFunctor::~HcalInterpolatedTableFunctor ( )

inlineoverride

Definition at line 32 of file HcalInterpolatedTableFunctor.h.

References operator()(), and x.

{}

Member Function Documentation

HcalPiecewiseLinearFunctor HcalInterpolatedTableFunctor::inverse

(

)

const

Definition at line 64 of file HcalInterpolatedTableFunctor.cc.

References Exception, mps_fire::i, isStrictlyMonotonous(), cmsLHEtoEOSManager::l, leftExtrapolationLinear_, HLT_2018_cff::points, alignCSCRings::r, rightExtrapolationLinear_, std::swap(), values_, x, xmax_, and xmin_.

Referenced by xmax().

                                                                       {
  if (!isStrictlyMonotonous())
    throw cms::Exception(
        "In HcalInterpolatedTableFunctor::inverse:"
        " can't invert non-monotonous functor");
  const std::size_t sz = values_.size();
  const std::size_t szm1 = sz - 1;
  const double step = (xmax_ - xmin_) / szm1;
  std::vector<std::pair<double, double> > points;
  points.reserve(sz);
  for (std::size_t i = 0; i < sz; ++i) {
    const double x = (i == szm1 ? xmax_ : xmin_ + step * i);
    points.push_back(std::make_pair(values_[i], x));
  }
  bool l = leftExtrapolationLinear_;
  bool r = rightExtrapolationLinear_;
  if (values_[0] > values_[sz - 1])
    std::swap(l, r);
  return HcalPiecewiseLinearFunctor(points, l, r);
}

bool HcalInterpolatedTableFunctor::isEqual ( const AbsHcalFunctor &  other ) const

inlineoverrideprotectedvirtual

Implements AbsHcalFunctor.

Definition at line 46 of file HcalInterpolatedTableFunctor.h.

References leftExtrapolationLinear_, trackingPlots::other, alignCSCRings::r, rightExtrapolationLinear_, values_, xmax_, and xmin_.

                                                                  {
    const HcalInterpolatedTableFunctor& r = static_cast<const HcalInterpolatedTableFunctor&>(other);
    return values_ == r.values_ && xmin_ == r.xmin_ && xmax_ == r.xmax_ &&
           leftExtrapolationLinear_ == r.leftExtrapolationLinear_ &&
           rightExtrapolationLinear_ == r.rightExtrapolationLinear_;
  }

bool HcalInterpolatedTableFunctor::isStrictlyMonotonous

(

)

const

Definition at line 60 of file HcalInterpolatedTableFunctor.cc.

References AbsHcalFunctor::isStrictlyDecreasing(), AbsHcalFunctor::isStrictlyIncreasing(), and values_.

Referenced by inverse(), and xmax().

                                                              {
  return isStrictlyIncreasing(values_.begin(), values_.end()) || isStrictlyDecreasing(values_.begin(), values_.end());
}

double HcalInterpolatedTableFunctor::operator() ( double  x ) const

overridevirtual

Implements AbsHcalFunctor.

Definition at line 34 of file HcalInterpolatedTableFunctor.cc.

References interpolateStep(), leftExtrapolationLinear_, mps_fire::result, rightExtrapolationLinear_, values_, xmax_, and xmin_.

Referenced by ~HcalInterpolatedTableFunctor().

                                                                    {
  double result = 0.0;
  const std::size_t sz = values_.size();
  const std::size_t szm1 = sz - 1;
  const double step = (xmax_ - xmin_) / szm1;

  if (x >= xmax_) {
    if (rightExtrapolationLinear_)
      result = interpolateStep(xmax_ - step, step, values_[sz - 2], values_[szm1], x);
    else
      result = values_[szm1];
  } else if (x <= xmin_) {
    if (leftExtrapolationLinear_)
      result = interpolateStep(xmin_, step, values_[0], values_[1], x);
    else
      result = values_[0];
  } else {
    const std::size_t ux = static_cast<std::size_t>((x - xmin_) / step);
    if (ux >= szm1)
      return values_[szm1];
    result = interpolateStep(ux * step + xmin_, step, values_[ux], values_[ux + 1], x);
  }

  return result;
}

template<class Archive >

void HcalInterpolatedTableFunctor::serialize ( Archive &  ar, unsigned    )

inlineprivate

Definition at line 63 of file HcalInterpolatedTableFunctor.h.

References rightExtrapolationLinear_.

                                                 {
    boost::serialization::base_object<AbsHcalFunctor>(*this);
    ar& values_& xmin_& xmax_& leftExtrapolationLinear_& rightExtrapolationLinear_;
  }

double HcalInterpolatedTableFunctor::xmax ( ) const

inlineoverridevirtual

Reimplemented from AbsHcalFunctor.

Definition at line 36 of file HcalInterpolatedTableFunctor.h.

References inverse(), isStrictlyMonotonous(), and xmax_.

Referenced by svgfig.XAxis::__repr__().

{ return xmax_; }

double HcalInterpolatedTableFunctor::xmin ( ) const

inlineoverridevirtual

Reimplemented from AbsHcalFunctor.

Definition at line 35 of file HcalInterpolatedTableFunctor.h.

References xmin_.

Referenced by svgfig.XAxis::__repr__(), svgfig.Axes::__repr__(), svgfig.HGrid::__repr__(), svgfig.Grid::__repr__(), and svgfig.Axes::SVG().

{ return xmin_; }

Friends And Related Function Documentation

friend class boost::serialization::access

friend

Definition at line 60 of file HcalInterpolatedTableFunctor.h.

Member Data Documentation

bool HcalInterpolatedTableFunctor::leftExtrapolationLinear_

private

Definition at line 57 of file HcalInterpolatedTableFunctor.h.

Referenced by inverse(), isEqual(), and operator()().

bool HcalInterpolatedTableFunctor::rightExtrapolationLinear_

private

Definition at line 58 of file HcalInterpolatedTableFunctor.h.

Referenced by inverse(), isEqual(), operator()(), and serialize().

std::vector<double> HcalInterpolatedTableFunctor::values_

private

Definition at line 54 of file HcalInterpolatedTableFunctor.h.

Referenced by HcalInterpolatedTableFunctor(), inverse(), isEqual(), isStrictlyMonotonous(), and operator()().

double HcalInterpolatedTableFunctor::xmax_

private

Definition at line 56 of file HcalInterpolatedTableFunctor.h.

Referenced by HcalInterpolatedTableFunctor(), inverse(), isEqual(), operator()(), and xmax().

double HcalInterpolatedTableFunctor::xmin_

private

Definition at line 55 of file HcalInterpolatedTableFunctor.h.

Referenced by HcalInterpolatedTableFunctor(), inverse(), isEqual(), operator()(), and xmin().