LMNN.h

Go to the documentation of this file.

/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * Written (W) 2013 Fernando J. Iglesias Garcia
 * Copyright (C) 2013 Fernando J. Iglesias Garcia
 */

#ifndef LMNN_H_
#define LMNN_H_

#include <shogun/lib/config.h>

#ifdef HAVE_EIGEN3
#ifdef HAVE_LAPACK

#include <shogun/base/SGObject.h>
#include <shogun/distance/CustomMahalanobisDistance.h>
#include <shogun/features/DenseFeatures.h>
#include <shogun/labels/MulticlassLabels.h>
#include <shogun/lib/SGMatrix.h>

namespace shogun
{

// Forward declaration
class CLMNNStatistics;

class CLMNN : public CSGObject
{
    public:
        CLMNN();

        CLMNN(CDenseFeatures<float64_t>* features, CMulticlassLabels* labels, int32_t k);

        virtual ~CLMNN();

        virtual const char* get_name() const;

        void train(SGMatrix<float64_t> init_transform=SGMatrix<float64_t>());

        SGMatrix<float64_t> get_linear_transform() const;

        CCustomMahalanobisDistance* get_distance() const;

        int32_t get_k() const;

        void set_k(const int32_t k);

        float64_t get_regularization() const;

        void set_regularization(const float64_t regularization);

        float64_t get_stepsize() const;

        void set_stepsize(const float64_t stepsize);

        float64_t get_stepsize_threshold() const;

        void set_stepsize_threshold(const float64_t stepsize_threshold);

        uint32_t get_maxiter() const;

        void set_maxiter(const uint32_t maxiter);

        uint32_t get_correction() const;

        void set_correction(const uint32_t correction);

        float64_t get_obj_threshold() const;

        void set_obj_threshold(const float64_t obj_threshold);

        bool get_diagonal() const;

        void set_diagonal(const bool diagonal);

        CLMNNStatistics* get_statistics() const;

    private:
        void init();

    private:
        SGMatrix<float64_t> m_linear_transform;

        CFeatures* m_features;

        CLabels* m_labels;

        float64_t m_regularization;

        int32_t m_k;

        float64_t m_stepsize;

        float64_t m_stepsize_threshold;

        uint32_t m_maxiter;

        uint32_t m_correction;

        float64_t m_obj_threshold;

        bool m_diagonal;

        CLMNNStatistics* m_statistics;

}; /* class CLMNN */

class CLMNNStatistics : public CSGObject
{
    public:
        CLMNNStatistics();

        virtual ~CLMNNStatistics();

        virtual const char* get_name() const;

        void resize(int32_t size);

        void set(index_t iter, float64_t obj_iter, float64_t stepsize_iter, uint32_t num_impostors_iter);

    private:
        void init();

    public:
        SGVector<float64_t> obj;

        SGVector<float64_t> stepsize;

        SGVector<uint32_t> num_impostors;
};

} /* namespace shogun */

#endif /* HAVE_LAPACK */
#endif /* HAVE_EIGEN3 */

#endif /* LMNN_H_ */