config.py

   1 #!/usr/bin/env python3
   2 # encoding: utf-8
   3
   4 """Configuration of check_neo, mainly the weights of the cost functions. Intended to be easily modified."""
   5
   6 #: The mutated letters - only these get changed. You may change these to leave letters in their defined place.
   7 abc = "abcdefghijklmnopqrstuvwxyzäöüß,."
   8
   9 #The letters which are used to calculate the costs - do not change anything or results will become incomparable.
  10 abc_full = "abcdefghijklmnopqrstuvwxyzäöüß,."
  11
  12 WEIGHT_POSITION = 10 #: reference cost - gets multiplied with the COST_PER_KEY.
  13
  14 WEIGHT_FINGER_REPEATS = 256 #: Cost of a finger repeat. Gets additional +1 from the row change on the same finger.
  15
  16 WEIGHT_FINGER_REPEATS_TOP_BOTTOM = 2048 #: Additional cost of a finger repetition from the top to the bottom line. Gets added to the cost of the normal finger repetition. Additionally this gets costs as row repetition on the same hand (+4).
  17
  18 WEIGHT_BIGRAM_ROW_CHANGE_PER_ROW = 0.6 #: When I have to switch the row in a bigram while on the same hand, that takes time => Penalty per (row to cross ² / horizontal distance)² if we’re on the same hand.
  19
  20 WEIGHT_COUNT_ROW_CHANGES_BETWEEN_HANDS = False #: Should we count a row change with a handswitch as row change?
  21
  22 WEIGHT_FINGER_DISBALANCE = 500 #: multiplied with the standard deviation of the finger usage - value guessed and only valid for the 1gramme.txt corpus.
  23
  24 WEIGHT_HAND_DISBALANCE = 30 #: Disbalance between the load on the hands. Calculated from the finger disbalance, but coarser. If both hands have slightly unequal load on the individual fingers, but overall both hands have the same load, the layout feels equal.
  25
  26 WEIGHT_TOO_LITTLE_HANDSWITCHING = 300 #: how high should it be counted, if the hands aren’t switched in a triple?
  27
  28 WEIGHT_NO_HANDSWITCH_AFTER_DIRECTION_CHANGE = 1 #: multipleir for triples without handswitch in which there also is a direction change? Also affects the “unweighted” result from total_cost!
  29 WEIGHT_NO_HANDSWITCH_WITHOUT_DIRECTION_CHANGE = 0 #: multipier for triples without handswitch in in which the direction doesn’t change. Also affects the “unweighted” result from total_cost!
  30
  31 WEIGHT_INTENDED_FINGER_LOAD_LEFT_PINKY_TO_RIGHT_PINKY = [
  32     1,
  33     1.6,
  34     2.6,
  35     2.6, # is 1/3 faster
  36     1,
  37     1,
  38     2.6,
  39     2.6,
  40     1.6,
  41     1] #: The intended load per finger. Inversed and then used as multiplier for the finger load before calculating the finger disbalance penalty. Any load distribution which strays from this optimum gives a penalty.
  42
  43 WEIGHT_XCVZ_ON_BAD_POSITION = 0.2 #: the penalty *per letter* in the text if xvcz are on bad positions (cumulative; if all 4 are on bad positions (not in the first 5 keys, counted from the left side horizontally) we get 4 times the penalty).
  44
  45 WEIGHT_FINGER_SWITCH = 20 #: how much worse is it to switch from middle to indexfinger compared with middle to pinky (~30ms according to Rohmert).
  46
  47 #: The cost for moving from one finger to another one with middle-to-index as 1 (30ms). Currently only uses the neighbors. Can also be used to favor a certain direction. Adapted the Rohmert times as per my own experiences: http://lists.neo-layout.org/pipermail/diskussion/2010-May/017171.html and http://lists.neo-layout.org/pipermail/diskussion/2010-May/017321.html
  48 FINGER_SWITCH_COST = { # iu td < ui dt dr ua rd au < ai rt < nd eu
  49     "Klein_L": {
  50         "Ring_L": 3,
  51         "Mittel_L": 3
  52         },
  53     "Ring_L": {
  54         "Klein_L": 4,
  55         "Mittel_L": 3
  56         },
  57     "Mittel_L": {
  58         "Klein_L": 1,
  59         "Ring_L": 2
  60         },
  61     "Zeige_L": {
  62         "Klein_L": 1
  63         },
  64     "Daumen_L": {
  65         },
  66     "Daumen_R": {
  67         },
  68     "Zeige_R": {
  69         "Klein_R": 1
  70         },
  71     "Mittel_R": {
  72         "Ring_R": 2,
  73         "Klein_R": 1
  74         },
  75     "Ring_R": {
  76         "Mittel_R": 3,
  77         "Klein_R": 4
  78         },
  79     "Klein_R": {
  80         "Mittel_R": 3,
  81         "Ring_R": 3
  82         }
  83 } # iutd, drua, uidt, rdau, airt, ndeu :)
  84
  85 WEIGHT_NO_HANDSWITCH_AFTER_UNBALANCING_KEY = 20 #: How much penalty we want if there’s no handswitching after an unbalancing key. Heavy unbalancing (wkßz, M3 right, return and the shifts) counts double (see UNBALANCING_POSITIONS). This also gives a penalty for handswitching after an uppercase letter.
  86
  87 #: Positions which pull the hand from the base row, position and cost (the strength of the pulling from base row).
  88 UNBALANCING_POSITIONS = {
  89     (1, 0, 0): 2, # Tab
  90     (1, 1, 0): 1,# x
  91     (1, 5, 0): 2, # w
  92     (1, 6, 0): 2, # k
  93     (1, 10, 0): 1, # q
  94     (1, 11, 0): 2, # ß
  95     (2, 0, 0): 2, # L_M3
  96     (2, 5, 0): 1, # o
  97     (2, 6, 0): 1, # s
  98     (2, 11, 0): 1, # y
  99     (2, 12, 0): 2, # R_M3
 100     (2, 13, 0): 2, # Return
 101     (3, 0, 0): 2, # L_Shift
 102     (3, 12, 0): 2, # R_Shift
 103     (3, 6, 0): 2 # z
 104 }
 105
 106 # Structured key weighting (but still mostly from experience and deducing from the work of others).
 107 # The speed of the fingers is taken out (see INTENDED_FINGER_LOAD_LEFT_PINKY_TO_RIGHT_PINKY).
 108 # So this shows the reachability of the keys, ignoring the different speed of the fingers.
 109 # “How much does the hand hurt when reaching for the key” :)
 110 # rationale: reaching for the Neo 2 x hurts thrice as much as just hitting the Neo2 u → 10 vs. 3.
 111 # the upper keys on the right hand can be reached a bit better, since movement is aligned with the hand
 112 # (except for q, since the pinky is too short for that).
 113 # theoretical minimum (assigning the lowest cost to the most frequent char, counting only the chars on layer 1):
 114 # 1123111113 = 3.3490913205386508 mean key position cost
 115 # Ringfinger on lower row takes 1.5 times the time of index on the upper row[1].
 116 # [1]: http://forschung.goebel-consult.de/de-ergo/rohmert/Rohmert.html - only one person!
 117 COST_PER_KEY  = [
 118     # The 0 values aren’t filled in at the moment.
 119     # Don’t put mutated keys there, otherwise the best keys will end up there!
 120     [50,    40,35,30,30, 35,   40,35,30,30,30,35,40,50], # Zahlenreihe (0)
 121     [24,    20, 6, 5, 6, 9,    10, 5, 4, 5, 8,24,36, 0], # Reihe 1
 122     [12,     3, 3, 3, 3, 5,     5, 3, 3, 3, 3, 5,10,18], # Reihe 2
 123     [15,10,12,24,20, 10,   30, 7, 6,22,22,10,   15],     # Reihe 3
 124     [0,0,0,               3           , 0, 0, 0, 0] # Reihe 4 mit Leertaste
 125 ]
 126
 127 COST_LAYER_ADDITION = [0, 15, 12, 10, 27, 22]
 128
 129 COST_PER_KEY_NOT_FOUND = 60
 130
 131 # for reference the neo layout
 132 NEO = [
 133     [("^"),("1"),("2"),("3"),("4"),("5"),("6"),("7"),("8"),("9"),("0"),("-"),("`"),("←")], # Zahlenreihe (0)
 134     [("⇥"),("x"),("v"),("l"),("c"),("w"),("k"),("h"),("g"),("f"),("q"),("ß"),("´"),()], # Reihe 1
 135     [("⇩"),("u"),("i"),("a"),("e"),("o"),("s"),("n"),("r"),("t"),("d"),("y"),("⇘"),("\n")], # Reihe 2
 136     [("⇧"),(),("ü"),("ö"),("ä"),("p"),("z"),("b"),("m"),(","),("."),("j"),("⇗")],        # Reihe 3
 137     [(), (), (), (" "), (), (), (), ()] # Reihe 4 mit Leertaste
 138 ]
 139
 140
 141 #: The positions which are by default accessed by the given finger.
 142 FINGER_POSITIONS = {
 143     "Klein_L": [(1, 1, 0), (2, 0, 0), (2, 1, 0), (3, 0, 0), (3, 1, 0), (3, 2, 0)], # Klein_L
 144     "Ring_L": [(1, 2, 0), (2, 2, 0), (3, 3, 0)], # Ring_L
 145     "Mittel_L": [(1, 3, 0), (2, 3, 0), (3, 4, 0)], # Mittel_L
 146     "Zeige_L": [(1, 4, 0), (2, 4, 0), (3, 5, 0), (1, 5, 0), (2, 5, 0), (3, 6, 0)], # Zeige_L
 147     "Daumen_L": [(4, 3, 0)], # Daumen_L
 148     "Daumen_R": [(4, 3, 0)], # Daumen_R
 149     "Zeige_R": [(1, 6, 0), (2, 6, 0), (3, 7, 0), (1, 7, 0), (2, 7, 0), (3, 8, 0)], # Zeige_R
 150     "Mittel_R": [(1, 8, 0), (2, 8, 0), (3, 9, 0)], # Mittel_R
 151     "Ring_R": [(1, 9, 0), (2, 9, 0), (3, 10, 0)], # Ring_R
 152     "Klein_R": [(1, 10, 0), (2, 10, 0), (3, 11, 0), (1, 11, 0), (2, 11, 0), (1, 12, 0), (2, 12, 0), (2, 13, 0), (3, 12, 0)] # Klein_R
 153 }