StructuredModel.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 Fernando José Iglesias García
 * Copyright (C) 2012 Fernando José Iglesias García
 */

#ifndef _STRUCTURED_MODEL__H__
#define _STRUCTURED_MODEL__H__

#include <shogun/base/SGObject.h>
#include <shogun/features/Features.h>
#include <shogun/labels/StructuredLabels.h>
#include <shogun/lib/SGVector.h>
#include <shogun/lib/StructuredData.h>

namespace shogun
{

#define IGNORE_IN_CLASSLIST

IGNORE_IN_CLASSLIST struct TMultipleCPinfo {
    uint32_t _from;
    uint32_t N;
};

class CStructuredModel;

struct CResultSet : public CSGObject
{
    CResultSet() : CSGObject(), argmax(NULL) { };

    virtual ~CResultSet() { SG_UNREF(argmax) }

    CStructuredData* argmax;

    SGVector< float64_t > psi_truth;

    SGVector< float64_t > psi_pred;

    float64_t score;

    float64_t delta;

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

class CStructuredModel : public CSGObject
{
    public:
        CStructuredModel();

        CStructuredModel(CFeatures* features, CStructuredLabels* labels);

        virtual ~CStructuredModel();

        virtual void init_opt(
                SGMatrix< float64_t > & A,  SGVector< float64_t > a,
                SGMatrix< float64_t > B,  SGVector< float64_t > & b,
                SGVector< float64_t > lb, SGVector< float64_t > ub,
                SGMatrix < float64_t >  & C);

        virtual int32_t get_dim() const = 0;

        void set_labels(CStructuredLabels* labs);

        CStructuredLabels* get_labels();

        void set_features(CFeatures* feats);

        CFeatures* get_features();

        SGVector< float64_t > get_joint_feature_vector(int32_t feat_idx, int32_t lab_idx);

        virtual SGVector< float64_t > get_joint_feature_vector(int32_t feat_idx, CStructuredData* y);

        virtual CResultSet* argmax(SGVector< float64_t > w, int32_t feat_idx, bool const training = true) = 0;

        float64_t delta_loss(int32_t ytrue_idx, CStructuredData* ypred);

        virtual float64_t delta_loss(CStructuredData* y1, CStructuredData* y2);

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

        virtual bool check_training_setup() const;

        virtual int32_t get_num_aux() const;

        virtual int32_t get_num_aux_con() const;

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

    private:
        void init();

    protected:
        CStructuredLabels* m_labels;

        CFeatures* m_features;

}; /* class CStructuredModel */

} /* namespace shogun */

#endif /* _STRUCTURED_MODEL__H__ */