RandomForest.h

Go to the documentation of this file.

/*
 * Copyright (c) The Shogun Machine Learning Toolbox
 * Written (w) 2014 Parijat Mazumdar
 * 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 _RANDOMFOREST_H__
#define _RANDOMFOREST_H__

#include <shogun/lib/config.h>
#include <shogun/machine/BaggingMachine.h>

namespace shogun
{

class CRandomForest : public CBaggingMachine
{
public:
    CRandomForest();

    CRandomForest(int32_t num_rand_feats, int32_t num_bags=10);

    CRandomForest(CFeatures* features, CLabels* labels, int32_t num_bags=10, int32_t num_rand_feats=0);

    CRandomForest(CFeatures* features, CLabels* labels, SGVector<float64_t> weights, int32_t num_bags=10, int32_t num_rand_feats=0);

    virtual ~CRandomForest();

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

    virtual void set_machine(CMachine* machine);

    void set_weights(SGVector<float64_t> weights);

    SGVector<float64_t> get_weights() const;

    void set_feature_types(SGVector<bool> ft);

    SGVector<bool> get_feature_types() const;

    virtual EProblemType get_machine_problem_type() const;

    void set_machine_problem_type(EProblemType mode);

    void set_num_random_features(int32_t rand_featsize);

    int32_t get_num_random_features() const;

protected:

    virtual bool train_machine(CFeatures* data=NULL);
    virtual void set_machine_parameters(CMachine* m, SGVector<index_t> idx);

private:
    void init();

private:
    SGVector<float64_t> m_weights;

    SGMatrix<float64_t> m_sorted_transposed_feats;

    SGMatrix<index_t> m_sorted_indices;
};
} /* namespace shogun */
#endif /* _RANDOMFOREST_H__ */