CHierarchical Class Reference

Inheritance diagram for CHierarchical:

Detailed Description

class Hierarchical

Definition at line 24 of file Hierarchical.h.


Public Member Functions
	CHierarchical ()
	CHierarchical (INT merges, CDistance *d)
virtual	~CHierarchical ()
virtual EClassifierType	get_classifier_type ()
virtual bool	train ()
virtual bool	load (FILE *srcfile)
virtual bool	save (FILE *dstfile)
void	set_merges (INT m)
INT	get_merges ()
void	get_assignment (INT *&assign, INT &num)
void	get_merge_distance (DREAL *&dist, INT &num)
void	get_merge_distances (DREAL *dist, INT num)
void	get_pairs (INT *&tuples, INT &rows, INT &num)
void	get_cluster_pairs (INT *tuples, INT rows, INT *num)
void	set_distance (CDistance *d)
CDistance *	get_distance ()
virtual CLabels *	classify (CLabels *output=NULL)
virtual DREAL	classify_example (INT num)
virtual void	set_labels (CLabels *lab)
virtual CLabels *	get_labels ()
virtual DREAL	get_label (INT i)
void	set_max_train_time (DREAL t)
DREAL	get_max_train_time ()
Static Public Attributes
static CParallel	parallel
static CIO	io
static CVersion	version
Protected Attributes
INT	merges
	the number of merges in hierarchical clustering
INT	dimensions
	number of dimensions
INT	assignment_size
	size of assignment table
INT *	assignment
	cluster assignment for the num_points
INT	table_size
	size of the below tables
INT *	pairs
	tuples of i/j
DREAL *	merge_distance
	distance at which pair i/j was added
CDistance *	distance
DREAL	max_train_time
CLabels *	labels

Constructor & Destructor Documentation

CHierarchical::CHierarchical ( )

default constructor

Definition at line 22 of file Hierarchical.cpp.

CHierarchical::CHierarchical	(	INT	merges,
		CDistance *	d
	)

constructor

Parameters:

	merges	the merges
	d	distance

Definition at line 28 of file Hierarchical.cpp.

CHierarchical::~CHierarchical ( ) [virtual]

Definition at line 35 of file Hierarchical.cpp.

Member Function Documentation

virtual EClassifierType CHierarchical::get_classifier_type ( ) [virtual]

get classifier type

Returns:: classifier type HIERARCHICAL

Reimplemented from CClassifier.

Definition at line 42 of file Hierarchical.h.

bool CHierarchical::train ( ) [virtual]

train distance machine

Returns:: if training was successful

Reimplemented from CClassifier.

Definition at line 42 of file Hierarchical.cpp.

bool CHierarchical::load ( FILE * srcfile ) [virtual]

load distance machine from file

Parameters:

srcfile

file to load from

Returns:: if loading was successful

Reimplemented from CClassifier.

Definition at line 137 of file Hierarchical.cpp.

bool CHierarchical::save ( FILE * dstfile ) [virtual]

save distance machine to file

Parameters:

dstfile

file to save to

Returns:: if saving was successful

Reimplemented from CClassifier.

Definition at line 142 of file Hierarchical.cpp.

void CHierarchical::set_merges ( INT m )

set merges

Parameters:

m

new merges

Definition at line 68 of file Hierarchical.h.

INT CHierarchical::get_merges ( )

get merges

Returns:: merges

Definition at line 78 of file Hierarchical.h.

void CHierarchical::get_assignment	(	INT *&	assign,
		INT &	num
	)

get assignment

Parameters:

	assign	current assignment is stored in here
	num	number of assignments is stored in here

Definition at line 88 of file Hierarchical.h.

void CHierarchical::get_merge_distance	(	DREAL *&	dist,
		INT &	num
	)

get merge distance

Parameters:

	dist	current merge distance is stored in here
	num	number of merge distances is stored in here

Definition at line 99 of file Hierarchical.h.

void CHierarchical::get_merge_distances	(	DREAL **	dist,
		INT *	num
	)

get merge distances (swig compatible)

Parameters:

	dist	current merge distances is stored in here
	num	number of merge distances is stored in here

