MulticlassLogisticRegression.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) 2012 Sergey Lisitsyn
 * Copyright (C) 2012 Sergey Lisitsyn
 */

#ifndef MULTICLASSLOGISTICREGRESSION_H_
#define MULTICLASSLOGISTICREGRESSION_H_
#include <shogun/lib/config.h>
#ifdef HAVE_EIGEN3
#include <shogun/lib/common.h>
#include <shogun/features/DotFeatures.h>
#include <shogun/machine/LinearMulticlassMachine.h>

namespace shogun
{

class CMulticlassLogisticRegression : public CLinearMulticlassMachine
{
    public:
        MACHINE_PROBLEM_TYPE(PT_MULTICLASS)

        
        CMulticlassLogisticRegression();

        CMulticlassLogisticRegression(float64_t z, CDotFeatures* feats, CLabels* labs);

        virtual ~CMulticlassLogisticRegression();

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

        inline void set_z(float64_t z)
        {
            ASSERT(z>0);
            m_z = z;
        }
        inline float64_t get_z() const { return m_z; }

        inline void set_epsilon(float64_t epsilon)
        {
            ASSERT(epsilon>0);
            m_epsilon = epsilon;
        }
        inline float64_t get_epsilon() const { return m_epsilon; }

        inline void set_max_iter(int32_t max_iter)
        {
            ASSERT(max_iter>0);
            m_max_iter = max_iter;
        }
        inline int32_t get_max_iter() const { return m_max_iter; }

    protected:

        virtual bool train_machine(CFeatures* data = NULL);

private:

        void init_defaults();

        void register_parameters();

protected:

        float64_t m_z;

        float64_t m_epsilon;

        int32_t m_max_iter;

};
}
#endif /* HAVE_EIGEN3 */
#endif