focus expression text field at startup -> version 1.2
[LeanCalc.git] / help / insert
1 NAME
2     insert - insert one or more elements into a list at a given position
3
4 SYNOPSIS
5     insert(x, y, z_0, z_1, ...)
6
7 TYPES
8     x           lvalue whose value is a list
9     y           int
10     z_0, ...    any
11
12     return      null value
13
14 DESCRIPTION
15      If after evaluation of z_0, z_1, ..., x is a list with contents
16      (x_0, x_1, ..., x_y-1, x_y, ..., x_n-1), then after insert(),
17      x has contents (x_0, x_1, ..., x_y-1, z_0, z_1, ..., x_y, ..., x_n-1),
18      i.e. z_0, z_1, ... are inserted in order immediately before the
19      element with index y (so that z_0 is now x[[y]]), or if y = n,
20      after the last element x_n-1.  An error occurs if y > n.
21
22 EXAMPLE
23     > A = list(2,3,4)
24     > print A
25
26     list (3 elements, 3 nonzero):
27       [[0]] = 2
28       [[1]] = 3
29       [[2]] = 4
30
31     > insert(A, 1, 5, 6)
32     > print A
33
34     list (5 elements, 5 nonzero):
35       [[0]] = 1
36       [[1]] = 5
37       [[2]] = 6
38       [[3]] = 3
39       [[4]] = 4
40
41     > insert(A, 2, remove(A))
42     > print A
43
44     list (5 elements, 5 nonzero):
45       [[0]] = 1
46       [[1]] = 5
47       [[2]] = 4
48       [[3]] = 6
49       [[4]] = 3
50
51 LIMITS
52     insert() can have at most 100 arguments
53     o <= y <= size(x)
54
55 LINK LIBRARY
56     none
57
58 SEE ALSO
59     append, delete, islist, list, pop, push, remove, rsearch, search, size
60