fuzzylite  6.0
A Fuzzy Logic Control Library in C++
fl::SShape Class Reference

The SShape class is an edge Term that represents the S-shaped membership function. More...

#include <SShape.h>

Inheritance diagram for fl::SShape:
Collaboration diagram for fl::SShape:

Public Member Functions

 SShape (const std::string &name="", scalar start=fl::nan, scalar end=fl::nan, scalar height=1.0)
 
virtual ~SShape () 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 edge. More...
 
virtual scalar getStart () const
 Gets the start of the edge. More...
 
virtual void setEnd (scalar end)
 Sets the end of the edge. More...
 
virtual scalar getEnd () const
 Gets the end of the edge. More...
 
virtual SShapeclone () 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 Termconstructor ()
 

Additional Inherited Members

- Protected Attributes inherited from fl::Term
scalar _height
 

Detailed Description

The SShape class is an edge Term that represents the S-shaped membership function.

sShape.svg
Author
Juan Rada-Vilela, Ph.D.
See also
Term
Variable
Since
4.0

Definition at line 35 of file SShape.h.

Constructor & Destructor Documentation

◆ SShape()

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

◆ ~SShape()

virtual fl::SShape::~SShape ( )
virtual

Member Function Documentation

◆ className()

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

Creates a clone of the term.

Returns
a clone of the term

Implements fl::Term.

◆ complexity()

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

Configures the term with the parameters.

Parameters
parametersas "start end [height]"

Implements fl::Term.

◆ constructor()

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

◆ getEnd()

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

Gets the end of the edge.

Returns
the end of the edge

◆ getStart()

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

Gets the start of the edge.

Returns
the start of the edge

◆ isMonotonic()

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

◆ membership()

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

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

Parameters
x
Returns
\(\begin{cases} 0h & \mbox{if $x \leq s$} \cr h(2 \left((x - s) / (e-s)\right)^2) & \mbox{if $x \leq 0.5(s+e)$}\cr h(1 - 2\left((x - e) / (e-s)\right)^2) & \mbox{if $x < e$}\cr 1h & \mbox{otherwise} \end{cases}\)

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

Implements fl::Term.

◆ parameters()

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

Returns the parameters of the term.

Returns
"start end [height]"

Implements fl::Term.

◆ setEnd()

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

Sets the end of the edge.

Parameters
endis the end of the edge

◆ setStart()

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

Sets the start of the edge.

Parameters
startis the start of the edge

◆ tsukamoto()

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

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