EuclideanDistance.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) 2007-2009 Soeren Sonnenburg
 * Written (W) 2016 Soumyajit De
 * Copyright (C) 2007-2009 Fraunhofer Institute FIRST and Max-Planck-Society
 */

#ifndef _EUCLIDEANDISTANCE_H__
#define _EUCLIDEANDISTANCE_H__

#include <shogun/lib/config.h>
#include <shogun/distance/Distance.h>

namespace shogun
{

class CFeatures;
class CDotFeatures;
template <typename T> class SGVector;

class CEuclideanDistance: public CDistance
{
public:
    CEuclideanDistance();

    CEuclideanDistance(CDotFeatures* l, CDotFeatures* r);

    virtual ~CEuclideanDistance();

    virtual bool init(CFeatures* l, CFeatures* r);

    virtual void cleanup();

    virtual EDistanceType get_distance_type() { return D_EUCLIDEAN; }

    virtual EFeatureClass get_feature_class() { return C_ANY; }

    virtual EFeatureType get_feature_type() { return F_DREAL; }

    virtual const char* get_name() const { return "EuclideanDistance"; }

    virtual bool get_disable_sqrt() { return disable_sqrt; };

    virtual void set_disable_sqrt(bool state) { disable_sqrt=state; };

    virtual float64_t distance_upper_bounded(int32_t idx_a, int32_t idx_b, float64_t upper_bound);

    virtual void precompute_rhs();

    virtual void precompute_lhs();

    virtual void reset_precompute();

    virtual CFeatures* replace_rhs(CFeatures* rhs);

    virtual CFeatures* replace_lhs(CFeatures* lhs);

protected:
    virtual float64_t compute(int32_t idx_a, int32_t idx_b);

    bool disable_sqrt;

    SGVector<float64_t> m_rhs_squared_norms;

    SGVector<float64_t> m_lhs_squared_norms;

private:
    void register_params();

};

} // namespace shogun
#endif /* _EUCLIDEANDISTANCE_H__ */