LinearLatentMachine.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 Viktor Gal
 * Copyright (C) 2012 Viktor Gal
 */

#ifndef __LATENTLINEARMACHINE_H__
#define __LATENTLINEARMACHINE_H__

#include <shogun/lib/config.h>

#include <shogun/lib/common.h>
#include <shogun/machine/LinearMachine.h>

namespace shogun
{
    class CFeatures;
    class CLatentLabels;
    class CLatentModel;

    class CLinearLatentMachine: public CLinearMachine
    {

        public:

            MACHINE_PROBLEM_TYPE(PT_LATENT);

            CLinearLatentMachine();

            CLinearLatentMachine(CLatentModel* model, float64_t C);

            virtual ~CLinearLatentMachine();

            virtual CLatentLabels* apply_latent() = 0;

            virtual CLatentLabels* apply_latent(CFeatures* data);

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

            inline void set_epsilon(float64_t eps) { m_epsilon=eps; }

            inline float64_t get_epsilon() { return m_epsilon; }

            inline void set_C(float64_t c)
            {
                m_C=c;
            }

            inline float64_t get_C() { return m_C; }

            inline void set_max_iterations(int32_t iter) { m_max_iter = iter; }

            inline int32_t get_max_iterations() { return m_max_iter; }

            void set_model(CLatentModel* latent_model);

        protected:
            virtual bool train_machine(CFeatures* data=NULL);

            virtual float64_t do_inner_loop(float64_t cooling_eps)=0;

            virtual bool train_require_labels() const { return false; }

        protected:
            CLatentModel* m_model;
            float64_t m_C;
            float64_t m_epsilon;
            int32_t m_max_iter;
            int32_t m_cur_iter;

        private:
            void init();
    };
}

#endif /* __LATENTLINEARMACHINE_H__ */