diff options
Diffstat (limited to 'fuzzylite/fl/rule/Expression.h')
-rw-r--r-- | fuzzylite/fl/rule/Expression.h | 93 |
1 files changed, 71 insertions, 22 deletions
diff --git a/fuzzylite/fl/rule/Expression.h b/fuzzylite/fl/rule/Expression.h index cb48355..dbacc60 100644 --- a/fuzzylite/fl/rule/Expression.h +++ b/fuzzylite/fl/rule/Expression.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_EXPRESSION_H @@ -37,48 +29,105 @@ namespace fl { class Hedge; class Term; + /** + The Expression class is the base class to build an expression tree. + + @author Juan Rada-Vilela, Ph.D. + @see Antecedent + @see Consequent + @see Rule + @since 4.0 + */ class FL_API Expression { public: + enum Type { + Proposition, Operator + }; Expression(); virtual ~Expression(); + /** + Returns the type of the expression + @return the type of the expression + */ + virtual Type type() const = 0; virtual std::string toString() const = 0; private: FL_DISABLE_COPY(Expression) }; - class FL_API Proposition : public Expression { + /** + The Proposition class is an Expression that represents a terminal node in + the expression tree as `variable is [hedge]* term`. + + @author Juan Rada-Vilela, Ph.D. + @see Antecedent + @see Consequent + @see Rule + @since 4.0 + */ + class FL_API Proposition FL_IFINAL : public Expression { public: + /**Variable in `variable is [hedge]* term`*/ Variable* variable; + /**Hedge%s in `variable is [hedge]* term`, owned by the object, + destroyed on destructor*/ std::vector<Hedge*> hedges; + /**Term in `variable is [hedge]* term`*/ Term* term; Proposition(); - virtual ~Proposition() FL_IOVERRIDE; + ~Proposition() FL_IOVERRIDE; + + Expression::Type type() const FL_IOVERRIDE; + + /** + Returns a string representation of the proposition + @return a string representation of the proposition + */ + std::string toString() const FL_IOVERRIDE; - virtual std::string toString() const FL_IOVERRIDE; private: FL_DISABLE_COPY(Proposition) }; - class FL_API Operator : public Expression { + /** + The Operator class is an Expression that represents a non-terminal node + in the expression tree as a binary operator (i.e., `and` or `or`) on two + Expression nodes. + + @author Juan Rada-Vilela, Ph.D. + @see Antecedent + @see Consequent + @see Rule + @since 4.0 + */ + class FL_API Operator FL_IFINAL : public Expression { public: + /**Name of the operator*/ std::string name; + /**Left expression in the binary tree*/ Expression* left; + /**Right expression in the binary tree*/ Expression* right; Operator(); - virtual ~Operator() FL_IOVERRIDE; + ~Operator() FL_IOVERRIDE; + + Expression::Type type() const FL_IOVERRIDE; - virtual std::string toString() const FL_IOVERRIDE; + /** + Returns the name of the operator + @return the name of the operator + */ + std::string toString() const FL_IOVERRIDE; private: FL_DISABLE_COPY(Operator) }; - } #endif /* FL_FUZZYEXPRESSION_H */ |