CDPL.Math.Vector3F Class Reference

Bounded 3-element vector holding floating-point values of type float. More...

Inheritance diagram for CDPL.Math.Vector3F:

Public Member Functions
None	__init__ ()
	Constructs a zero-initialized N element vector.
None	__init__ (Vector3F vec)
	Constructs a copy of the fixed-size vector vec. More...
None	__init__ (float 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 Vector3F 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...
Vector3F	assign (ConstFVectorExpression e)
	Assigns the vector expression e to this fixed-size vector (via a temporary to handle aliasing). More...
Vector3F	assign (ConstDVectorExpression e)
	Assigns the vector expression e to this fixed-size vector (via a temporary to handle aliasing). More...
Vector3F	assign (ConstLVectorExpression e)
	Assigns the vector expression e to this fixed-size vector (via a temporary to handle aliasing). More...
Vector3F	assign (ConstULVectorExpression e)
	Assigns the vector expression e to this fixed-size vector (via a temporary to handle aliasing). More...
Vector3F	assign (Vector3F v)
	Copy-assigns the elements of v to this fixed-size vector. More...
Vector3F	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...
float	getElement (int i)
object	toArray ()
	Converts the Vector3F instance into a corresponding numpy.ndarray object. More...
None	swap (Vector3F v)
	Swaps the contents of this fixed-size vector with those of v. More...
None	setElement (int i, float v)
bool	__eq__ (Vector3F v)
	Returns the result of the comparison operation self == v. More...
bool	__eq__ (ConstFVectorExpression e)
	Returns the result of the comparison operation self == e. More...
bool	__ne__ (Vector3F v)
	Returns the result of the comparison operation self != v. More...
bool	__ne__ (ConstFVectorExpression e)
	Returns the result of the comparison operation self != e. More...
float	__call__ (int i)
	Returns the element at index i. More...
float	__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 Vector3F instance. More...
Vector3F	__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)
Vector3F	__iadd__ (Vector3F v)
	Performs the in-place addition operation self += v. More...
Vector3F	__iadd__ (ConstFVectorExpression e)
	Adds the vector expression e element-wise to this fixed-size vector (via a temporary to handle aliasing). More...
Vector3F	__isub__ (Vector3F v)
	Performs the in-place subtraction operation self -= v. More...
Vector3F	__isub__ (ConstFVectorExpression e)
	Subtracts the vector expression e element-wise from this fixed-size vector (via a temporary to handle aliasing). More...
Vector3F	__imul__ (float t)
	Multiplies every element by the scalar t. More...
Vector3F	__idiv__ (float t)
	Divides every element by the scalar t. More...
Vector3F	__itruediv__ (float t)
	Divides every element by the scalar t. More...

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

Detailed Description

Bounded 3-element vector holding floating-point values of type float.

Constructor & Destructor Documentation

__init__() [1/7]

None CDPL.Math.Vector3F.__init__

(

Vector3F

vec

)

Constructs a copy of the fixed-size vector vec.

Parameters

vec	The fixed-size vector to copy.

__init__() [2/7]

None CDPL.Math.Vector3F.__init__

(

float

v

)

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

Parameters

v	The initial element value.

__init__() [3/7]

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

(

object

a

)

Contructs the Vector3F instance.

Parameters

a

Member Function Documentation

clear()

None CDPL.Math.Vector3F.clear

(

float

v = 0.0

)

Sets every element of the vector to the value v.

Parameters

v	The fill value.

getObjectID()

int CDPL.Math.Vector3F.getObjectID

(

)

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

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

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

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

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

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

Vector3F CDPL.Math.Vector3F.assign

(

Vector3F

v

)

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

Parameters

v	The source fixed-size vector.

Returns

self.

assign() [6/6]

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

(

)

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

Returns

True if N is zero, and False otherwise.

getSize()

int CDPL.Math.Vector3F.getSize

(

)

Returns the fixed element count N.

Returns

The element count.

toArray()

object CDPL.Math.Vector3F.toArray

(

)

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

Returns

The generated numpy.ndarray object.

See also

[NUMPY]

swap()

None CDPL.Math.Vector3F.swap

(

Vector3F

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

(

Vector3F

v

)

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

Parameters

v	The Vector3F instance to be compared with.

Returns

The result of the comparison operation.

__eq__() [2/2]

bool CDPL.Math.Vector3F.__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.Vector3F.__ne__

(

Vector3F

v

)

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

Parameters

v	The Vector3F instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [2/2]

bool CDPL.Math.Vector3F.__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.Vector3F.__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__()

float CDPL.Math.Vector3F.__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.Vector3F.__len__

(

)

Returns the fixed element count N.

Returns

The element count.

__str__()

str CDPL.Math.Vector3F.__str__

(

)

Returns a string representation of the Vector3F instance.

Returns

The generated string representation.

__pos__()

Vector3F CDPL.Math.Vector3F.__pos__

(

)

Returns self.

Returns

self.

__neg__()

ConstFVectorExpression CDPL.Math.Vector3F.__neg__

(

)

Returns the result of the operation self * -1.

Returns

A ConstFVectorExpression instance holding the result of the element negation.

__add__()

ConstFVectorExpression CDPL.Math.Vector3F.__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.Vector3F.__sub__

(

ConstFVectorExpression

e

)

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns

A Vector3F instance holding the result of the subtraction.

__mul__() [1/2]

ConstFVectorExpression CDPL.Math.Vector3F.__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.Vector3F.__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.Vector3F.__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.Vector3F.__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.Vector3F.__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.

__iadd__() [1/2]

Vector3F CDPL.Math.Vector3F.__iadd__

(

Vector3F

v

)

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

Parameters

v	Specifies the second addend.

Returns

The updated Vector3F instance self.

__iadd__() [2/2]

Vector3F CDPL.Math.Vector3F.__iadd__

(

ConstFVectorExpression

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]

Vector3F CDPL.Math.Vector3F.__isub__

(

Vector3F

v

)

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

Parameters

v	Specifies the subtrahend.

Returns

The updated Vector3F instance self.

__isub__() [2/2]

Vector3F CDPL.Math.Vector3F.__isub__

(

ConstFVectorExpression

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

Vector3F CDPL.Math.Vector3F.__imul__

(

float

t

)

Multiplies every element by the scalar t.

Parameters

t	The scalar multiplier.

Returns

self.

__idiv__()

Vector3F CDPL.Math.Vector3F.__idiv__

(

float

t

)

Divides every element by the scalar t.

Parameters

t	The scalar divisor.

Returns

self.

__itruediv__()

Vector3F CDPL.Math.Vector3F.__itruediv__

(

float

t

)

Divides every element by the scalar t.

Parameters

t	The scalar divisor.

Returns

self.