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

Inheritance diagram for CDPL.Math.DMatrixColumn:

Public Member Functions
None	__init__ (DMatrixColumn mc)
	Contructs a copy of the `DMatrixColumn` instance mc. More...

None	__init__ (DMatrixExpression m, int i)
	Constructs the column proxy viewing column i of m. 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...

DMatrixColumn	assign (ConstFVectorExpression e)
	Assigns the elements of the vector expression e to this column (via a temporary to handle aliasing). More...

DMatrixColumn	assign (ConstDVectorExpression e)
	Assigns the elements of the vector expression e to this column (via a temporary to handle aliasing). More...

DMatrixColumn	assign (ConstLVectorExpression e)
	Assigns the elements of the vector expression e to this column (via a temporary to handle aliasing). More...

DMatrixColumn	assign (ConstULVectorExpression e)
	Assigns the elements of the vector expression e to this column (via a temporary to handle aliasing). More...

DMatrixColumn	assign (DMatrixColumn c)
	Copy-assigns the contents of c to this column (via a temporary to handle aliasing). More...

DMatrixColumn	assign (object a)
	Assigns the contents of the `numpy.ndarray` object a to this column. 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)
	Returns the element at row i of the column. More...

object	toArray ()
	Converts the `DMatrixColumn` instance into a corresponding `numpy.ndarray` object. More...

None	swap (DMatrixColumn c)
	Swaps the contents of this column with those of c (via element-wise swap of the underlying matrix elements). More...

None	setElement (int i, float v)
	Sets the value of the element at row i of the column to v. More...

DMatrixExpression	getData ()
	Returns the wrapped matrix. More...

