CDPL.Math.Matrix2D Class Reference

Bounded 2x2 matrix holding floating point values of type double. More...

Inheritance diagram for CDPL.Math.Matrix2D:

Public Member Functions
None	__init__ ()
	Constructs a zero-initialized \( M \times N \) matrix.
None	__init__ (float v)
	Constructs an \( M \times N \) matrix with every element initialized to v. More...
None	__init__ (Matrix2D m)
	Constructs a copy of the fixed-size matrix m. More...
None	__init__ (ConstFMatrixExpression e)
	Initializes the Matrix2D instance. More...
None	__init__ (ConstDMatrixExpression e)
	Initializes the Matrix2D instance. More...
None	__init__ (ConstLMatrixExpression e)
	Initializes the Matrix2D instance. More...
None	__init__ (ConstULMatrixExpression e)
	Initializes the Matrix2D instance. More...
None	__init__ (object a)
	Initializes the Matrix2D instance. More...
None	clear (float v=0.0)
	Sets every element of the matrix to the value v. More...
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
Matrix2D	assign (ConstFMatrixExpression e)
	Assigns the elements of the matrix expression e to this fixed-size matrix without intermediate temporary. More...
Matrix2D	assign (ConstDMatrixExpression e)
	Assigns the elements of the matrix expression e to this fixed-size matrix without intermediate temporary. More...
Matrix2D	assign (ConstLMatrixExpression e)
	Assigns the elements of the matrix expression e to this fixed-size matrix without intermediate temporary. More...
Matrix2D	assign (ConstULMatrixExpression e)
	Assigns the elements of the matrix expression e to this fixed-size matrix without intermediate temporary. More...
Matrix2D	assign (Matrix2D m)
	Copy-assigns the elements of m to this fixed-size matrix. More...
None	assign (object a)
	Replaces the current state of self with a copy of the state of the object instance a. More...
int	getSize1 ()
	Returns the fixed row count M. More...
int	getSize2 ()
	Returns the fixed column count N. More...
bool	isEmpty ()
	Tells whether the matrix is empty (M or N is zero). More...
float	getElement (int i, int j)
object	toArray ()
None	swap (Matrix2D m)
	Swaps the contents of this fixed-size matrix with those of m. More...
None	setElement (int i, int j, float v)
float	__call__ (int i, int j)
	Returns a reference to the element at (i, j). More...
float	__getitem__ (tuple ij)
int	__len__ ()
bool	__eq__ (Matrix2D m)
	Returns the result of the comparison operation self == m. More...
bool	__eq__ (ConstDMatrixExpression e)
	Returns the result of the comparison operation self == e. More...
bool	__ne__ (Matrix2D m)
	Returns the result of the comparison operation self != m. More...
bool	__ne__ (ConstDMatrixExpression e)
	Returns the result of the comparison operation self != e. More...
str	__str__ ()
	Returns a string representation of the Matrix2D instance. More...
Matrix2D	__pos__ ()
ConstDMatrixExpression	__neg__ ()
ConstDMatrixExpression	__add__ (ConstDMatrixExpression e)
	Returns the result of the addition operation self + e. More...
ConstDMatrixExpression	__sub__ (ConstDMatrixExpression e)
	Returns the result of the subtraction operation self - e. More...
ConstDMatrixExpression	__mul__ (float t)
	Returns the result of the multiplication operation self * t. More...
ConstDMatrixExpression	__mul__ (ConstDMatrixExpression e)
	Returns the result of the multiplication operation self * e. More...
ConstDVectorExpression	__mul__ (ConstDVectorExpression e)
	Returns the result of the multiplication operation self * e. More...
ConstDMatrixExpression	__div__ (float t)
	Returns the result of the division operation self // t. More...
ConstDMatrixExpression	__truediv__ (float t)
	Returns the result of the true division operation self / t. More...
ConstDMatrixExpression	__rmul__ (float t)
	Returns the result of the multiplication operation t * self. More...
None	__setitem__ (tuple ij, float v)
Matrix2D	__iadd__ (Matrix2D m)
	Performs the in-place addition operation self += m. More...
Matrix2D	__iadd__ (ConstDMatrixExpression e)
	Performs the in-place addition operation self += e. More...
Matrix2D	__isub__ (Matrix2D m)
	Performs the in-place subtraction operation self -= m. More...
Matrix2D	__isub__ (ConstDMatrixExpression e)
	Performs the in-place subtraction operation self -= e. More...
Matrix2D	__imul__ (float t)
	Performs the in-place multiplication operation self *= t. More...
Matrix2D	__idiv__ (float t)
	Performs the in-place division operation self /= t. More...
