CDPL.Math.Matrix4L Class Reference

Bounded 4×4 matrix holding signed integers of type long. More...

Inheritance diagram for CDPL.Math.Matrix4L:

Public Member Functions
None	__init__ ()
	Constructs a zero-initialized M×N matrix.
None	__init__ (int v)
	Constructs an M×N matrix with every element initialized to v. More...
None	__init__ (Matrix4L m)
	Constructs a copy of the fixed-size matrix m. More...
None	__init__ (ConstFMatrixExpression e)
	Initializes the Matrix4L instance. More...
None	__init__ (ConstDMatrixExpression e)
	Initializes the Matrix4L instance. More...
None	__init__ (ConstLMatrixExpression e)
	Initializes the Matrix4L instance. More...
None	__init__ (ConstULMatrixExpression e)
	Initializes the Matrix4L instance. More...
None	__init__ (object a)
	Initializes the Matrix4L instance. More...
None	clear (int v=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...
Matrix4L	assign (ConstFMatrixExpression e)
	Assigns the elements of the matrix expression e to this fixed-size matrix without intermediate temporary. More...
Matrix4L	assign (ConstDMatrixExpression e)
	Assigns the elements of the matrix expression e to this fixed-size matrix without intermediate temporary. More...
Matrix4L	assign (ConstLMatrixExpression e)
	Assigns the elements of the matrix expression e to this fixed-size matrix without intermediate temporary. More...
Matrix4L	assign (ConstULMatrixExpression e)
	Assigns the elements of the matrix expression e to this fixed-size matrix without intermediate temporary. More...
Matrix4L	assign (Matrix4L 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...
int	getElement (int i, int j)
object	toArray ()
None	swap (Matrix4L m)
	Swaps the contents of this fixed-size matrix with those of m. More...
None	setElement (int i, int j, int v)
int	__call__ (int i, int j)
	Returns a reference to the element at (i, j). More...
int	__getitem__ (tuple ij)
int	__len__ ()
bool	__eq__ (Matrix4L 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__ (Matrix4L 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 Matrix4L instance. More...
Matrix4L	__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...
None	__setitem__ (tuple ij, int v)
Matrix4L	__iadd__ (Matrix4L m)
	Performs the in-place addition operation self += m. More...
Matrix4L	__iadd__ (ConstLMatrixExpression e)
	Adds the matrix expression e element-wise to this fixed-size matrix (via a temporary to handle aliasing). More...
Matrix4L	__isub__ (Matrix4L m)
	Performs the in-place subtraction operation self -= m. More...
Matrix4L	__isub__ (ConstLMatrixExpression e)
	Subtracts the matrix expression e element-wise from this fixed-size matrix (via a temporary to handle aliasing). More...
Matrix4L	__imul__ (int t)
	Multiplies every element by the scalar t. More...
Matrix4L	__idiv__ (int t)
	Divides every element by the scalar t. More...
Matrix4L	__itruediv__ (int t)

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

Detailed Description

Bounded 4×4 matrix holding signed integers of type long.

Constructor & Destructor Documentation

__init__() [1/7]

None CDPL.Math.Matrix4L.__init__

(

int

v

)

Constructs an M×N matrix with every element initialized to v.

Parameters

v	The initial element value.

__init__() [2/7]

None CDPL.Math.Matrix4L.__init__

(

Matrix4L

m

)

Constructs a copy of the fixed-size matrix m.

Parameters

m	The fixed-size matrix to copy.

__init__() [3/7]

None CDPL.Math.Matrix4L.__init__

(

ConstFMatrixExpression

e

)

Initializes the Matrix4L instance.

Parameters

e

__init__() [4/7]

None CDPL.Math.Matrix4L.__init__

(

ConstDMatrixExpression

e

)

Initializes the Matrix4L instance.

Parameters

e

__init__() [5/7]

None CDPL.Math.Matrix4L.__init__

(

ConstLMatrixExpression

e

)

Initializes the Matrix4L instance.

Parameters

e

__init__() [6/7]

None CDPL.Math.Matrix4L.__init__

(

ConstULMatrixExpression

e

)

Initializes the Matrix4L instance.

Parameters

e

__init__() [7/7]

None CDPL.Math.Matrix4L.__init__

(

object

a

)

Initializes the Matrix4L instance.

Parameters

a

Member Function Documentation

clear()

None CDPL.Math.Matrix4L.clear

(

int

v = 0

)

Sets every element of the matrix to the value v.

Parameters

v	The fill value.

getObjectID()

int CDPL.Math.Matrix4L.getObjectID

(

)

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

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

Matrix4L CDPL.Math.Matrix4L.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]

Matrix4L CDPL.Math.Matrix4L.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]

Matrix4L CDPL.Math.Matrix4L.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]

Matrix4L CDPL.Math.Matrix4L.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]

Matrix4L CDPL.Math.Matrix4L.assign

(

Matrix4L

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.Matrix4L.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.Matrix4L.getSize1

(

)

Returns the fixed row count M.

Returns

The number of rows.

getSize2()

int CDPL.Math.Matrix4L.getSize2

(

)

Returns the fixed column count N.

Returns

The number of columns.

isEmpty()

bool CDPL.Math.Matrix4L.isEmpty

(

)

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

Returns

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

swap()

None CDPL.Math.Matrix4L.swap

(

Matrix4L

m

)

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

Parameters

m	The fixed-size matrix to swap with.

__call__()

int CDPL.Math.Matrix4L.__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.

__eq__() [1/2]

bool CDPL.Math.Matrix4L.__eq__

(

Matrix4L

m

)

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

Parameters

m	The Matrix4L instance to be compared with.

Returns

The result of the comparison operation.

__eq__() [2/2]

bool CDPL.Math.Matrix4L.__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.Matrix4L.__ne__

(

Matrix4L

m

)

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

Parameters

m	The Matrix4L instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [2/2]

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

(

)

Returns a string representation of the Matrix4L instance.

Returns

The generated string representation.

__add__()

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

(

ConstLMatrixExpression

e

)

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns

A Matrix4L instance holding the result of the subtraction.

__mul__() [1/3]

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

__iadd__() [1/2]

Matrix4L CDPL.Math.Matrix4L.__iadd__

(

Matrix4L

m

)

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

Parameters

m	Specifies the second addend.

Returns

The updated Matrix4L instance self.

__iadd__() [2/2]

Matrix4L CDPL.Math.Matrix4L.__iadd__

(

ConstLMatrixExpression

e

)

Adds the matrix expression e element-wise to this fixed-size matrix (via a temporary to handle aliasing).

Parameters

e	The source matrix expression.

Returns

self

__isub__() [1/2]

Matrix4L CDPL.Math.Matrix4L.__isub__

(

Matrix4L

m

)

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

Parameters

m	Specifies the subtrahend.

Returns

The updated Matrix4L instance self.

__isub__() [2/2]

Matrix4L CDPL.Math.Matrix4L.__isub__

(

ConstLMatrixExpression

e

)

Subtracts the matrix expression e element-wise from this fixed-size matrix (via a temporary to handle aliasing).

Parameters

e	The source matrix expression.

Returns

self

__imul__()

Matrix4L CDPL.Math.Matrix4L.__imul__

(

int

t

)

Multiplies every element by the scalar t.

Parameters

t	The scalar multiplier.

Returns

self

__idiv__()

Matrix4L CDPL.Math.Matrix4L.__idiv__

(

int

t

)

Divides every element by the scalar t.

Parameters

t	The scalar divisor.

Returns

self