Bounded 3-element vector holding unsigned integers of type unsigned long. More...

Inheritance diagram for CDPL.Math.Vector3UL:

Public Member Functions
None	__init__ ()
	Constructs a zero-initialized N element vector.

None	__init__ (Vector3UL vec)
	Constructs a copy of the fixed-size vector vec. More...

None	__init__ (int v)
	Constructs an N-element vector with every element initialized to v. More...

None	__init__ (ConstFVectorExpression e)
	Constructs a fixed-size vector from the vector expression e. More...

None	__init__ (ConstDVectorExpression e)
	Constructs a fixed-size vector from the vector expression e. More...

None	__init__ (ConstLVectorExpression e)
	Constructs a fixed-size vector from the vector expression e. More...

None	__init__ (ConstULVectorExpression e)
	Constructs a fixed-size vector from the vector expression e. More...

None	__init__ (object a)
	Contructs the `Vector3UL` instance. More...

None	clear (int v=0)
	Sets every element of the vector to the value v. More...

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

Vector3UL	assign (ConstFVectorExpression e)
	Assigns the vector expression e to this fixed-size vector (via a temporary to handle aliasing). More...

Vector3UL	assign (ConstDVectorExpression e)
	Assigns the vector expression e to this fixed-size vector (via a temporary to handle aliasing). More...

Vector3UL	assign (ConstLVectorExpression e)
	Assigns the vector expression e to this fixed-size vector (via a temporary to handle aliasing). More...

Vector3UL	assign (ConstULVectorExpression e)
	Assigns the vector expression e to this fixed-size vector (via a temporary to handle aliasing). More...

Vector3UL	assign (Vector3UL v)
	Copy-assigns the elements of v to this fixed-size vector. More...

Vector3UL	assign (object a)
	Replaces the current state with a copy of the state of the `object` instance a. More...

bool	isEmpty ()
	Tells whether the vector is empty (N is zero). More...

int	getSize ()
	Returns the fixed element count N. More...

int	getElement (int i)

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

None	swap (Vector3UL v)
	Swaps the contents of this fixed-size vector with those of v. More...

None	setElement (int i, int v)

bool	__eq__ (Vector3UL 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__ (Vector3UL 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)
	Returns the element at index i. More...

int	__getitem__ (int i)
	Returns the element at index i. More...

int	__len__ ()
	Returns the fixed element count N. More...

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

Vector3UL	__pos__ ()
	Returns self. More...

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

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)
	Returns the result of the true division operation `self / t`. More...

ConstULVectorExpression	__rmul__ (int t)
	Returns the result of the multiplication operation `t * self`. More...

None	__setitem__ (int i, int v)

Vector3UL	__iadd__ (Vector3UL v)
	Performs the in-place addition operation `self += v`. More...

Vector3UL	__iadd__ (ConstULVectorExpression e)
	Adds the vector expression e element-wise to this fixed-size vector (via a temporary to handle aliasing). More...

Vector3UL	__isub__ (Vector3UL v)
	Performs the in-place subtraction operation `self -= v`. More...

Vector3UL	__isub__ (ConstULVectorExpression e)
	Subtracts the vector expression e element-wise from this fixed-size vector (via a temporary to handle aliasing). More...

Vector3UL	__imul__ (int t)
	Multiplies every element by the scalar t. More...

Vector3UL	__idiv__ (int t)
	Divides every element by the scalar t. More...

Vector3UL	__itruediv__ (int t)
	Divides every element by the scalar t. More...

Properties
	objectID = property(getObjectID)

	size = property(getSize)

Detailed Description

Bounded 3-element vector holding unsigned integers of type unsigned long.

Constructor & Destructor Documentation

◆ init() [1/7]

None CDPL.Math.Vector3UL.__init__ ( Vector3UL vec )

Constructs a copy of the fixed-size vector vec.

Parameters

vec	The fixed-size vector to copy.

◆ init() [2/7]

None CDPL.Math.Vector3UL.__init__ ( int v )

Constructs an N-element vector with every element initialized to v.

Parameters

v	The initial element value.

◆ init() [3/7]

None CDPL.Math.Vector3UL.__init__ ( ConstFVectorExpression e )

Constructs a fixed-size vector from the vector expression e.

Parameters

e	The source vector expression.

◆ init() [4/7]

None CDPL.Math.Vector3UL.__init__ ( ConstDVectorExpression e )

Constructs a fixed-size vector from the vector expression e.

Parameters

e	The source vector expression.

◆ init() [5/7]

None CDPL.Math.Vector3UL.__init__ ( ConstLVectorExpression e )

Constructs a fixed-size vector from the vector expression e.

Parameters

e	The source vector expression.

◆ init() [6/7]

None CDPL.Math.Vector3UL.__init__ ( ConstULVectorExpression e )

Constructs a fixed-size vector from the vector expression e.

Parameters

e	The source vector expression.

◆ init() [7/7]

None CDPL.Math.Vector3UL.__init__ ( object a )

Contructs the Vector3UL instance.

Parameters

a

Member Function Documentation

◆ clear()

None CDPL.Math.Vector3UL.clear ( int v = 0 )

Sets every element of the vector to the value v.

Parameters

v	The fill value.

◆ getObjectID()

int CDPL.Math.Vector3UL.getObjectID ( )

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

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

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

Assigns the vector expression e to this fixed-size vector (via a temporary to handle aliasing).

Parameters

e	The source vector expression.

Returns: self.

◆ assign() [2/6]

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

Assigns the vector expression e to this fixed-size vector (via a temporary to handle aliasing).

Parameters

e	The source vector expression.

Returns: self.

◆ assign() [3/6]

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

