Vector expression that exposes a vector as its homogeneous-coordinate extension by appending an implicit 1 at the end. More...

Inheritance diagram for CDPL.Math.DHomogenousCoordsAdapter:

Public Member Functions
None	__init__ (DHomogenousCoordsAdapter va)
	Contructs a copy of the `DHomogenousCoordsAdapter` instance va. More...

None	__init__ (DVectorExpression v)
	Constructs the adapter wrapping v. More...

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

DHomogenousCoordsAdapter	assign (ConstFVectorExpression e)
	Assigns the vector expression e to this view (writing through to the wrapped vector). More...

DHomogenousCoordsAdapter	assign (ConstDVectorExpression e)
	Assigns the vector expression e to this view (writing through to the wrapped vector). More...

DHomogenousCoordsAdapter	assign (ConstLVectorExpression e)
	Assigns the vector expression e to this view (writing through to the wrapped vector). More...

DHomogenousCoordsAdapter	assign (ConstULVectorExpression e)
	Assigns the vector expression e to this view (writing through to the wrapped vector). More...

DHomogenousCoordsAdapter	assign (DHomogenousCoordsAdapter va)
	Copies the elements of va into this view (writing through to the wrapped vector and to the extension element). More...

DHomogenousCoordsAdapter	assign (object a)
	Assigns the contents of the `numpy.ndarray` object a to this view. More...

bool	isEmpty ()
	Tells whether the view is empty (always `False`). More...

int	getSize ()
	Returns the dimensionality of the view (wrapped vector size + 1). More...

float	getElement (int i)
	Returns the element at index i of the view. More...

object	toArray ()
	Converts the `DHomogenousCoordsAdapter` instance into a corresponding `numpy.ndarray` object. More...

None	swap (DHomogenousCoordsAdapter va)
	Swaps the contents of this view with those of va. More...

None	setElement (int i, float v)
	Sets the value of the element at index i of the view to v. More...

DVectorExpression	getData ()
	Returns the wrapped vector. More...

bool	__eq__ (DHomogenousCoordsAdapter va)
	Returns the result of the comparison operation `self == va`. More...

bool	__eq__ (ConstDVectorExpression e)
	Returns the result of the comparison operation `self == e`. More...

bool	__ne__ (DHomogenousCoordsAdapter va)
	Returns the result of the comparison operation `self != va`. More...

bool	__ne__ (ConstDVectorExpression e)
	Returns the result of the comparison operation `self != e`. More...

float	__call__ (int i)
	Returns the element at index i of the view. More...

float	__getitem__ (int i)
	Returns the element at index i of the view. More...

int	__len__ ()
	Returns the dimensionality of the view (wrapped vector size + 1). More...

str	__str__ ()
	Returns a string representation of the `DHomogenousCoordsAdapter` instance. More...

DHomogenousCoordsAdapter	__pos__ ()
	Returns self. More...

ConstDVectorExpression	__neg__ ()
	Returns the result of the operation `self * -1`. More...

ConstDVectorExpression	__add__ (ConstDVectorExpression e)
	Returns the result of the addition operation `self + e`. More...

ConstDVectorExpression	__sub__ (ConstDVectorExpression e)
	Returns the result of the subtraction operation `self - e`. More...

ConstDVectorExpression	__mul__ (float t)
	Returns the result of the multiplication operation `self * t`. More...

ConstDVectorExpression	__mul__ (ConstDMatrixExpression e)
	Returns the result of the multiplication operation `self * e`. More...

ConstDVectorExpression	__div__ (float t)
	Returns the result of the division operation `self // t`. More...

ConstDVectorExpression	__truediv__ (float t)
	Returns the result of the true division operation `self / t`. More...

ConstDVectorExpression	__rmul__ (float t)
	Returns the result of the multiplication operation `t * self`. More...

None	__setitem__ (int i, float v)
	Sets the value of the element at index i of the view to v. More...

DHomogenousCoordsAdapter	__iadd__ (DHomogenousCoordsAdapter va)
	Adds the vector adapter va componentwise to this view. More...

DHomogenousCoordsAdapter	__iadd__ (ConstDVectorExpression e)
	Adds the vector expression e componentwise to this view. More...

