The Variable class is the base class for linguistic variables. More...

#include <Variable.h>

Inheritance diagram for fl::Variable:

Collaboration diagram for fl::Variable:

Public Types
enum	Type { None, Input, Output }
	Indicates the type of the variable to avoid costly `dynamic_casts` More...

Public Member Functions
	Variable (const std::string &name="", scalar minimum=-fl::inf, scalar maximum=fl::inf)

	Variable (const Variable &other)

Variable &	operator= (const Variable &other)

virtual	~Variable ()

virtual void	setName (const std::string &name)
	Sets the name of the variable. More...

virtual std::string	getName () const
	Gets the name of the variable. More...

virtual std::string	getDescription () const
	Gets the description of the variable. More...

virtual void	setDescription (const std::string &description)
	Sets the description of the variable. More...

virtual void	setValue (scalar value)
	Sets the value of the variable. More...

virtual scalar	getValue () const
	Gets the value of the variable. More...

virtual void	setRange (scalar minimum, scalar maximum)
	Sets the range of the variable between `[minimum, maximum]` More...

virtual scalar	range () const
	Gets the magnitude of the range of the variable. More...

virtual void	setMinimum (scalar minimum)
	Sets the minimum value of the range of the variable. More...

virtual scalar	getMinimum () const
	Gets the minimum value of the range of the variable. More...

virtual void	setMaximum (scalar maximum)
	Sets the maximum value of the range of the variable. More...

virtual scalar	getMaximum () const
	Gets the maximum value of the range of the variable. More...

virtual void	setEnabled (bool enabled)
	Sets whether the variable is enabled. More...

virtual bool	isEnabled () const
	Gets whether the variable is enabled. More...

virtual void	setLockValueInRange (bool lockValueInRange)
	Sets whether the variable locks the current value to the range of the variable. More...

virtual bool	isLockValueInRange () const
	Gets whether the variable locks the current value to the range of the variable. More...

virtual Complexity	complexity () const
	Computes the aggregated complexity of the underlying terms. More...

virtual std::string	fuzzify (scalar x) const
	Evaluates the membership function of value \(x\) for each term \(i\), resulting in a fuzzy value in the form \(\tilde{x}=\sum_i{\mu_i(x)/i}\). More...

virtual Term *	highestMembership (scalar x, scalar *yhighest=fl::null) const
	Gets the term which has the highest membership function value for \(x\). More...

virtual Type	type () const
	Returns the type of the variable. More...

virtual std::string	toString () const
	Gets a string representation of the variable in the FuzzyLite Language. More...

virtual void	sort ()
	Sorts the terms in ascending order according to their centroids. More...

virtual void	addTerm (Term *term)
	Adds a term to the variable. More...

virtual void	insertTerm (Term *term, std::size_t index)
	Inserts the term in the variable. More...

virtual Term *	getTerm (std::size_t index) const
	Gets the term at the given index. More...

virtual Term *	getTerm (const std::string &name) const
	Gets the term of the given name. More...

virtual bool	hasTerm (const std::string &name) const
	Gets whether a term of the given name has been added. More...

virtual Term *	removeTerm (std::size_t index)
	Removes the term at the given index. More...

virtual std::size_t	numberOfTerms () const
	Gets the number of terms added to the variable. More...

virtual void	setTerms (const std::vector< Term *> &terms)
	Sets the terms of the variable. More...

virtual const std::vector< Term * > &	terms () const
	Gets an immutable vector of the terms. More...

virtual std::vector< Term * > &	terms ()
	Gets a mutable vector of the terms. More...

virtual Variable *	clone () const
	Creates a clone of the variable. More...

Protected Attributes
std::string	_name

std::string	_description

std::vector< Term * >	_terms

scalar	_value

scalar	_minimum

scalar	_maximum

bool	_enabled

bool	_lockValueInRange

Detailed Description

The Variable class is the base class for linguistic variables.

Author: Juan Rada-Vilela, Ph.D.

See also: InputVariable; OutputVariable; Term

Since: 4.0

Definition at line 39 of file Variable.h.

Member Enumeration Documentation

◆ Type

enum fl::Variable::Type

Indicates the type of the variable to avoid costly dynamic_casts

Enumerator
None
Input
Output

Definition at line 45 of file Variable.h.

Constructor & Destructor Documentation

◆ Variable() [1/2]

fl::Variable::Variable	(	const std::string &	name = `""`,
		scalar	minimum = `-fl::inf`,
		scalar	maximum = `fl::inf`
	)

explicit

◆ Variable() [2/2]

fl::Variable::Variable ( const Variable & other )

explicit

◆ ~Variable()

virtual fl::Variable::~Variable ( )

virtual

Member Function Documentation

◆ addTerm()

virtual void fl::Variable::addTerm ( Term * term )

virtual

Adds a term to the variable.

Parameters

term	is the term to add

◆ clone()

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

virtual

Creates a clone of the variable.

