CDPL.Descr.BitSetBulkSimilarityCalculator Class Reference

Inheritance diagram for CDPL.Descr.BitSetBulkSimilarityCalculator:

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

(

BitSetBulkSimilarityCalculator

calc

)

Initializes a copy of the BitSetBulkSimilarityCalculator instance calc.

Parameters

calc	The BitSetBulkSimilarityCalculator instance to copy.

__init__() [2/2]

None CDPL.Descr.BitSetBulkSimilarityCalculator.__init__

(

DoubleBitSet2Functor

sim_func

)

Initializes the BitSetBulkSimilarityCalculator instance.

Parameters

sim_func

Member Function Documentation

getObjectID()

int CDPL.Descr.BitSetBulkSimilarityCalculator.getObjectID

(

)

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

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

BitSetBulkSimilarityCalculator CDPL.Descr.BitSetBulkSimilarityCalculator.assign

(

BitSetBulkSimilarityCalculator

calc

)

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

Parameters

calc	The BitSetBulkSimilarityCalculator instance to copy.

Returns

self

setSimilarityFunction()

None CDPL.Descr.BitSetBulkSimilarityCalculator.setSimilarityFunction

(

DoubleBitSet2Functor

func

)

Parameters

func

getSimilarityFunction()

DoubleBitSet2Functor CDPL.Descr.BitSetBulkSimilarityCalculator.getSimilarityFunction

(

)

Returns

getNumDescriptors()

int CDPL.Descr.BitSetBulkSimilarityCalculator.getNumDescriptors

(

)

Returns

addDescriptor()

None CDPL.Descr.BitSetBulkSimilarityCalculator.addDescriptor

(

Util.BitSet

descr

)

Parameters

descr

containsDescriptor()

bool CDPL.Descr.BitSetBulkSimilarityCalculator.containsDescriptor

(

Util.BitSet

descr

)

Parameters

descr

Returns

getDescriptor()

Util.BitSet CDPL.Descr.BitSetBulkSimilarityCalculator.getDescriptor

(

int

idx

)

Parameters

idx

Returns

removeDescriptor()

None CDPL.Descr.BitSetBulkSimilarityCalculator.removeDescriptor

(

int

idx

)

Parameters

idx

calculate()

None CDPL.Descr.BitSetBulkSimilarityCalculator.calculate	(	Util.BitSet	descr,
		bool	sort = False,
		bool	sort_desc = True
	)

Parameters

descr
sort
sort_desc

getResult()

tuple CDPL.Descr.BitSetBulkSimilarityCalculator.getResult

(

int

idx

)

Parameters

idx

Returns

getSimilarity()

float CDPL.Descr.BitSetBulkSimilarityCalculator.getSimilarity

(

int

idx

)

Parameters

idx

Returns

getDescriptorIndex()

int CDPL.Descr.BitSetBulkSimilarityCalculator.getDescriptorIndex

(

int

idx

)

Parameters

idx

Returns

__getitem__()

tuple CDPL.Descr.BitSetBulkSimilarityCalculator.__getitem__

(

int

idx

)

Parameters

idx

Returns

__contains__()

bool CDPL.Descr.BitSetBulkSimilarityCalculator.__contains__

(

Util.BitSet

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.