diff options
Diffstat (limited to 'fuzzylite/fl/Console.h')
| -rw-r--r-- | fuzzylite/fl/Console.h | 143 |
1 files changed, 104 insertions, 39 deletions
diff --git a/fuzzylite/fl/Console.h b/fuzzylite/fl/Console.h index 59e818d..b96d677 100644 --- a/fuzzylite/fl/Console.h +++ b/fuzzylite/fl/Console.h @@ -1,32 +1,23 @@ /* - 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_CONSOLE_H #define FL_CONSOLE_H #include "fl/fuzzylite.h" - #include <map> #include <string> #include <vector> @@ -34,57 +25,131 @@ namespace fl { class Engine; + /** + The Console class is a command-line tool that helps to utilize the + `fuzzylite` library. + + @author Juan Rada-Vilela, Ph.D. + @since 4.0 + */ class FL_API Console { public: + /** + A command-line option given by key, value and description + */ struct Option { std::string key, value, description; - explicit Option(const std::string& key = "", const std::string& value = "", const std::string& description = "") : - key(key), value(value), description(description) { - } + explicit Option(const std::string& key = "", + const std::string& value = "", + const std::string& description = ""); }; + /**Keyword for input file*/ static const std::string KW_INPUT_FILE; + /**Keyword for input file format*/ static const std::string KW_INPUT_FORMAT; + /**Keyword for output file*/ static const std::string KW_OUTPUT_FILE; + /**Keyword for output file format*/ static const std::string KW_OUTPUT_FORMAT; + /**Keyword for built-in example*/ static const std::string KW_EXAMPLE; + /**Keyword for number of decimals*/ static const std::string KW_DECIMALS; - static const std::string KW_DATA_INPUT; - static const std::string KW_DATA_MAXIMUM; + /**Keyword for file containing input data*/ + static const std::string KW_DATA_INPUT_FILE; + /**Keyword for number of values to generate*/ + static const std::string KW_DATA_VALUES; + /**Keyword for the scope of the number of values to generate*/ + static const std::string KW_DATA_VALUES_SCOPE; + /**Keyword for exporting headers in FLD*/ static const std::string KW_DATA_EXPORT_HEADER; + /**Keyword for exporting input values in FLD*/ static const std::string KW_DATA_EXPORT_INPUTS; + /** + Creates a new Mamdani Engine based on the SimpleDimmer example + @return a new Mamdani Engine based on the SimpleDimmer example + */ static Engine* mamdani(); + /** + Creates a new TakagiSugeno Engine based on the Approximation example of @f$sin(x)/x@f$ + @return a new TakagiSugeno Engine based on the Approximation example of @f$sin(x)/x@f$ + */ static Engine* takagiSugeno(); + /** + Creates a new Hybrid Engine based on the Tipper example using Mamdani + and TakagiSugeno outputs. + @return a new Hybrid Engine based on the Tipper example using Mamdani + and TakagiSugeno outputs. + */ + static Engine* hybrid(); + + protected: - static std::map<std::string, std::string> parse(int argc, char** argv); - static void process(const std::map<std::string, std::string>& options); + virtual std::map<std::string, std::string> parse(int argc, const char* argv[]); + virtual void process(const std::map<std::string, std::string>& options); - static void process(const std::string& input, std::ostream& writer, + virtual void process(const std::string& input, std::ostream& writer, const std::string& inputFormat, const std::string& outputFormat, const std::map<std::string, std::string>& options); - static int readCharacter(); - static void interactive(std::ostream& writer, Engine* engine); - static std::string interactiveHelp(); - - static void exportAllExamples(const std::string& from, const std::string& to); - static void exportAllExamples(const std::string& from, const std::string& to, const std::string& path); -#ifdef FL_CPP11 - static void benchmarkExamples(const std::string& path, int runs); -#endif + virtual int readCharacter(); + virtual void interactive(std::ostream& writer, Engine* engine); + virtual std::string interactiveHelp(); + + virtual void exportAllExamples(const std::string& from, const std::string& to); + virtual void exportAllExamples(const std::string& from, const std::string& to, + const std::string& examplesPath, const std::string& outputPath); + + /** + Benchmarks the engine described in the FLL file against the dataset + contained in the FLD file. + + @param fllFile is the file describing the engine in FLL format + @param fldFile is the file containing the dataset in FLD format + @param runs is the number of runs to evaluate the benchmarks + @param writer is the output where the results will be written to + @throws Exception if something goes wrong reading the files, importing the + engines or evaluating the benchmark + */ + + virtual void benchmark(const std::string& fllFile, const std::string& fldFile, + int runs, std::ofstream* writer = fl::null) const; + /** + Benchmarks the list of engines against the list of datasets, both described + as absolute or relative paths + + @param fllFileList is the file containing the list of paths of engines in + FLL format + @param fldFileList is the file containing the list of paths of datasets in + FLD format + @param runs is the number of runs to evaluate the benchmarks + @param writer is the output where the results will be written to + @throws Exception if something goes wrong reading the files, importing the + engines or evaluating the benchmark + */ + virtual void benchmarks(const std::string& fllFileList, const std::string& fldFileList, + int runs, std::ofstream* writer = fl::null) const; public: - static std::string usage(); - static std::vector<Option> availableOptions(); - - static int main(int argc, char** argv); + /** + Returns a string representation of the usage of the command-line tool + @return a string representation of the usage of the command-line tool + */ + virtual std::string usage(); + + /** + Returns a vector of the options available from the command line + @return a vector of the options available from the command line + */ + virtual std::vector<Option> availableOptions(); + + static int main(int argc, const char* argv[]); }; - } - #endif /* FL_CONSOLE_H */ |