vector

An array of any number of floats.

as-mat

as-mat(
v: vector,mode: str,
) 

Converts a vector to a row or column matrix.

v:

vector

The vector to convert.

mode:

str

The type of matrix to convert into. Must be one of "row" or "column".

as-vec

as-vec(
v: vector,init: vector,
) 

Ensures a vector has an exact number of components. This is done by passing another vector init that has the required dimension. If the original vector does not have enough dimensions, the values from init will be inserted. It is recommended to use a zero vector for init.

v:

vector

The vector to ensure.

init:

vector

The vector to check the dimension against.

len

len(
v: vector,
) 

Return length/magnitude of a vector.

v:

vector

The vector to find the magnitude of.

add

add(
v1: vector,v2: vector,
) 

Adds two vectors of the same dimension

v1:

vector

The vector on the left hand side.

v2:

vector

The vector on the right hand side.

sub

sub(
v1: vector,v2: vector,
) 

Subtracts two vectors of the same dimension

v1:

vector

The vector on the left hand side.

v2:

vector

The vector on the right hand side.

dist

dist(
a: vector,b: vector,
) 

Calculates the distance between two vectors by subtracting the length of vector a from vector b.

a:

vector

Vector a

b:

vector

Vector b

scale

scale(
v: vector,x: float,
) 

Multiplys a vector with scalar x

v:

vector

The vector to scale.

x:

float

The scale factor.

div

div(
v: vector,x: float,
) 

Divides a vector by scalar x

v:

vector

The vector to be divded.

x:

float

The inverse scale factor.

neg

neg(
v: vector,
) 

Negates each value in a vector

v:

vector

The vector to negate.

norm

norm(
v: vector,
) 

Normalizes a vector (divide by its length)

v:

vector

The vector to normalize.

element-product

element-product(
a: vector,b: vector,
) 

Multiply two vectors component-wise

a:

vector

First vector.

b:

vector

Second vector.

dot

dot(
v1: vector,v2: vector,
) 

Calculates the dot product between two vectors.

v1:

vector

The vector on the left hand side.

v2:

vector

The vector on the right hand side.

cross

cross(
v1: vector,v2: vector,
) 

Calculates the cross product of two vectors with a dimension of three.

v1:

vector

The vector on the left hand side.

v2:

vector

The vector on the right hand side.

angle2

angle2(
a: vector,b: vector,
) 

Calculates the angle between two vectors and the x-axis in 2d space

a:

vector

The vector to measure the angle from.

b:

vector

The vector to measure the angle to.

angle

angle(
v1: vector,c: vector,v2: vector,
) 

Calculates the angle between three vectors

v1:

vector

The vector to measure the angle from.

c:

vector

The vector to measure the angle at.

v2:

vector

The vector to measure the angle to.

lerp

lerp(
v1: vector,v2: vector,t: float,
) 

Linear interpolation between two vectors.

v1:

vector

The vector to interpolate from.

v2:

vector

The vector to interpolate to.

t:

float

The factor to interpolate by. A value of 0 is v1 and a value of 1 is v2.