add changelog and modify file headers

alvesoaj · May 25, 2018 · 3f10fda · 3f10fda
1 parent 48425ef
commit 3f10fda
Show file tree

Hide file tree

Showing 20 changed files with 99 additions and 82 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,18 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.10] - 2017-08-21
+### Added
+- CHARGELOG.md file to document this project.
+
+### Changed
+- The way that FuzzyOutput truncate trapezoidals funcctions, improve the acurace.
+- File headers with author references.
+
+### Removed
+- None.
diff --git a/Fuzzy.cpp b/Fuzzy.cpp
@@ -4,9 +4,9 @@
  *
  * Fuzzy.cpp
  *
- *      Author: Msc. Marvin Lemos <marvinlemos@gmail.com>
- *              AJ Alves <aj.alves@zerokol.com>
- *          Co authors: Douglas S. Kridi <douglaskridi@gmail.com>
+ *      Author: AJ Alves <aj.alves@zerokol.com>
+ *          Co authors: Msc. Marvin Lemos <marvinlemos@gmail.com>
+ *                      Douglas S. Kridi <douglaskridi@gmail.com>
  *                      Kannya Leal <kannyal@hotmail.com>
  */
 #include "Fuzzy.h"

diff --git a/Fuzzy.h b/Fuzzy.h
@@ -4,9 +4,9 @@
  *
  * Fuzzy.h
  *
- *      Author: Msc. Marvin Lemos <marvinlemos@gmail.com>
- *              AJ Alves <aj.alves@zerokol.com>
- *          Co authors: Douglas S. Kridi <douglaskridi@gmail.com>
+ *      Author: AJ Alves <aj.alves@zerokol.com>
+ *          Co authors: Msc. Marvin Lemos <marvinlemos@gmail.com>
+ *                      Douglas S. Kridi <douglaskridi@gmail.com>
  *                      Kannya Leal <kannyal@hotmail.com>
  */
 #ifndef FUZZY_H

diff --git a/FuzzyComposition.cpp b/FuzzyComposition.cpp
@@ -4,9 +4,9 @@
  *
  * FuzzyComposition.cpp
  *
- *      Author: Msc. Marvin Lemos <marvinlemos@gmail.com>
- *              AJ Alves <aj.alves@zerokol.com>
- *          Co authors: Douglas S. Kridi <douglaskridi@gmail.com>
+ *      Author: AJ Alves <aj.alves@zerokol.com>
+ *          Co authors: Msc. Marvin Lemos <marvinlemos@gmail.com>
+ *                      Douglas S. Kridi <douglaskridi@gmail.com>
  *                      Kannya Leal <kannyal@hotmail.com>
  */
 #include "FuzzyComposition.h"

diff --git a/FuzzyComposition.h b/FuzzyComposition.h
@@ -4,9 +4,9 @@
  *
  * FuzzyComposition.h
  *
- *      Author: Msc. Marvin Lemos <marvinlemos@gmail.com>
- *              AJ Alves <aj.alves@zerokol.com>
- *          Co authors: Douglas S. Kridi <douglaskridi@gmail.com>
+ *      Author: AJ Alves <aj.alves@zerokol.com>
+ *          Co authors: Msc. Marvin Lemos <marvinlemos@gmail.com>
+ *                      Douglas S. Kridi <douglaskridi@gmail.com>
  *                      Kannya Leal <kannyal@hotmail.com>
  */
 #ifndef FUZZYCOMPOSITION_H

diff --git a/FuzzyIO.cpp b/FuzzyIO.cpp
@@ -4,9 +4,9 @@
  *
  * FuzzyIO.cpp
  *
- *      Author: Msc. Marvin Lemos <marvinlemos@gmail.com>
- *              AJ Alves <aj.alves@zerokol.com>
- *          Co authors: Douglas S. Kridi <douglaskridi@gmail.com>
+ *      Author: AJ Alves <aj.alves@zerokol.com>
+ *          Co authors: Msc. Marvin Lemos <marvinlemos@gmail.com>
+ *                      Douglas S. Kridi <douglaskridi@gmail.com>
  *                      Kannya Leal <kannyal@hotmail.com>
  */
 #include "FuzzyIO.h"

diff --git a/FuzzyIO.h b/FuzzyIO.h
@@ -4,9 +4,9 @@
  *
  * FuzzyIO.h
  *