Matrix2D	__itruediv__ (float t)

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

Detailed Description

Bounded 2x2 matrix holding floating point values of type double.

Constructor & Destructor Documentation

__init__() [1/7]

None CDPL.Math.Matrix2D.__init__

(

float

v

)

Constructs an \( M \times N \) matrix with every element initialized to v.

Parameters

v	The initial element value.

__init__() [2/7]

None CDPL.Math.Matrix2D.__init__

(

Matrix2D

m

)

Constructs a copy of the fixed-size matrix m.

Parameters

m	The fixed-size matrix to copy.

__init__() [3/7]

None CDPL.Math.Matrix2D.__init__

(

ConstFMatrixExpression

e

)

Initializes the Matrix2D instance.

Parameters

e

__init__() [4/7]

None CDPL.Math.Matrix2D.__init__

(

ConstDMatrixExpression

e

)

Initializes the Matrix2D instance.

Parameters

e

__init__() [5/7]

None CDPL.Math.Matrix2D.__init__

(

ConstLMatrixExpression

e

)

Initializes the Matrix2D instance.

Parameters

e

__init__() [6/7]

None CDPL.Math.Matrix2D.__init__

(

ConstULMatrixExpression

e

)

Initializes the Matrix2D instance.

Parameters

e

__init__() [7/7]

None CDPL.Math.Matrix2D.__init__

(

object

a

)

Initializes the Matrix2D instance.

Parameters

a

Member Function Documentation

clear()

None CDPL.Math.Matrix2D.clear

(

float

v = 0.0

)

Sets every element of the matrix to the value v.

Parameters

v	The fill value.

getObjectID()

int CDPL.Math.Matrix2D.getObjectID

(

)

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

Different Python Matrix2D 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 Matrix2D 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]

Matrix2D CDPL.Math.Matrix2D.assign

(

ConstFMatrixExpression

e

)

Assigns the elements of the matrix expression e to this fixed-size matrix without intermediate temporary.

Parameters

e	The source matrix expression.

Returns

self

assign() [2/6]

Matrix2D CDPL.Math.Matrix2D.assign

(

ConstDMatrixExpression

e

)

Assigns the elements of the matrix expression e to this fixed-size matrix without intermediate temporary.

Parameters

e	The source matrix expression.

Returns

self

assign() [3/6]

Matrix2D CDPL.Math.Matrix2D.assign

(

ConstLMatrixExpression

e

)

Assigns the elements of the matrix expression e to this fixed-size matrix without intermediate temporary.

Parameters

e	The source matrix expression.

Returns

self

assign() [4/6]

Matrix2D CDPL.Math.Matrix2D.assign

(

ConstULMatrixExpression

e

)

Assigns the elements of the matrix expression e to this fixed-size matrix without intermediate temporary.

Parameters

e	The source matrix expression.

Returns

self

assign() [5/6]

Matrix2D CDPL.Math.Matrix2D.assign

(

Matrix2D

m

)

Copy-assigns the elements of m to this fixed-size matrix.

Parameters

m	The source fixed-size matrix.

Returns

self

assign() [6/6]

None CDPL.Math.Matrix2D.assign

(

object

a

)

Replaces the current state of self with a copy of the state of the object instance a.

Parameters

a	The object instance to copy.

Returns

self

getSize1()

int CDPL.Math.Matrix2D.getSize1

(

)

Returns the fixed row count M.

Returns

The number of rows.

getSize2()

int CDPL.Math.Matrix2D.getSize2

(

)

Returns the fixed column count N.

Returns

The number of columns.

isEmpty()

bool CDPL.Math.Matrix2D.isEmpty

(

)

Tells whether the matrix is empty (M or N is zero).

Returns

True if either M or N is zero, and False otherwise.

getElement()

float CDPL.Math.Matrix2D.getElement	(	int	i,
		int	j
	)

Parameters

i
j

Returns

toArray()

object CDPL.Math.Matrix2D.toArray

(

)

Returns

swap()

None CDPL.Math.Matrix2D.swap

(

Matrix2D

m

)

Swaps the contents of this fixed-size matrix with those of m.

Parameters

m	The fixed-size matrix to swap with.

setElement()

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

Parameters

i
j
v

__call__()

float CDPL.Math.Matrix2D.__call__	(	int	i,
		int	j
	)

Returns a reference to the element at (i, j).

Parameters

i	The zero-based row index.
j	The zero-based column index.

Returns

A reference to the element.

Exceptions

Base.IndexError

if either index is out of range.

__getitem__()

float CDPL.Math.Matrix2D.__getitem__

(

tuple

ij

)

Parameters

ij

Returns

__len__()

int CDPL.Math.Matrix2D.__len__

