GradientEvaluation.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.
 *
 * Copyright (C) 2012 Jacob Walker
 */


#ifndef CGRADIENTEVALUATION_H_
#define CGRADIENTEVALUATION_H_

#include <shogun/evaluation/MachineEvaluation.h>
#include <shogun/evaluation/DifferentiableFunction.h>
#include <shogun/evaluation/GradientResult.h>

namespace shogun
{
class CGradientEvaluation: public CMachineEvaluation
{

public:

    /*Constructor*/
    CGradientEvaluation();

    CGradientEvaluation(CMachine* machine, CFeatures* features, CLabels* labels,
            CEvaluation* evaluation_criterion, bool autolock = true);

    /*Destructor*/
    virtual ~CGradientEvaluation();

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

    /*Evaluates differentiable function for value
     * and derivative.
     *
     * @return GradientResult containing value and
     * gradient
     */
    virtual CEvaluationResult* evaluate();

    inline void set_function(CDifferentiableFunction* d)
    {
        SG_REF(d);
        SG_UNREF(m_diff);
        m_diff = d;
    };

    inline CDifferentiableFunction* get_function()
    {
        SG_REF(m_diff);
        return m_diff;
    };

private:

    /*Initializer*/
    void init();

private:

    CDifferentiableFunction* m_diff;
};

} /* namespace shogun */

#endif /* CGRADIENTEVALUATION_H_ */