- *      Author: Msc. Marvin Lemos <marvinlemos@gmail.com>
- *              AJ Alves <aj.alves@zerokol.com>
- *          Co authors: Douglas S. Kridi <douglaskridi@gmail.com>
+ *      Author: AJ Alves <aj.alves@zerokol.com>
+ *          Co authors: Msc. Marvin Lemos <marvinlemos@gmail.com>
+ *                      Douglas S. Kridi <douglaskridi@gmail.com>
  *                      Kannya Leal <kannyal@hotmail.com>
  */
 #ifndef FUZZYIO_H

diff --git a/FuzzyInput.cpp b/FuzzyInput.cpp
@@ -4,9 +4,9 @@
  *
  * FuzzyInput.cpp
  *
- *      Author: Msc. Marvin Lemos <marvinlemos@gmail.com>
- *              AJ Alves <aj.alves@zerokol.com>
- *          Co authors: Douglas S. Kridi <douglaskridi@gmail.com>
+ *      Author: AJ Alves <aj.alves@zerokol.com>
+ *          Co authors: Msc. Marvin Lemos <marvinlemos@gmail.com>
+ *                      Douglas S. Kridi <douglaskridi@gmail.com>
  *                      Kannya Leal <kannyal@hotmail.com>
  */
 #include "FuzzyInput.h"

diff --git a/FuzzyInput.h b/FuzzyInput.h
@@ -4,9 +4,9 @@
  *
  * FuzzyInput.h
  *
- *      Author: Msc. Marvin Lemos <marvinlemos@gmail.com>
- *              AJ Alves <aj.alves@zerokol.com>
- *          Co authors: Douglas S. Kridi <douglaskridi@gmail.com>
+ *      Author: AJ Alves <aj.alves@zerokol.com>
+ *          Co authors: Msc. Marvin Lemos <marvinlemos@gmail.com>
+ *                      Douglas S. Kridi <douglaskridi@gmail.com>
  *                      Kannya Leal <kannyal@hotmail.com>
  */
 #ifndef FUZZYINPUT_H

diff --git a/FuzzyOutput.cpp b/FuzzyOutput.cpp
@@ -4,9 +4,9 @@
  *
  * FuzzyOutput.cpp
  *
- *      Author: Msc. Marvin Lemos <marvinlemos@gmail.com>
- *              AJ Alves <aj.alves@zerokol.com>
- *          Co authors: Douglas S. Kridi <douglaskridi@gmail.com>
+ *      Author: AJ Alves <aj.alves@zerokol.com>
+ *          Co authors: Msc. Marvin Lemos <marvinlemos@gmail.com>
+ *                      Douglas S. Kridi <douglaskridi@gmail.com>
  *                      Kannya Leal <kannyal@hotmail.com>
  */
 #include "FuzzyOutput.h"

diff --git a/FuzzyOutput.h b/FuzzyOutput.h
@@ -4,9 +4,9 @@
  *
  * FuzzyOutput.h
  *
- *      Author: Msc. Marvin Lemos <marvinlemos@gmail.com>
- *              AJ Alves <aj.alves@zerokol.com>
- *          Co authors: Douglas S. Kridi <douglaskridi@gmail.com>
+ *      Author: AJ Alves <aj.alves@zerokol.com>
+ *          Co authors: Msc. Marvin Lemos <marvinlemos@gmail.com>
+ *                      Douglas S. Kridi <douglaskridi@gmail.com>
  *                      Kannya Leal <kannyal@hotmail.com>
  */
 #ifndef FUZZYOUTPUT_H

diff --git a/FuzzyRule.cpp b/FuzzyRule.cpp
@@ -4,9 +4,9 @@
  *
  * FuzzyOutput.cpp
  *
- *      Author: Msc. Marvin Lemos <marvinlemos@gmail.com>
- *              AJ Alves <aj.alves@zerokol.com>
- *          Co authors: Douglas S. Kridi <douglaskridi@gmail.com>
+ *      Author: AJ Alves <aj.alves@zerokol.com>
+ *          Co authors: Msc. Marvin Lemos <marvinlemos@gmail.com>
+ *                      Douglas S. Kridi <douglaskridi@gmail.com>
  *                      Kannya Leal <kannyal@hotmail.com>
  */
 #include "FuzzyRule.h"

