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

Inheritance diagram for CDPL.Math.FMatrixColumn:

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

None	__init__ (FMatrixExpression 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...

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

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

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

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

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

FMatrixColumn	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 `FMatrixColumn` instance into a corresponding `numpy.ndarray` object. More...

None	swap (FMatrixColumn 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...

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

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

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

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

bool	__ne__ (ConstFVectorExpression 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 `FMatrixColumn` instance. More...

FMatrixColumn	__pos__ ()
	Returns self. More...

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

ConstFVectorExpression	__add__ (ConstFVectorExpression e)
	Returns the result of the addition operation `self + e`. More...

ConstFVectorExpression	__sub__ (ConstFVectorExpression e)
	Returns the result of the subtraction operation `self - e`. More...

ConstFVectorExpression	__mul__ (float t)
	Returns the result of the multiplication operation `self * t`. More...

ConstFVectorExpression	__mul__ (ConstFMatrixExpression e)
	Returns the result of the multiplication operation `self * e`. More...

ConstFVectorExpression	__div__ (float t)
	Returns the result of the division operation `self // t`. More...

ConstFVectorExpression	__truediv__ (float t)
	Returns the result of the true division operation `self / t`. More...

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

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

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

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

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

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

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

FMatrixColumn	__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.FMatrixColumn.__init__ ( FMatrixColumn mc )

Contructs a copy of the FMatrixColumn instance mc.

Parameters

mc	The `FMatrixColumn` instance to copy.

◆ init() [2/2]

None CDPL.Math.FMatrixColumn.__init__	(	FMatrixExpression	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.FMatrixColumn.getIndex ( )

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

Returns: The zero-based column index.

◆ getObjectID()

int CDPL.Math.FMatrixColumn.getObjectID ( )

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

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

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

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

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

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

FMatrixColumn CDPL.Math.FMatrixColumn.assign ( FMatrixColumn 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]

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

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

Returns: The number of rows.

◆ getElement()

float CDPL.Math.FMatrixColumn.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.FMatrixColumn.toArray ( )

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ swap()

None CDPL.Math.FMatrixColumn.swap ( FMatrixColumn 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.FMatrixColumn.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()

FMatrixExpression CDPL.Math.FMatrixColumn.getData ( )

Returns the wrapped matrix.

Returns: The wrapped matrix.

◆ eq() [1/2]

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

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

Parameters

c	The `FMatrixColumn` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

bool CDPL.Math.FMatrixColumn.__eq__ ( ConstFVectorExpression e )

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

Parameters

e	The `ConstFVectorExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [1/2]

bool CDPL.Math.FMatrixColumn.__ne__ ( FMatrixColumn c )

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

Parameters

c	The `FMatrixColumn` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

bool CDPL.Math.FMatrixColumn.__ne__ ( ConstFVectorExpression e )

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

Parameters

e	The `ConstFVectorExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ call()

float CDPL.Math.FMatrixColumn.__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.FMatrixColumn.__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.FMatrixColumn.__len__ ( )

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

Returns: The number of rows.

◆ str()

str CDPL.Math.FMatrixColumn.__str__ ( )

Returns a string representation of the FMatrixColumn instance.

Returns: The generated string representation.

◆ pos()

FMatrixColumn CDPL.Math.FMatrixColumn.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstFVectorExpression CDPL.Math.FMatrixColumn.__neg__ ( )

Returns the result of the operation self * -1.

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

◆ add()

ConstFVectorExpression CDPL.Math.FMatrixColumn.__add__ ( ConstFVectorExpression e )

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

Returns: A ConstFVectorExpression instance holding the result of the addition.

◆ sub()

ConstFVectorExpression CDPL.Math.FMatrixColumn.__sub__ ( ConstFVectorExpression e )

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ mul() [1/2]

ConstFVectorExpression CDPL.Math.FMatrixColumn.__mul__ ( float t )

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

Returns: A ConstFVectorExpression instance holding the result of the multiplication.

◆ mul() [2/2]

ConstFVectorExpression CDPL.Math.FMatrixColumn.__mul__ ( ConstFMatrixExpression e )

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

Returns: A ConstFVectorExpression instance holding the result of the multiplication.

◆ div()

ConstFVectorExpression CDPL.Math.FMatrixColumn.__div__ ( float t )

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

Parameters

t	Specifies the divisor.

Returns: A ConstFVectorExpression instance holding the result of the division.

◆ truediv()

ConstFVectorExpression CDPL.Math.FMatrixColumn.__truediv__ ( float t )

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

Parameters

t	Specifies the divisor.

Returns: A ConstFVectorExpression instance holding the result of the division.

◆ rmul()

ConstFVectorExpression CDPL.Math.FMatrixColumn.__rmul__ ( float t )

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

Returns: A ConstFVectorExpression instance holding the result of the multiplication.

◆ setitem()

None CDPL.Math.FMatrixColumn.__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]

FMatrixColumn CDPL.Math.FMatrixColumn.__iadd__ ( FMatrixColumn 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]

FMatrixColumn CDPL.Math.FMatrixColumn.__iadd__ ( ConstFVectorExpression 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]

FMatrixColumn CDPL.Math.FMatrixColumn.__isub__ ( FMatrixColumn 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]

FMatrixColumn CDPL.Math.FMatrixColumn.__isub__ ( ConstFVectorExpression 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()

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

Multiplies every element of this column by the scalar t.

Parameters

t	The scalar multiplier.

Returns: self.

◆ idiv()

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

Divides every element of this column by the scalar t.

Parameters

t	The scalar divisor.

Returns: self.

◆ itruediv()

FMatrixColumn CDPL.Math.FMatrixColumn.__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()