Relacs Numerics Library: GammaKernel Class Reference

Relacs Numerics Library 0.9.8

#include <kernel.h>

Inheritance diagram for GammaKernel:

Inheritance graph

Collaboration diagram for GammaKernel:

Collaboration graph

Public Member Functions
	GammaKernel (void)

	GammaKernel (double stdev, int order=1)

virtual	~GammaKernel (void)

double	operator() (double x) const

virtual double	value (double x) const

virtual void	setScale (double scale)

virtual double	mean (void) const

virtual double	stdev (void) const

virtual void	setStdev (double stdev)

virtual double	max (void) const

int	order (void) const

void	setOrder (int order)

virtual double	left (void) const

virtual double	right (void) const

Public Member Functions inherited from Kernel
	Kernel (void)

	Kernel (double stdev)

virtual	~Kernel (void)

double	operator() (double x) const

double	scale (void) const

Detailed Description

A gamma kernel of order n.

Author: Jan Benda

Version

1.0

$f_n(x) = \left\{ \begin{array}{lcl} \frac{1}{s (n-1)!} \left( \frac{x}{s} \right)^{n-1} \mathrm{e}^{-\frac{x}{s}} & ; & 0 \le x \le 5 s\sqrt{n} \\ 0 & ; & x < 0 \end{array} \right.$

$f_1(x) = \frac{1}{s} \mathrm{e}^{-\frac{x}{s}}$

$\frac{x}{s} f_n(x) = n f_{n+1}(x)$

$\Gamma(n) = (n-1)!$

$\mu = s n$

$\sigma = s\sqrt{n}$

THe order of the gamma kernel is order() and can be set by setOrder().

Constructor & Destructor Documentation

GammaKernel ( void )

References Kernel::scale(), and GammaKernel::setScale().

GammaKernel	(	double	stdev,
		int	order = `1`
	)

References GammaKernel::setOrder(), and GammaKernel::setStdev().

~GammaKernel ( void )

virtual

Member Function Documentation

double operator() ( double x ) const

References relacs::exp(), relacs::pow(), and Kernel::scale().

Referenced by GammaKernel::value().

double value ( double x ) const

virtual

Reimplemented from Kernel.

References GammaKernel::operator()().

void setScale ( double scale )

virtual

Reimplemented from Kernel.

References Kernel::scale(), and Kernel::setScale().

Referenced by GammaKernel::GammaKernel(), and GammaKernel::setStdev().

double mean ( void ) const

virtual

Reimplemented from Kernel.

References Kernel::scale().

double stdev ( void ) const

virtual

Reimplemented from Kernel.

References Kernel::scale(), and relacs::sqrt().

Referenced by GammaKernel::right().

void setStdev ( double stdev )

virtual

Reimplemented from Kernel.

References GammaKernel::setScale(), and relacs::sqrt().

Referenced by GammaKernel::GammaKernel().

double max ( void ) const

virtual

Reimplemented from Kernel.

References relacs::exp(), and relacs::pow().

int order ( void ) const

inline

void setOrder ( int order )

inline

Referenced by GammaKernel::GammaKernel().

double left ( void ) const

virtual

Reimplemented from Kernel.

double right ( void ) const

virtual

Reimplemented from Kernel.

References GammaKernel::stdev().

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