DHomogenousCoordsAdapter	__isub__ (DHomogenousCoordsAdapter va)
	Subtracts the vector adapter va componentwise from this view. More...

DHomogenousCoordsAdapter	__isub__ (ConstDVectorExpression e)
	Subtracts the vector expression e componentwise from this view. More...

DHomogenousCoordsAdapter	__imul__ (float t)
	Multiplies every element of this view by the scalar t. More...

DHomogenousCoordsAdapter	__idiv__ (float t)
	Divides every element of this view by the scalar t. More...

DHomogenousCoordsAdapter	__itruediv__ (float t)
	Divides every element of this view by the scalar t. More...

Properties
	objectID = property(getObjectID)

	size = property(getSize)

	data = property(getData)

Detailed Description

Vector expression that exposes a vector as its homogeneous-coordinate extension by appending an implicit 1 at the end.

Constructor & Destructor Documentation

◆ init() [1/2]

None CDPL.Math.DHomogenousCoordsAdapter.__init__ ( DHomogenousCoordsAdapter va )

Contructs a copy of the DHomogenousCoordsAdapter instance va.

Parameters

va	The `DHomogenousCoordsAdapter` instance to copy.

◆ init() [2/2]

None CDPL.Math.DHomogenousCoordsAdapter.__init__ ( DVectorExpression v )

Constructs the adapter wrapping v.

Parameters

v	The vector to be viewed as its homogeneous-coordinate extension.

Member Function Documentation

◆ getObjectID()

int CDPL.Math.DHomogenousCoordsAdapter.getObjectID ( )

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

Different Python DHomogenousCoordsAdapter 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 DHomogenousCoordsAdapter 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() [1/6]

DHomogenousCoordsAdapter CDPL.Math.DHomogenousCoordsAdapter.assign ( ConstFVectorExpression e )

Assigns the vector expression e to this view (writing through to the wrapped vector).

Parameters

e	The source vector expression.

Returns: self.

◆ assign() [2/6]

DHomogenousCoordsAdapter CDPL.Math.DHomogenousCoordsAdapter.assign ( ConstDVectorExpression e )

Assigns the vector expression e to this view (writing through to the wrapped vector).

Parameters

e	The source vector expression.

Returns: self.

◆ assign() [3/6]

DHomogenousCoordsAdapter CDPL.Math.DHomogenousCoordsAdapter.assign ( ConstLVectorExpression e )

Assigns the vector expression e to this view (writing through to the wrapped vector).

Parameters

e	The source vector expression.

Returns: self.

◆ assign() [4/6]

DHomogenousCoordsAdapter CDPL.Math.DHomogenousCoordsAdapter.assign ( ConstULVectorExpression e )

Assigns the vector expression e to this view (writing through to the wrapped vector).

Parameters

e	The source vector expression.

Returns: self.

◆ assign() [5/6]

DHomogenousCoordsAdapter CDPL.Math.DHomogenousCoordsAdapter.assign ( DHomogenousCoordsAdapter va )

Copies the elements of va into this view (writing through to the wrapped vector and to the extension element).

Parameters

va	The source adapter.

Returns: self.

◆ assign() [6/6]

DHomogenousCoordsAdapter CDPL.Math.DHomogenousCoordsAdapter.assign ( object a )

Assigns the contents of the numpy.ndarray object a to this view.

Parameters

a	The `numpy.ndarray` object.

See also: [NUMPY]

◆ isEmpty()

bool CDPL.Math.DHomogenousCoordsAdapter.isEmpty ( )

Tells whether the view is empty (always False).

Returns: False.

◆ getSize()

int CDPL.Math.DHomogenousCoordsAdapter.getSize ( )

Returns the dimensionality of the view (wrapped vector size + 1).

Returns: The view size.

◆ getElement()

float CDPL.Math.DHomogenousCoordsAdapter.getElement ( int i )

Returns the element at index i of the view.

Parameters

i	The zero-based index within the view.

Returns: The value of the element.

◆ toArray()

object CDPL.Math.DHomogenousCoordsAdapter.toArray ( )

Converts the DHomogenousCoordsAdapter instance into a corresponding numpy.ndarray object.

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ swap()

None CDPL.Math.DHomogenousCoordsAdapter.swap ( DHomogenousCoordsAdapter va )

