LatentModel.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 __LATENTMODEL_H__
#define __LATENTMODEL_H__

#include <shogun/lib/config.h>

#include <shogun/labels/LatentLabels.h>
#include <shogun/features/LatentFeatures.h>
#include <shogun/features/DotFeatures.h>
#include <shogun/features/DenseFeatures.h>

namespace shogun
{
    class CLatentModel: public CSGObject
    {
        public:
            CLatentModel();

            CLatentModel(CLatentFeatures* feats, CLatentLabels* labels, bool do_caching = true);

            virtual ~CLatentModel();

            virtual int32_t get_num_vectors() const;

            virtual int32_t get_dim() const=0;

            void set_labels(CLatentLabels* labs);

            CLatentLabels* get_labels() const;

            void set_features(CLatentFeatures* feats);

            CLatentFeatures* get_features() const;

            virtual CDotFeatures* get_psi_feature_vectors()=0;

            virtual CData* infer_latent_variable(const SGVector<float64_t>& w, index_t idx)=0;

            virtual void argmax_h(const SGVector<float64_t>& w);

            void cache_psi_features();

            CDotFeatures* get_cached_psi_features() const;

            inline bool get_caching() const
            {
                return m_do_caching;
            }

            inline void set_caching(bool caching)
            {
                m_do_caching = caching;
            }

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

        protected:
            CLatentFeatures* m_features;
            CLatentLabels* m_labels;
            bool m_do_caching;
            CDotFeatures* m_cached_psi;

        private:
            void register_parameters();
    };
}

#endif /* __LATENTMODEL_H__ */