BinnedDotFeatures.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.
 *
 * Copyright (C) 2012 Soeren Sonnenburg
 */

#ifndef _BINNED_DOTFEATURES_H___
#define _BINNED_DOTFEATURES_H___

#include <shogun/lib/common.h>
#include <shogun/features/DotFeatures.h>
#include <shogun/features/DenseFeatures.h>

namespace shogun
{
    template <class T> class CDenseFeatures;

class CBinnedDotFeatures : public CDotFeatures
{
    public:
        CBinnedDotFeatures(int32_t size=0);

        CBinnedDotFeatures(const CBinnedDotFeatures & orig);

        CBinnedDotFeatures(CDenseFeatures<float64_t>* sf, SGMatrix<float64_t> bins);

        virtual ~CBinnedDotFeatures();

        virtual int32_t get_dim_feature_space() const;

        virtual float64_t dot(int32_t vec_idx1, CDotFeatures* df, int32_t vec_idx2);

        virtual float64_t dense_dot(int32_t vec_idx1, const float64_t* vec2, int32_t vec2_len);

        virtual void add_to_dense_vec(float64_t alpha, int32_t vec_idx1, float64_t* vec2, int32_t vec2_len, bool abs_val=false);

        virtual int32_t get_nnz_features_for_vector(int32_t num);

        virtual void* get_feature_iterator(int32_t vector_index);

        virtual bool get_next_feature(int32_t& index, float64_t& value, void* iterator);

        virtual void free_feature_iterator(void* iterator);


        bool get_fill();

        void set_fill(bool fill);

        bool get_norm_one();

        void set_norm_one(bool norm_one);

        void set_simple_features(CDenseFeatures<float64_t>* features);

        CDenseFeatures<float64_t>* get_simple_features();

        void set_bins(SGMatrix<float64_t> bins);

        SGMatrix<float64_t> get_bins();

        virtual const char* get_name() const;

        virtual CFeatures* duplicate() const;

        virtual EFeatureType get_feature_type() const;

        virtual EFeatureClass get_feature_class() const;

        virtual int32_t get_num_vectors() const;

        virtual int32_t get_size() const;

    private:
        void init();

        void assert_shape(int32_t vec2_len);

    protected:
        CDenseFeatures<float64_t>* m_features;

        SGMatrix<float64_t> m_bins;

        bool m_fill;

        bool m_norm_one;
};
}
#endif // _BINNED_DOTFEATURES_H___