CDPL.Math.Vector2D Class Reference

Bounded 2 element vector holding floating-point values of type double. More...

Inheritance diagram for CDPL.Math.Vector2D:

Public Member Functions
None	__init__ ()
	Constructs a zero-initialized N element vector.
None	__init__ (Vector2D v)
	Constructs a copy of the fixed-size vector v. More...
None	__init__ (float v)
	Constructs a copy of the fixed-size vector v. More...
None	__init__ (ConstFVectorExpression e)
	Initializes the Vector2D instance. More...
None	__init__ (ConstDVectorExpression e)
	Initializes the Vector2D instance. More...
None	__init__ (ConstLVectorExpression e)
	Initializes the Vector2D instance. More...
None	__init__ (ConstULVectorExpression e)
	Initializes the Vector2D instance. More...
None	__init__ (object a)
	Initializes the Vector2D instance. More...
None	clear (float v=0.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...
Vector2D	assign (ConstFVectorExpression e)
	Assigns the elements of the vector expression e to this fixed-size vector without intermediate temporary. More...
Vector2D	assign (ConstDVectorExpression e)
	Assigns the elements of the vector expression e to this fixed-size vector without intermediate temporary. More...
Vector2D	assign (ConstLVectorExpression e)
	Assigns the elements of the vector expression e to this fixed-size vector without intermediate temporary. More...
Vector2D	assign (ConstULVectorExpression e)
	Assigns the elements of the vector expression e to this fixed-size vector without intermediate temporary. More...
Vector2D	assign (Vector2D v)
	Copy-assigns the elements of v to this fixed-size vector. More...
None	assign (object a)
	Replaces the current state of self 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...
float	getElement (int i)
object	toArray ()
None	swap (Vector2D v)
	Swaps the contents of this fixed-size vector with those of v. More...
None	setElement (int i, float v)
bool	__eq__ (Vector2D v)
	Returns the result of the comparison operation self == v. More...
bool	__eq__ (ConstDVectorExpression e)
	Returns the result of the comparison operation self == e. More...
bool	__ne__ (Vector2D v)
	Returns the result of the comparison operation self != v. More...
bool	__ne__ (ConstDVectorExpression e)
	Returns the result of the comparison operation self != e. More...
float	__call__ (int i)
	Returns a reference to the element at index i. More...
float	__getitem__ (int i)
	Returns a reference to the element at index i. More...
int	__len__ ()
	Returns the fixed element count N. More...
str	__str__ ()
	Returns a string representation of the Vector2D instance. More...
Vector2D	__pos__ ()
ConstDVectorExpression	__neg__ ()
ConstDVectorExpression	__add__ (ConstDVectorExpression e)
	Returns the result of the addition operation self + e. More...
ConstDVectorExpression	__sub__ (ConstDVectorExpression e)
	Returns the result of the subtraction operation self - e. More...
ConstDVectorExpression	__mul__ (float t)
	Returns the result of the multiplication operation self * t. More...
ConstDVectorExpression	__mul__ (ConstDMatrixExpression e)
	Returns the result of the multiplication operation self * e. More...
ConstDVectorExpression	__div__ (float t)
	Returns the result of the division operation self // t. More...
ConstDVectorExpression	__truediv__ (float t)
	Returns the result of the true division operation self / t. More...
ConstDVectorExpression	__rmul__ (float t)
	Returns the result of the multiplication operation t * self. More...
None	__setitem__ (int i, float v)
Vector2D	__iadd__ (Vector2D v)
	Performs the in-place addition operation self += v. More...
Vector2D	__iadd__ (ConstDVectorExpression e)
	Adds the vector expression e element-wise to this fixed-size vector (via a temporary to handle aliasing). More...
Vector2D	__isub__ (Vector2D v)
	Performs the in-place subtraction operation self -= v. More...
Vector2D	__isub__ (ConstDVectorExpression e)
	Subtracts the vector expression e element-wise from this fixed-size vector (via a temporary to handle aliasing). More...
Vector2D	__imul__ (float t)
	Multiplies every element by the scalar t. More...
Vector2D	__idiv__ (float t)
	Divides every element by the scalar t. More...
Vector2D	__itruediv__ (float t)

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

Detailed Description

Bounded 2 element vector holding floating-point values of type double.

Constructor & Destructor Documentation

__init__() [1/7]

None CDPL.Math.Vector2D.__init__

(

Vector2D

v

)

Constructs a copy of the fixed-size vector v.

Parameters

v	The fixed-size vector to copy.

__init__() [2/7]

None CDPL.Math.Vector2D.__init__

(

float

v

)

Constructs a copy of the fixed-size vector v.

Parameters

v	The fixed-size vector to copy.

__init__() [3/7]

None CDPL.Math.Vector2D.__init__

(

ConstFVectorExpression

e

)

Initializes the Vector2D instance.

Parameters

e

__init__() [4/7]

None CDPL.Math.Vector2D.__init__

(

ConstDVectorExpression

e

)

Initializes the Vector2D instance.

Parameters

e

__init__() [5/7]

None CDPL.Math.Vector2D.__init__

(

ConstLVectorExpression

e

)

Initializes the Vector2D instance.

Parameters

e

__init__() [6/7]

None CDPL.Math.Vector2D.__init__

(

ConstULVectorExpression

e

)

Initializes the Vector2D instance.

Parameters

e

__init__() [7/7]

None CDPL.Math.Vector2D.__init__

(

object

a

)

Initializes the Vector2D instance.

Parameters

a

Member Function Documentation

clear()

None CDPL.Math.Vector2D.clear

(

float

v = 0.0

)

Sets every element of the vector to the value v.

Parameters

v	The fill value.

getObjectID()

int CDPL.Math.Vector2D.getObjectID

(

)

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

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

Vector2D CDPL.Math.Vector2D.assign

(

ConstFVectorExpression

e

)

Assigns the elements of the vector expression e to this fixed-size vector without intermediate temporary.

Parameters

e	The source vector expression.

Returns

self

assign() [2/6]

Vector2D CDPL.Math.Vector2D.assign

(

ConstDVectorExpression

e

)

Assigns the elements of the vector expression e to this fixed-size vector without intermediate temporary.

Parameters

e	The source vector expression.

Returns

self

assign() [3/6]

Vector2D CDPL.Math.Vector2D.assign

(

ConstLVectorExpression

e

)

Assigns the elements of the vector expression e to this fixed-size vector without intermediate temporary.

Parameters

e	The source vector expression.

Returns

self

assign() [4/6]

Vector2D CDPL.Math.Vector2D.assign

(

ConstULVectorExpression

e

)

Assigns the elements of the vector expression e to this fixed-size vector without intermediate temporary.

Parameters

e	The source vector expression.

Returns

self

assign() [5/6]

Vector2D CDPL.Math.Vector2D.assign

(

Vector2D

v

)

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

Parameters

v	The source fixed-size vector.

Returns

self

assign() [6/6]

None CDPL.Math.Vector2D.assign

(

object

a

)

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

Parameters

a	The object instance to copy.

Returns

self

isEmpty()

bool CDPL.Math.Vector2D.isEmpty

(

)

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

Returns

True if N is zero, and False otherwise.

getSize()

int CDPL.Math.Vector2D.getSize

(

)

Returns the fixed element count N.

Returns

The element count.

swap()

None CDPL.Math.Vector2D.swap

(

Vector2D

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

(

Vector2D

v

)

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

Parameters

v	The Vector2D instance to be compared with.

Returns

The result of the comparison operation.

__eq__() [2/2]

bool CDPL.Math.Vector2D.__eq__

(

ConstDVectorExpression

e

)

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

Parameters

e	The ConstDVectorExpression instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [1/2]

bool CDPL.Math.Vector2D.__ne__

(

Vector2D

v

)

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

Parameters

v	The Vector2D instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [2/2]

bool CDPL.Math.Vector2D.__ne__

(

ConstDVectorExpression

e

)

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

Parameters

e	The ConstDVectorExpression instance to be compared with.

Returns

The result of the comparison operation.

__call__()

float CDPL.Math.Vector2D.__call__

(

int

i

)

Returns a reference to the element at index i.

Parameters

i	The zero-based element index.

Returns

A reference to the element.

Exceptions

Base.IndexError

if i is out of range.

__getitem__()

float CDPL.Math.Vector2D.__getitem__

(

int

i

)

Returns a reference to the element at index i.

Parameters

i	The zero-based element index.

Returns

A reference to the element.

Exceptions

Base.IndexError

if i is out of range.

__len__()

int CDPL.Math.Vector2D.__len__

(

)

Returns the fixed element count N.

Returns

The element count.

__str__()

str CDPL.Math.Vector2D.__str__

(

)

Returns a string representation of the Vector2D instance.

Returns

The generated string representation.

__add__()

ConstDVectorExpression CDPL.Math.Vector2D.__add__

(

ConstDVectorExpression

e

)

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

Returns

A ConstDVectorExpression instance holding the result of the addition.

__sub__()

ConstDVectorExpression CDPL.Math.Vector2D.__sub__

(

ConstDVectorExpression

e

)

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns

A Vector2D instance holding the result of the subtraction.

__mul__() [1/2]

ConstDVectorExpression CDPL.Math.Vector2D.__mul__

(

float

t

)

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

Returns

A ConstDVectorExpression instance holding the result of the multiplication.

__mul__() [2/2]

ConstDVectorExpression CDPL.Math.Vector2D.__mul__

(

ConstDMatrixExpression

e

)

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

Returns

A ConstDVectorExpression instance holding the result of the multiplication.

__div__()

ConstDVectorExpression CDPL.Math.Vector2D.__div__

(

float

t

)

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

Parameters

t	Specifies the divisor.

Returns

A ConstDVectorExpression instance holding the result of the division.

__truediv__()

ConstDVectorExpression CDPL.Math.Vector2D.__truediv__

(

float

t

)

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

Parameters

t	Specifies the divisor.

Returns

A ConstDVectorExpression instance holding the result of the division.

__rmul__()

ConstDVectorExpression CDPL.Math.Vector2D.__rmul__

(

float

t

)

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

Returns

A ConstDVectorExpression instance holding the result of the multiplication.

__iadd__() [1/2]

Vector2D CDPL.Math.Vector2D.__iadd__

(

Vector2D

v

)

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

Parameters

v	Specifies the second addend.

Returns

The updated Vector2D instance self.

__iadd__() [2/2]

Vector2D CDPL.Math.Vector2D.__iadd__

(

ConstDVectorExpression

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]

Vector2D CDPL.Math.Vector2D.__isub__

(

Vector2D

v

)

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

Parameters

v	Specifies the subtrahend.

Returns

The updated Vector2D instance self.

__isub__() [2/2]

Vector2D CDPL.Math.Vector2D.__isub__

(

ConstDVectorExpression

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

Vector2D CDPL.Math.Vector2D.__imul__

(

float

t

)

Multiplies every element by the scalar t.

Parameters

t	The scalar multiplier.

Returns

self

__idiv__()

Vector2D CDPL.Math.Vector2D.__idiv__

(

float

t

)

Divides every element by the scalar t.

Parameters

t	The scalar divisor.

Returns

self