Cosan::CosanMetric< NumericType > Class Template Reference

CosanMetric class for metric functionality. More...

#include <CosanMetric.h>

Inheritance diagram for Cosan::CosanMetric< NumericType >:

Public Member Functions
	CosanMetric ()
	CosanMetric (const CosanMatrix< NumericType > &yPredict, const CosanMatrix< NumericType > &yTrue)
virtual NumericType	GetError (const CosanMatrix< NumericType > &yPredict, const CosanMatrix< NumericType > &yTrue)
void	setAttr (const CosanMatrix< NumericType > &yPredict, const CosanMatrix< NumericType > &yTrue)
Public Member Functions inherited from Cosan::Evaluation
	Evaluation ()
Public Member Functions inherited from Cosan::CosanBO
	CosanBO ()
	Default constructor. More...
virtual const std::string	GetName () const
	Get the name of the objects. More...

Public Attributes
NumericType	error

Detailed Description

template<Numeric NumericType>
class Cosan::CosanMetric< NumericType >

CosanMetric class for metric functionality.

Parameters

[in]	yPredict	data for prediction
[in]	yTrue	data for truth Initialize metric class by CosanMetric(const CosanMatrix <NumericType> &yPredict, const CosanMatrix <NumericType> &yTrue) Get the metric error by GetError(const CosanMatrix <NumericType> &yPredict, const CosanMatrix <NumericType> &yTrue)

Definition at line 37 of file CosanMetric.h.

Constructor & Destructor Documentation

CosanMetric() [1/2]

template<Numeric NumericType>

Cosan::CosanMetric< NumericType >::CosanMetric ( )

inline

Definition at line 40 of file CosanMetric.h.

: Evaluation() {}

CosanMetric() [2/2]

template<Numeric NumericType>

Cosan::CosanMetric< NumericType >::CosanMetric ( const CosanMatrix< NumericType > &  yPredict, const CosanMatrix< NumericType > &  yTrue  )

inline

Definition at line 45 of file CosanMetric.h.

                                                                                                       : Evaluation() {
            setAttr(yPredict, yTrue);
        };

Member Function Documentation

GetError()

template<Numeric NumericType>

virtual NumericType Cosan::CosanMetric< NumericType >::GetError ( const CosanMatrix< NumericType > &  yPredict, const CosanMatrix< NumericType > &  yTrue  )

inlinevirtual

Reimplemented in Cosan::MaxError< NumericType >, Cosan::R2Score< NumericType >, Cosan::MeanSquareError< NumericType >, and Cosan::MeanAbsError< NumericType >.

Definition at line 51 of file CosanMetric.h.

                                                                                                    {
            return 0;
        };

setAttr()

template<Numeric NumericType>

void Cosan::CosanMetric< NumericType >::setAttr ( const CosanMatrix< NumericType > &  yPredict, const CosanMatrix< NumericType > &  yTrue  )

inline

Definition at line 58 of file CosanMetric.h.

                                                                                                        {
            // check if the input matrices have the same size
            if (!SameSize(yPredict, yTrue)) {
                throw DiffSize;
            }
            // check the shape of the input
            if (!LabelShape(yPredict)) {
                throw InvalidLabelShape;
            }
            GetError(yPredict, yTrue);
        }

Member Data Documentation

error

template<Numeric NumericType>

NumericType Cosan::CosanMetric< NumericType >::error

Definition at line 70 of file CosanMetric.h.

---

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

• cosan/evaluation/CosanMetric.h