CDPL.Descr.FVectorBulkSimilarityCalculator Class Reference

Inheritance diagram for CDPL.Descr.FVectorBulkSimilarityCalculator:

Public Member Functions
None	__init__ ()
	Initializes the FVectorBulkSimilarityCalculator instance.
None	__init__ (FVectorBulkSimilarityCalculator calc)
	Initializes a copy of the FVectorBulkSimilarityCalculator instance calc. More...
None	__init__ (DoubleFVector2Functor sim_func)
	Initializes the FVectorBulkSimilarityCalculator instance. More...
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
FVectorBulkSimilarityCalculator	assign (FVectorBulkSimilarityCalculator calc)
	Replaces the current state of self with a copy of the state of the FVectorBulkSimilarityCalculator instance calc. More...
None	setSimilarityFunction (DoubleFVector2Functor func)
DoubleFVector2Functor	getSimilarityFunction ()
None	clear ()
int	getNumDescriptors ()
None	addDescriptor (Math.FVector descr)
bool	containsDescriptor (Math.FVector descr)
Math.FVector	getDescriptor (int idx)
None	removeDescriptor (int idx)
None	calculate (Math.FVector 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.FVector 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.FVectorBulkSimilarityCalculator.__init__

(

FVectorBulkSimilarityCalculator

calc

)

Initializes a copy of the FVectorBulkSimilarityCalculator instance calc.

Parameters

calc	The FVectorBulkSimilarityCalculator instance to copy.

__init__() [2/2]

None CDPL.Descr.FVectorBulkSimilarityCalculator.__init__

(

DoubleFVector2Functor

sim_func

)

Initializes the FVectorBulkSimilarityCalculator instance.

Parameters

sim_func

Member Function Documentation

getObjectID()

int CDPL.Descr.FVectorBulkSimilarityCalculator.getObjectID

(

)

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

Different Python FVectorBulkSimilarityCalculator 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 FVectorBulkSimilarityCalculator 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()

FVectorBulkSimilarityCalculator CDPL.Descr.FVectorBulkSimilarityCalculator.assign

(

FVectorBulkSimilarityCalculator

calc

)

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

Parameters

calc	The FVectorBulkSimilarityCalculator instance to copy.

Returns

self

setSimilarityFunction()

None CDPL.Descr.FVectorBulkSimilarityCalculator.setSimilarityFunction

(

DoubleFVector2Functor

func

)

Parameters

func

getSimilarityFunction()

DoubleFVector2Functor CDPL.Descr.FVectorBulkSimilarityCalculator.getSimilarityFunction

(

)

Returns

getNumDescriptors()

int CDPL.Descr.FVectorBulkSimilarityCalculator.getNumDescriptors

(

)

Returns

addDescriptor()

None CDPL.Descr.FVectorBulkSimilarityCalculator.addDescriptor

(

Math.FVector

descr

)

Parameters

descr

containsDescriptor()

bool CDPL.Descr.FVectorBulkSimilarityCalculator.containsDescriptor

(

Math.FVector

descr

)

Parameters

descr

Returns

getDescriptor()

Math.FVector CDPL.Descr.FVectorBulkSimilarityCalculator.getDescriptor

(

int

idx

)

Parameters

idx

Returns

removeDescriptor()

None CDPL.Descr.FVectorBulkSimilarityCalculator.removeDescriptor

(

int

idx

)

Parameters

idx

calculate()

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

Parameters

descr
sort
sort_desc

getResult()

tuple CDPL.Descr.FVectorBulkSimilarityCalculator.getResult

(

int

idx

)

Parameters

idx

Returns

getSimilarity()

float CDPL.Descr.FVectorBulkSimilarityCalculator.getSimilarity

(

int

idx

)

Parameters

idx

Returns

getDescriptorIndex()

int CDPL.Descr.FVectorBulkSimilarityCalculator.getDescriptorIndex

(

int

idx

)

Parameters

idx

Returns

__getitem__()

tuple CDPL.Descr.FVectorBulkSimilarityCalculator.__getitem__

(

int

idx

)

Parameters

idx

Returns

__contains__()

bool CDPL.Descr.FVectorBulkSimilarityCalculator.__contains__

(

Math.FVector

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.