CDPL.Math.ConstLMatrixExpression Class Reference

CRTP base class of all matrix expression types. More...

Inheritance diagram for CDPL.Math.ConstLMatrixExpression:

Public Member Functions
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
int	getSize1 ()
int	getSize2 ()
bool	isEmpty ()
int	getElement (int i, int j)
object	toArray ()
int	__call__ (int i, int j)
int	__getitem__ (tuple ij)
int	__len__ ()
bool	__eq__ (ConstLMatrixExpression e)
	Returns the result of the comparison operation self == e. More...
bool	__ne__ (ConstLMatrixExpression e)
	Returns the result of the comparison operation self != e. More...
str	__str__ ()
	Returns a string representation of the ConstLMatrixExpression instance. More...
ConstLMatrixExpression	__pos__ ()
ConstLMatrixExpression	__neg__ ()
ConstLMatrixExpression	__add__ (ConstLMatrixExpression e)
	Returns the result of the addition operation self + e. More...
ConstLMatrixExpression	__sub__ (ConstLMatrixExpression e)
	Returns the result of the subtraction operation self - e. More...
ConstLMatrixExpression	__mul__ (int t)
	Returns the result of the multiplication operation self * t. More...
ConstLMatrixExpression	__mul__ (ConstLMatrixExpression e)
	Returns the result of the multiplication operation self * e. More...
ConstLVectorExpression	__mul__ (ConstLVectorExpression e)
	Returns the result of the multiplication operation self * e. More...
ConstLMatrixExpression	__div__ (int t)
	Returns the result of the division operation self // t. More...
ConstLMatrixExpression	__truediv__ (int t)
	Returns the result of the true division operation self / t. More...
ConstLMatrixExpression	__rmul__ (int t)
	Returns the result of the multiplication operation t * self. More...

Properties
	objectID = property(getObjectID)
	size1 = property(getSize1)
	size2 = property(getSize2)

Detailed Description

CRTP base class of all matrix expression types.

Provides downcast access to the concrete derived expression class instance via the function call operator.

Member Function Documentation

getObjectID()

int CDPL.Math.ConstLMatrixExpression.getObjectID

(

)

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

Different Python ConstLMatrixExpression 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 ConstLMatrixExpression 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.

__eq__()

bool CDPL.Math.ConstLMatrixExpression.__eq__

(

ConstLMatrixExpression

e

)

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

Parameters

e	The ConstLMatrixExpression instance to be compared with.

Returns

The result of the comparison operation.

__ne__()

bool CDPL.Math.ConstLMatrixExpression.__ne__

(

ConstLMatrixExpression

e

)

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

Parameters

e	The ConstLMatrixExpression instance to be compared with.

Returns

The result of the comparison operation.

__str__()

str CDPL.Math.ConstLMatrixExpression.__str__

(

)

Returns a string representation of the ConstLMatrixExpression instance.

Returns

The generated string representation.

__add__()

ConstLMatrixExpression CDPL.Math.ConstLMatrixExpression.__add__

(

ConstLMatrixExpression

e

)

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

Returns

A ConstLMatrixExpression instance holding the result of the addition.

__sub__()

ConstLMatrixExpression CDPL.Math.ConstLMatrixExpression.__sub__

(

ConstLMatrixExpression

e

)

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns

A ConstLMatrixExpression instance holding the result of the subtraction.

__mul__() [1/3]

ConstLMatrixExpression CDPL.Math.ConstLMatrixExpression.__mul__

(

int

t

)

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

Returns

A ConstLMatrixExpression instance holding the result of the multiplication.

__mul__() [2/3]

ConstLMatrixExpression CDPL.Math.ConstLMatrixExpression.__mul__

(

ConstLMatrixExpression

e

)

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

Returns

A ConstLMatrixExpression instance holding the result of the multiplication.

__mul__() [3/3]

ConstLVectorExpression CDPL.Math.ConstLMatrixExpression.__mul__

(

ConstLVectorExpression

e

)

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

Returns

A ConstLVectorExpression instance holding the result of the multiplication.

__div__()

ConstLMatrixExpression CDPL.Math.ConstLMatrixExpression.__div__

(

int

t

)

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

Parameters

t	Specifies the divisor.

Returns

A ConstLMatrixExpression instance holding the result of the division.

__truediv__()

ConstLMatrixExpression CDPL.Math.ConstLMatrixExpression.__truediv__

(

int

t

)

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

Parameters

t	Specifies the divisor.

Returns

A ConstLMatrixExpression instance holding the result of the division.

__rmul__()

ConstLMatrixExpression CDPL.Math.ConstLMatrixExpression.__rmul__

(

int

t

)

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

Returns

A ConstLMatrixExpression instance holding the result of the multiplication.