CDPL.Descr.ULVectorBulkSimilarityCalculator Class Reference

Inheritance diagram for CDPL.Descr.ULVectorBulkSimilarityCalculator:

Public Member Functions
None	__init__ ()
	Initializes the ULVectorBulkSimilarityCalculator instance.
None	__init__ (ULVectorBulkSimilarityCalculator calc)
	Initializes a copy of the ULVectorBulkSimilarityCalculator instance calc. More...
None	__init__ (DoubleULVector2Functor sim_func)
	Initializes the ULVectorBulkSimilarityCalculator instance. More...
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
ULVectorBulkSimilarityCalculator	assign (ULVectorBulkSimilarityCalculator calc)
	Replaces the current state of self with a copy of the state of the ULVectorBulkSimilarityCalculator instance calc. More...
None	setSimilarityFunction (DoubleULVector2Functor func)
DoubleULVector2Functor	getSimilarityFunction ()
None	clear ()
int	getNumDescriptors ()
None	addDescriptor (Math.ULVector descr)
bool	containsDescriptor (Math.ULVector descr)
Math.ULVector	getDescriptor (int idx)
None	removeDescriptor (int idx)
None	calculate (Math.ULVector descr, bool sort=False, bool sort_desc=True)
tuple	getResult (int idx)
float	getSimilarity (int idx)
int	getDescriptorIndex (int idx)
tuple	__getitem__ (int idx)
bool	__contains__ (Math.ULVector descr)
	Returns the result of the membership test operation descr in self. More...

Properties
	objectID = property(getObjectID)
	numDescriptors = property(getNumDescriptors)
	similarityFunc = property(getSimilarityFunction, setSimilarityFunction)

Constructor & Destructor Documentation

__init__() [1/2]

None CDPL.Descr.ULVectorBulkSimilarityCalculator.__init__

(

ULVectorBulkSimilarityCalculator

calc

)

Initializes a copy of the ULVectorBulkSimilarityCalculator instance calc.

Parameters

calc	The ULVectorBulkSimilarityCalculator instance to copy.

__init__() [2/2]

None CDPL.Descr.ULVectorBulkSimilarityCalculator.__init__

(

DoubleULVector2Functor

sim_func

)

Initializes the ULVectorBulkSimilarityCalculator instance.

Parameters

sim_func

Member Function Documentation

getObjectID()

int CDPL.Descr.ULVectorBulkSimilarityCalculator.getObjectID

(

)

Returns the numeric identifier (ID) of the wrapped C++ class instance.

Different Python ULVectorBulkSimilarityCalculator instances may reference the same underlying C++ class instance. The commonly used Python expression a is not b thus cannot tell reliably whether the two ULVectorBulkSimilarityCalculator instances a and b reference different C++ objects. The numeric identifier returned by this method allows to correctly implement such an identity test via the simple expression a.getObjectID() != b.getObjectID().

Returns

The numeric ID of the internally referenced C++ class instance.

assign()

ULVectorBulkSimilarityCalculator CDPL.Descr.ULVectorBulkSimilarityCalculator.assign

(

ULVectorBulkSimilarityCalculator

calc

)

Replaces the current state of self with a copy of the state of the ULVectorBulkSimilarityCalculator instance calc.

Parameters

calc	The ULVectorBulkSimilarityCalculator instance to copy.

Returns

self

setSimilarityFunction()

None CDPL.Descr.ULVectorBulkSimilarityCalculator.setSimilarityFunction

(

DoubleULVector2Functor

func

)

Parameters

func

getSimilarityFunction()

DoubleULVector2Functor CDPL.Descr.ULVectorBulkSimilarityCalculator.getSimilarityFunction

(

)

Returns

getNumDescriptors()

int CDPL.Descr.ULVectorBulkSimilarityCalculator.getNumDescriptors

(

)

Returns

addDescriptor()

None CDPL.Descr.ULVectorBulkSimilarityCalculator.addDescriptor

(

Math.ULVector

descr

)

Parameters

descr

containsDescriptor()

bool CDPL.Descr.ULVectorBulkSimilarityCalculator.containsDescriptor

(

Math.ULVector

descr

)

Parameters

descr

Returns

getDescriptor()

Math.ULVector CDPL.Descr.ULVectorBulkSimilarityCalculator.getDescriptor

(

int

idx

)

Parameters

idx

Returns

removeDescriptor()

None CDPL.Descr.ULVectorBulkSimilarityCalculator.removeDescriptor

(

int

idx

)

Parameters

idx

calculate()

None CDPL.Descr.ULVectorBulkSimilarityCalculator.calculate	(	Math.ULVector	descr,
		bool	sort = False,
		bool	sort_desc = True
	)

Parameters

descr
sort
sort_desc

getResult()

tuple CDPL.Descr.ULVectorBulkSimilarityCalculator.getResult

(

int

idx

)

Parameters

idx

Returns

getSimilarity()

float CDPL.Descr.ULVectorBulkSimilarityCalculator.getSimilarity

(

int

idx

)

Parameters

idx

Returns

getDescriptorIndex()

int CDPL.Descr.ULVectorBulkSimilarityCalculator.getDescriptorIndex

(

int

idx

)

Parameters

idx

Returns

__getitem__()

tuple CDPL.Descr.ULVectorBulkSimilarityCalculator.__getitem__

(

int

idx

)

Parameters

idx

Returns

__contains__()

bool CDPL.Descr.ULVectorBulkSimilarityCalculator.__contains__

(

Math.ULVector

descr

)

Returns the result of the membership test operation descr in self.

Parameters

descr

The value to test for membership.

Returns

The result of the membership test operation.