kcl-std → functions → vector::sub

vector::subFunction in std::vector

Subtracts from every element of u its corresponding element in v. Both vectors must have the same length. Returns a new vector of the same length. In other words, component-wise subtraction.

vector::sub(
  @u: [number],
  v: [number],
): [number]

Arguments

Name	Type	Description	Required
`u`	`[number]`		Yes
`v`	`[number]`		Yes

Returns

[number]

Examples

u = [10, 10, 10]
v = [1, 2, 3]
v2 = vector::sub(u, v)
assert(v2[0], isEqualTo = 9)
assert(v2[1], isEqualTo = 8)
assert(v2[2], isEqualTo = 7)

Found a typo?