Definition at line 110 of file Hierarchical.h.

void CHierarchical::get_pairs	(	INT *&	tuples,
		INT &	rows,
		INT &	num
	)

get pairs

Parameters:

	tuples	current pairs are stored in here
	rows	number of rows is stored in here
	num	number of pairs is stored in here

Definition at line 126 of file Hierarchical.h.

void CHierarchical::get_cluster_pairs	(	INT **	tuples,
		INT *	rows,
		INT *	num
	)

get cluster pairs (swig compatible)

Parameters:

	tuples	current pairs are stored in here
	rows	number of rows is stored in here
	num	number of pairs is stored in here

Definition at line 139 of file Hierarchical.h.

void CDistanceMachine::set_distance ( CDistance * d ) [inherited]

set distance

Parameters:

d

distance to set

Definition at line 34 of file DistanceMachine.h.

CDistance* CDistanceMachine::get_distance ( ) [inherited]

get distance

Returns:: distance

Definition at line 45 of file DistanceMachine.h.

CLabels * CClassifier::classify ( CLabels * output = NULL ) [virtual, inherited]

classify object

Parameters:

output

classified labels

Returns:: classified labels

Reimplemented in CKNN, CLinearClassifier, CPluginEstimate, CSparseLinearClassifier, CMultiClassSVM, CSVM, CWDSVMOcas, and CKernelMachine.

Definition at line 22 of file Classifier.cpp.

virtual DREAL CClassifier::classify_example ( INT num ) [virtual, inherited]

classify one example

abstract base method

Parameters:

num

which example to classify

Returns:: infinite float value

Reimplemented in CKernelPerceptron, CKNN, CLinearClassifier, CPluginEstimate, CSparseLinearClassifier, CMultiClassSVM, CSVM, and CWDSVMOcas.

Definition at line 47 of file Classifier.h.

virtual void CClassifier::set_labels ( CLabels * lab ) [virtual, inherited]

set labels

Parameters:

lab

labels

Definition at line 71 of file Classifier.h.

virtual CLabels* CClassifier::get_labels ( ) [virtual, inherited]

get labels

Returns:: labels

Definition at line 82 of file Classifier.h.

virtual DREAL CClassifier::get_label ( INT i ) [virtual, inherited]

get one specific label

Parameters:

i

index of label to get

Returns:: value of label at index i

Definition at line 89 of file Classifier.h.

void CClassifier::set_max_train_time ( DREAL t ) [inherited]

set maximum training time

Parameters:

t

maximimum training time

Definition at line 95 of file Classifier.h.

DREAL CClassifier::get_max_train_time ( ) [inherited]

get maximum training time

Returns:: maximum training time

Definition at line 101 of file Classifier.h.

Member Data Documentation

INT CHierarchical::merges [protected]

the number of merges in hierarchical clustering

Definition at line 152 of file Hierarchical.h.

INT CHierarchical::dimensions [protected]

number of dimensions

Definition at line 155 of file Hierarchical.h.

INT CHierarchical::assignment_size [protected]

size of assignment table

Definition at line 158 of file Hierarchical.h.

INT* CHierarchical::assignment [protected]

cluster assignment for the num_points

Definition at line 161 of file Hierarchical.h.

INT CHierarchical::table_size [protected]

size of the below tables

Definition at line 164 of file Hierarchical.h.

INT* CHierarchical::pairs [protected]

tuples of i/j

Definition at line 167 of file Hierarchical.h.

DREAL* CHierarchical::merge_distance [protected]

distance at which pair i/j was added

Definition at line 170 of file Hierarchical.h.

CDistance* CDistanceMachine::distance [protected, inherited]

the distance

Definition at line 49 of file DistanceMachine.h.

DREAL CClassifier::max_train_time [protected, inherited]

maximum training time

Definition at line 111 of file Classifier.h.

CLabels* CClassifier::labels [protected, inherited]

labels

Definition at line 114 of file Classifier.h.

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:

CHierarchical Class Reference

Detailed Description

Public Member Functions

Static Public Attributes

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation