CDPL.Math.ULScalarVector Class Reference

Inheritance diagram for CDPL.Math.ULScalarVector:

Public Member Functions
None	__init__ ()
	Initializes the ULScalarVector instance.
None	__init__ (ULScalarVector v)
	Initializes a copy of the ULScalarVector instance v. More...
None	__init__ (int n, int v=0)
	Initializes the ULScalarVector instance. More...
None	resize (int n)
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
bool	isEmpty ()
int	getSize ()
int	getElement (int i)
object	toArray ()
ULScalarVector	assign (ULScalarVector v)
	Replaces the current state of self with a copy of the state of the ULScalarVector instance v. More...
None	swap (ULScalarVector v)
bool	__eq__ (ULScalarVector v)
	Returns the result of the comparison operation self == v. More...
bool	__eq__ (ConstULVectorExpression e)
	Returns the result of the comparison operation self == e. More...
bool	__ne__ (ULScalarVector v)
	Returns the result of the comparison operation self != v. More...
bool	__ne__ (ConstULVectorExpression e)
	Returns the result of the comparison operation self != e. More...
int	__call__ (int i)
int	__getitem__ (int i)
int	__len__ ()
str	__str__ ()
	Returns a string representation of the ULScalarVector instance. More...
ULScalarVector	__pos__ ()
ConstULVectorExpression	__neg__ ()
ConstULVectorExpression	__add__ (ConstULVectorExpression e)
	Returns the result of the addition operation self + e. More...
ConstULVectorExpression	__sub__ (ConstULVectorExpression e)
	Returns the result of the subtraction operation self - e. More...
ConstULVectorExpression	__mul__ (int t)
	Returns the result of the multiplication operation self * t. More...
ConstULVectorExpression	__mul__ (ConstULMatrixExpression e)
	Returns the result of the multiplication operation self * e. More...
ConstULVectorExpression	__div__ (int t)
	Returns the result of the division operation self / t. More...
ConstULVectorExpression	__truediv__ (int t)
ConstULVectorExpression	__rmul__ (int t)

Properties
	objectID = property(getObjectID)
	size = property(getSize)

Constructor & Destructor Documentation

__init__() [1/2]

None CDPL.Math.ULScalarVector.__init__

(

ULScalarVector

v

)

Initializes a copy of the ULScalarVector instance v.

Parameters

v	The ULScalarVector instance to copy.

__init__() [2/2]

None CDPL.Math.ULScalarVector.__init__	(	int	n,
		int	v = 0
	)

Initializes the ULScalarVector instance.

Parameters

n
v

Member Function Documentation

resize()

None CDPL.Math.ULScalarVector.resize

(

int

n

)

Parameters

n

getObjectID()

int CDPL.Math.ULScalarVector.getObjectID

(

)

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

Different Python ULScalarVector 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 ULScalarVector 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.ULScalarVector.isEmpty

(

)

Returns

getSize()

int CDPL.Math.ULScalarVector.getSize

(

)

Returns

getElement()

int CDPL.Math.ULScalarVector.getElement

(

int

i

)

Parameters

i

Returns

toArray()

object CDPL.Math.ULScalarVector.toArray

(

)

Returns

assign()

ULScalarVector CDPL.Math.ULScalarVector.assign

(

ULScalarVector

v

)

Replaces the current state of self with a copy of the state of the ULScalarVector instance v.

Parameters

v	The ULScalarVector instance to copy.

Returns

self

swap()

None CDPL.Math.ULScalarVector.swap

(

ULScalarVector

v

)

Parameters

v

__eq__() [1/2]

bool CDPL.Math.ULScalarVector.__eq__

(

ULScalarVector

v

)

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

Parameters

v	The ULScalarVector instance to be compared with.

Returns

The result of the comparison operation.

__eq__() [2/2]

bool CDPL.Math.ULScalarVector.__eq__

(

ConstULVectorExpression

e

)

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

Parameters

e	The ConstULVectorExpression instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [1/2]

bool CDPL.Math.ULScalarVector.__ne__

(

ULScalarVector

v

)

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

Parameters

v	The ULScalarVector instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [2/2]

bool CDPL.Math.ULScalarVector.__ne__

(

ConstULVectorExpression

e

)

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

Parameters

e	The ConstULVectorExpression instance to be compared with.

Returns

The result of the comparison operation.

__call__()

int CDPL.Math.ULScalarVector.__call__

(

int

i

)

Parameters

i

Returns

__getitem__()

int CDPL.Math.ULScalarVector.__getitem__

(

int

i

)

Parameters

i

Returns

__len__()

int CDPL.Math.ULScalarVector.__len__

(

)

Returns

__str__()

str CDPL.Math.ULScalarVector.__str__

(

)

Returns a string representation of the ULScalarVector instance.

Returns

The generated string representation.

__pos__()

ULScalarVector CDPL.Math.ULScalarVector.__pos__

(

)

Returns

__neg__()

ConstULVectorExpression CDPL.Math.ULScalarVector.__neg__

(

)

Returns

__add__()

ConstULVectorExpression CDPL.Math.ULScalarVector.__add__

(

ConstULVectorExpression

e

)

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

Returns

A ConstULVectorExpression instance holding the result of the addition.

__sub__()

ConstULVectorExpression CDPL.Math.ULScalarVector.__sub__

(

ConstULVectorExpression

e

)

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns

A ULScalarVector instance holding the result of the subtraction.

__mul__() [1/2]

ConstULVectorExpression CDPL.Math.ULScalarVector.__mul__

(

int

t

)

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

Returns

A ConstULVectorExpression instance holding the result of the multiplication.

__mul__() [2/2]

ConstULVectorExpression CDPL.Math.ULScalarVector.__mul__

(

ConstULMatrixExpression

e

)

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

Returns

A ConstULVectorExpression instance holding the result of the multiplication.

__div__()

ConstULVectorExpression CDPL.Math.ULScalarVector.__div__

(

int

t

)

Returns the result of the division operation self / t.

Parameters

t	Specifies the divisor.

Returns

A ConstULVectorExpression instance holding the result of the division.

__truediv__()

ConstULVectorExpression CDPL.Math.ULScalarVector.__truediv__

(

int

t

)

Parameters

t

Returns

__rmul__()

ConstULVectorExpression CDPL.Math.ULScalarVector.__rmul__

(

int

t

)

Parameters

t

Returns