/usr/include/shark/ObjectiveFunctions/AbstractCost.h is in libshark-dev 3.0.1+ds1-2ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 | //===========================================================================
/*!
*
*
* \brief cost function for quantitative judgement of deviations of predictions from target values
*
*
*
* \author T. Glasmachers
* \date 2011
*
*
* \par Copyright 1995-2015 Shark Development Team
*
* <BR><HR>
* This file is part of Shark.
* <http://image.diku.dk/shark/>
*
* Shark is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Shark is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Shark. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef SHARK_OBJECTIVEFUNCTIONS_ABSTRACTCOST_H
#define SHARK_OBJECTIVEFUNCTIONS_ABSTRACTCOST_H
#include <shark/LinAlg/Base.h>
#include <shark/Core/INameable.h>
#include <shark/Core/Flags.h>
#include <shark/Data/Dataset.h>
namespace shark {
/// \brief Cost function interface
///
/// \par
/// In Shark a cost function encodes the severity of a deviation
/// of predictions from targets. This concept is more general than
/// that or a loss function, because it does not necessarily amount
/// to (uniformly) averaging a loss function over samples.
/// In general, the loss depends on the true (training) label and
/// the prediction in a not necessarily symmetric way. Also, in
/// the most general case predictions can be in a different format
/// than labels. E.g., the model prediction could be a probability
/// distribution, while the label is a single value.
///
/// \par
/// The concept of an AbstractCost function is different from that
/// encoded by the ErrorFunction class. A cost function compares
/// model predictions to labels. It does not know about the model
/// making the predictions, and thus it can not handle LabeledData
/// directly. However, it is one of the components necessary to
/// process LabeledData in an ErrorFunction.
///
template<class LabelT, class OutputT = LabelT>
class AbstractCost : public INameable
{
public:
typedef OutputT OutputType;
typedef LabelT LabelType;
typedef typename Batch<OutputType>::type BatchOutputType;
typedef typename Batch<LabelType>::type BatchLabelType;
virtual ~AbstractCost()
{ }
/// list of features a cost function can have
enum Feature {
HAS_FIRST_DERIVATIVE = 1,
HAS_SECOND_DERIVATIVE = 2,
IS_LOSS_FUNCTION = 4,
};
SHARK_FEATURE_INTERFACE;
/// returns true when the first parameter derivative is implemented
bool hasFirstDerivative() const{
return m_features & HAS_FIRST_DERIVATIVE;
}
//~ /// returns true when the second parameter derivative is implemented
//~ bool hasSecondDerivative() const{
//~ return m_features & HAS_SECOND_DERIVATIVE;
//~ }
/// returns true when the cost function is in fact a loss function
bool isLossFunction() const{
return m_features & IS_LOSS_FUNCTION;
}
/// Evaluates the cost of predictions, given targets.
/// \param targets target values
/// \param predictions predictions, typically made by a model
virtual double eval(Data<LabelType> const& targets, Data<OutputType> const& predictions) const = 0;
double operator () (Data<LabelType> const& targets, Data<OutputType> const& predictions) const
{ return eval(targets, predictions); }
};
}
#endif
|