LikelihoodModel.h

Go to the documentation of this file.

/*
 * Copyright (c) The Shogun Machine Learning Toolbox
 * Written (W) 2013 Heiko Strathmann
 * Written (W) 2013 Roman Votyakov
 * Written (W) 2012 Jacob Walker
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation are those
 * of the authors and should not be interpreted as representing official policies,
 * either expressed or implied, of the Shogun Development Team.
 *
 */

#ifndef CLIKELIHOODMODEL_H_
#define CLIKELIHOODMODEL_H_

#include <shogun/lib/config.h>

#include <shogun/base/SGObject.h>
#include <shogun/labels/Labels.h>
#include <shogun/lib/SGMatrix.h>

namespace shogun
{

enum ELikelihoodModelType
{
    LT_NONE=0,
    LT_GAUSSIAN=10,
    LT_STUDENTST=20,
    LT_LOGIT=30,
    LT_PROBIT=40,
    LT_SOFTMAX=50
};

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

    virtual ~CLikelihoodModel();

    virtual SGVector<float64_t> get_predictive_log_probabilities(
            SGVector<float64_t> mu, SGVector<float64_t> s2,
            const CLabels* lab=NULL);

    virtual SGVector<float64_t> get_predictive_means(SGVector<float64_t> mu,
            SGVector<float64_t> s2, const CLabels* lab=NULL) const=0;

    virtual SGVector<float64_t> get_predictive_variances(SGVector<float64_t> mu,
            SGVector<float64_t> s2, const CLabels* lab=NULL) const=0;

    virtual ELikelihoodModelType get_model_type() const { return LT_NONE; }

    virtual SGVector<float64_t> get_log_probability_f(const CLabels* lab,
            SGVector<float64_t> func) const=0;

    virtual SGVector<float64_t> get_log_probability_fmatrix(const CLabels* lab,
            SGMatrix<float64_t> F) const;

    virtual SGVector<float64_t> get_log_probability_derivative_f(
            const CLabels* lab, SGVector<float64_t> func, index_t i) const=0;

    virtual SGVector<float64_t> get_first_derivative(const CLabels* lab,
            SGVector<float64_t> func, const TParameter* param) const
    {
        SG_ERROR("Can't compute derivative wrt %s parameter\n", param->m_name)
        return SGVector<float64_t>();
    }


    virtual SGVector<float64_t> get_second_derivative(const CLabels* lab,
            SGVector<float64_t> func, const TParameter* param) const
    {
        SG_ERROR("Can't compute derivative wrt %s parameter\n", param->m_name)
        return SGVector<float64_t>();
    }

    virtual SGVector<float64_t> get_third_derivative(const CLabels* lab,
            SGVector<float64_t> func, const TParameter* param) const
    {
        SG_ERROR("Can't compute derivative wrt %s parameter\n", param->m_name)
        return SGVector<float64_t>();
    }

    virtual SGVector<float64_t> get_log_zeroth_moments(SGVector<float64_t> mu,
            SGVector<float64_t> s2, const CLabels* lab) const=0;

    virtual float64_t get_first_moment(SGVector<float64_t> mu,
            SGVector<float64_t> s2, const CLabels* lab, index_t i) const=0;

    virtual SGVector<float64_t> get_first_moments(SGVector<float64_t> mu,
            SGVector<float64_t> s2, const CLabels* lab) const;

    virtual float64_t get_second_moment(SGVector<float64_t> mu,
            SGVector<float64_t> s2, const CLabels* lab, index_t i) const=0;

    virtual SGVector<float64_t> get_second_moments(SGVector<float64_t> mu,
            SGVector<float64_t> s2, const CLabels* lab) const;

    virtual bool supports_regression() const { return false; }

    virtual bool supports_binary() const { return false; }

    virtual bool supports_multiclass() const { return false; }
};
}
#endif /* CLIKELIHOODMODEL_H_ */