diff options
Diffstat (limited to 'fuzzylite/fl/term/Rectangle.h')
-rw-r--r-- | fuzzylite/fl/term/Rectangle.h | 74 |
1 files changed, 57 insertions, 17 deletions
diff --git a/fuzzylite/fl/term/Rectangle.h b/fuzzylite/fl/term/Rectangle.h index 23b5eda..0e29cd2 100644 --- a/fuzzylite/fl/term/Rectangle.h +++ b/fuzzylite/fl/term/Rectangle.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_RECTANGLE_H @@ -29,8 +21,19 @@ namespace fl { + /** + The Rectangle class is a basic Term that represents the rectangle + membership function. + + @image html rectangle.svg + + @author Juan Rada-Vilela, Ph.D. + @see Term + @see Variable + @since 4.0 + */ class FL_API Rectangle : public Term { - protected: + private: scalar _start, _end; public: @@ -42,21 +45,58 @@ namespace fl { FL_DEFAULT_COPY_AND_MOVE(Rectangle) virtual std::string className() const FL_IOVERRIDE; + /** + Returns the parameters of the term + @return `"start end [height]"` + */ virtual std::string parameters() const FL_IOVERRIDE; + /** + Configures the term with the parameters + @param parameters as `"start end [height]"` + */ virtual void configure(const std::string& parameters) FL_IOVERRIDE; + virtual Complexity complexity() const FL_IOVERRIDE; + + /** + Computes the membership function evaluated at @f$x@f$ + @param x + @return @f$\begin{cases} + 1h & \mbox{if $x \in [s, e]$} \cr + 0h & \mbox{otherwise} + \end{cases}@f$ + + where @f$h@f$ is the height of the Term, + @f$s@f$ is the start of the Rectangle, + @f$e@f$ is the end of the Rectangle. + */ virtual scalar membership(scalar x) const FL_IOVERRIDE; + /** + Sets the start of the rectangle + @param start is the start of the rectangle + */ virtual void setStart(scalar start); + /** + Gets the start of the rectangle + @return the start of the rectangle + */ virtual scalar getStart() const; + /** + Sets the end of the rectangle + @param end is the end of the rectangle + */ virtual void setEnd(scalar end); + /** + Gets the end of the rectangle + @return the end of the rectangle + */ virtual scalar getEnd() const; virtual Rectangle* clone() const FL_IOVERRIDE; static Term* constructor(); }; - } #endif /* FL_RECTANGLE_H */ |