CShortFeatures Class Reference

Inheritance diagram for CShortFeatures:

[legend]

List of all members.

Public Member Functions
	CShortFeatures (int32_t size=0)
	CShortFeatures (const CShortFeatures &orig)
	CShortFeatures (int16_t *src, int32_t num_feat, int32_t num_vec)
	CShortFeatures (char *fname)
bool	obtain_from_char_features (CCharFeatures *cf, int32_t start, int32_t order, int32_t gap=0)
virtual EFeatureType	get_feature_type ()
virtual void	copy_feature_matrix (int16_t *src, int32_t num_feat, int32_t num_vec)
virtual bool	load (char *fname)
virtual bool	save (char *fname)
Protected Member Functions
void	translate_from_single_order (int16_t *obs, int32_t sequence_length, int32_t start, int32_t order, int32_t max_val, int32_t gap)

---

Detailed Description

The class ShortFeatures implements a dense short integer matrix. It inherits its functionality from CSimpleFeatures, which should be consulted for further reference.

Definition at line 23 of file ShortFeatures.h.

---

Constructor & Destructor Documentation

CShortFeatures::CShortFeatures

(

int32_t

size = 0

)

constructor

Parameters:

size

cache size

Definition at line 15 of file ShortFeatures.cpp.

CShortFeatures::CShortFeatures

(

const CShortFeatures &

orig

)

copy constructor

Definition at line 20 of file ShortFeatures.cpp.

CShortFeatures::CShortFeatures	(	int16_t *	src,
		int32_t	num_feat,
		int32_t	num_vec
	)

constructor that copies feature matrix from pointer num_feat,num_vec pair

Parameters:

	src	feature matrix to copy
	num_feat	number of features
	num_vec	number of vectors

Definition at line 42 of file ShortFeatures.h.

CShortFeatures::CShortFeatures

(

char *

fname

)

constructor

Parameters:

fname

filename to load features from

Definition at line 25 of file ShortFeatures.cpp.

---

Member Function Documentation

virtual void CShortFeatures::copy_feature_matrix	(	int16_t *	src,
		int32_t	num_feat,
		int32_t	num_vec
	)			[virtual]

copy feature matrix

wrapper to base class' method

Parameters:

	src	feature matrix to copy
	num_feat	number of features
	num_vec	number of vectors

Reimplemented from CSimpleFeatures< int16_t >.

Definition at line 77 of file ShortFeatures.h.

virtual EFeatureType CShortFeatures::get_feature_type

(

)

[virtual]

get feature type

Returns:

feature type SHORT

Reimplemented from CSimpleFeatures< int16_t >.

Definition at line 67 of file ShortFeatures.h.

bool CShortFeatures::load

(

char *

fname

)

[virtual]

load features from file

Parameters:

fname

filename to load from

Returns:

if loading was successful

Reimplemented from CFeatures.

Definition at line 126 of file ShortFeatures.cpp.

bool CShortFeatures::obtain_from_char_features	(	CCharFeatures *	cf,
		int32_t	start,
		int32_t	order,
		int32_t	gap = 0
	)

obtain from char features

Parameters:

	cf	char features
	start	start
	order	order
	gap	gap

Returns:

if obtaining was successful

Definition at line 30 of file ShortFeatures.cpp.

bool CShortFeatures::save

(

char *

fname

)

[virtual]

save features to file

Parameters:

fname

filename to save to

Returns:

if saving was successful

Reimplemented from CFeatures.

Definition at line 131 of file ShortFeatures.cpp.

void CShortFeatures::translate_from_single_order	(	int16_t *	obs,
		int32_t	sequence_length,
		int32_t	start,
		int32_t	order,
		int32_t	max_val,
		int32_t	gap
	)			[protected]

translate from single order

Parameters:

	obs	observation
	sequence_length	length of sequence
	start	start
	order	order
	max_val	maximum value
	gap	gap

Definition at line 75 of file ShortFeatures.cpp.

---

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

• ShortFeatures.h
• ShortFeatures.cpp