inlib  1.2.0
Public Member Functions
inlib::func::gaussian Class Reference

List of all members.

Public Member Functions

 gaussian (double a_scale=1, double a_mean=0, double a_sigma=1)
virtual ~gaussian ()
 gaussian (const gaussian &a_from)
gaussianoperator= (const gaussian &a_from)
bool in_domain (double) const
double value (double a_x) const
void set (double a_scale, double a_mean, double a_sigma)
void scale (double a_scale)
void mean (double a_mean)
void sigma (double a_sigma)
double scale () const
double mean () const
double sigma () const

Detailed Description

Definition at line 17 of file func.


Constructor & Destructor Documentation

inlib::func::gaussian::gaussian ( double  a_scale = 1,
double  a_mean = 0,
double  a_sigma = 1 
) [inline]

Definition at line 19 of file func.

                                                                   {
    set(a_scale,a_mean,a_sigma);
  }
virtual inlib::func::gaussian::~gaussian ( ) [inline, virtual]

Definition at line 22 of file func.

{}
inlib::func::gaussian::gaussian ( const gaussian a_from) [inline]

Definition at line 24 of file func.

  :m_scale(a_from.m_scale)
  ,m_mean(a_from.m_mean)
  ,m_sigma(a_from.m_sigma)
  {}

Member Function Documentation

bool inlib::func::gaussian::in_domain ( double  ) const [inline]

Definition at line 36 of file func.

{return true;}
void inlib::func::gaussian::mean ( double  a_mean) [inline]

Definition at line 49 of file func.

{m_mean = a_mean;}
double inlib::func::gaussian::mean ( ) const [inline]

Definition at line 55 of file func.

{return m_mean;}
gaussian& inlib::func::gaussian::operator= ( const gaussian a_from) [inline]

Definition at line 29 of file func.

                                             {
    m_scale = a_from.m_scale;
    m_mean = a_from.m_mean;
    m_sigma = a_from.m_sigma;
    return *this;
  }
void inlib::func::gaussian::scale ( double  a_scale) [inline]

Definition at line 48 of file func.

{m_scale = a_scale;}
double inlib::func::gaussian::scale ( ) const [inline]

Definition at line 54 of file func.

{return m_scale;}
void inlib::func::gaussian::set ( double  a_scale,
double  a_mean,
double  a_sigma 
) [inline]

Definition at line 42 of file func.

                                                       {
    m_scale = a_scale;
    m_mean = a_mean;
    m_sigma = a_sigma;
    if(m_sigma<=0) m_sigma = 1;
  }
void inlib::func::gaussian::sigma ( double  a_sigma) [inline]

Definition at line 50 of file func.

                            {
    m_sigma = a_sigma;
    if(m_sigma<=0) m_sigma = 1;
  }
double inlib::func::gaussian::sigma ( ) const [inline]

Definition at line 56 of file func.

{return m_sigma;} 
double inlib::func::gaussian::value ( double  a_x) const [inline]

Definition at line 37 of file func.

                                 {
    double value = (a_x - m_mean)/m_sigma;
    return m_scale * ::exp(-0.5 * value * value);
  }

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines