fl::Ramp Class Reference

The Ramp class is an edge Term that represents the ramp membership function. More...

#include <Ramp.h>

Inheritance diagram for fl::Ramp:

Collaboration diagram for fl::Ramp:

Public Types
enum	Direction { Positive, Zero, Negative }
	Direction is an enumerator that indicates the direction of the ramp. More...

Public Member Functions
	Ramp (const std::string &name="", scalar start=fl::nan, scalar end=fl::nan, scalar height=1.0)
virtual	~Ramp () 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 scalar	tsukamoto (scalar activationDegree, scalar minimum, scalar maximum) const FL_IOVERRIDE
virtual bool	isMonotonic () const FL_IOVERRIDE
virtual void	setStart (scalar start)
	Sets the start of the ramp. More...
virtual scalar	getStart () const
	Gets the start of the ramp. More...
virtual void	setEnd (scalar end)
	Sets the end of the ramp. More...
virtual scalar	getEnd () const
	Gets the end of the ramp. More...
virtual Direction	direction () const
	Returns the direction of the ramp. More...
virtual Ramp *	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 Ramp class is an edge Term that represents the ramp membership function.

Author

Juan Rada-Vilela, Ph.D.

See also

Term

Variable

Since

4.0

Definition at line 35 of file Ramp.h.

Member Enumeration Documentation

Direction

enum fl::Ramp::Direction

Direction is an enumerator that indicates the direction of the ramp.

Enumerator
Positive	(_/) increases to the right
Zero	(--) slope is zero
Negative	(\\_) increases to the left

Definition at line 44 of file Ramp.h.

Constructor & Destructor Documentation

Ramp()

fl::Ramp::Ramp ( const std::string &  name = "", scalar  start = fl::nan, scalar  end = fl::nan, scalar  height = 1.0  )

explicit

~Ramp()

virtual fl::Ramp::~Ramp ( )

virtual

Member Function Documentation

className()

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

virtual

Creates a clone of the term.

Returns

a clone of the term

Implements fl::Term.

complexity()

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

virtual

Configures the term with the parameters.

Parameters

parameters

as "start end [height]"

Implements fl::Term.

constructor()

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

static

direction()

virtual Direction fl::Ramp::direction ( ) const

virtual

Returns the direction of the ramp.

Returns

the direction of the ramp

getEnd()

virtual scalar fl::Ramp::getEnd ( ) const

virtual

Gets the end of the ramp.

Returns

the end of the ramp

getStart()

virtual scalar fl::Ramp::getStart ( ) const

virtual

Gets the start of the ramp.

Returns

the start of the ramp

isMonotonic()

virtual bool fl::Ramp::isMonotonic ( ) const

virtual

membership()

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

virtual

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

Parameters

x

Returns

\(\begin{cases} 0h & \mbox{if $x = e$}\cr \begin{cases} 0h & \mbox{if $x \leq s$}\cr 1h & \mbox{if $x \geq e$}\cr h (x - s) / (e - s) & \mbox{otherwise}\cr \end{cases} & \mbox{if $s < e$}\cr \begin{cases} 0h & \mbox{if $x \geq s$}\cr 1h & \mbox{if $x \leq e$}\cr h (s - x) / (s - e) & \mbox{otherwise} \end{cases} & \mbox{if $s > e$}\cr \end{cases}\)

where \(h\) is the height of the Term, \(s\) is the start of the Ramp, \(e\) is the end of the Ramp

Implements fl::Term.

parameters()

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

virtual

Returns the parameters of the term.

Returns

"start end [height]"

Implements fl::Term.

setEnd()

virtual void fl::Ramp::setEnd ( scalar  end )

virtual

Sets the end of the ramp.

Parameters

end	is the end of the ramp

setStart()

virtual void fl::Ramp::setStart ( scalar  start )

virtual

Sets the start of the ramp.

Parameters

start

is the start of the ramp

tsukamoto()

virtual scalar fl::Ramp::tsukamoto ( scalar  activationDegree, scalar  minimum, scalar  maximum  ) const

virtual

---

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

• fuzzylite/fl/term/Ramp.h