Swaps the contents of this view with those of va.

Parameters

va	The view to swap with.

◆ setElement()

None CDPL.Math.DHomogenousCoordsAdapter.setElement	(	int	i,
		float	v
	)

Sets the value of the element at index i of the view to v.

Parameters

i	The zero-based index within the view.
v	The new value of the element.

Exceptions

Base.IndexError if i is not in the range [0, getSize()).

◆ getData()

DVectorExpression CDPL.Math.DHomogenousCoordsAdapter.getData ( )

Returns the wrapped vector.

Returns: The wrapped vector closure.

◆ eq() [1/2]

bool CDPL.Math.DHomogenousCoordsAdapter.__eq__ ( DHomogenousCoordsAdapter va )

Returns the result of the comparison operation self == va.

Parameters

va	The `DHomogenousCoordsAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

bool CDPL.Math.DHomogenousCoordsAdapter.__eq__ ( ConstDVectorExpression e )

Returns the result of the comparison operation self == e.

Parameters

e	The `ConstDVectorExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [1/2]

bool CDPL.Math.DHomogenousCoordsAdapter.__ne__ ( DHomogenousCoordsAdapter va )

Returns the result of the comparison operation self != va.

Parameters

va	The `DHomogenousCoordsAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

bool CDPL.Math.DHomogenousCoordsAdapter.__ne__ ( ConstDVectorExpression e )

Returns the result of the comparison operation self != e.

Parameters

e	The `ConstDVectorExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ call()

float CDPL.Math.DHomogenousCoordsAdapter.__call__ ( int i )

Returns the element at index i of the view.

At index getSize() - 1 the method returns the extension element (initialized to 1). At lower indices it returns the corresponding element of the wrapped vector.

Parameters

i	The zero-based index within the view.

Returns: The value of the element.

◆ getitem()

float CDPL.Math.DHomogenousCoordsAdapter.__getitem__ ( int i )

Returns the element at index i of the view.

Parameters

i	The zero-based index within the view.

Returns: The value of the element.

◆ len()

int CDPL.Math.DHomogenousCoordsAdapter.__len__ ( )

Returns the dimensionality of the view (wrapped vector size + 1).

Returns: The view size.

◆ str()

str CDPL.Math.DHomogenousCoordsAdapter.__str__ ( )

Returns a string representation of the DHomogenousCoordsAdapter instance.

Returns: The generated string representation.

◆ pos()

DHomogenousCoordsAdapter CDPL.Math.DHomogenousCoordsAdapter.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstDVectorExpression CDPL.Math.DHomogenousCoordsAdapter.__neg__ ( )

Returns the result of the operation self * -1.

Returns: A ConstDVectorExpression instance holding the result of the element negation.

◆ add()

ConstDVectorExpression CDPL.Math.DHomogenousCoordsAdapter.__add__ ( ConstDVectorExpression e )

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

Returns: A ConstDVectorExpression instance holding the result of the addition.

◆ sub()

ConstDVectorExpression CDPL.Math.DHomogenousCoordsAdapter.__sub__ ( ConstDVectorExpression e )

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns: A DHomogenousCoordsAdapter instance holding the result of the subtraction.

◆ mul() [1/2]

ConstDVectorExpression CDPL.Math.DHomogenousCoordsAdapter.__mul__ ( float t )

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

Returns: A ConstDVectorExpression instance holding the result of the multiplication.

◆ mul() [2/2]

ConstDVectorExpression CDPL.Math.DHomogenousCoordsAdapter.__mul__ ( ConstDMatrixExpression e )

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

Returns: A ConstDVectorExpression instance holding the result of the multiplication.

◆ div()

ConstDVectorExpression CDPL.Math.DHomogenousCoordsAdapter.__div__ ( float t )

Returns the result of the division operation self // t.

Parameters

t	Specifies the divisor.

Returns: A ConstDVectorExpression instance holding the result of the division.

◆ truediv()

ConstDVectorExpression CDPL.Math.DHomogenousCoordsAdapter.__truediv__ ( float t )

Returns the result of the true division operation self / t.

Parameters

t	Specifies the divisor.

Returns: A ConstDVectorExpression instance holding the result of the division.