Returns: a clone of the variable

Reimplemented in fl::OutputVariable, and fl::InputVariable.

◆ complexity()

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

virtual

Computes the aggregated complexity of the underlying terms.

Returns: the aggregated complexity of the underlying terms

◆ fuzzify()

virtual std::string fl::Variable::fuzzify ( scalar x ) const

virtual

Evaluates the membership function of value \(x\) for each term \(i\), resulting in a fuzzy value in the form \(\tilde{x}=\sum_i{\mu_i(x)/i}\).

Parameters

x	is the value to fuzzify

Returns: the fuzzy value expressed as \(\sum_i{\mu_i(x)/i}\)

◆ getDescription()

virtual std::string fl::Variable::getDescription ( ) const

virtual

Gets the description of the variable.

Returns: the description of the variable

◆ getMaximum()

virtual scalar fl::Variable::getMaximum ( ) const

virtual

Gets the maximum value of the range of the variable.

Returns: the maximum value of the range of the variable

◆ getMinimum()

virtual scalar fl::Variable::getMinimum ( ) const

virtual

Gets the minimum value of the range of the variable.

Returns: the minimum value of the range of the variable

◆ getName()

virtual std::string fl::Variable::getName ( ) const

virtual

Gets the name of the variable.

Returns: the name of the variable

◆ getTerm() [1/2]

virtual Term* fl::Variable::getTerm ( std::size_t index ) const

virtual

Gets the term at the given index.

Parameters

index is the position of the term in the vector

Returns: the term at the given index

◆ getTerm() [2/2]

virtual Term* fl::Variable::getTerm ( const std::string & name ) const

virtual

Gets the term of the given name.

Parameters

name	is the name of the term to retrieve

Returns: the term of the given name

Exceptions

Exception if the term is not found

◆ getValue()

virtual scalar fl::Variable::getValue ( ) const

virtual

Gets the value of the variable.

Returns: the input value of an InputVariable, or the output value of an OutputVariable

◆ hasTerm()

virtual bool fl::Variable::hasTerm ( const std::string & name ) const

virtual

Gets whether a term of the given name has been added.

Parameters

name	the name of the term

Returns: whether the term of the given name is found

◆ highestMembership()

virtual Term* fl::Variable::highestMembership	(	scalar	x,
		scalar *	yhighest = `fl::null`
	)		const

virtual

Gets the term which has the highest membership function value for \(x\).

Parameters

	x	is the value of interest
[out]	yhighest	is a pointer where the highest membership function value will be stored

Returns: the term \(i\) which maximimizes \(\mu_i(x)\)

◆ insertTerm()

virtual void fl::Variable::insertTerm	(	Term *	term,
		std::size_t	index
	)

virtual

Inserts the term in the variable.

Parameters

term	is the term to insert
index	is the index where the term will be inserted

◆ isEnabled()

virtual bool fl::Variable::isEnabled ( ) const

virtual

Gets whether the variable is enabled.

Returns: whether the variable is enabled

◆ isLockValueInRange()

virtual bool fl::Variable::isLockValueInRange ( ) const

virtual

Gets whether the variable locks the current value to the range of the variable.

If enabled in an InputVariable \(i\), the input value \(x_i\) will be used when computing the Antecedent::activationDegree() as long as \(x_i \in [\mbox{min}, \mbox{max}]\). Else, for the case of \(x_i \not\in [\mbox{min}, \mbox{max}]\), the range values will be used instead but without changing the input value \(x_i\).

If enabled in an OutputVariable \(j\), the output value \(y_j\) will be overriden by the range values when \(y_j \not\in [\mbox{min}, \mbox{max}]\). See OutputVariable for more information.

Returns: whether the variable locks the current value to the range of the variable

◆ numberOfTerms()

virtual std::size_t fl::Variable::numberOfTerms ( ) const

virtual

Gets the number of terms added to the variable.

Returns: the number of terms in the variable

◆ operator=()

Variable& fl::Variable::operator= ( const Variable & other )

◆ range()

virtual scalar fl::Variable::range ( ) const

virtual

Gets the magnitude of the range of the variable.

Returns: maximum - minimum

◆ removeTerm()

virtual Term* fl::Variable::removeTerm ( std::size_t index )

virtual

Removes the term at the given index.

Parameters

index the index of the term to remove

Returns: the removed term

◆ setDescription()

virtual void fl::Variable::setDescription ( const std::string & description )

virtual

Sets the description of the variable.

Parameters

description is the description of the variable

◆ setEnabled()

virtual void fl::Variable::setEnabled ( bool enabled )

virtual

Sets whether the variable is enabled.

Parameters

enabled determines whether to enable the variable

◆ setLockValueInRange()

virtual void fl::Variable::setLockValueInRange ( bool lockValueInRange )

virtual

Sets whether the variable locks the current value to the range of the variable.

