modeling-app/docs/kcl-std/map.md

title, subtitle, excerpt, layout

title	subtitle	excerpt	layout
map	Function in std::array	Apply a function to every element of a list.	manual

Apply a function to every element of a list.

map(
  @array: [any],
  f: FunctionSource,
): [any]

Given a list like [a, b, c], and a function like f, returns [f(a), f(b), f(c)]

Arguments

Name	Type	Description	Required
array	[any]	Input array. The output array is this input array, but every element has had the function f run on it.	Yes
f	FunctionSource	A function. The output array is just the input array, but f has been run on every item.	Yes

Returns

[any]

Examples

r = 10 // radius
fn drawCircle(@id) {
  return startSketchOn(XY)
    |> circle(center = [id * 2 * r, 0], radius = r)
}

// Call `drawCircle`, passing in each element of the array.
// The outputs from each `drawCircle` form a new array,
// which is the return value from `map`.
circles = map([1..3], f = drawCircle)

r = 10 // radius
// Call `map`, using an anonymous function instead of a named one.
circles = map(
  [1..3],
  f = fn(@id) {
    return startSketchOn(XY)
      |> circle(center = [id * 2 * r, 0], radius = r)
  },
)