◆ rmul()

ConstDVectorExpression CDPL.Math.DHomogenousCoordsAdapter.__rmul__ ( float t )

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

Returns: A ConstDVectorExpression instance holding the result of the multiplication.

◆ setitem()

None CDPL.Math.DHomogenousCoordsAdapter.__setitem__	(	int	i,
		float	v
	)

Sets the value of the element at index i of the view to v.

Parameters

i	The zero-based index within the view.
v	The new value of the element.

Exceptions

Base.IndexError if i is not in the range [0, getSize()).

◆ iadd() [1/2]

DHomogenousCoordsAdapter CDPL.Math.DHomogenousCoordsAdapter.__iadd__ ( DHomogenousCoordsAdapter va )

Adds the vector adapter va componentwise to this view.

Parameters

va	The vector adapter to add.

Returns: self.

◆ iadd() [2/2]

DHomogenousCoordsAdapter CDPL.Math.DHomogenousCoordsAdapter.__iadd__ ( ConstDVectorExpression e )

Adds the vector expression e componentwise to this view.

Parameters

e	The vector expression to add.

Returns: self.

◆ isub() [1/2]

DHomogenousCoordsAdapter CDPL.Math.DHomogenousCoordsAdapter.__isub__ ( DHomogenousCoordsAdapter va )

Subtracts the vector adapter va componentwise from this view.

Parameters

va	The vector adapter to subtract.

Returns: self.

◆ isub() [2/2]

DHomogenousCoordsAdapter CDPL.Math.DHomogenousCoordsAdapter.__isub__ ( ConstDVectorExpression e )

Subtracts the vector expression e componentwise from this view.

Parameters

e	The vector expression to subtract.

Returns: self.

◆ imul()

DHomogenousCoordsAdapter CDPL.Math.DHomogenousCoordsAdapter.__imul__ ( float t )

Multiplies every element of this view by the scalar t.

Parameters

t	The scalar multiplier.

Returns: self.

◆ idiv()

DHomogenousCoordsAdapter CDPL.Math.DHomogenousCoordsAdapter.__idiv__ ( float t )

Divides every element of this view by the scalar t.

Parameters

t	The scalar divisor.

Returns: self.

◆ itruediv()

DHomogenousCoordsAdapter CDPL.Math.DHomogenousCoordsAdapter.__itruediv__ ( float t )

Divides every element of this view by the scalar t.

Parameters

t	The scalar divisor.

Returns: self.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/2]

◆ __init__() [2/2]

Member Function Documentation

◆ getObjectID()

◆ assign() [1/6]

◆ assign() [2/6]

◆ assign() [3/6]

◆ assign() [4/6]

◆ assign() [5/6]

◆ assign() [6/6]

◆ isEmpty()

◆ getSize()

◆ getElement()

◆ toArray()

◆ swap()

◆ setElement()

◆ getData()

◆ __eq__() [1/2]

◆ __eq__() [2/2]

◆ __ne__() [1/2]

◆ __ne__() [2/2]

◆ __call__()

◆ __getitem__()

◆ __len__()

◆ __str__()

◆ __pos__()

◆ __neg__()

◆ __add__()

◆ __sub__()

◆ __mul__() [1/2]

◆ __mul__() [2/2]

◆ __div__()

◆ __truediv__()

◆ __rmul__()

◆ __setitem__()

◆ __iadd__() [1/2]

◆ __iadd__() [2/2]

◆ __isub__() [1/2]

◆ __isub__() [2/2]

◆ __imul__()

◆ __idiv__()

◆ __itruediv__()

◆ init() [1/2]

◆ init() [2/2]

◆ eq() [1/2]

◆ eq() [2/2]

◆ ne() [1/2]

◆ ne() [2/2]

◆ call()

◆ getitem()

◆ len()

◆ str()

◆ pos()

◆ neg()

◆ add()

◆ sub()

◆ mul() [1/2]

◆ mul() [2/2]

◆ div()

◆ truediv()

◆ rmul()

◆ setitem()

◆ iadd() [1/2]

◆ iadd() [2/2]

◆ isub() [1/2]

◆ isub() [2/2]

◆ imul()

◆ idiv()

◆ itruediv()