fl::Spike Class Reference

The Spike class is an extended Term that represents the spike membership function. More...

#include <Spike.h>

Inheritance diagram for fl::Spike:

Collaboration diagram for fl::Spike:

Public Member Functions
	Spike (const std::string &name="", scalar center=fl::nan, scalar width=fl::nan, scalar height=1.0)
virtual	~Spike () 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	setCenter (scalar center)
	Sets the center of the spike. More...
virtual scalar	getCenter () const
	Gets the center of the spike. More...
virtual void	setWidth (scalar width)
	Sets the width of the spike. More...
virtual scalar	getWidth () const
	Gets the width of the spike. More...
virtual Spike *	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 Spike class is an extended Term that represents the spike membership function.

Author

Juan Rada-Vilela, Ph.D.

See also

Term

Variable

Since

5.0

Definition at line 35 of file Spike.h.

Constructor & Destructor Documentation

Spike()

fl::Spike::Spike ( const std::string &  name = "", scalar  center = fl::nan, scalar  width = fl::nan, scalar  height = 1.0  )

explicit

~Spike()

virtual fl::Spike::~Spike ( )

virtual

Member Function Documentation

className()

virtual std::string fl::Spike::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 Spike* fl::Spike::clone ( ) const

virtual

Creates a clone of the term.

Returns

a clone of the term

Implements fl::Term.

complexity()

virtual Complexity fl::Spike::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::Spike::configure ( const std::string &  parameters )

virtual

Configures the term with the parameters.

Parameters

parameters

as "center width [height]"

Implements fl::Term.

constructor()

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

static

getCenter()

virtual scalar fl::Spike::getCenter ( ) const

virtual

Gets the center of the spike.

Returns

the center of the spike

getWidth()

virtual scalar fl::Spike::getWidth ( ) const

virtual

Gets the width of the spike.

Returns

the width of the spike

membership()

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

virtual

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

Parameters

x

Returns

\(h \times \exp(-|10 / w (x - c)|)\)

where \(h\) is the height of the Term, \(w\) is the width of the Spike, \(c\) is the center of the Spike

Implements fl::Term.

parameters()

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

virtual

Returns the parameters of the term.

Returns

"center width [height]"

Implements fl::Term.

setCenter()

virtual void fl::Spike::setCenter ( scalar  center )

virtual

Sets the center of the spike.

Parameters

center

is the center of the spike

setWidth()

virtual void fl::Spike::setWidth ( scalar  width )

virtual

Sets the width of the spike.

Parameters

width

is the width of the spike

---

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

• fuzzylite/fl/term/Spike.h