bool	__eq__ (DMatrixColumn 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__ (DMatrixColumn 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 the element at row i of the column. More...

float	__getitem__ (int i)
	Returns 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 `DMatrixColumn` instance. More...

DMatrixColumn	__pos__ ()
	Returns self. More...

ConstDVectorExpression	__neg__ ()
	Returns the result of the operation `self * -1`. More...

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

None	__setitem__ (int i, float v)
	Sets the value of the element at row i of the column to v. More...

DMatrixColumn	__iadd__ (DMatrixColumn c)
	Adds the elements of the matrix column c to this column (via a temporary to handle aliasing). More...

DMatrixColumn	__iadd__ (ConstDVectorExpression e)
	Adds the elements of the vector expression e to this column (via a temporary to handle aliasing). More...

DMatrixColumn	__isub__ (DMatrixColumn c)
	Subtracts the elements of the matrix column c from this column (via a temporary to handle aliasing). More...

DMatrixColumn	__isub__ (ConstDVectorExpression e)
	Subtracts the elements of the vector expression e from this column (via a temporary to handle aliasing). More...

DMatrixColumn	__imul__ (float t)
	Multiplies every element of this column by the scalar t. More...

DMatrixColumn	__idiv__ (float t)
	Divides every element of this column by the scalar t. More...

DMatrixColumn	__itruediv__ (float t)
	Divides every element of this column by the scalar t. 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.DMatrixColumn.__init__ ( DMatrixColumn mc )

Contructs a copy of the DMatrixColumn instance mc.

Parameters

mc	The `DMatrixColumn` instance to copy.

◆ init() [2/2]

None CDPL.Math.DMatrixColumn.__init__	(	DMatrixExpression	m,
		int	i
	)

Constructs the column proxy viewing column i of m.

Parameters

m	The wrapped matrix.
i	The zero-based column index to view.

Member Function Documentation

◆ getIndex()

int CDPL.Math.DMatrixColumn.getIndex ( )

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

Returns: The zero-based column index.

◆ getObjectID()

int CDPL.Math.DMatrixColumn.getObjectID ( )

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

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

DMatrixColumn CDPL.Math.DMatrixColumn.assign ( ConstFVectorExpression e )

Assigns the elements of the vector expression e to this column (via a temporary to handle aliasing).

Parameters

e	The source vector expression.

Returns: self.

◆ assign() [2/6]

DMatrixColumn CDPL.Math.DMatrixColumn.assign ( ConstDVectorExpression e )

Assigns the elements of the vector expression e to this column (via a temporary to handle aliasing).

Parameters

e	The source vector expression.

Returns: self.

◆ assign() [3/6]

DMatrixColumn CDPL.Math.DMatrixColumn.assign ( ConstLVectorExpression e )

Assigns the elements of the vector expression e to this column (via a temporary to handle aliasing).

Parameters

e	The source vector expression.

Returns: self.

◆ assign() [4/6]

DMatrixColumn CDPL.Math.DMatrixColumn.assign ( ConstULVectorExpression e )

Assigns the elements of the vector expression e to this column (via a temporary to handle aliasing).

Parameters

e	The source vector expression.

Returns: self.

◆ assign() [5/6]

DMatrixColumn CDPL.Math.DMatrixColumn.assign ( DMatrixColumn c )

Copy-assigns the contents of c to this column (via a temporary to handle aliasing).

Parameters

c	The source column.

Returns: self.

◆ assign() [6/6]

DMatrixColumn CDPL.Math.DMatrixColumn.assign ( object a )

Assigns the contents of the numpy.ndarray object a to this column.

Parameters

a	The `numpy.ndarray` object.

See also: [NUMPY]

◆ isEmpty()

bool CDPL.Math.DMatrixColumn.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.DMatrixColumn.getSize ( )

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

Returns: The number of rows.

◆ getElement()

float CDPL.Math.DMatrixColumn.getElement ( int i )

Returns the element at row i of the column.

Parameters

i	The zero-based row index.

Returns: The value of the element m(i, index).

◆ toArray()

object CDPL.Math.DMatrixColumn.toArray ( )

Converts the DMatrixColumn instance into a corresponding numpy.ndarray object.

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ swap()

None CDPL.Math.DMatrixColumn.swap ( DMatrixColumn c )

Swaps the contents of this column with those of c (via element-wise swap of the underlying matrix elements).

Parameters

c	The column to swap with.

◆ setElement()

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

Sets the value of the element at row i of the column to v.

Parameters

i	The zero-based row index.
v	The new value of the element.

Exceptions

Base.IndexError if i is not in the range [0, getSize()).

◆ getData()

DMatrixExpression CDPL.Math.DMatrixColumn.getData ( )

Returns the wrapped matrix.

Returns: The wrapped matrix.

◆ eq() [1/2]

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

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

Parameters

c	The `DMatrixColumn` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

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

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

Parameters

c	The `DMatrixColumn` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

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

Returns the element at row i of the column.

Parameters

i	The zero-based row index.

Returns: The value of the element m(i, index).

◆ getitem()

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

Returns the element at row i of the column.

Parameters

i	The zero-based row index.

Returns: The value of the element m(i, index).

◆ len()

int CDPL.Math.DMatrixColumn.__len__ ( )

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

Returns: The number of rows.

◆ str()

str CDPL.Math.DMatrixColumn.__str__ ( )

Returns a string representation of the DMatrixColumn instance.

Returns: The generated string representation.

◆ pos()

DMatrixColumn CDPL.Math.DMatrixColumn.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstDVectorExpression CDPL.Math.DMatrixColumn.__neg__ ( )

Returns the result of the operation self * -1.

Returns: A ConstDVectorExpression instance holding the result of the element negation.

◆ add()

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

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ mul() [1/2]

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

◆ setitem()

None CDPL.Math.DMatrixColumn.__setitem__	(	int	i,
		float	v
	)

Sets the value of the element at row i of the column to v.

Parameters

i	The zero-based row index.
v	The new value of the element.

Exceptions

Base.IndexError if i is not in the range [0, getSize()).

◆ iadd() [1/2]

DMatrixColumn CDPL.Math.DMatrixColumn.__iadd__ ( DMatrixColumn c )

Adds the elements of the matrix column c to this column (via a temporary to handle aliasing).

Parameters

c	The source matrix column.

Returns: self.

◆ iadd() [2/2]

DMatrixColumn CDPL.Math.DMatrixColumn.__iadd__ ( ConstDVectorExpression e )

Adds the elements of the vector expression e to this column (via a temporary to handle aliasing).

Parameters

e	The source vector expression.

Returns: self.

◆ isub() [1/2]

DMatrixColumn CDPL.Math.DMatrixColumn.__isub__ ( DMatrixColumn c )

Subtracts the elements of the matrix column c from this column (via a temporary to handle aliasing).

Parameters

c	The source matrix column.

Returns: self.

◆ isub() [2/2]

DMatrixColumn CDPL.Math.DMatrixColumn.__isub__ ( ConstDVectorExpression e )

Subtracts the elements of the vector expression e from this column (via a temporary to handle aliasing).

Parameters

e	The source vector expression.

Returns: self.

◆ imul()

DMatrixColumn CDPL.Math.DMatrixColumn.__imul__ ( float t )

Multiplies every element of this column by the scalar t.

Parameters

t	The scalar multiplier.

Returns: self.

◆ idiv()

DMatrixColumn CDPL.Math.DMatrixColumn.__idiv__ ( float t )

Divides every element of this column by the scalar t.

Parameters

t	The scalar divisor.

Returns: self.

◆ itruediv()

DMatrixColumn CDPL.Math.DMatrixColumn.__itruediv__ ( float t )

Divides every element of this column by the scalar t.

Parameters

t	The scalar divisor.

Returns: self.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/2]

◆ __init__() [2/2]

Member Function Documentation

◆ getIndex()

◆ getObjectID()

◆ assign() [1/6]

◆ assign() [2/6]

◆ assign() [3/6]

◆ assign() [4/6]

◆ assign() [5/6]

◆ assign() [6/6]

◆ isEmpty()

◆ getSize()

◆ getElement()

◆ toArray()

◆ swap()

◆ setElement()

◆ getData()

◆ __eq__() [1/2]

◆ __eq__() [2/2]

◆ __ne__() [1/2]

◆ __ne__() [2/2]

◆ __call__()

◆ __getitem__()

◆ __len__()

◆ __str__()

◆ __pos__()

◆ __neg__()

◆ __add__()

◆ __sub__()

◆ __mul__() [1/2]

◆ __mul__() [2/2]

◆ __div__()

◆ __truediv__()

◆ __rmul__()

◆ __setitem__()

◆ __iadd__() [1/2]

◆ __iadd__() [2/2]

◆ __isub__() [1/2]

◆ __isub__() [2/2]

◆ __imul__()

◆ __idiv__()

◆ __itruediv__()

◆ init() [1/2]

◆ init() [2/2]

◆ eq() [1/2]

◆ eq() [2/2]

◆ ne() [1/2]

◆ ne() [2/2]

◆ call()

◆ getitem()

◆ len()

◆ str()

◆ pos()

◆ neg()

◆ add()

◆ sub()

◆ mul() [1/2]

◆ mul() [2/2]

◆ div()

◆ truediv()

◆ rmul()

◆ setitem()

◆ iadd() [1/2]

◆ iadd() [2/2]

◆ isub() [1/2]

◆ isub() [2/2]

◆ imul()

◆ idiv()

◆ itruediv()