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

Inheritance diagram for CDPL.Math.FMatrixRow:

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

None	__init__ (FMatrixExpression m, int i)
	Constructs the row proxy viewing row i of m. More...

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

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

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

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

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

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

FMatrixRow	assign (FMatrixRow r)
	Copy-assigns the contents of r to this row (via a temporary to handle aliasing). More...

FMatrixRow	assign (object a)
	Assigns the contents of the `numpy.ndarray` object a to this row. More...

bool	isEmpty ()
	Tells whether the row is empty (the wrapped matrix has zero columns). More...

int	getSize ()
	Returns the size of the row (number of columns of the wrapped matrix). More...

float	getElement (int i)
	Returns the element at column i of the row. More...

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

None	swap (FMatrixRow r)
	Swaps the contents of this row with those of r (via element-wise swap of the underlying matrix elements). More...

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

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

bool	__eq__ (FMatrixRow r)
	Returns the result of the comparison operation `self == r`. More...

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

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

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

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

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

int	__len__ ()
	Returns the size of the row (number of columns of the wrapped matrix). More...

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

FMatrixRow	__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 column i of the row to v. More...

FMatrixRow	__iadd__ (FMatrixRow r)
	Adds the elements of the matrix row r to this row (via a temporary to handle aliasing). More...

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

FMatrixRow	__isub__ (FMatrixRow r)
	Subtracts the elements of the matrix row r from this row (via a temporary to handle aliasing). More...

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

FMatrixRow	__imul__ (float t)
	Multiplies every element of this row by the scalar t. More...

FMatrixRow	__idiv__ (float t)
	Divides every element of this row by the scalar t. More...

FMatrixRow	__itruediv__ (float t)
	Divides every element of this row 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 row of an underlying matrix.

Constructor & Destructor Documentation

◆ init() [1/2]

None CDPL.Math.FMatrixRow.__init__ ( FMatrixRow mr )

Contructs a copy of the FMatrixRow instance mr.

Parameters

mr	The `FMatrixRow` instance to copy.

◆ init() [2/2]

None CDPL.Math.FMatrixRow.__init__	(	FMatrixExpression	m,
		int	i
	)

Constructs the row proxy viewing row i of m.

Parameters

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

Member Function Documentation

◆ getIndex()

int CDPL.Math.FMatrixRow.getIndex ( )

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

Returns: The zero-based row index.

◆ getObjectID()

int CDPL.Math.FMatrixRow.getObjectID ( )

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

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

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

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

Parameters

e	The source vector expression.

Returns: self.

◆ assign() [2/6]

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

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

Parameters

e	The source vector expression.

Returns: self.

◆ assign() [3/6]

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

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

Parameters

e	The source vector expression.

Returns: self.

◆ assign() [4/6]

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

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

Parameters

e	The source vector expression.

Returns: self.

◆ assign() [5/6]

FMatrixRow CDPL.Math.FMatrixRow.assign ( FMatrixRow r )

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

Parameters

r	The source row.

Returns: self.

◆ assign() [6/6]

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

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

Parameters

a	The `numpy.ndarray` object.

See also: [NUMPY]

◆ isEmpty()

bool CDPL.Math.FMatrixRow.isEmpty ( )

Tells whether the row is empty (the wrapped matrix has zero columns).

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

◆ getSize()

int CDPL.Math.FMatrixRow.getSize ( )

Returns the size of the row (number of columns of the wrapped matrix).

Returns: The number of columns.

◆ getElement()

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

Returns the element at column i of the row.

Parameters

i	The zero-based column index.

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

◆ toArray()

object CDPL.Math.FMatrixRow.toArray ( )

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ swap()

None CDPL.Math.FMatrixRow.swap ( FMatrixRow r )

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

Parameters

r	The row to swap with.

◆ setElement()

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

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

Parameters

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

Exceptions

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

◆ getData()

FMatrixExpression CDPL.Math.FMatrixRow.getData ( )

Returns the wrapped matrix.

Returns: The wrapped matrix.

◆ eq() [1/2]

bool CDPL.Math.FMatrixRow.__eq__ ( FMatrixRow r )

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

Parameters

r	The `FMatrixRow` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

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

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

Parameters

r	The `FMatrixRow` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

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

Returns the element at column i of the row.

Parameters

i	The zero-based column index.

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

◆ getitem()

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

Returns the element at column i of the row.

Parameters

i	The zero-based column index.

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

◆ len()

int CDPL.Math.FMatrixRow.__len__ ( )

Returns the size of the row (number of columns of the wrapped matrix).

Returns: The number of columns.

◆ str()

str CDPL.Math.FMatrixRow.__str__ ( )

Returns a string representation of the FMatrixRow instance.

Returns: The generated string representation.

◆ pos()

FMatrixRow CDPL.Math.FMatrixRow.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstFVectorExpression CDPL.Math.FMatrixRow.__neg__ ( )

Returns the result of the operation self * -1.

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

◆ add()

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

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ mul() [1/2]

ConstFVectorExpression CDPL.Math.FMatrixRow.__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.FMatrixRow.__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.FMatrixRow.__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.FMatrixRow.__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.FMatrixRow.__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.FMatrixRow.__setitem__	(	int	i,
		float	v
	)

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

Parameters

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

Exceptions

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

◆ iadd() [1/2]

FMatrixRow CDPL.Math.FMatrixRow.__iadd__ ( FMatrixRow r )

Adds the elements of the matrix row r to this row (via a temporary to handle aliasing).

Parameters

r	The source matrix row.

Returns: self.

◆ iadd() [2/2]

FMatrixRow CDPL.Math.FMatrixRow.__iadd__ ( ConstFVectorExpression e )

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

Parameters

e	The source vector expression.

Returns: self.

◆ isub() [1/2]

FMatrixRow CDPL.Math.FMatrixRow.__isub__ ( FMatrixRow r )

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

Parameters

r	The source matrix row.

Returns: self.

◆ isub() [2/2]

FMatrixRow CDPL.Math.FMatrixRow.__isub__ ( ConstFVectorExpression e )

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

Parameters

e	The source vector expression.

Returns: self.

◆ imul()

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

Multiplies every element of this row by the scalar t.

Parameters

t	The scalar multiplier.

Returns: self.

◆ idiv()

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

Divides every element of this row by the scalar t.

Parameters

t	The scalar divisor.

Returns: self.

◆ itruediv()

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

Divides every element of this row 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()