LocallyLinearEmbedding.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) 2011 Sergey Lisitsyn
 * Copyright (C) 2011 Berlin Institute of Technology and Max-Planck-Society
 */

#ifndef LOCALLYLINEAREMBEDDING_H_
#define LOCALLYLINEAREMBEDDING_H_
#include <shogun/lib/config.h>
#ifdef HAVE_LAPACK
#include <shogun/converter/EmbeddingConverter.h>
#include <shogun/features/Features.h>
#include <shogun/features/SimpleFeatures.h>
#include <shogun/distance/Distance.h>

namespace shogun
{

class CFeatures;
class CDistance;

class CLocallyLinearEmbedding: public CEmbeddingConverter
{
public:

    CLocallyLinearEmbedding();

    virtual ~CLocallyLinearEmbedding();

    virtual CFeatures* apply(CFeatures* features);

    void set_k(int32_t k);

    int32_t get_k() const;

    void set_max_k(int32_t max_k);

    int32_t get_max_k() const;

    void set_auto_k(bool auto_k);

    bool get_auto_k() const;

    void set_reconstruction_shift(float64_t reconstruction_shift);

    float64_t get_reconstruction_shift() const;

    void set_nullspace_shift(float64_t nullspace_shift);

    float64_t get_nullspace_shift() const;

    void set_use_arpack(bool use_arpack);

    bool get_use_arpack() const;

    virtual const char* get_name() const;

protected:

    void init();

    virtual SGMatrix<float64_t> construct_weight_matrix(CSimpleFeatures<float64_t>* simple_features,float64_t* W_matrix, 
                                                            SGMatrix<int32_t> neighborhood_matrix);

    virtual SGMatrix<float64_t> construct_embedding(SGMatrix<float64_t> matrix,int dimension);

    virtual SGMatrix<int32_t> get_neighborhood_matrix(SGMatrix<float64_t> distance_matrix, int32_t k);

    int32_t estimate_k(CSimpleFeatures<float64_t>* simple_features, SGMatrix<int32_t> neighborhood_matrix);

    float64_t compute_reconstruction_error(int32_t k, int dim, int N, float64_t* feature_matrix,
                                           float64_t* z_matrix, float64_t* covariance_matrix,
                                           float64_t* resid_vector, float64_t* id_vector,
                                           SGMatrix<int32_t> neighborhood_matrix);

protected:

    int32_t m_k;

    int32_t m_max_k;

    float64_t m_reconstruction_shift;

    float64_t m_nullspace_shift;

    bool m_use_arpack;

    bool m_auto_k;

protected:

    static void* run_neighborhood_thread(void* p);

    static void* run_linearreconstruction_thread(void* p);

};
}

#endif /* HAVE_LAPACK */
#endif /* LOCALLYLINEAREMBEDDING_H_ */