Initial revision
[LeanCalc.git] / help / pop
1 NAME
2     pop - pop a value from front of a list
3
4 SYNOPSIS
5     pop(lst)
6
7 TYPES
8     lst         list, &list
9
10     return      any
11
12 DESCRIPTION
13      This function removes index 0 and returns it.
14
15      This function is equivalent to calling delete(lst, 0).
16
17 EXAMPLE
18     > lst = list(2,"three")
19
20     list (2 elements, 2 nonzero):
21       [[0]] = 2
22       [[1]] = "three"
23
24     > pop(lst)
25             2
26     > print lst
27
28     list (1 elements, 1 nonzero):
29       [[0]] = "three"
30
31     > pop(lst)
32             "three"
33     > print lst
34     list (0 elements, 0 nonzero)
35     > pop(lst)
36     > print lst
37     list (0 elements, 0 nonzero)
38
39 LIMITS
40     none
41
42 LINK LIBRARY
43     none
44
45 SEE ALSO
46     append, delete, insert, islist, list, push, remove, rsearch, search, size
47