File: randomSubset-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 (40 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
doc ///
  Key
     randomSubset
    (randomSubset, VisibleList, ZZ)
    (randomSubset, Set, ZZ)
    (randomSubset, ZZ, ZZ)
    (randomSubset, VisibleList)
    (randomSubset, Set)
    (randomSubset, ZZ)
  Usage
    randomSubset(x, n)
    randomSubset x
  Inputs
    x:{VisibleList, Set, ZZ}
    n:ZZ
  Description
    Text
      When @VAR "n"@ is given, then a random subset @VAR "x"@ of cardinality
      @VAR "n"@ is returned.
    Example
      randomSubset({2, 3, 5, 7, 11}, 2)
    Text
      Otherwise, a random subset of arbitrary cardinality is returned.
    Example
      randomSubset {2, 3, 5, 7, 11}
      randomSubset {2, 3, 5, 7, 11}
      randomSubset {2, 3, 5, 7, 11}
    Text
      If @VAR "x"@ is an integer, then a subset of $\{0,\ldots,x - 1\}$ is
      returned.
    Example
      randomSubset(4, 2)
      randomSubset 5
  References
    Knuth, Donald E.
    @EM "The Art of Computer Programming: Seminumerical Algorithms, Volume 2"@.
    Addison-Wesley Professional, 2014. (Algorithm S, Section 3.4.2)
  SeeAlso
    random
///