SimpleSVM.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Hendrik Weisser $
// $Authors: Hendrik Weisser $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/DATASTRUCTURES/DefaultParamHandler.h>
 
// Remove libSVM header include
// #include <svm.h>
 
#include <map>
#include <vector>
#include <utility> // for "pair"
#include <tuple>
#include <memory> // for std::unique_ptr
 
namespace OpenMS
{
  class OPENMS_DLLAPI SimpleSVM :
    public DefaultParamHandler
  {
 
  public:
    typedef std::map<String, std::vector<double> > PredictorMap;
 
    typedef std::map<String, std::pair<double, double> > ScaleMap;
 
    struct Prediction
    {
      double outcome;
 
      std::map<double, double> probabilities;
    };
 
    SimpleSVM();
 
    ~SimpleSVM() override;
 
    // Prevent copy and assignment
    SimpleSVM(const SimpleSVM&) = delete;
    SimpleSVM& operator=(const SimpleSVM&) = delete;
 
    void setup(PredictorMap& predictors, const std::map<Size, double>& outcomes, bool classification = true);
 
    void predict(std::vector<Prediction>& predictions,
                 std::vector<Size> indexes = std::vector<Size>()) const;
 
    void predict(PredictorMap& predictors, std::vector<Prediction>& predictions) const;
 
    void getFeatureWeights(std::map<String, double>& feature_weights) const;
 
    void writeXvalResults(const String& path) const;
 
    const ScaleMap& getScaling() const;
 
  protected:
    // Forward declaration of implementation class
    class Impl;
    
    // Pointer to implementation (Pimpl pattern)
    std::unique_ptr<Impl> pimpl_;
  };
}