StateModel.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 __STATE_MODEL_H__
#define __STATE_MODEL_H__

#include <shogun/base/SGObject.h>
#include <shogun/lib/SGMatrix.h>
#include <shogun/lib/SGVector.h>
#include <shogun/mathematics/Math.h>
#include <shogun/structure/SequenceLabels.h>
#include <shogun/structure/StateModelTypes.h>

namespace shogun
{

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

        virtual ~CStateModel();

        int32_t get_num_states() const;

        int32_t get_num_transmission_params() const;

        virtual SGMatrix< float64_t > loss_matrix(CSequence* label_seq) = 0;

        virtual float64_t loss(CSequence* label_seq_lhs, CSequence* label_seq_rhs) = 0;

        virtual void reshape_emission_params(SGVector< float64_t >& emission_weights,
            SGVector< float64_t > w, int32_t num_feats, int32_t num_obs) = 0;

        virtual void reshape_emission_params(CDynamicObjectArray* plif_matrix,
            SGVector< float64_t > w, int32_t num_feats, int32_t num_plif_nodes) = 0;

        virtual void reshape_transmission_params(
                SGMatrix< float64_t >& transmission_weights,
                SGVector< float64_t > w) = 0;

        virtual SGVector< int32_t > labels_to_states(CSequence* label_seq) const = 0;

        virtual CSequence* states_to_labels(SGVector< int32_t > state_seq) const = 0;

        virtual void weights_to_vector(SGVector< float64_t >& psi,
                SGMatrix< float64_t > transmission_weights,
                SGVector< float64_t > emission_weights,
                int32_t num_feats, int32_t num_obs) const = 0;

        virtual SGVector< float64_t > weights_to_vector(SGMatrix< float64_t > transmission_weights,
                SGVector< float64_t > emission_weights, int32_t num_feats, int32_t num_obs) const = 0;

        virtual SGVector< int32_t > get_monotonicity(int32_t num_free_states,
                int32_t num_feats) const;

        SGVector< float64_t > get_start_states() const;

        SGVector< float64_t > get_stop_states() const;

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

    private:
        void init();

    protected:
        int32_t m_num_states;

        int32_t m_num_transmission_params;

        SGMatrix< float64_t > m_state_loss_mat;

        SGVector< float64_t > m_p;

        SGVector< float64_t > m_q;

}; /* class CStateModel */

} /* namespace shogun */

#endif /* __STATE_MODEL_H__ */