Assigns the vector expression e to this fixed-size vector (via a temporary to handle aliasing).

Parameters

e	The source vector expression.

Returns: self.

◆ assign() [4/6]

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

Assigns the vector expression e to this fixed-size vector (via a temporary to handle aliasing).

Parameters

e	The source vector expression.

Returns: self.

◆ assign() [5/6]

Vector3UL CDPL.Math.Vector3UL.assign ( Vector3UL v )

Copy-assigns the elements of v to this fixed-size vector.

Parameters

v	The source fixed-size vector.

Returns: self.

◆ assign() [6/6]

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

Replaces the current state with a copy of the state of the object instance a.

Parameters

a	The `object` instance to copy.

Returns: self.

◆ isEmpty()

bool CDPL.Math.Vector3UL.isEmpty ( )

Tells whether the vector is empty (N is zero).

Returns: True if N is zero, and False otherwise.

◆ getSize()

int CDPL.Math.Vector3UL.getSize ( )

Returns the fixed element count N.

Returns: The element count.

◆ toArray()

object CDPL.Math.Vector3UL.toArray ( )

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

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ swap()

None CDPL.Math.Vector3UL.swap ( Vector3UL v )

Swaps the contents of this fixed-size vector with those of v.

Parameters

v	The fixed-size vector to swap with.

◆ eq() [1/2]

bool CDPL.Math.Vector3UL.__eq__ ( Vector3UL v )

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

Parameters

v	The `Vector3UL` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

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

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

Parameters

v	The `Vector3UL` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

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

Returns the element at index i.

Parameters

i	The zero-based element index.

Returns: The value of the element.

Exceptions

Base.IndexError if i is out of range.

◆ getitem()

int CDPL.Math.Vector3UL.__getitem__ ( int i )

Returns the element at index i.

Parameters

i	The zero-based element index.

Returns: The value of the element.

Exceptions

Base.IndexError if i is out of range.

◆ len()

int CDPL.Math.Vector3UL.__len__ ( )

Returns the fixed element count N.

Returns: The element count.

◆ str()

str CDPL.Math.Vector3UL.__str__ ( )

Returns a string representation of the Vector3UL instance.

Returns: The generated string representation.

◆ pos()

Vector3UL CDPL.Math.Vector3UL.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstULVectorExpression CDPL.Math.Vector3UL.__neg__ ( )

Returns the result of the operation self * -1.

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

◆ add()

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

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ mul() [1/2]

ConstULVectorExpression CDPL.Math.Vector3UL.__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.Vector3UL.__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.Vector3UL.__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.Vector3UL.__truediv__ ( int t )

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

Parameters

t	Specifies the divisor.

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

◆ rmul()

ConstULVectorExpression CDPL.Math.Vector3UL.__rmul__ ( int t )

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

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

◆ iadd() [1/2]

Vector3UL CDPL.Math.Vector3UL.__iadd__ ( Vector3UL v )

Performs the in-place addition operation self += v.

Parameters

v	Specifies the second addend.

Returns: The updated Vector3UL instance self.

◆ iadd() [2/2]

Vector3UL CDPL.Math.Vector3UL.__iadd__ ( ConstULVectorExpression e )

Adds the vector expression e element-wise to this fixed-size vector (via a temporary to handle aliasing).

Parameters

e	The source vector expression.

Returns: self.

◆ isub() [1/2]

Vector3UL CDPL.Math.Vector3UL.__isub__ ( Vector3UL v )

Performs the in-place subtraction operation self -= v.

Parameters

v	Specifies the subtrahend.

Returns: The updated Vector3UL instance self.

◆ isub() [2/2]

Vector3UL CDPL.Math.Vector3UL.__isub__ ( ConstULVectorExpression e )

Subtracts the vector expression e element-wise from this fixed-size vector (via a temporary to handle aliasing).

Parameters

e	The source vector expression.

Returns: self.

◆ imul()

Vector3UL CDPL.Math.Vector3UL.__imul__ ( int t )

Multiplies every element by the scalar t.

Parameters

t	The scalar multiplier.

Returns: self.

◆ idiv()

Vector3UL CDPL.Math.Vector3UL.__idiv__ ( int t )

Divides every element by the scalar t.

Parameters

t	The scalar divisor.

Returns: self.

◆ itruediv()

Vector3UL CDPL.Math.Vector3UL.__itruediv__ ( int t )

Divides every element by the scalar t.

Parameters

t	The scalar divisor.

Returns: self.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/7]

◆ __init__() [2/7]

◆ __init__() [3/7]

◆ __init__() [4/7]

◆ __init__() [5/7]

◆ __init__() [6/7]

◆ __init__() [7/7]

Member Function Documentation

◆ clear()

◆ getObjectID()

◆ assign() [1/6]

◆ assign() [2/6]

◆ assign() [3/6]

◆ assign() [4/6]

◆ assign() [5/6]

◆ assign() [6/6]

◆ isEmpty()

◆ getSize()

◆ toArray()

◆ swap()

◆ __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__()

◆ __iadd__() [1/2]

◆ __iadd__() [2/2]

◆ __isub__() [1/2]

◆ __isub__() [2/2]

◆ __imul__()

◆ __idiv__()

◆ __itruediv__()

◆ init() [1/7]

◆ init() [2/7]

◆ init() [3/7]

◆ init() [4/7]

◆ init() [5/7]

◆ init() [6/7]

◆ init() [7/7]

◆ 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()

◆ iadd() [1/2]

◆ iadd() [2/2]

◆ isub() [1/2]

◆ isub() [2/2]

◆ imul()

◆ idiv()

◆ itruediv()