diff --git a/FuzzyRule.h b/FuzzyRule.h
@@ -4,9 +4,9 @@
  *
  * FuzzyRule.h
  *
- *      Author: Msc. Marvin Lemos <marvinlemos@gmail.com>
- *              AJ Alves <aj.alves@zerokol.com>
- *          Co authors: Douglas S. Kridi <douglaskridi@gmail.com>
+ *      Author: AJ Alves <aj.alves@zerokol.com>
+ *          Co authors: Msc. Marvin Lemos <marvinlemos@gmail.com>
+ *                      Douglas S. Kridi <douglaskridi@gmail.com>
  *                      Kannya Leal <kannyal@hotmail.com>
  */
 #ifndef FUZZYRULE_H

diff --git a/FuzzyRuleAntecedent.cpp b/FuzzyRuleAntecedent.cpp
@@ -4,9 +4,9 @@
  *
  * FuzzyRuleAntecedent.cpp
  *
- *      Author: Msc. Marvin Lemos <marvinlemos@gmail.com>
- *              AJ Alves <aj.alves@zerokol.com>
- *          Co authors: Douglas S. Kridi <douglaskridi@gmail.com>
+ *      Author: AJ Alves <aj.alves@zerokol.com>
+ *          Co authors: Msc. Marvin Lemos <marvinlemos@gmail.com>
+ *                      Douglas S. Kridi <douglaskridi@gmail.com>
  *                      Kannya Leal <kannyal@hotmail.com>
  */
 #include "FuzzyRuleAntecedent.h"

diff --git a/FuzzyRuleAntecedent.h b/FuzzyRuleAntecedent.h
@@ -4,9 +4,9 @@
  *
  * FuzzyRuleAntecedent.h
  *
- *      Author: Msc. Marvin Lemos <marvinlemos@gmail.com>
- *              AJ Alves <aj.alves@zerokol.com>
- *          Co authors: Douglas S. Kridi <douglaskridi@gmail.com>
+ *      Author: AJ Alves <aj.alves@zerokol.com>
+ *          Co authors: Msc. Marvin Lemos <marvinlemos@gmail.com>
+ *                      Douglas S. Kridi <douglaskridi@gmail.com>
  *                      Kannya Leal <kannyal@hotmail.com>
  */
 #ifndef FUZZYRULEANTECEDENT_H

diff --git a/FuzzyRuleConsequent.cpp b/FuzzyRuleConsequent.cpp
@@ -4,9 +4,9 @@
  *
  * FuzzyRuleConsequent.cpp
  *
- *      Author: Msc. Marvin Lemos <marvinlemos@gmail.com>
- *              AJ Alves <aj.alves@zerokol.com>
- *          Co authors: Douglas S. Kridi <douglaskridi@gmail.com>
+ *      Author: AJ Alves <aj.alves@zerokol.com>
+ *          Co authors: Msc. Marvin Lemos <marvinlemos@gmail.com>
+ *                      Douglas S. Kridi <douglaskridi@gmail.com>
  *                      Kannya Leal <kannyal@hotmail.com>
  */
 #include "FuzzyRuleConsequent.h"

diff --git a/FuzzyRuleConsequent.h b/FuzzyRuleConsequent.h
@@ -4,9 +4,9 @@
  *
  * FuzzyRuleConsequent.h
  *
- *      Author: Msc. Marvin Lemos <marvinlemos@gmail.com>
- *              AJ Alves <aj.alves@zerokol.com>
- *          Co authors: Douglas S. Kridi <douglaskridi@gmail.com>
+ *      Author: AJ Alves <aj.alves@zerokol.com>
+ *          Co authors: Msc. Marvin Lemos <marvinlemos@gmail.com>
+ *                      Douglas S. Kridi <douglaskridi@gmail.com>
  *                      Kannya Leal <kannyal@hotmail.com>
  */
 #ifndef FUZZYRULECONSEQUENT_H

diff --git a/FuzzySet.cpp b/FuzzySet.cpp
@@ -4,9 +4,9 @@
  *
  * FuzzySet.cpp
  *
