File: join-doc.m2

package info (click to toggle)
macaulay2 1.25.05%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 172,152 kB
  • sloc: cpp: 107,824; ansic: 16,193; javascript: 4,189; makefile: 3,899; lisp: 702; yacc: 604; sh: 476; xml: 177; perl: 114; lex: 65; python: 33
file content (52 lines) | stat: -rw-r--r-- 1,463 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
-- Status: rewritten July 2018
-- Author: Lily Silverstein

doc///
 Key
  join
 Headline
  join lists, sequences, and iterable objects
 Usage
  join(A, B, ...)
 Inputs
  A: BasicList
  B: BasicList
    or any instance of a class  with the @TO iterator@ method installed
 Outputs
  Z: {BasicList, Iterator}
 Description
  Text
   {\tt join(A, B, ...)} joins the elements of the lists or sequences
   {\tt A, B, ...} into a single list or sequence. The inputs may belong
   to different classes; the class of the result will match the class of
   the first argument passed to {\tt join}.
  Example
   join( {1,2,3}, (4,5,6), (7,8,9) )
   join( (1,2,3), {4,5,6}, {7}, (8,9,10) )
  Text
   The operator @TO"|"@ is a convenient shorthand for joining two
   inputs of the same class. 
  Example
   {1,2,3} | {4,5,6}
   (1,2,3) | (4,5,6)
  Text
   If the first argument is a list or sequence and any later arguments are
   instances of a class with the @TO iterator@ method installed, then these
   instances are converted to sequences and are then joined.
  Example
   join({1, 2, 3}, iterator {4, 5, 6})
  Text
   If the first argument is not a list or sequence, then an @TO Iterator@
   object is returned that iterates through each argument sequentially,
   provided that each argument is an iterable object.
  Example
   join(iterator {1, 2, 3}, {4, 5, 6})
   toList oo
 SeeAlso
  concatenate
  demark
  flatten
  mingle
  "List | List"
  "lists and sequences"
///