(

)

Returns

__eq__() [1/2]

bool CDPL.Math.Matrix2D.__eq__

(

Matrix2D

m

)

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

Parameters

m	The Matrix2D instance to be compared with.

Returns

The result of the comparison operation.

__eq__() [2/2]

bool CDPL.Math.Matrix2D.__eq__

(

ConstDMatrixExpression

e

)

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

Parameters

e	The ConstDMatrixExpression instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [1/2]

bool CDPL.Math.Matrix2D.__ne__

(

Matrix2D

m

)

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

Parameters

m	The Matrix2D instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [2/2]

bool CDPL.Math.Matrix2D.__ne__

(

ConstDMatrixExpression

e

)

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

Parameters

e	The ConstDMatrixExpression instance to be compared with.

Returns

The result of the comparison operation.

__str__()

str CDPL.Math.Matrix2D.__str__

(

)

Returns a string representation of the Matrix2D instance.

Returns

The generated string representation.

__pos__()

Matrix2D CDPL.Math.Matrix2D.__pos__

(

)

Returns

__neg__()

ConstDMatrixExpression CDPL.Math.Matrix2D.__neg__

(

)

Returns

__add__()

ConstDMatrixExpression CDPL.Math.Matrix2D.__add__

(

ConstDMatrixExpression

e

)

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

Returns

A ConstDMatrixExpression instance holding the result of the addition.

__sub__()

ConstDMatrixExpression CDPL.Math.Matrix2D.__sub__

(

ConstDMatrixExpression

e

)

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns

A Matrix2D instance holding the result of the subtraction.

__mul__() [1/3]

ConstDMatrixExpression CDPL.Math.Matrix2D.__mul__

(

float

t

)

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

Returns

A ConstDMatrixExpression instance holding the result of the multiplication.

__mul__() [2/3]

ConstDMatrixExpression CDPL.Math.Matrix2D.__mul__

(

ConstDMatrixExpression

e

)

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

Returns

A ConstDMatrixExpression instance holding the result of the multiplication.

__mul__() [3/3]

ConstDVectorExpression CDPL.Math.Matrix2D.__mul__

(

ConstDVectorExpression

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__()

ConstDMatrixExpression CDPL.Math.Matrix2D.__div__

(

float

t

)

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

Parameters

t	Specifies the divisor.

Returns

A ConstDMatrixExpression instance holding the result of the division.

__truediv__()

ConstDMatrixExpression CDPL.Math.Matrix2D.__truediv__

(

float

t

)

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

Parameters

t	Specifies the divisor.

Returns

A ConstDMatrixExpression instance holding the result of the division.

__rmul__()

ConstDMatrixExpression CDPL.Math.Matrix2D.__rmul__

(

float

t

)

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

Returns

A ConstDMatrixExpression instance holding the result of the multiplication.

__setitem__()

None CDPL.Math.Matrix2D.__setitem__	(	tuple	ij,
		float	v
	)

Parameters

ij
v

__iadd__() [1/2]

Matrix2D CDPL.Math.Matrix2D.__iadd__

(

Matrix2D

m

)

Performs the in-place addition operation self += m.

Parameters

m	Specifies the second addend.

Returns

The updated Matrix2D instance self.

__iadd__() [2/2]

Matrix2D CDPL.Math.Matrix2D.__iadd__

(

ConstDMatrixExpression

e

)

Performs the in-place addition operation self += e.

Parameters

e	Specifies the second addend.

Returns

The updated Matrix2D instance self.

__isub__() [1/2]

Matrix2D CDPL.Math.Matrix2D.__isub__

(

Matrix2D

m

)

Performs the in-place subtraction operation self -= m.

Parameters

m	Specifies the subtrahend.

Returns

The updated Matrix2D instance self.

__isub__() [2/2]

Matrix2D CDPL.Math.Matrix2D.__isub__

(

ConstDMatrixExpression

e

)

Performs the in-place subtraction operation self -= e.

Parameters

e	Specifies the subtrahend.

Returns

The updated Matrix2D instance self.

__imul__()

Matrix2D CDPL.Math.Matrix2D.__imul__

(

float

t

)

Performs the in-place multiplication operation self *= t.

Parameters

t	Specifies the multiplier.

Returns

The updated Matrix2D instance self.

__idiv__()

Matrix2D CDPL.Math.Matrix2D.__idiv__

(

float

t

)

Performs the in-place division operation self /= t.

Parameters

t	Specifies the divisor.

Returns

The updated Matrix2D instance self.

__itruediv__()

Matrix2D CDPL.Math.Matrix2D.__itruediv__

(

float

t

)

Parameters

t

Returns