- *      Author: Msc. Marvin Lemos <marvinlemos@gmail.com>
- *              AJ Alves <aj.alves@zerokol.com>
- *          Co authors: Douglas S. Kridi <douglaskridi@gmail.com>
+ *      Author: AJ Alves <aj.alves@zerokol.com>
+ *          Co authors: Msc. Marvin Lemos <marvinlemos@gmail.com>
+ *                      Douglas S. Kridi <douglaskridi@gmail.com>
  *                      Kannya Leal <kannyal@hotmail.com>
  */
 #include "FuzzySet.h"

diff --git a/FuzzySet.h b/FuzzySet.h
@@ -4,9 +4,9 @@
  *
  * FuzzySet.h
  *
- *      Author: Msc. Marvin Lemos <marvinlemos@gmail.com>
- *              AJ Alves <aj.alves@zerokol.com>
- *          Co authors: Douglas S. Kridi <douglaskridi@gmail.com>
+ *      Author: AJ Alves <aj.alves@zerokol.com>
+ *          Co authors: Msc. Marvin Lemos <marvinlemos@gmail.com>
+ *                      Douglas S. Kridi <douglaskridi@gmail.com>
  *                      Kannya Leal <kannyal@hotmail.com>
  */
 #ifndef FUZZYSET_H

diff --git a/README.md b/README.md
@@ -2,9 +2,9 @@
 
 eFLL (Embedded Fuzzy Logic Library) is a standard library for Embedded Systems to implement easy and eficient Fuzzy Systems.
 
