CDPL.Math.LScalarMatrix Class Reference

Inheritance diagram for CDPL.Math.LScalarMatrix:

Public Member Functions
None	__init__ ()
	Initializes the LScalarMatrix instance.
None	__init__ (LScalarMatrix m)
	Initializes a copy of the LScalarMatrix instance m. More...
None	__init__ (int m, int n, int v=0)
	Initializes the LScalarMatrix instance. More...
None	resize (int m, int n)
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 ()
LScalarMatrix	assign (LScalarMatrix m)
	Replaces the current state of self with a copy of the state of the LScalarMatrix instance m. More...
None	swap (LScalarMatrix m)
int	__call__ (int i, int j)
int	__getitem__ (tuple ij)
int	__len__ ()
bool	__eq__ (LScalarMatrix m)
	Returns the result of the comparison operation self == m. More...
bool	__eq__ (ConstLMatrixExpression e)
	Returns the result of the comparison operation self == e. More...
bool	__ne__ (LScalarMatrix m)
	Returns the result of the comparison operation self != m. More...
bool	__ne__ (ConstLMatrixExpression e)
	Returns the result of the comparison operation self != e. More...
str	__str__ ()
	Returns a string representation of the LScalarMatrix instance. More...
LScalarMatrix	__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)
ConstLMatrixExpression	__rmul__ (int t)

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

Constructor & Destructor Documentation

__init__() [1/2]

None CDPL.Math.LScalarMatrix.__init__

(

LScalarMatrix

m

)

Initializes a copy of the LScalarMatrix instance m.

Parameters

m	The LScalarMatrix instance to copy.

__init__() [2/2]

None CDPL.Math.LScalarMatrix.__init__	(	int	m,
		int	n,
		int	v = 0
	)

Initializes the LScalarMatrix instance.

Parameters

m
n
v

Member Function Documentation

resize()

None CDPL.Math.LScalarMatrix.resize	(	int	m,
		int	n
	)

Parameters

m
n

getObjectID()

int CDPL.Math.LScalarMatrix.getObjectID

(

)

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

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

getSize1()

int CDPL.Math.LScalarMatrix.getSize1

(

)

Returns

getSize2()

int CDPL.Math.LScalarMatrix.getSize2

(

)

Returns

isEmpty()

bool CDPL.Math.LScalarMatrix.isEmpty

(

)

Returns

getElement()

int CDPL.Math.LScalarMatrix.getElement	(	int	i,
		int	j
	)

Parameters

i
j

Returns

toArray()

object CDPL.Math.LScalarMatrix.toArray

(

)

Returns

assign()

LScalarMatrix CDPL.Math.LScalarMatrix.assign

(

LScalarMatrix

m

)

Replaces the current state of self with a copy of the state of the LScalarMatrix instance m.

Parameters

m	The LScalarMatrix instance to copy.

Returns

self

swap()

None CDPL.Math.LScalarMatrix.swap

(

LScalarMatrix

m

)

Parameters

m

__call__()

int CDPL.Math.LScalarMatrix.__call__	(	int	i,
		int	j
	)

Parameters

i
j

Returns

__getitem__()

int CDPL.Math.LScalarMatrix.__getitem__

(

tuple

ij

)

Parameters

ij

Returns

__len__()

int CDPL.Math.LScalarMatrix.__len__

(

)

Returns

__eq__() [1/2]

bool CDPL.Math.LScalarMatrix.__eq__

(

LScalarMatrix

m

)

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

Parameters

m	The LScalarMatrix instance to be compared with.

Returns

The result of the comparison operation.

__eq__() [2/2]

bool CDPL.Math.LScalarMatrix.__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__() [1/2]

bool CDPL.Math.LScalarMatrix.__ne__

(

LScalarMatrix

m

)

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

Parameters

m	The LScalarMatrix instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [2/2]

bool CDPL.Math.LScalarMatrix.__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.LScalarMatrix.__str__

(

)

Returns a string representation of the LScalarMatrix instance.

Returns

The generated string representation.

__pos__()

LScalarMatrix CDPL.Math.LScalarMatrix.__pos__

(

)

Returns

__neg__()

ConstLMatrixExpression CDPL.Math.LScalarMatrix.__neg__

(

)

Returns

__add__()

ConstLMatrixExpression CDPL.Math.LScalarMatrix.__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.LScalarMatrix.__sub__

(

ConstLMatrixExpression

e

)

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns

A LScalarMatrix instance holding the result of the subtraction.

__mul__() [1/3]

ConstLMatrixExpression CDPL.Math.LScalarMatrix.__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.LScalarMatrix.__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.LScalarMatrix.__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.LScalarMatrix.__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.LScalarMatrix.__truediv__

(

int

t

)

Parameters

t

Returns

__rmul__()

ConstLMatrixExpression CDPL.Math.LScalarMatrix.__rmul__

(

int

t

)

Parameters

t

Returns