CEmbeddingConverter Class Reference

Detailed Description

class EmbeddingConverter used to create embeddings of features, e.g. construct dense numeric embedding of string features

Definition at line 30 of file EmbeddingConverter.h.

Inheritance diagram for CEmbeddingConverter:

Public Member Functions
	CEmbeddingConverter ()
virtual	~CEmbeddingConverter ()
virtual CFeatures *	apply (CFeatures *features)=0
virtual CSimpleFeatures < float64_t > *	embed (CFeatures *features)
void	set_target_dim (int32_t dim)
int32_t	get_target_dim () const
void	set_distance (CDistance *distance)
CDistance *	get_distance () const
void	set_kernel (CKernel *kernel)
CKernel *	get_kernel () const
virtual const char *	get_name () const
Public Member Functions inherited from CConverter
	CConverter ()
virtual	~CConverter ()
Public Member Functions inherited from CSGObject
	CSGObject ()
	CSGObject (const CSGObject &orig)
virtual	~CSGObject ()
virtual bool	is_generic (EPrimitiveType *generic) const
template<class T >
void	set_generic ()
void	unset_generic ()
virtual void	print_serializable (const char *prefix="")
virtual bool	save_serializable (CSerializableFile *file, const char *prefix="")
virtual bool	load_serializable (CSerializableFile *file, const char *prefix="")
void	set_global_io (SGIO *io)
SGIO *	get_global_io ()
void	set_global_parallel (Parallel *parallel)
Parallel *	get_global_parallel ()
void	set_global_version (Version *version)
Version *	get_global_version ()
SGVector< char * >	get_modelsel_names ()
char *	get_modsel_param_descr (const char *param_name)
index_t	get_modsel_param_index (const char *param_name)

Protected Member Functions
void	init ()

Protected Attributes
int32_t	m_target_dim
CDistance *	m_distance
CKernel *	m_kernel

Additional Inherited Members
Public Attributes inherited from CSGObject
SGIO *	io
Parallel *	parallel
Version *	version
Parameter *	m_parameters
Parameter *	m_model_selection_parameters

Constructor & Destructor Documentation

CEmbeddingConverter

(

)

constructor

Definition at line 20 of file EmbeddingConverter.cpp.

~CEmbeddingConverter ( )

virtual

destructor

Definition at line 30 of file EmbeddingConverter.cpp.

Member Function Documentation

virtual CFeatures* apply ( CFeatures *  features )

pure virtual

applies to the given data, returns embedding

Parameters

features

features to embed

Returns

embedding features

Implements CConverter.

Implemented in CMultidimensionalScaling, CLocallyLinearEmbedding, CLaplacianEigenmaps, CKernelLocallyLinearEmbedding, and CDiffusionMaps.

CSimpleFeatures< float64_t > * embed ( CFeatures *  features )

virtual

embed given features, acts the same as apply, but returns SimpleFeatures

Parameters

features

features to embed

Returns

embedding simple features

Definition at line 36 of file EmbeddingConverter.cpp.

CDistance * get_distance

(

)

const

getter for distance

Returns

distance

Definition at line 59 of file EmbeddingConverter.cpp.

CKernel * get_kernel

(

)

const

getter for kernel

Returns

kernel

Definition at line 72 of file EmbeddingConverter.cpp.

virtual const char* get_name ( ) const

virtual

get name

Reimplemented from CConverter.

Reimplemented in CLocallyLinearEmbedding, CLaplacianEigenmaps, CMultidimensionalScaling, CKernelLocallyLinearEmbedding, CLocalTangentSpaceAlignment, CDiffusionMaps, CIsomap, CHessianLocallyLinearEmbedding, CKernelLocalTangentSpaceAlignment, CLinearLocalTangentSpaceAlignment, CNeighborhoodPreservingEmbedding, and CLocalityPreservingProjections.

Definition at line 83 of file EmbeddingConverter.h.

int32_t get_target_dim

(

)

const

getter for target dimension

Returns

target dimension

Definition at line 47 of file EmbeddingConverter.cpp.

void init ( )

protected

default init

Reimplemented from CSGObject.

Reimplemented in CLocallyLinearEmbedding, CMultidimensionalScaling, CLaplacianEigenmaps, CIsomap, and CDiffusionMaps.

Definition at line 78 of file EmbeddingConverter.cpp.

void set_distance

(

CDistance *

distance

)

setter for distance

Parameters

distance

distance to set

Definition at line 52 of file EmbeddingConverter.cpp.

void set_kernel

(

CKernel *

kernel

)

setter for kernel

Parameters

kernel

kernel to set

Definition at line 65 of file EmbeddingConverter.cpp.

void set_target_dim

(

int32_t

dim

)

setter for target dimension

Parameters

dim	target dimension

Definition at line 41 of file EmbeddingConverter.cpp.

Member Data Documentation

CDistance* m_distance

protected

distance to be used

Definition at line 96 of file EmbeddingConverter.h.

CKernel* m_kernel

protected

kernel to be used

Definition at line 99 of file EmbeddingConverter.h.

int32_t m_target_dim

protected

target dim of dimensionality reduction preprocessor

Definition at line 93 of file EmbeddingConverter.h.

---

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

• EmbeddingConverter.h
• EmbeddingConverter.cpp