-Para informações avançadas, documentação e exemplos de uso em PORTUGUÊS: [eFLL - Uma Biblioteca Fuzzy para Arduino e Sistemas Embarcados](http://www.zerokol.com/2012/09/arduinofuzzy-uma-biblioteca-fuzzy-para.html)
+Para informações avançadas, documentação e exemplos de uso em PORTUGUÊS: [eFLL - Uma Biblioteca Fuzzy para Arduino e Sistemas Embarcados](https://blog.zerokol.com/2012/09/arduinofuzzy-uma-biblioteca-fuzzy-para.html)
 
-For advanced information, documentation, and usage examples in ENGLISH: [eFLL - A Fuzzy Library for Arduino and Embeded Systems](http://www.zerokol.com/2012/09/arduinofuzzy-fuzzy-library-for-arduino.html)
+For advanced information, documentation, and usage examples in ENGLISH: [eFLL - A Fuzzy Library for Arduino and Embeded Systems](https://blog.zerokol.com/2012/09/arduinofuzzy-fuzzy-library-for-arduino.html)
 
 ## Characteristics
 
@@ -20,72 +20,71 @@ Tested with [GTest](http://code.google.com/p/googletest/) for C, Google Inc.
 
 ## How to install (general use)
 
-Step 1: Go to the official project page on GitHub (Here)
+**Step 1:** Go to the official project page on GitHub (Here)
 
-Step 2: Make a clone of the project using Git or download at Donwload on the button "Download as zip."
+**Step 2:** Make a clone of the project using Git or download at Donwload on the button "Download as zip."
 
-Step 3: Clone or unzip (For safety, rename the folder to "eFLL") the files into some folder
+**Step 3:** Clone or unzip (For safety, rename the folder to "eFLL") the files into some folder
 
-Step 4: Compile and link it to your code (See Makefile)
+**Step 4:** Compile and link it to your code (See Makefile)
 
 ## How to install (and import to use with Arduino)
 
-Step 1: Go to the official project page on GitHub (Here)
+**Step 1:** Go to the official project page on GitHub (Here)
 
-Step 2: Make a clone of the project using Git or download at Donwload on the button "Download as zip."
+**Step 2:** Make a clone of the project using Git or download at Donwload on the button "Download as zip."
 
-Step 3: Clone or unzip (For safety, rename the folder to "eFLL") the files into Arduino libraries' folder:
+**Step 3:** Clone or unzip (For safety, rename the folder to "eFLL") the files into Arduino libraries' folder:
 
 Ubuntu (/usr/share/arduino/libraries/) if installed via apt-get, if not, on Windows, Mac or Linux (where you downloaded the Arduino IDE, the Library folder is inside)
 
-Ok! The library is ready to be used.
+_Ok! The library is ready to be used._
 
 If the installation of the library has been successfully held, to import the library is easy:
 
-Step 4: Open your Arduino IDE, check out the tab on the top menu SKETCKS → LIBRARY → Import eFLL
+**Step 4:** Open your Arduino IDE, check out the tab on the top menu SKETCKS → LIBRARY → Import eFLL
 
-## Brief documentation
+## Brief Documentation
 
-PARA MAIORES INFORMAÇÕES VISITE OS LINKS NO TOPO
+_PARA MAIORES INFORMAÇÕES VISITE OS LINKS NO TOPO_
 
-FOR MORE INFORMATIONS VISITE THE LINKS ON THE TOP
+_FOR MORE INFORMATIONS VISITE THE LINKS ON THE TOP_
 
-Fuzzy object - This object includes all the Fuzzy System, through it, you can manipulate the Fuzzy Sets, Linguistic Rules, inputs and outputs.
+**Fuzzy object** - This object includes all the Fuzzy System, through it, you can manipulate the Fuzzy Sets, Linguistic Rules, inputs and outputs.
 
-FuzzyInput object - This object groups all entries Fuzzy Sets that belongs to the same domain.
+**FuzzyInput** object - This object groups all entries Fuzzy Sets that belongs to the same domain.
 
-FuzzyOutput object - This object is similar to FuzzyInput, is used to group all output Fuzzy Sets thar belongs to the same domain.
+**FuzzyOutput** object - This object is similar to FuzzyInput, is used to group all output Fuzzy Sets thar belongs to the same domain.
 
-FuzzySet object - This is one of the main objects of Fuzzy Library, with each set is possible to model the system in question. Currently the library supports triangular membership functions, trapezoidal and singleton, which are assembled based on points A, B, C and D, they are passed by parameter in its constructor FuzzySet(float a, float b, float c, float d):
+**FuzzySet** object - This is one of the main objects of Fuzzy Library, with each set is possible to model the system in question. Currently the library supports triangular membership functions, trapezoidal and singleton, which are assembled based on points A, B, C and D, they are passed by parameter in its constructor FuzzySet(float a, float b, float c, float d).
 
-FuzzyRule object - This object is used to mount the base rule of Fuzzy object, which contains one or more of this object. Instantiated with FuzzyRule fr = new FuzzyRule (ID, antecedent, consequent)
+**FuzzyRule** object - This object is used to mount the base rule of Fuzzy object, which contains one or more of this object. Instantiated with FuzzyRule fr = new FuzzyRule (ID, antecedent, consequent).
 
-FuzzyRuleAntecedent object - This object is used to compound the object FuzzyRule, responsible for assembling the antecedent of the conditional expression of a FuzzyRule:
+**FuzzyRuleAntecedent** object - This object is used to compound the object FuzzyRule, responsible for assembling the antecedent of the conditional expression of a FuzzyRule.
 
-FuzzyRuleConsequente object - This object is used to render the object FuzzyRule, responsible for assembling the output expression of a FuzzyRule:
+**FuzzyRuleConsequente** object - This object is used to render the object FuzzyRule, responsible for assembling the output expression of a FuzzyRule.
 
-## Tip
+## Tips
 
 These are all eFLL library objects that are used in the process. The next step, generally interactive is handled by three methods of the Fuzzy Class first:
 
-bool setInput(int id, float value);
+`bool setInput(int id, float value);`
 
 It is used to pass the Crispe input value to the system note that the first parameter is the FuzzyInput object' ID which parameter value is intended.
 
-bool fuzzify();
+`bool fuzzify();`
 
 It is used to start the fuzzification process, composition and inference.
 
 And finally:
 
-float defuzzify(int id);
+`float defuzzify(int id);`
 
 ## REFERENCES
 
-Authors: AJ Alves <aj.alves@zerokol.com>, Msc. Marvin Lemos <marvinlemos@gmail.com>;
-        Co authors: Douglas S. Kridi <douglaskridi@gmail.com>, Kannya Leal <kannyal@hotmail.com>
+**Authors:** AJ Alves <aj.alves@zerokol.com>; **Co authors:** Msc. Marvin Lemos <marvinlemos@gmail.com>, Douglas S. Kridi <douglaskridi@gmail.com>, Kannya Leal <kannyal@hotmail.com>
 
-## Special Thanks to contributors:
+## Special Thanks to Contributors:
 
 [@mikebutrimov](https://github.com/mikebutrimov), [@tzikis](https://github.com/tzikis), [@na7an](https://github.com/na7an)