diff options
Diffstat (limited to 'fuzzylite/fl/variable/InputVariable.h')
| -rw-r--r-- | fuzzylite/fl/variable/InputVariable.h | 48 |
1 files changed, 28 insertions, 20 deletions
diff --git a/fuzzylite/fl/variable/InputVariable.h b/fuzzylite/fl/variable/InputVariable.h index bba3c7d..3201e3d 100644 --- a/fuzzylite/fl/variable/InputVariable.h +++ b/fuzzylite/fl/variable/InputVariable.h @@ -1,25 +1,17 @@ /* - Author: Juan Rada-Vilela, Ph.D. - Copyright (C) 2010-2014 FuzzyLite Limited - All rights reserved + fuzzylite (R), a fuzzy logic control library in C++. + Copyright (C) 2010-2017 FuzzyLite Limited. All rights reserved. + Author: Juan Rada-Vilela, Ph.D. <jcrada@fuzzylite.com> This file is part of fuzzylite. fuzzylite is free software: you can redistribute it and/or modify it under - the terms of the GNU Lesser General Public License as published by the Free - Software Foundation, either version 3 of the License, or (at your option) - any later version. + the terms of the FuzzyLite License included with the software. - fuzzylite is distributed in the hope that it will be useful, but WITHOUT - ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or - FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License - for more details. - - You should have received a copy of the GNU Lesser General Public License - along with fuzzylite. If not, see <http://www.gnu.org/licenses/>. - - fuzzylite™ is a trademark of FuzzyLite Limited. + You should have received a copy of the FuzzyLite License along with + fuzzylite. If not, see <http://www.fuzzylite.com/license/>. + fuzzylite is a registered trademark of FuzzyLite Limited. */ #ifndef FL_INPUTVARIABLE_H @@ -29,9 +21,17 @@ namespace fl { + /** + The InputVariable class is a Variable that represents an input of the + fuzzy logic controller. + + @author Juan Rada-Vilela, Ph.D. + @see Variable + @see OutputVariable + @see Term + @since 4.0 + */ class FL_API InputVariable : public Variable { - protected: - scalar _inputValue; public: explicit InputVariable(const std::string& name = "", scalar minimum = -fl::inf, @@ -39,14 +39,22 @@ namespace fl { virtual ~InputVariable() FL_IOVERRIDE; FL_DEFAULT_COPY_AND_MOVE(InputVariable) - virtual void setInputValue(scalar inputValue); - virtual scalar getInputValue() const; + /** + Evaluates the membership function of the current input value @f$x@f$ + for each term @f$i@f$, resulting in a fuzzy input value in the form + @f$\tilde{x}=\sum_i{\mu_i(x)/i}@f$. This is equivalent to a call to + Variable::fuzzify() passing @f$x@f$ as input value + @return the fuzzy input value expressed as @f$\sum_i{\mu_i(x)/i}@f$ + */ virtual std::string fuzzyInputValue() const; + virtual Variable::Type type() const FL_IOVERRIDE; + virtual std::string toString() const FL_IOVERRIDE; - }; + virtual InputVariable* clone() const FL_IOVERRIDE; + }; } #endif /* FL_INPUTVARIABLE_H */ |