DotFeatures.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) 2009-2010 Soeren Sonnenburg
 * Copyright (C) 2009 Fraunhofer Institute FIRST and Max-Planck-Society
 * Copyright (C) 2010 Berlin Institute of Technology
 */

#ifndef _DOTFEATURES_H___
#define _DOTFEATURES_H___

#include "lib/common.h"
#include "lib/Time.h"
#include "lib/Mathematics.h"
#include "features/Features.h"

namespace shogun
{
class CDotFeatures : public CFeatures
{
    public:

        CDotFeatures(int32_t size=0) : CFeatures(size), combined_weight(1.0)
        {
            set_property(FP_DOT);
        }

        CDotFeatures(const CDotFeatures & orig) :
            CFeatures(orig), combined_weight(orig.combined_weight)  {}

        CDotFeatures(CFile* loader) : CFeatures(loader) {}

        virtual ~CDotFeatures() { }

        virtual int32_t get_dim_feature_space()=0;

        virtual float64_t dot(int32_t vec_idx1, int32_t vec_idx2)=0;

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

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

        virtual void dense_dot_range(float64_t* output, int32_t start, int32_t stop, float64_t* alphas, float64_t* vec, int32_t dim, float64_t b);

        virtual void dense_dot_range_subset(int32_t* sub_index, int32_t num, float64_t* output, float64_t* alphas, float64_t* vec, int32_t dim, float64_t b);

        static void* dense_dot_range_helper(void* p);

        virtual int32_t get_nnz_features_for_vector(int32_t num)=0;

        inline float64_t get_combined_feature_weight() { return combined_weight; }

        inline void set_combined_feature_weight(float64_t nw) { combined_weight=nw; }

        virtual void get_feature_matrix(float64_t** dst, int32_t* num_feat, int32_t* num_vec);

        virtual void get_feature_vector(float64_t** dst, int32_t* len, int32_t num);

        void benchmark_add_to_dense_vector(int32_t repeats=5);

        void benchmark_dense_dot_range(int32_t repeats=5);

        virtual void* get_feature_iterator(int32_t vector_index)=0;

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

        virtual void free_feature_iterator(void* iterator)=0;

    protected:
        inline void display_progress(int32_t start, int32_t stop, int32_t v)
        {
            int32_t num_vectors=stop-start;
            int32_t i=v-start;

            if ( (i% (num_vectors/100+1))== 0)
                SG_PROGRESS(v, 0.0, num_vectors-1);
        }

#ifdef HAVE_BOOST_SERIALIZATION
        friend class ::boost::serialization::access;
        // When the class Archive corresponds to an output archive, the
        // & operator is defined similar to <<.  Likewise, when the class Archive
        // is a type of input archive the & operator is defined similar to >>.
        template<class Archive>
            void serialize(Archive & ar, const unsigned int archive_version)
            {

                SG_DEBUG("archiving DotFeatures\n");

                ar & ::boost::serialization::base_object<CFeatures>(*this);
                ar & combined_weight;

                SG_DEBUG("done with DotFeatures\n");
            }

#endif //HAVE_BOOST_SERIALIZATION

    protected:

        float64_t combined_weight;
};
}
#endif // _DOTFEATURES_H___