CDPL.Math.Vector4L Class Reference

Bounded 4-element vector holding signed integers of type long. More...

Inheritance diagram for CDPL.Math.Vector4L:

Public Member Functions
None	__init__ ()
	Constructs a zero-initialized N element vector.
None	__init__ (Vector4L 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 Vector4L 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...
Vector4L	assign (ConstFVectorExpression e)
	Assigns the vector expression e to this fixed-size vector (via a temporary to handle aliasing). More...
Vector4L	assign (ConstDVectorExpression e)
	Assigns the vector expression e to this fixed-size vector (via a temporary to handle aliasing). More...
Vector4L	assign (ConstLVectorExpression e)
	Assigns the vector expression e to this fixed-size vector (via a temporary to handle aliasing). More...
Vector4L	assign (ConstULVectorExpression e)
	Assigns the vector expression e to this fixed-size vector (via a temporary to handle aliasing). More...
Vector4L	assign (Vector4L v)
	Copy-assigns the elements of v to this fixed-size vector. More...
Vector4L	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 Vector4L instance into a corresponding numpy.ndarray object. More...
None	swap (Vector4L v)
	Swaps the contents of this fixed-size vector with those of v. More...
None	setElement (int i, int v)
bool	__eq__ (Vector4L v)
	Returns the result of the comparison operation self == v. More...
bool	__eq__ (ConstLVectorExpression e)
	Returns the result of the comparison operation self == e. More...
bool	__ne__ (Vector4L v)
	Returns the result of the comparison operation self != v. More...
bool	__ne__ (ConstLVectorExpression 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 Vector4L instance. More...
Vector4L	__pos__ ()
	Returns self. More...
ConstLVectorExpression	__neg__ ()
	Returns the result of the operation self * -1. More...
ConstLVectorExpression	__add__ (ConstLVectorExpression e)
	Returns the result of the addition operation self + e. More...
ConstLVectorExpression	__sub__ (ConstLVectorExpression e)
	Returns the result of the subtraction operation self - e. More...
ConstLVectorExpression	__mul__ (int t)
	Returns the result of the multiplication operation self * t. More...
ConstLVectorExpression	__mul__ (ConstLMatrixExpression e)
	Returns the result of the multiplication operation self * e. More...
ConstLVectorExpression	__div__ (int t)
	Returns the result of the division operation self // t. More...
ConstLVectorExpression	__truediv__ (int t)
	Returns the result of the true division operation self / t. More...
ConstLVectorExpression	__rmul__ (int t)
	Returns the result of the multiplication operation t * self. More...
None	__setitem__ (int i, int v)
Vector4L	__iadd__ (Vector4L v)
	Performs the in-place addition operation self += v. More...
Vector4L	__iadd__ (ConstLVectorExpression e)
	Adds the vector expression e element-wise to this fixed-size vector (via a temporary to handle aliasing). More...
Vector4L	__isub__ (Vector4L v)
	Performs the in-place subtraction operation self -= v. More...
Vector4L	__isub__ (ConstLVectorExpression e)
	Subtracts the vector expression e element-wise from this fixed-size vector (via a temporary to handle aliasing). More...
Vector4L	__imul__ (int t)
	Multiplies every element by the scalar t. More...
Vector4L	__idiv__ (int t)
	Divides every element by the scalar t. More...
Vector4L	__itruediv__ (int t)
	Divides every element by the scalar t. More...

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

Detailed Description

Bounded 4-element vector holding signed integers of type long.

Constructor & Destructor Documentation

__init__() [1/7]

None CDPL.Math.Vector4L.__init__

(

Vector4L

vec

)

Constructs a copy of the fixed-size vector vec.

Parameters

vec	The fixed-size vector to copy.

__init__() [2/7]

None CDPL.Math.Vector4L.__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.Vector4L.__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.Vector4L.__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.Vector4L.__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.Vector4L.__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.Vector4L.__init__

(

object

a

)

Contructs the Vector4L instance.

Parameters

a

Member Function Documentation

clear()

None CDPL.Math.Vector4L.clear

(

int

v = 0

)

Sets every element of the vector to the value v.

Parameters

v	The fill value.

getObjectID()

int CDPL.Math.Vector4L.getObjectID

(

)

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

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

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

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

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

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

Vector4L CDPL.Math.Vector4L.assign

(

Vector4L

v

)

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

Parameters

v	The source fixed-size vector.

Returns

self.

assign() [6/6]

Vector4L CDPL.Math.Vector4L.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.Vector4L.isEmpty

(

)

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

Returns

True if N is zero, and False otherwise.

getSize()

int CDPL.Math.Vector4L.getSize

(

)

Returns the fixed element count N.

Returns

The element count.

toArray()

object CDPL.Math.Vector4L.toArray

(

)

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

Returns

The generated numpy.ndarray object.

See also

[NUMPY]

swap()

None CDPL.Math.Vector4L.swap

(

Vector4L

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

(

Vector4L

v

)

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

Parameters

v	The Vector4L instance to be compared with.

Returns

The result of the comparison operation.

__eq__() [2/2]

bool CDPL.Math.Vector4L.__eq__

(

ConstLVectorExpression

e

)

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

Parameters

e	The ConstLVectorExpression instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [1/2]

bool CDPL.Math.Vector4L.__ne__

(

Vector4L

v

)

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

Parameters

v	The Vector4L instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [2/2]

bool CDPL.Math.Vector4L.__ne__

(

ConstLVectorExpression

e

)

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

Parameters

e	The ConstLVectorExpression instance to be compared with.

Returns

The result of the comparison operation.

__call__()

int CDPL.Math.Vector4L.__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.Vector4L.__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.Vector4L.__len__

(

)

Returns the fixed element count N.

Returns

The element count.

__str__()

str CDPL.Math.Vector4L.__str__

(

)

Returns a string representation of the Vector4L instance.

Returns

The generated string representation.

__pos__()

Vector4L CDPL.Math.Vector4L.__pos__

(

)

Returns self.

Returns

self.

__neg__()

ConstLVectorExpression CDPL.Math.Vector4L.__neg__

(

)

Returns the result of the operation self * -1.

Returns

A ConstLVectorExpression instance holding the result of the element negation.

__add__()

ConstLVectorExpression CDPL.Math.Vector4L.__add__

(

ConstLVectorExpression

e

)

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

Returns

A ConstLVectorExpression instance holding the result of the addition.

__sub__()

ConstLVectorExpression CDPL.Math.Vector4L.__sub__

(

ConstLVectorExpression

e

)

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns

A Vector4L instance holding the result of the subtraction.

__mul__() [1/2]

ConstLVectorExpression CDPL.Math.Vector4L.__mul__

(

int

t

)

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

Returns

A ConstLVectorExpression instance holding the result of the multiplication.

__mul__() [2/2]

ConstLVectorExpression CDPL.Math.Vector4L.__mul__

(

ConstLMatrixExpression

e

)

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

Returns

A ConstLVectorExpression instance holding the result of the multiplication.

__div__()

ConstLVectorExpression CDPL.Math.Vector4L.__div__

(

int

t

)

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

Parameters

t	Specifies the divisor.

Returns

A ConstLVectorExpression instance holding the result of the division.

__truediv__()

ConstLVectorExpression CDPL.Math.Vector4L.__truediv__

(

int

t

)

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

Parameters

t	Specifies the divisor.

Returns

A ConstLVectorExpression instance holding the result of the division.

__rmul__()

ConstLVectorExpression CDPL.Math.Vector4L.__rmul__

(

int

t

)

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

Returns

A ConstLVectorExpression instance holding the result of the multiplication.

__iadd__() [1/2]

Vector4L CDPL.Math.Vector4L.__iadd__

(

Vector4L

v

)

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

Parameters

v	Specifies the second addend.

Returns

The updated Vector4L instance self.

__iadd__() [2/2]

Vector4L CDPL.Math.Vector4L.__iadd__

(

ConstLVectorExpression

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]

Vector4L CDPL.Math.Vector4L.__isub__

(

Vector4L

v

)

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

Parameters

v	Specifies the subtrahend.

Returns

The updated Vector4L instance self.

__isub__() [2/2]

Vector4L CDPL.Math.Vector4L.__isub__

(

ConstLVectorExpression

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

Vector4L CDPL.Math.Vector4L.__imul__

(

int

t

)

Multiplies every element by the scalar t.

Parameters

t	The scalar multiplier.

Returns

self.

__idiv__()

Vector4L CDPL.Math.Vector4L.__idiv__

(

int

t

)

Divides every element by the scalar t.

Parameters

t	The scalar divisor.

Returns

self.

__itruediv__()

Vector4L CDPL.Math.Vector4L.__itruediv__

(

int

t

)

Divides every element by the scalar t.

Parameters

t	The scalar divisor.

Returns

self.