shark::SquaredLoss< OutputType, LabelType > Class Template Reference

squared loss for regression and classification More...

#include <shark/ObjectiveFunctions/Loss/SquaredLoss.h>

+ Inheritance diagram for shark::SquaredLoss< OutputType, LabelType >:

Public Types

typedef base_type::BatchOutputType BatchOutputType
 
typedef base_type::BatchLabelType BatchLabelType
 
- Public Types inherited from shark::AbstractLoss< LabelType, OutputType >
typedef OutputType OutputType
 
typedef LabelType LabelType
 
typedef RealMatrix MatrixType
 
typedef Batch< OutputType >::type BatchOutputType
 
typedef Batch< LabelType >::type BatchLabelType
 
typedef ConstProxyReference< LabelType const >::type ConstLabelReference
 Const references to LabelType. More...
 
typedef ConstProxyReference< OutputType const >::type ConstOutputReference
 Const references to OutputType. More...
 
- Public Types inherited from shark::AbstractCost< LabelType, OutputType >
enum  Feature
 list of features a cost function can have More...
 
typedef OutputType OutputType
 
typedef LabelType LabelType
 
typedef Batch< OutputType >::type BatchOutputType
 
typedef Batch< LabelType >::type BatchLabelType
 
typedef TypedFlags< FeatureFeatures
 
typedef TypedFeatureNotAvailableException< FeatureFeatureNotAvailableException
 

Public Member Functions

 SquaredLoss ()
 Constructor. More...
 
std::string name () const
 From INameable: return the class name. More...
 
double eval (BatchLabelType const &labels, BatchOutputType const &predictions) const
 Evaluate the squared loss \( (label - prediction)^2 \). More...
 
double evalDerivative (BatchLabelType const &label, BatchOutputType const &prediction, BatchOutputType &gradient) const
 
- Public Member Functions inherited from shark::AbstractLoss< LabelType, OutputType >
 AbstractLoss ()
 
virtual double eval (ConstLabelReference target, ConstOutputReference prediction) const
 evaluate the loss for a target and a prediction More...
 
double eval (Data< LabelType > const &targets, Data< OutputType > const &predictions) const
 
virtual double evalDerivative (ConstLabelReference target, ConstOutputReference prediction, OutputType &gradient) const
 evaluate the loss and its derivative for a target and a prediction More...
 
virtual double evalDerivative (ConstLabelReference target, ConstOutputReference prediction, OutputType &gradient, MatrixType &hessian) const
 evaluate the loss and its first and second derivative for a target and a prediction More...
 
double operator() (LabelType const &target, OutputType const &prediction) const
 evaluate the loss for a target and a prediction More...
 
double operator() (BatchLabelType const &target, BatchOutputType const &prediction) const
 
- Public Member Functions inherited from shark::AbstractCost< LabelType, OutputType >
virtual ~AbstractCost ()
 
const Featuresfeatures () const
 
virtual void updateFeatures ()
 
bool hasFirstDerivative () const
 returns true when the first parameter derivative is implemented More...
 
bool isLossFunction () const
 returns true when the cost function is in fact a loss function More...
 
double operator() (Data< LabelType > const &targets, Data< OutputType > const &predictions) const
 
- Public Member Functions inherited from shark::INameable
virtual ~INameable ()
 

Additional Inherited Members

- Protected Attributes inherited from shark::AbstractCost< LabelType, OutputType >
Features m_features
 

Detailed Description

template<class OutputType = RealVector, class LabelType = OutputType>
class shark::SquaredLoss< OutputType, LabelType >

squared loss for regression and classification

The SquaredLoss computes the squared distance between target and prediction. It is defined for both vectorial as well as integral labels. In the case of integral labels, the label c is interpreted as unit-vector having the c-th component activated.

Definition at line 48 of file SquaredLoss.h.

Member Typedef Documentation

◆ BatchLabelType

template<class OutputType = RealVector, class LabelType = OutputType>
typedef base_type::BatchLabelType shark::SquaredLoss< OutputType, LabelType >::BatchLabelType

Definition at line 53 of file SquaredLoss.h.

◆ BatchOutputType

template<class OutputType = RealVector, class LabelType = OutputType>
typedef base_type::BatchOutputType shark::SquaredLoss< OutputType, LabelType >::BatchOutputType

Definition at line 52 of file SquaredLoss.h.

Constructor & Destructor Documentation

◆ SquaredLoss()

template<class OutputType = RealVector, class LabelType = OutputType>
shark::SquaredLoss< OutputType, LabelType >::SquaredLoss ( )
inline

Member Function Documentation

◆ eval()

template<class OutputType = RealVector, class LabelType = OutputType>
double shark::SquaredLoss< OutputType, LabelType >::eval ( BatchLabelType const &  labels,
BatchOutputType const &  predictions 
) const
inlinevirtual

Evaluate the squared loss \( (label - prediction)^2 \).

Implements shark::AbstractLoss< LabelType, OutputType >.

Definition at line 69 of file SquaredLoss.h.

References SIZE_CHECK.

Referenced by main().

◆ evalDerivative()

template<class OutputType = RealVector, class LabelType = OutputType>
double shark::SquaredLoss< OutputType, LabelType >::evalDerivative ( BatchLabelType const &  label,
BatchOutputType const &  prediction,
BatchOutputType gradient 
) const
inlinevirtual

Evaluate the squared loss \( (label - prediction)^2 \) and its deriative \( \frac{\partial}{\partial prediction} 1/2 (label - prediction)^2 = prediction - label \).

Reimplemented from shark::AbstractLoss< LabelType, OutputType >.

Definition at line 82 of file SquaredLoss.h.

◆ name()

template<class OutputType = RealVector, class LabelType = OutputType>
std::string shark::SquaredLoss< OutputType, LabelType >::name ( ) const
inlinevirtual

From INameable: return the class name.

Reimplemented from shark::INameable.

Definition at line 63 of file SquaredLoss.h.

References shark::AbstractLoss< LabelType, OutputType >::eval().


The documentation for this class was generated from the following file: