Improve documentation.
[pyutils.git] / docs / pyutils.typez.rst
1 pyutils.typez package
2 =====================
3
4 Submodules
5 ----------
6
7 pyutils.typez.centcount module
8 ------------------------------
9
10 .. automodule:: pyutils.typez.centcount
11    :members:
12    :undoc-members:
13    :show-inheritance:
14
15 pyutils.typez.histogram module
16 ------------------------------
17
18 A Histogram helper class.  Creates outputs like this::
19
20       [4..5): ▏                                                     ( 0.16% n=1)
21       [5..6): ██▍                                                   ( 0.64% n=4)
22       [6..7): ██████▏                                               ( 1.60% n=10)
23       [7..8): ████████████▍                                         ( 3.20% n=20)
24       [8..9): █████████████████████▊                                ( 5.60% n=35)
25      [9..10): ████████████████████████████████▍                     ( 8.32% n=52)
26     [10..11): ██████████████████████████████████████████▍           (10.88% n=68)
27     [11..12): █████████████████████████████████████████████████▉    (12.80% n=80)
28     [12..13): ████████████████████████████████████████████████████▉ (13.60% n=85)
29     [13..14): █████████████████████████████████████████████████▉    (12.80% n=80)
30     [14..15): ██████████████████████████████████████████▍           (10.88% n=68)
31     [15..16): ████████████████████████████████▍                     ( 8.32% n=52)
32     [16..17): █████████████████████▊                                ( 5.60% n=35)
33     [17..18): ████████████▍                                         ( 3.20% n=20)
34     [18..19): ██████▏                                               ( 1.60% n=10)
35     [19..20): ██▍                                                   ( 0.64% n=4)
36     [20..21): ▏                                                     ( 0.16% n=1)
37     --------------------------------------------------------------------------------
38      [4..21):                                                         pop(Σn)=625
39                                                                       mean(x̄)=12.000
40                                                                   median(p50)=12.000
41                                                                      mode(Mo)=12.000
42                                                                      stdev(σ)=0.113
43
44 .. automodule:: pyutils.typez.histogram
45    :members:
46    :undoc-members:
47    :show-inheritance:
48
49 pyutils.typez.money module
50 --------------------------
51
52 .. automodule:: pyutils.typez.money
53    :members:
54    :undoc-members:
55    :show-inheritance:
56
57 pyutils.typez.rate module
58 -------------------------
59
60 .. automodule:: pyutils.typez.rate
61    :members:
62    :undoc-members:
63    :show-inheritance:
64
65 pyutils.typez.type\_utils module
66 --------------------------------
67
68 .. automodule:: pyutils.typez.type_utils
69    :members:
70    :undoc-members:
71    :show-inheritance:
72
73 Module contents
74 ---------------
75
76 .. automodule:: pyutils.typez
77    :members:
78    :undoc-members:
79    :show-inheritance: