StructuredOutputMachine.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) 2013 Shell Hu
 * Written (W) 2012 Fernando José Iglesias García
 * Copyright (C) 2012 Fernando José Iglesias García
 */

#ifndef _STRUCTURED_OUTPUT_MACHINE__H__
#define _STRUCTURED_OUTPUT_MACHINE__H__

#include <shogun/lib/config.h>

#include <shogun/lib/common.h>
#include <shogun/machine/Machine.h>
#include <shogun/structure/SOSVMHelper.h>

namespace shogun
{

class CFeatures;
class CLabels;
class CLossFunction;
class CStructuredLabels;
struct TMultipleCPinfo;

enum EStructRiskType
{
    N_SLACK_MARGIN_RESCALING = 0,
    N_SLACK_SLACK_RESCALING = 1,
    ONE_SLACK_MARGIN_RESCALING = 2,
    ONE_SLACK_SLACK_RESCALING = 3,
    CUSTOMIZED_RISK = 4
};

class CStructuredModel;

class CStructuredOutputMachine : public CMachine
{
    public:
        MACHINE_PROBLEM_TYPE(PT_STRUCTURED);

        CStructuredOutputMachine();

        CStructuredOutputMachine(CStructuredModel* model, CStructuredLabels* labs);

        virtual ~CStructuredOutputMachine();

        void set_model(CStructuredModel* model);

        CStructuredModel* get_model() const;

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

        virtual void set_labels(CLabels* lab);

        void set_features(CFeatures* f);

        CFeatures* get_features() const;

        void set_surrogate_loss(CLossFunction* loss);

        CLossFunction* get_surrogate_loss() const;

        virtual float64_t risk(float64_t* subgrad, float64_t* W,
                TMultipleCPinfo* info=0, EStructRiskType rtype = N_SLACK_MARGIN_RESCALING);

        CSOSVMHelper* get_helper() const;

        void set_verbose(bool verbose);

        bool get_verbose() const;

    protected:
        virtual float64_t risk_nslack_margin_rescale(float64_t* subgrad, float64_t* W, TMultipleCPinfo* info=0);

        virtual float64_t risk_nslack_slack_rescale(float64_t* subgrad, float64_t* W, TMultipleCPinfo* info=0);

        virtual float64_t risk_1slack_margin_rescale(float64_t* subgrad, float64_t* W, TMultipleCPinfo* info=0);

        virtual float64_t risk_1slack_slack_rescale(float64_t* subgrad, float64_t* W, TMultipleCPinfo* info=0);

        virtual float64_t risk_customized_formulation(float64_t* subgrad, float64_t* W, TMultipleCPinfo* info=0);

    private:
        void register_parameters();

    protected:
        CStructuredModel* m_model;

        CLossFunction* m_surrogate_loss;

        CSOSVMHelper* m_helper;

        bool m_verbose;

}; /* class CStructuredOutputMachine */

} /* namespace shogun */

#endif /* _STRUCTURED_OUTPUT_MACHINE__H__ */