nearest_neighbor_classifier.hpp
Go to the documentation of this file.
1 // Copyright (c) 2012, 2019 Scott Niekum, Joshua Whitley
2 // All rights reserved.
3 //
4 // Software License Agreement (BSD License 2.0)
5 //
6 // Redistribution and use in source and binary forms, with or without
7 // modification, are permitted provided that the following conditions
8 // are met:
9 //
10 // * Redistributions of source code must retain the above copyright
11 // notice, this list of conditions and the following disclaimer.
12 // * Redistributions in binary form must reproduce the above
13 // copyright notice, this list of conditions and the following
14 // disclaimer in the documentation and/or other materials provided
15 // with the distribution.
16 // * Neither the name of {copyright_holder} nor the names of its
17 // contributors may be used to endorse or promote products derived
18 // from this software without specific prior written permission.
19 //
20 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23 // FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24 // COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25 // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26 // BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27 // LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 // CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 // LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30 // ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 // POSSIBILITY OF SUCH DAMAGE.
32 
33 #ifndef ML_CLASSIFIERS__NEAREST_NEIGHBOR_CLASSIFIER_HPP_
34 #define ML_CLASSIFIERS__NEAREST_NEIGHBOR_CLASSIFIER_HPP_
35 
36 #include <map>
37 #include <string>
38 #include <vector>
39 
41 
42 namespace ml_classifiers
43 {
44 
45 using CPoint = std::vector<double>;
46 using CPointList = std::vector<CPoint>;
47 using ClassMap = std::map<std::string, CPointList>;
48 
50 {
51 public:
53 
56 
57  void save(const std::string filename);
58  bool load(const std::string filename);
59  void addTrainingPoint(std::string target_class, const std::vector<double> point);
60  void train();
61  void clear();
62  std::string classifyPoint(const std::vector<double> point);
63 };
64 
65 } // namespace ml_classifiers
66 
67 #endif // ML_CLASSIFIERS__NEAREST_NEIGHBOR_CLASSIFIER_HPP_
std::vector< double > CPoint
std::map< std::string, CPointList > ClassMap
void addTrainingPoint(std::string target_class, const std::vector< double > point)
std::string classifyPoint(const std::vector< double > point)
std::vector< CPoint > CPointList


ml_classifiers
Author(s): Scott Niekum , Joshua Whitley
autogenerated on Tue May 14 2019 02:28:35