GradientResult.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 CGRADIENTRESULT_H_
#define CGRADIENTRESULT_H_

#include <shogun/evaluation/EvaluationResult.h>
#include <shogun/lib/Map.h>
#include <shogun/lib/SGString.h>

namespace shogun
{

class CGradientResult: public CEvaluationResult
{

public:

    /*Constructor*/
    CGradientResult();

    /*Destructor*/
    virtual ~CGradientResult();

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

    virtual EEvaluationResultType get_result_type()
    {
        return GRADIENTEVALUATION_RESULT;
    }

    SGVector<float64_t> quantity;

    CMap<TParameter*, SGVector<float64_t> > gradient;

    CMap<TParameter*, CSGObject*>  parameter_dictionary;

    index_t total_variables;

    void print_result()
    {
        SG_SPRINT("Quantity: [");

        for (index_t i = 0; i < quantity.vlen; i++)
            SG_SPRINT("%f, ", quantity[i]);

        SG_SPRINT("] ");

        SG_SPRINT("Gradient: [");

        for (index_t i = 0; i < gradient.get_num_elements(); i++)
        {
            char* name = gradient.get_node_ptr(i)->key->m_name;
            for (index_t j = 0; j < gradient.get_element_ptr(i)->vlen; j++)
                SG_SPRINT("%s: %f, ", (*gradient.get_element_ptr(i))[j], name);
        }
        SG_SPRINT("]\n");

        SG_SPRINT("Total Variables: %i\n", total_variables);

    }
};

} /* namespace shogun */

#endif /* CGRADIENTRESULT_H_ */