Vector expression proxy that views a single column of an underlying matrix. More...

Inheritance diagram for CDPL.Math.ConstDMatrixColumn:

Public Member Functions
None	__init__ (ConstDMatrixColumn c)
	Initializes a copy of the `ConstDMatrixColumn` instance c. More...

None	__init__ (ConstDMatrixExpression e, int i)
	Initializes the `ConstDMatrixColumn` instance. More...

int	getIndex ()
	Returns the column index this proxy refers to within the wrapped matrix. More...

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

bool	isEmpty ()
	Tells whether the column is empty (the wrapped matrix has zero rows). More...

int	getSize ()
	Returns the size of the column (number of rows of the wrapped matrix). More...

float	getElement (int i)

object	toArray ()

ConstDMatrixExpression	getData ()
	Returns a reference to the wrapped matrix (via its stored closure). More...

bool	__eq__ (ConstDMatrixColumn c)
	Returns the result of the comparison operation `self == c`. More...

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

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

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

float	__call__ (int i)
	Returns a reference to the element at row i of the column. More...

float	__getitem__ (int i)
	Returns a reference to the element at row i of the column. More...

int	__len__ ()
	Returns the size of the column (number of rows of the wrapped matrix). More...

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

ConstDMatrixColumn	__pos__ ()

ConstDVectorExpression	__neg__ ()

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

Properties
	objectID = property(getObjectID)

	size = property(getSize)

	data = property(getData)

	index = property(getIndex)

Detailed Description

Vector expression proxy that views a single column of an underlying matrix.

Constructor & Destructor Documentation

◆ init() [1/2]

None CDPL.Math.ConstDMatrixColumn.__init__ ( ConstDMatrixColumn c )

Initializes a copy of the ConstDMatrixColumn instance c.

Parameters

c	The `ConstDMatrixColumn` instance to copy.

◆ init() [2/2]

None CDPL.Math.ConstDMatrixColumn.__init__	(	ConstDMatrixExpression	e,
		int	i
	)

Initializes the ConstDMatrixColumn instance.

Parameters

e
i

Member Function Documentation

◆ getIndex()

int CDPL.Math.ConstDMatrixColumn.getIndex ( )

Returns the column index this proxy refers to within the wrapped matrix.

Returns: The zero-based column index.

◆ getObjectID()

int CDPL.Math.ConstDMatrixColumn.getObjectID ( )

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

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

◆ isEmpty()

bool CDPL.Math.ConstDMatrixColumn.isEmpty ( )

Tells whether the column is empty (the wrapped matrix has zero rows).

Returns: True if the wrapped matrix has zero rows, and False otherwise.

◆ getSize()

int CDPL.Math.ConstDMatrixColumn.getSize ( )

Returns the size of the column (number of rows of the wrapped matrix).

Returns: The number of rows.

◆ getData()

ConstDMatrixExpression CDPL.Math.ConstDMatrixColumn.getData ( )

Returns a reference to the wrapped matrix (via its stored closure).

Returns: A reference to the wrapped matrix closure.

◆ eq() [1/2]

bool CDPL.Math.ConstDMatrixColumn.__eq__ ( ConstDMatrixColumn c )

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

Parameters

c	The `ConstDMatrixColumn` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

bool CDPL.Math.ConstDMatrixColumn.__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.ConstDMatrixColumn.__ne__ ( ConstDMatrixColumn c )

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

Parameters

c	The `ConstDMatrixColumn` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

bool CDPL.Math.ConstDMatrixColumn.__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.ConstDMatrixColumn.__call__ ( int i )

Returns a reference to the element at row i of the column.

Parameters

i	The zero-based row index.

Returns: A reference to the underlying element m(i, index).

◆ getitem()

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

Returns a reference to the element at row i of the column.

Parameters

i	The zero-based row index.

Returns: A reference to the underlying element.

◆ len()

int CDPL.Math.ConstDMatrixColumn.__len__ ( )

Returns the size of the column (number of rows of the wrapped matrix).

Returns: The number of rows.

◆ str()

str CDPL.Math.ConstDMatrixColumn.__str__ ( )

Returns a string representation of the ConstDMatrixColumn instance.

Returns: The generated string representation.

◆ add()

ConstDVectorExpression CDPL.Math.ConstDMatrixColumn.__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.ConstDMatrixColumn.__sub__ ( ConstDVectorExpression e )

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ mul() [1/2]

ConstDVectorExpression CDPL.Math.ConstDMatrixColumn.__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.ConstDMatrixColumn.__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.ConstDMatrixColumn.__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.ConstDMatrixColumn.__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.ConstDMatrixColumn.__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.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/2]

◆ __init__() [2/2]

Member Function Documentation

◆ getIndex()

◆ getObjectID()

◆ isEmpty()

◆ getSize()

◆ getData()

◆ __eq__() [1/2]

◆ __eq__() [2/2]

◆ __ne__() [1/2]

◆ __ne__() [2/2]

◆ __call__()

◆ __getitem__()

◆ __len__()

◆ __str__()

◆ __add__()

◆ __sub__()

◆ __mul__() [1/2]

◆ __mul__() [2/2]

◆ __div__()

◆ __truediv__()

◆ __rmul__()

◆ init() [1/2]

◆ init() [2/2]

◆ eq() [1/2]

◆ eq() [2/2]

◆ ne() [1/2]

◆ ne() [2/2]

◆ call()

◆ getitem()

◆ len()

◆ str()

◆ add()

◆ sub()

◆ mul() [1/2]

◆ mul() [2/2]

◆ div()

◆ truediv()

◆ rmul()