If enabled in an InputVariable \(i\), the input value \(x_i\) will be used when computing the Antecedent::activationDegree() as long as \(x_i \in [\mbox{min}, \mbox{max}]\). Else, for the case of \(x_i \not\in [\mbox{min}, \mbox{max}]\), the range values will be used instead but without changing the input value \(x_i\).

If enabled in an OutputVariable \(j\), the output value \(y_j\) will be overriden by the range values when \(y_j \not\in [\mbox{min}, \mbox{max}]\). See OutputVariable for more information.

Parameters

lockValueInRange indicates whether to lock the value to the range of the variable

◆ setMaximum()

virtual void fl::Variable::setMaximum ( scalar maximum )

virtual

Sets the maximum value of the range of the variable.

Parameters

maximum is the maximum value of the range

Reimplemented in fl::OutputVariable.

◆ setMinimum()

virtual void fl::Variable::setMinimum ( scalar minimum )

virtual

Sets the minimum value of the range of the variable.

Parameters

minimum is the minimum value of the range

Reimplemented in fl::OutputVariable.

◆ setName()

virtual void fl::Variable::setName ( const std::string & name )

virtual

Sets the name of the variable.

Parameters

name	is the name of the variable

Reimplemented in fl::OutputVariable.

◆ setRange()

virtual void fl::Variable::setRange	(	scalar	minimum,
		scalar	maximum
	)

virtual

Sets the range of the variable between [minimum, maximum]

Parameters

minimum	is the minimum value in range
maximum	is the maximum value in range

◆ setTerms()

virtual void fl::Variable::setTerms ( const std::vector< Term *> & terms )

virtual

Sets the terms of the variable.

Parameters

terms is a vector of terms

◆ setValue()

virtual void fl::Variable::setValue ( scalar value )

virtual

Sets the value of the variable.

Parameters

value is the input value of an InputVariable, or the output value of an OutputVariable

◆ sort()

virtual void fl::Variable::sort ( )

virtual

Sorts the terms in ascending order according to their centroids.

◆ terms() [1/2]

virtual const std::vector<Term*>& fl::Variable::terms ( ) const

virtual

Gets an immutable vector of the terms.

Returns: an immutable vector of terms

◆ terms() [2/2]

virtual std::vector<Term*>& fl::Variable::terms ( )

virtual

Gets a mutable vector of the terms.

Returns: a mutable vector of terms

◆ toString()

virtual std::string fl::Variable::toString ( ) const

virtual

Gets a string representation of the variable in the FuzzyLite Language.

Returns: a string representation of the variable in the FuzzyLite Language

See also: FllExporter

Reimplemented in fl::OutputVariable, and fl::InputVariable.

◆ type()

virtual Type fl::Variable::type ( ) const

virtual

Returns the type of the variable.

Returns: the type of the variable

Reimplemented in fl::OutputVariable, and fl::InputVariable.

Member Data Documentation

◆ _description

std::string fl::Variable::_description

protected

Definition at line 52 of file Variable.h.

◆ _enabled

bool fl::Variable::_enabled

protected

Definition at line 56 of file Variable.h.

◆ _lockValueInRange

bool fl::Variable::_lockValueInRange

protected

Definition at line 57 of file Variable.h.

◆ _maximum

scalar fl::Variable::_maximum

protected

Definition at line 55 of file Variable.h.

◆ _minimum

scalar fl::Variable::_minimum

protected

Definition at line 55 of file Variable.h.

◆ _name

std::string fl::Variable::_name

protected

Definition at line 51 of file Variable.h.

◆ _terms

std::vector<Term*> fl::Variable::_terms

protected

Definition at line 53 of file Variable.h.

◆ _value

scalar fl::Variable::_value

protected

Definition at line 54 of file Variable.h.

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

fuzzylite/fl/variable/Variable.h

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ Type

Constructor & Destructor Documentation

◆ Variable() [1/2]

◆ Variable() [2/2]

◆ ~Variable()

Member Function Documentation

◆ addTerm()

◆ clone()

◆ complexity()

◆ fuzzify()

◆ getDescription()

◆ getMaximum()

◆ getMinimum()

◆ getName()

◆ getTerm() [1/2]

◆ getTerm() [2/2]

◆ getValue()

◆ hasTerm()

◆ highestMembership()

◆ insertTerm()

◆ isEnabled()

◆ isLockValueInRange()

◆ numberOfTerms()

◆ operator=()

◆ range()

◆ removeTerm()

◆ setDescription()

◆ setEnabled()

◆ setLockValueInRange()

◆ setMaximum()

◆ setMinimum()

◆ setName()

◆ setRange()

◆ setTerms()

◆ setValue()

◆ sort()

◆ terms() [1/2]

◆ terms() [2/2]

◆ toString()

◆ type()

Member Data Documentation

◆ _description

◆ _enabled

◆ _lockValueInRange

◆ _maximum

◆ _minimum

◆ _name

◆ _terms

◆ _value