gurls::Norm< T > Class Template Reference

Norm is a class that spherifies the data.

#include <norm.h>

Inheritance diagram for gurls::Norm< T >:

List of all members.

Public Member Functions
virtual GurlsOptionsList *	execute (const gMat2D< T > &X, const gMat2D< T > &Y, const GurlsOptionsList &opt)=0
	Spherifies the data.
Static Public Member Functions
static Norm< T > *	factory (const std::string &id) throw (BadNormCreation)
	Factory function returning a pointer to the newly created object.

---

Detailed Description

template<typename T>
class gurls::Norm< T >

Definition at line 133 of file norm.h.

---

Member Function Documentation

template<typename T>

virtual GurlsOptionsList* gurls::Norm< T >::execute	(	const gMat2D< T > &	X,
		const gMat2D< T > &	Y,
		const GurlsOptionsList &	opt
	)		[pure virtual]

Parameters:

X	input data matrix
Y	labels matrix
opt	options with the different required fields based on the sub-class

Returns:

spherified input data matrix

Implemented in gurls::NormTestZScore< T >, gurls::NormZScore< T >, and gurls::NormL2< T >.

template<typename T>

static Norm<T>* gurls::Norm< T >::factory

(

const std::string &

id

)

throw (BadNormCreation) [inline, static]

Warning:

The returned pointer is a plain, un-managed pointer. The calling function is responsible of deallocating the object.

Definition at line 152 of file norm.h.

    {
        if(id == "l2")
            return new NormL2<T>;
        if(id == "zscore")
            return new NormZScore<T>;
        if(id == "testzscore")
            return new NormTestZScore<T>;

        throw BadNormCreation(id);
    }

---

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

• norm.h