DenseSubSamplesFeatures.h

浏览该文件的文档.

/*
 * Copyright (c) The Shogun Machine Learning Toolbox
 * Written (W) 2015 Wu Lin
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation are those
 * of the authors and should not be interpreted as representing official policies,
 * either expressed or implied, of the Shogun Development Team.
 *
 */

#ifndef DENSESUBSAMPLESFEATURES_H
#define DENSESUBSAMPLESFEATURES_H

#include <shogun/lib/config.h>

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

namespace shogun
{

template<class ST> class CDenseFeatures;
template<class ST> class SGVector;
class CDotFeatures;

template<class ST> class CDenseSubSamplesFeatures: public CDotFeatures
{
public:
    CDenseSubSamplesFeatures();

    CDenseSubSamplesFeatures(CDenseFeatures<ST> *fea, SGVector<int32_t> idx);

    virtual ~CDenseSubSamplesFeatures();

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

    void set_features(CDenseFeatures<ST> *fea);

    void set_subset_idx(SGVector<int32_t> idx);

    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_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);


    virtual bool support_compatible_class() const {return true;}

    virtual bool get_feature_class_compatibility (EFeatureClass rhs) const;
private:
    /* init */
    void init();

    void check_bound(int32_t index);

    /* full samples  */
    CDenseFeatures<ST> *m_fea;

    /* the indices of subsamples of m_fea */
    SGVector<int32_t> m_idx;
};
} /*  shogun */

#endif /*  DENSESUBSAMPLESFEATURES_H */