fl::Gaussian Class Reference

The Gaussian class is an extended Term that represents the Gaussian curve membership function. More...

#include <Gaussian.h>

Inheritance diagram for fl::Gaussian:

Collaboration diagram for fl::Gaussian:

Public Member Functions
	Gaussian (const std::string &name="", scalar mean=fl::nan, scalar standardDeviation=fl::nan, scalar height=1.0)
virtual	~Gaussian () FL_IOVERRIDE
virtual std::string	className () const FL_IOVERRIDE
	Returns the name of the class of the term. More...
virtual std::string	parameters () const FL_IOVERRIDE
	Returns the parameters of the term. More...
virtual void	configure (const std::string &parameters) FL_IOVERRIDE
	Configures the term with the parameters. More...
virtual Complexity	complexity () const FL_IOVERRIDE
	Computes the estimated complexity of evaluating the membership function. More...
virtual scalar	membership (scalar x) const FL_IOVERRIDE
	Computes the membership function evaluated at \(x\). More...
virtual void	setMean (scalar mean)
	Sets the mean of the Gaussian curve. More...
virtual scalar	getMean () const
	Gets the mean of the Gaussian curve. More...
virtual void	setStandardDeviation (scalar standardDeviation)
	Sets the standard deviation of the Gaussian curve. More...
virtual scalar	getStandardDeviation () const
	Gets the standard deviation of the Gaussian curve. More...
virtual Gaussian *	clone () const FL_IOVERRIDE
	Creates a clone of the term. More...
Public Member Functions inherited from fl::Term
	Term (const std::string &name="", scalar height=1.0)
virtual	~Term ()
virtual void	setName (const std::string &name)
	Sets the name of the term. More...
virtual std::string	getName () const
	Gets the name of the term. More...
virtual void	setHeight (scalar height)
	Sets the height of the term. More...
virtual scalar	getHeight () const
	Gets the height of the term. More...
virtual std::string	toString () const
	Returns the representation of the term in the FuzzyLite Language. More...
virtual void	updateReference (const Engine *engine)
	Updates the references (if any) to point to the current engine (useful when cloning engines or creating terms within Importer objects. More...

Static Public Member Functions
static Term *	constructor ()

Additional Inherited Members
Protected Attributes inherited from fl::Term
scalar	_height

Detailed Description

The Gaussian class is an extended Term that represents the Gaussian curve membership function.

Author

Juan Rada-Vilela, Ph.D.

See also

Term

Variable

Since

4.0

Definition at line 35 of file Gaussian.h.

Constructor & Destructor Documentation

Gaussian()

fl::Gaussian::Gaussian ( const std::string &  name = "", scalar  mean = fl::nan, scalar  standardDeviation = fl::nan, scalar  height = 1.0  )

explicit

~Gaussian()

virtual fl::Gaussian::~Gaussian ( )

virtual

Member Function Documentation

className()

virtual std::string fl::Gaussian::className ( ) const

virtual

Returns the name of the class of the term.

Returns

the name of the class of the term

Implements fl::Term.

clone()

virtual Gaussian* fl::Gaussian::clone ( ) const

virtual

Creates a clone of the term.

Returns

a clone of the term

Implements fl::Term.

complexity()

virtual Complexity fl::Gaussian::complexity ( ) const

virtual

Computes the estimated complexity of evaluating the membership function.

Returns

the estimated complexity of evaluating the membership function

Implements fl::Term.

configure()

virtual void fl::Gaussian::configure ( const std::string &  parameters )

virtual

Configures the term with the parameters.

Parameters

parameters

as "mean standardDeviation [height]"

Implements fl::Term.

constructor()

static Term* fl::Gaussian::constructor ( )

static

getMean()

virtual scalar fl::Gaussian::getMean ( ) const

virtual

Gets the mean of the Gaussian curve.

Returns

the mean of the Gaussian curve

getStandardDeviation()

virtual scalar fl::Gaussian::getStandardDeviation ( ) const

virtual

Gets the standard deviation of the Gaussian curve.

Returns

the standard deviation of the Gaussian curve

membership()

virtual scalar fl::Gaussian::membership ( scalar  x ) const

virtual

Computes the membership function evaluated at \(x\).

Parameters

x

Returns

\( h \times \exp(-(x-\mu)^2/(2\sigma^2))\)

where \(h\) is the height of the Term, \(\mu\) is the mean of the Gaussian, \(\sigma\) is the standard deviation of the Gaussian

Implements fl::Term.

parameters()

virtual std::string fl::Gaussian::parameters ( ) const

virtual

Returns the parameters of the term.

Returns

"mean standardDeviation [height]"

Implements fl::Term.

setMean()

virtual void fl::Gaussian::setMean ( scalar  mean )

virtual

Sets the mean of the Gaussian curve.

Parameters

mean	is the mean of the Gaussian curve

setStandardDeviation()

virtual void fl::Gaussian::setStandardDeviation ( scalar  standardDeviation )

virtual

Sets the standard deviation of the Gaussian curve.

Parameters

standardDeviation

is the standard deviation of the Gaussian curve

---

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

• fuzzylite/fl/term/Gaussian.h