CDPL.Descr.DVectorBulkSimilarityCalculator Class Reference

Inheritance diagram for CDPL.Descr.DVectorBulkSimilarityCalculator:

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

(

DVectorBulkSimilarityCalculator

calc

)

Initializes a copy of the DVectorBulkSimilarityCalculator instance calc.

Parameters

calc	The DVectorBulkSimilarityCalculator instance to copy.

__init__() [2/2]

None CDPL.Descr.DVectorBulkSimilarityCalculator.__init__

(

Math.DoubleDVector2Functor

sim_func

)

Initializes the DVectorBulkSimilarityCalculator instance.

Parameters

sim_func

Member Function Documentation

getObjectID()

int CDPL.Descr.DVectorBulkSimilarityCalculator.getObjectID

(

)

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

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

DVectorBulkSimilarityCalculator CDPL.Descr.DVectorBulkSimilarityCalculator.assign

(

DVectorBulkSimilarityCalculator

calc

)

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

Parameters

calc	The DVectorBulkSimilarityCalculator instance to copy.

Returns

self

setSimilarityFunction()

None CDPL.Descr.DVectorBulkSimilarityCalculator.setSimilarityFunction

(

Math.DoubleDVector2Functor

func

)

Parameters

func

getSimilarityFunction()

Math.DoubleDVector2Functor CDPL.Descr.DVectorBulkSimilarityCalculator.getSimilarityFunction

(

)

Returns

getNumDescriptors()

int CDPL.Descr.DVectorBulkSimilarityCalculator.getNumDescriptors

(

)

Returns

addDescriptor()

None CDPL.Descr.DVectorBulkSimilarityCalculator.addDescriptor

(

Math.DVector

descr

)

Parameters

descr

containsDescriptor()

bool CDPL.Descr.DVectorBulkSimilarityCalculator.containsDescriptor

(

Math.DVector

descr

)

Parameters

descr

Returns

getDescriptor()

Math.DVector CDPL.Descr.DVectorBulkSimilarityCalculator.getDescriptor

(

int

idx

)

Parameters

idx

Returns

removeDescriptor()

None CDPL.Descr.DVectorBulkSimilarityCalculator.removeDescriptor

(

int

idx

)

Parameters

idx

calculate()

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

Parameters

descr
sort
sort_desc

getResult()

tuple CDPL.Descr.DVectorBulkSimilarityCalculator.getResult

(

int

idx

)

Parameters

idx

Returns

getSimilarity()

float CDPL.Descr.DVectorBulkSimilarityCalculator.getSimilarity

(

int

idx

)

Parameters

idx

Returns

getDescriptorIndex()

int CDPL.Descr.DVectorBulkSimilarityCalculator.getDescriptorIndex

(

int

idx

)

Parameters

idx

Returns

__getitem__()

tuple CDPL.Descr.DVectorBulkSimilarityCalculator.__getitem__

(

int

idx

)

Parameters

idx

Returns

__contains__()

bool CDPL.Descr.DVectorBulkSimilarityCalculator.__contains__

(

Math.DVector

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.