All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
PLMD::HistogramBead Class Reference

A class for calculating whether or not values are within a given range using : \( \sum_i \int_a^b G( s_i, \sigma*(b-a) ) \). More...

#include <HistogramBead.h>

Public Member Functions

 HistogramBead ()
 
std::string description () const
 
bool hasBeenSet () const
 
void isNotPeriodic ()
 
void isPeriodic (const double &mlow, const double &mhigh)
 
void setKernelType (const std::string &ktype)
 
void set (const std::string &params, const std::string &dd, std::string &errormsg)
 
void set (double l, double h, double w)
 
double calculate (double x, double &df) const
 
double getlowb () const
 
double getbigb () const
 

Static Public Member Functions

static void registerKeywords (Keywords &keys)
 
static void generateBins (const std::string &params, const std::string &dd, std::vector< std::string > &bins)
 

Private Types

enum  { gaussian, triangular }
 
enum  { unset, periodic, notperiodic }
 

Private Member Functions

double difference (const double &d1, const double &d2) const
 

Private Attributes

bool init
 
double lowb
 
double highb
 
double width
 
enum PLMD::HistogramBead:: { ... }  type
 
enum PLMD::HistogramBead:: { ... }  periodicity
 
double min
 
double max
 
double max_minus_min
 
double inv_max_minus_min
 

Detailed Description

A class for calculating whether or not values are within a given range using : \( \sum_i \int_a^b G( s_i, \sigma*(b-a) ) \).

Member Enumeration Documentation

anonymous enum
private
Enumerator
gaussian 
triangular 
anonymous enum
private
Enumerator
unset 
periodic 
notperiodic 

Constructor & Destructor Documentation

PLMD::HistogramBead::HistogramBead ( )

Member Function Documentation

double PLMD::HistogramBead::calculate ( double  x,
double &  df 
) const
std::string PLMD::HistogramBead::description ( ) const
double PLMD::HistogramBead::difference ( const double &  d1,
const double &  d2 
) const
inlineprivate
void PLMD::HistogramBead::generateBins ( const std::string &  params,
const std::string &  dd,
std::vector< std::string > &  bins 
)
static
double PLMD::HistogramBead::getbigb ( ) const
inline
double PLMD::HistogramBead::getlowb ( ) const
inline
bool PLMD::HistogramBead::hasBeenSet ( ) const
inline
void PLMD::HistogramBead::isNotPeriodic ( )
inline
void PLMD::HistogramBead::isPeriodic ( const double &  mlow,
const double &  mhigh 
)
inline
void PLMD::HistogramBead::registerKeywords ( Keywords keys)
static
void PLMD::HistogramBead::set ( const std::string &  params,
const std::string &  dd,
std::string &  errormsg 
)
void PLMD::HistogramBead::set ( double  l,
double  h,
double  w 
)
void PLMD::HistogramBead::setKernelType ( const std::string &  ktype)

Member Data Documentation

double PLMD::HistogramBead::highb
private
bool PLMD::HistogramBead::init
private
double PLMD::HistogramBead::inv_max_minus_min
private
double PLMD::HistogramBead::lowb
private
double PLMD::HistogramBead::max
private
double PLMD::HistogramBead::max_minus_min
private
double PLMD::HistogramBead::min
private
enum { ... } PLMD::HistogramBead::periodicity
enum { ... } PLMD::HistogramBead::type
double PLMD::HistogramBead::width
private

The documentation for this class was generated from the following files: