CFeatures Class Reference

Inheritance diagram for CFeatures:

Detailed Description

class Features Features can just be DREALs, SHORT or STRINGs, FILES, or...

Definition at line 27 of file Features.h.


Public Member Functions
	CFeatures (INT size)
	CFeatures (const CFeatures &orig)
	CFeatures (CHAR *fname)
virtual CFeatures *	duplicate () const =0
virtual	~CFeatures ()
virtual EFeatureType	get_feature_type ()=0
virtual EFeatureClass	get_feature_class ()=0
virtual INT	add_preproc (CPreProc *p)
	set preprocessor
virtual CPreProc *	del_preproc (INT num)
	del current preprocessor
CPreProc *	get_preproc (INT num)
	get current preprocessor
void	set_preprocessed (INT num)
bool	is_preprocessed (INT num)
INT	get_num_preprocessed ()
	get whether specified preprocessor (or all if num=1) was/were already applied
INT	get_num_preproc ()
void	clean_preprocs ()
	clears all preprocs
INT	get_cache_size ()
virtual INT	get_num_vectors ()=0
virtual bool	reshape (INT num_features, INT num_vectors)
virtual INT	get_size ()=0
void	list_feature_obj ()
virtual bool	load (CHAR *fname)
virtual bool	save (CHAR *fname)
bool	check_feature_compatibility (CFeatures *f)
Static Public Attributes
static CParallel	parallel
static CIO	io
static CVersion	version

Constructor & Destructor Documentation

CFeatures::CFeatures ( INT size )

constructor

Parameters:

size

cache size

Definition at line 18 of file Features.cpp.

CFeatures::CFeatures ( const CFeatures & orig )

copy constructor

Definition at line 25 of file Features.cpp.

CFeatures::CFeatures ( CHAR * fname )

constructor

Parameters:

fname

filename to load features from

Definition at line 33 of file Features.cpp.

CFeatures::~CFeatures ( ) [virtual]

Definition at line 41 of file Features.cpp.

Member Function Documentation

virtual CFeatures* CFeatures::duplicate ( ) const [pure virtual]

duplicate feature object

abstract base method

Returns:: feature object

Implemented in CCombinedFeatures, CSimpleFeatures< ST >, CSparseFeatures< ST >, CStringFeatures< ST >, CSimpleFeatures< double >, CSimpleFeatures< float >, CSimpleFeatures< int >, CSimpleFeatures< short int >, CSimpleFeatures< unsigned char >, CSimpleFeatures< char >, CSimpleFeatures< unsigned short int >, CSparseFeatures< double >, CStringFeatures< unsigned char >, and CStringFeatures< unsigned short int >.

virtual EFeatureType CFeatures::get_feature_type ( ) [pure virtual]

get feature type

abstract base method

Returns:: templated feature type

virtual EFeatureClass CFeatures::get_feature_class ( ) [pure virtual]

get feature class

abstract base method

Returns:: feature class like STRING, SIMPLE, SPARSE...

Implemented in CCombinedFeatures, CSimpleFeatures< ST >, CSparseFeatures< ST >, CStringFeatures< ST >, CSimpleFeatures< double >, CSimpleFeatures< float >, CSimpleFeatures< int >, CSimpleFeatures< short int >, CSimpleFeatures< unsigned char >, CSimpleFeatures< char >, CSimpleFeatures< unsigned short int >, CSparseFeatures< double >, CStringFeatures< unsigned char >, and CStringFeatures< unsigned short int >.

INT CFeatures::add_preproc ( CPreProc * p ) [virtual]

set preprocessor

add preprocessor

Parameters:

p

preprocessor to set

Returns:: something inty

Definition at line 48 of file Features.cpp.

CPreProc * CFeatures::del_preproc ( INT num ) [virtual]

del current preprocessor

delete preprocessor from list caller has to clean up returned preproc

Parameters:

num

index of preprocessor in list

Definition at line 107 of file Features.cpp.

CPreProc * CFeatures::get_preproc ( INT num )

get current preprocessor

get specified preprocessor

Parameters:

num

index of preprocessor in list

Definition at line 78 of file Features.cpp.

void CFeatures::set_preprocessed ( INT num )

set applied flag for preprocessor

Parameters:

num

index of preprocessor in list

Definition at line 95 of file Features.h.

bool CFeatures::is_preprocessed ( INT num )

get whether specified preprocessor was already applied

Parameters:

num

index of preprocessor in list

Definition at line 101 of file Features.h.

INT CFeatures::get_num_preprocessed ( )

get whether specified preprocessor (or all if num=1) was/were already applied

get the number of applied preprocs

Returns:: number of applied preprocessors

Definition at line 87 of file Features.cpp.

INT CFeatures::get_num_preproc ( )

get number of preprocessors

Returns:: number of preprocessors

Definition at line 113 of file Features.h.

void CFeatures::clean_preprocs ( )

clears all preprocs

Definition at line 101 of file Features.cpp.

INT CFeatures::get_cache_size ( )

get cache size

Returns:: cache size

Definition at line 122 of file Features.h.

virtual INT CFeatures::get_num_vectors ( ) [pure virtual]

get number of examples/vectors

abstract base method

Returns:: number of examples/vectors

Implemented in CCombinedFeatures, CSimpleFeatures< ST >, CSparseFeatures< ST >, CStringFeatures< ST >, CSimpleFeatures< double >, CSimpleFeatures< float >, CSimpleFeatures< int >, CSimpleFeatures< short int >, CSimpleFeatures< unsigned char >, CSimpleFeatures< char >, CSimpleFeatures< unsigned short int >, CSparseFeatures< double >, CStringFeatures< unsigned char >, and CStringFeatures< unsigned short int >.

virtual bool CFeatures::reshape	(	INT	num_features,
		INT	num_vectors
	)			`[virtual]`

in case there is a feature matrix allow for reshaping

NOT IMPLEMENTED!

Parameters:

	num_features	new number of features
	num_vectors	new number of vectors

Returns:: if reshaping was succesful

Reimplemented in CSimpleFeatures< ST >, CSimpleFeatures< double >, CSimpleFeatures< float >, CSimpleFeatures< int >, CSimpleFeatures< short int >, CSimpleFeatures< unsigned char >, CSimpleFeatures< char >, and CSimpleFeatures< unsigned short int >.

Definition at line 140 of file Features.h.

virtual INT CFeatures::get_size ( ) [pure virtual]

get memory footprint of one feature

abstrace base method

Returns:: memory footprint of one feature

Implemented in CCombinedFeatures, CSimpleFeatures< ST >, CSparseFeatures< ST >, CStringFeatures< ST >, CSimpleFeatures< double >, CSimpleFeatures< float >, CSimpleFeatures< int >, CSimpleFeatures< short int >, CSimpleFeatures< unsigned char >, CSimpleFeatures< char >, CSimpleFeatures< unsigned short int >, CSparseFeatures< double >, CStringFeatures< unsigned char >, and CStringFeatures< unsigned short int >.

void CFeatures::list_feature_obj ( )

list feature object

Definition at line 152 of file Features.cpp.

bool CFeatures::load ( CHAR * fname ) [virtual]

load features from file

Parameters:

fname

filename to load from

Returns:: if loading was successful

Reimplemented in CByteFeatures, CCharFeatures, CIntFeatures, CRealFeatures, CShortFeatures, CShortRealFeatures, CStringFeatures< ST >, CWordFeatures, CStringFeatures< unsigned char >, and CStringFeatures< unsigned short int >.

Definition at line 213 of file Features.cpp.

bool CFeatures::save ( CHAR * fname ) [virtual]

save features to file

Parameters:

fname

filename to save to

Returns:: if saving was successful

Reimplemented in CByteFeatures, CCharFeatures, CIntFeatures, CRealFeatures, CShortFeatures, CShortRealFeatures, CStringFeatures< ST >, CWordFeatures, CStringFeatures< unsigned char >, and CStringFeatures< unsigned short int >.

Definition at line 218 of file Features.cpp.

bool CFeatures::check_feature_compatibility ( CFeatures * f )

check feature compatibility

Parameters:

f

features to check for compatibility

Returns:: if features are compatible

Definition at line 223 of file Features.cpp.

Member Data Documentation

CParallel CSGObject::parallel [static, inherited]

Definition at line 105 of file SGObject.h.

CIO CSGObject::io [static, inherited]

Definition at line 106 of file SGObject.h.

CVersion CSGObject::version [static, inherited]

Definition at line 107 of file SGObject.h.

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

CFeatures Class Reference

Detailed Description

Public Member Functions

Static Public Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation