File: applyPairs-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 (42 lines) | stat: -rw-r--r-- 1,045 bytes parent folder | download | duplicates (2)
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
--- status: DRAFT
--- author(s): L.Gold, Lily Silverstein
--- notes: 

doc ///
 Key
  applyPairs
  (applyPairs,HashTable,Function)
  (applyPairs,BasicList,Function)
  (applyPairs,Dictionary,Function)
  (applyPairs,Thing,Function)
 Headline
  apply a function to each pair in a hash table
 Usage
  applyPairs(H, f)
 Inputs
  H:{HashTable, BasicList, Dictionary}
   or any instance of a class with an @TO iterator@ method installed
  f:Function
   of two arguments, returning a pair or @TO null@
 Outputs
  :HashTable
   obtained by applying {\tt f} to each key/value pair in {\tt H}
 Description
  Example
   H = new HashTable from {1 => 10, 2 => 15, 3 => 20}
   applyPairs(H, (k,v) -> (k+1, v+10))
   applyPairs(H, (k,v) -> (v,k))
  Text
   If @CODE "H"@ is not a hash table, then @M2CODE "apply(pairs H, f)"@ is
   called.
  Example
   applyPairs({4, 5, 6}, (i, x) -> i * x)
 Caveat	  
  It is an error for the function {\tt f} to return two pairs with the same key.
 SeeAlso
  "hash tables"
  applyKeys
  applyValues
  pairs  
  scanPairs
///