Features.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) 1999-2009 Soeren Sonnenburg
 * Written (W) 1999-2008 Gunnar Raetsch
 * Written (W) 2011-2012 Heiko Strathmann
 * Copyright (C) 1999-2009 Fraunhofer Institute FIRST and Max-Planck-Society
 */

#ifndef _CFEATURES__H__
#define _CFEATURES__H__

#include <shogun/lib/config.h>

#include <shogun/lib/common.h>
#include <shogun/io/File.h>
#include <shogun/base/SGObject.h>
#include <shogun/preprocessor/Preprocessor.h>
#include <shogun/features/FeatureTypes.h>
#include <shogun/features/SubsetStack.h>
#include <shogun/lib/List.h>
#include <shogun/lib/DynamicObjectArray.h>
#include <shogun/lib/DynamicArray.h>

namespace shogun
{
    class CFile;
    class CPreprocessor;
    class CKernel;
}

namespace shogun
{

class CFeatures : public CSGObject
{
    public:
        CFeatures(int32_t size=0);

        CFeatures(const CFeatures& orig);

        CFeatures(CFile* loader);

        virtual CFeatures* duplicate() const=0;

        virtual ~CFeatures();

        virtual EFeatureType get_feature_type() const=0;

        virtual EFeatureClass get_feature_class() const=0;

        virtual void add_preprocessor(CPreprocessor* p);

        virtual void del_preprocessor(int32_t num);

        CPreprocessor* get_preprocessor(int32_t num) const;

        void set_preprocessed(int32_t num);

        bool is_preprocessed(int32_t num) const;

        int32_t get_num_preprocessed() const;

        int32_t get_num_preprocessors() const;

        void clean_preprocessors();

        void list_preprocessors();

        int32_t get_cache_size() const;

        virtual int32_t get_num_vectors() const=0;

        virtual bool reshape(int32_t num_features, int32_t num_vectors);

        void list_feature_obj() const;

        virtual void load(CFile* loader);

        virtual void save(CFile* writer);

        bool check_feature_compatibility(CFeatures* f) const;

        bool has_property(EFeatureProperty p) const;

        void set_property(EFeatureProperty p);

        void unset_property(EFeatureProperty p);

        virtual CFeatures* create_merged_copy(CList* others)
        {
            SG_ERROR("%s::create_merged_copy() is not yet implemented!\n")
            return NULL;
        }

        virtual CFeatures* create_merged_copy(CFeatures* other)
        {
            SG_ERROR("%s::create_merged_copy() is not yet implemented!\n")
            return NULL;
        }

        virtual void add_subset(SGVector<index_t> subset);

        virtual void add_subset_in_place(SGVector<index_t> subset);

        virtual void remove_subset();

        virtual void remove_all_subsets();

        virtual CSubsetStack* get_subset_stack();

        virtual void subset_changed_post() {}

        virtual CFeatures* copy_subset(SGVector<index_t> indices);

        virtual CFeatures* copy_dimension_subset(SGVector<index_t> dims);

        virtual bool support_compatible_class() const {return false;}

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

    private:
        uint64_t  properties;

        int32_t cache_size;

        CDynamicObjectArray* preproc;

        CDynamicArray<bool>* preprocessed;

    protected:
        CSubsetStack* m_subset_stack;
};
}
#endif