CDPL.Descr.ManhattanDistance Class Reference

Functor class for calculating the Manhattan Distance [MADI] between bitsets and vectors. More...

Inheritance diagram for CDPL.Descr.ManhattanDistance:

Public Member Functions
None	__init__ ()
	Initializes the ManhattanDistance instance.
None	__init__ (ManhattanDistance func)
	Initializes a copy of the ManhattanDistance instance func. More...
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
ManhattanDistance	assign (ManhattanDistance func)
	Replaces the current state of self with a copy of the state of the ManhattanDistance instance func. More...
float	__call__ (Math.FVector v1, Math.FVector v2)
	Calculates the Manhattan Distance [MADI] between the vectors v1 and v2. More...
float	__call__ (Math.DVector v1, Math.DVector v2)
	Calculates the Manhattan Distance [MADI] between the vectors v1 and v2. More...
float	__call__ (Math.LVector v1, Math.LVector v2)
	Calculates the Manhattan Distance [MADI] between the vectors v1 and v2. More...
float	__call__ (Math.ULVector v1, Math.ULVector v2)
	Calculates the Manhattan Distance [MADI] between the vectors v1 and v2. More...

Properties
	objectID = property(getObjectID)

Detailed Description

Functor class for calculating the Manhattan Distance [MADI] between bitsets and vectors.

Constructor & Destructor Documentation

__init__()

None CDPL.Descr.ManhattanDistance.__init__

(

ManhattanDistance

func

)

Initializes a copy of the ManhattanDistance instance func.

Parameters

func	The ManhattanDistance instance to copy.

Member Function Documentation

getObjectID()

int CDPL.Descr.ManhattanDistance.getObjectID

(

)

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

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

ManhattanDistance CDPL.Descr.ManhattanDistance.assign

(

ManhattanDistance

func

)

Replaces the current state of self with a copy of the state of the ManhattanDistance instance func.

Parameters

func	The ManhattanDistance instance to copy.

Returns

self

__call__() [1/4]

float CDPL.Descr.ManhattanDistance.__call__	(	Math.FVector	v1,
		Math.FVector	v2
	)

Calculates the Manhattan Distance [MADI] between the vectors v1 and v2.

The Manhattan Distance \( D_{12} \) is calculated by:

[ D_{12} = {\left | \vec{v}_1 - \vec{v}_2 \right |}_1 ]

Parameters

v1	The first vector.
v2	The second vector.

Returns

The calculated distance measure.

__call__() [2/4]

float CDPL.Descr.ManhattanDistance.__call__	(	Math.DVector	v1,
		Math.DVector	v2
	)

Calculates the Manhattan Distance [MADI] between the vectors v1 and v2.

The Manhattan Distance \( D_{12} \) is calculated by:

[ D_{12} = {\left | \vec{v}_1 - \vec{v}_2 \right |}_1 ]

Parameters

v1	The first vector.
v2	The second vector.

Returns

The calculated distance measure.

__call__() [3/4]

float CDPL.Descr.ManhattanDistance.__call__	(	Math.LVector	v1,
		Math.LVector	v2
	)

Calculates the Manhattan Distance [MADI] between the vectors v1 and v2.

The Manhattan Distance \( D_{12} \) is calculated by:

[ D_{12} = {\left | \vec{v}_1 - \vec{v}_2 \right |}_1 ]

Parameters

v1	The first vector.
v2	The second vector.

Returns

The calculated distance measure.

__call__() [4/4]

float CDPL.Descr.ManhattanDistance.__call__	(	Math.ULVector	v1,
		Math.ULVector	v2
	)

Calculates the Manhattan Distance [MADI] between the vectors v1 and v2.

The Manhattan Distance \( D_{12} \) is calculated by:

[ D_{12} = {\left | \vec{v}_1 - \vec{v}_2 \right |}_1 ]

Parameters

v1	The first vector.
v2	The second vector.

Returns

The calculated distance measure.