Documentation / @interstellar-tools/equations / scale

Function: scale()

function scale(v: Vector3DTupleType, s: number): Vector3DTupleType;

Defined in: helpers/misc.ts:44

Scale a 3D vector by a scalar.

Computes:

$$s\mathbf{v}=[sx,sy,sz]$$

Parameters

Parameter	Type	Description
v	Vector3DTupleType	3D vector [x, y, z].
s	number	Scalar multiplier.

Returns

Vector3DTupleType

Scaled vector s * v.

Example

scale([1, -2, 3], 10); // [10, -20, 30]