new upstream version 6.0

1 files changed, 57 insertions, 18 deletions

diff --git a/fuzzylite/fl/term/Cosine.h b/fuzzylite/fl/term/Cosine.h
index 510669f..b45ab85 100644
--- a/fuzzylite/fl/term/Cosine.h
+++ b/fuzzylite/fl/term/Cosine.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_COSINE_H
@@ -29,8 +21,20 @@
 
 namespace fl {
 
+    /**
+      The Cosine class is an extended Term that represents the cosine
+      membership function.
+
+      @image html cosine.svg
+
+      @author Juan Rada-Vilela, Ph.D.
+      @see Term
+      @see Variable
+      @since 5.0
+     */
+
     class FL_API Cosine : public Term {
-    protected:
+    private:
         scalar _center, _width;
     public:
         explicit Cosine(const std::string& name = "",
@@ -41,15 +45,51 @@ namespace fl {
         FL_DEFAULT_COPY_AND_MOVE(Cosine)
 
         virtual std::string className() const FL_IOVERRIDE;
+        /**
+          Returns the parameters of the term
+          @return `"center width [height]"`
+         */
         virtual std::string parameters() const FL_IOVERRIDE;
+        /**
+          Configures the term with the parameters
+          @param parameters as `"center width [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}
+          0h & \mbox{if $x < c - 0.5w \vee x > c + 0.5w$} \cr
+          0.5h \times ( 1 + \cos(2.0 / w\pi(x-c))) & \mbox{otherwise}
+          \end{cases}@f$
+
+          where @f$h@f$ is the height of the Term,
+                @f$c@f$ is the center of the Cosine,
+                @f$w@f$ is the width of the Cosine
+         */
         virtual scalar membership(scalar x) const FL_IOVERRIDE;
-
+        /**
+          Sets the center of the cosine
+          @param center is the center of the cosine
+         */
         virtual void setCenter(scalar center);
+        /**
+          Gets the center of the cosine
+          @return the center of the cosine
+         */
         virtual scalar getCenter() const;
 
+        /**
+          Sets the width of the cosine
+          @param width is the width of the cosine
+         */
         virtual void setWidth(scalar width);
+        /**
+          Gets the width of the cosine
+          @return the width of the cosine
+         */
         virtual scalar getWidth() const;
 
         virtual Cosine* clone() const FL_IOVERRIDE;
@@ -57,6 +97,5 @@ namespace fl {
         static Term* constructor();
     };
 }
-
 #endif  /* FL_COSINE_H */