kcl-std → functions → concat

concatFunction in std::array

Combine two arrays into one by concatenating them.

concat(
  @array: [any],
  items: [any],
): [any]

Returns a new array with the all the elements of the first array followed by all the elements of the second array.

Arguments

NameTypeDescriptionRequired
array[any]The array of starting elements.Yes
items[any]The array of ending elements.Yes

Returns

[any]

Examples

arr1 = [10, 20, 30]
arr2 = [40, 50, 60]
newArr = concat(arr1, items = arr2)
assert(newArr[0], isEqualTo = 10, tolerance = 0.00001)
assert(newArr[1], isEqualTo = 20, tolerance = 0.00001)
assert(newArr[2], isEqualTo = 30, tolerance = 0.00001)
assert(newArr[3], isEqualTo = 40, tolerance = 0.00001)
assert(newArr[4], isEqualTo = 50, tolerance = 0.00001)
assert(newArr[5], isEqualTo = 60, tolerance = 0.00001)
assert(count(newArr), isEqualTo = 6, tolerance = 0.00001)

Rendered example of concat 0

// Concatenating an empty array has no effect.
newArr = concat([10, 20, 30], items = [])
assert(newArr[0], isEqualTo = 10, tolerance = 0.00001)
assert(newArr[1], isEqualTo = 20, tolerance = 0.00001)
assert(newArr[2], isEqualTo = 30, tolerance = 0.00001)
assert(count(newArr), isEqualTo = 3, tolerance = 0.00001)

Rendered example of concat 1

Found a typo?