mknn_general_domain.h File Reference

General Domain Constants. More...

#include "../metricknn_c.h"

Go to the source code of this file.

Functions
bool	mknn_generalDomain_areEqual (const MknnGeneralDomain general_domain1, const MknnGeneralDomain general_domain2)
	Returns if two domains are identical. More...
bool	mknn_generalDomain_isString (const MknnGeneralDomain general_domain)
bool	mknn_generalDomain_isVector (const MknnGeneralDomain general_domain)
bool	mknn_generalDomain_isMultiObject (const MknnGeneralDomain general_domain)
bool	mknn_generalDomain_isCustom (const MknnGeneralDomain general_domain)
const char *	mknn_generalDomain_toString (const MknnGeneralDomain general_domain)
bool	mknn_generalDomain_parseString (const char *string, MknnGeneralDomain *out_general_domain)

Variables
MknnGeneralDomain	MKNN_GENERAL_DOMAIN_STRING
	General Domain of Strings. More...
MknnGeneralDomain	MKNN_GENERAL_DOMAIN_VECTOR
	General Domain of Vectors. More...
MknnGeneralDomain	MKNN_GENERAL_DOMAIN_MULTIOBJECT
	General Domain of Multi-Object. More...
MknnGeneralDomain	MKNN_GENERAL_DOMAIN_CUSTOMOBJECT
	General Domain of Custom Objects. More...

Detailed Description

General Domain Constants.

Function Documentation

bool mknn_generalDomain_areEqual	(	const MknnGeneralDomain	general_domain1,
		const MknnGeneralDomain	general_domain2
	)

Returns if two domains are identical.

Parameters

general_domain1	one of the constants MKNN_GENERAL_DOMAIN_xxx.
general_domain2	one of the constants MKNN_GENERAL_DOMAIN_xxx.

Returns

true if general_domain1 and general_domain2 are identical.

bool mknn_generalDomain_parseString	(	const char *	string,
		MknnGeneralDomain *	out_general_domain
	)

Parameters

string

Returns

a general domain constant

Parameters

string	the string to read and parse a general domain. The string should be a value returned by mknn_generalDomain_toString.
out_general_domain	the parsed value

Returns

true if some value was assigned to out_general_domain

const char* mknn_generalDomain_toString

(

const MknnGeneralDomain

general_domain

)

Parameters

general_domain

the constant

Returns

a string with a string representation

Variable Documentation

MknnGeneralDomain MKNN_GENERAL_DOMAIN_CUSTOMOBJECT

General Domain of Custom Objects.

The custom objects are not casted, thus they cannot be saved or printed.

MknnGeneralDomain MKNN_GENERAL_DOMAIN_MULTIOBJECT

General Domain of Multi-Object.

The objects will be casted to void** (an array of objects).

MknnGeneralDomain MKNN_GENERAL_DOMAIN_STRING

General Domain of Strings.

The objects will be casted to char*. As usual in C, the end of each string is given by char '\0'.

MknnGeneralDomain MKNN_GENERAL_DOMAIN_VECTOR

General Domain of Vectors.

In order to declare a domain the number of dimensions and datatype are needed. The objects will be casted to datatype*. See MKNN_DATATYPE_xxx constants.