knnClassification.h

Go to the documentation of this file.

//
//  knnClassification.h
//  RapidLib
//
//  Created by mzed on 05/09/2016.
//  Copyright © 2016 Goldsmiths. All rights reserved.
//
 
#ifndef KNNCLASSIFICATION_H
#define KNNCLASSIFICATION_H
 
#include <vector>
#include "baseModel.h"
 
#ifndef EMSCRIPTEN
#include "../dependencies/json/json.h"
#endif
 
template<typename T>
class knnClassification final : public baseModel<T>
{
  public:
  knnClassification(const int &num_inputs,
                    const std::vector<size_t> &which_inputs,
                    const std::vector<trainingExampleTemplate<T> > &trainingSet,
                    const int k);
 
  ~knnClassification();
 
  void addNeighbour(const int classNum, const std::vector<T>& features);
 
  T run(const std::vector<T>& inputVector) override;
 
  void train(const std::vector<trainingExampleTemplate<T> >& trainingSet) override;
 
  void train(const std::vector<trainingExampleTemplate<T>>& trainingSet, const std::size_t whichOutput) override;
 
  void reset() override;
 
  size_t getNumInputs() const override;
 
  std::vector<size_t> getWhichInputs() const override;
 
  int getK() const;
 
  void setK(int newK);
 
#ifndef EMSCRIPTEN
  void getJSONDescription(Json::Value& currentModel) override;
#endif
 
  private:
  int numInputs {};
  std::vector<size_t> whichInputs {};
  std::size_t whichOutput {};
  std::vector<trainingExampleTemplate<T>> neighbours {};
  int desiredK {}; //K that user asked for might be limited but number of examples
  int currentK {}; //K minimum of desiredK or neighbours.size()
  inline void updateK();
};
 
#endif