Passed
Push — v5 ( 043137...387bee )
by smiley
09:56
created

GF256::log()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 7
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 2
eloc 3
nc 2
nop 1
dl 0
loc 7
rs 10
c 1
b 0
f 0
1
<?php
2
/**
3
 * Class GF256
4
 *
5
 * @filesource   GF256.php
6
 * @created      16.01.2021
7
 * @package      chillerlan\QRCode\Common
8
 * @author       ZXing Authors
9
 * @author       Smiley <[email protected]>
10
 * @copyright    2021 Smiley
11
 * @license      Apache-2.0
12
 */
13
14
namespace chillerlan\QRCode\Common;
15
16
use InvalidArgumentException;
17
18
use function array_fill;
19
20
/**
21
 * <p>This class contains utility methods for performing mathematical operations over
22
 * the Galois Fields. Operations use a given primitive polynomial in calculations.</p>
23
 *
24
 * <p>Throughout this package, elements of the GF are represented as an {@code int}
25
 * for convenience and speed (but at the cost of memory).
26
 * </p>
27
 *
28
 * @author Sean Owen
29
 * @author David Olivier
30
 */
31
final class GF256{
32
33
	/**
34
	 * irreducible polynomial whose coefficients are represented by the bits of an int,
35
	 * where the least-significant bit represents the constant coefficient
36
	 */
37
#	private int $primitive = 0x011D;
38
39
	private const logTable = [
40
		null,  0,   1,  25,   2,  50,  26, 198,   3, 223,  51, 238,  27, 104, 199,  75,
41
		  4, 100, 224,  14,  52, 141, 239, 129,  28, 193, 105, 248, 200,   8,  76, 113,
42
		  5, 138, 101,  47, 225,  36,  15,  33,  53, 147, 142, 218, 240,  18, 130,  69,
43
		 29, 181, 194, 125, 106,  39, 249, 185, 201, 154,   9, 120,  77, 228, 114, 166,
44
		  6, 191, 139,  98, 102, 221,  48, 253, 226, 152,  37, 179,  16, 145,  34, 136,
45
		 54, 208, 148, 206, 143, 150, 219, 189, 241, 210,  19,  92, 131,  56,  70,  64,
46
		 30,  66, 182, 163, 195,  72, 126, 110, 107,  58,  40,  84, 250, 133, 186,  61,
47
		202,  94, 155, 159,  10,  21, 121,  43,  78, 212, 229, 172, 115, 243, 167,  87,
48
		  7, 112, 192, 247, 140, 128,  99,  13, 103,  74, 222, 237,  49, 197, 254,  24,
49
		227, 165, 153, 119,  38, 184, 180, 124,  17,  68, 146, 217,  35,  32, 137,  46,
50
		 55,  63, 209,  91, 149, 188, 207, 205, 144, 135, 151, 178, 220, 252, 190,  97,
51
		242,  86, 211, 171,  20,  42,  93, 158, 132,  60,  57,  83,  71, 109,  65, 162,
52
		 31,  45,  67, 216, 183, 123, 164, 118, 196,  23,  73, 236, 127,  12, 111, 246,
53
		108, 161,  59,  82,  41, 157,  85, 170, 251,  96, 134, 177, 187, 204,  62,  90,
54
		203,  89,  95, 176, 156, 169, 160,  81,  11, 245,  22, 235, 122, 117,  44, 215,
55
		 79, 174, 213, 233, 230, 231, 173, 232, 116, 214, 244, 234, 168,  80,  88, 175,
56
	];
57
58
	private const expTable = [
59
		  1,   2,   4,   8,  16,  32,  64, 128,  29,  58, 116, 232, 205, 135,  19,  38,
60
		 76, 152,  45,  90, 180, 117, 234, 201, 143,   3,   6,  12,  24,  48,  96, 192,
61
		157,  39,  78, 156,  37,  74, 148,  53, 106, 212, 181, 119, 238, 193, 159,  35,
62
		 70, 140,   5,  10,  20,  40,  80, 160,  93, 186, 105, 210, 185, 111, 222, 161,
63
		 95, 190,  97, 194, 153,  47,  94, 188, 101, 202, 137,  15,  30,  60, 120, 240,
64
		253, 231, 211, 187, 107, 214, 177, 127, 254, 225, 223, 163,  91, 182, 113, 226,
65
		217, 175,  67, 134,  17,  34,  68, 136,  13,  26,  52, 104, 208, 189, 103, 206,
66
		129,  31,  62, 124, 248, 237, 199, 147,  59, 118, 236, 197, 151,  51, 102, 204,
67
		133,  23,  46,  92, 184, 109, 218, 169,  79, 158,  33,  66, 132,  21,  42,  84,
68
		168,  77, 154,  41,  82, 164,  85, 170,  73, 146,  57, 114, 228, 213, 183, 115,
69
		230, 209, 191,  99, 198, 145,  63, 126, 252, 229, 215, 179, 123, 246, 241, 255,
70
		227, 219, 171,  75, 150,  49,  98, 196, 149,  55, 110, 220, 165,  87, 174,  65,
71
		130,  25,  50, 100, 200, 141,   7,  14,  28,  56, 112, 224, 221, 167,  83, 166,
72
		 81, 162,  89, 178, 121, 242, 249, 239, 195, 155,  43,  86, 172,  69, 138,   9,
73
		 18,  36,  72, 144,  61, 122, 244, 245, 247, 243, 251, 235, 203, 139,  11,  22,
74
		 44,  88, 176, 125, 250, 233, 207, 131,  27,  54, 108, 216, 173,  71, 142,   1,
75
	];
76
77
	/**
78
	 * Implements both addition and subtraction -- they are the same in GF(size).
79
	 *
80
	 * @return int sum/difference of a and b
81
	 */
82
	public static function addOrSubtract(int $a, int $b):int{
83
		return $a ^ $b;
84
	}
85
86
	/**
87
	 * @return GenericGFPoly the monomial representing coefficient * x^degree
88
	 */
89
	public static function buildMonomial(int $degree, int $coefficient):GenericGFPoly{
90
91
		if($degree < 0){
92
			throw new InvalidArgumentException();
93
		}
94
95
		$coefficients    = array_fill(0, $degree + 1, 0);
96
		$coefficients[0] = $coefficient;
97
98
		return new GenericGFPoly($coefficients);
99
	}
100
101
	/**
102
	 * @return int 2 to the power of a in GF(size)
103
	 */
104
	public static function exp(int $a):int{
105
106
		if($a < 0){
107
			$a += 255;
108
		}
109
		elseif($a >= 256){
110
			$a -= 255;
111
		}
112
113
		return self::expTable[$a];
114
	}
115
116
	/**
117
	 * @return int base 2 log of a in GF(size)
118
	 */
119
	public static function log(int $a):int{
120
121
		if($a < 1){
122
			throw new InvalidArgumentException();
123
		}
124
125
		return self::logTable[$a];
126
	}
127
128
	/**
129
	 * @return int multiplicative inverse of a
130
	 */
131
	public static function inverse(int $a):int{
132
133
		if($a === 0){
134
			throw new InvalidArgumentException();
135
		}
136
137
		return self::expTable[256 - self::logTable[$a] - 1];
138
	}
139
140
	/**
141
	 * @return int product of a and b in GF(size)
142
	 */
143
	public static function multiply(int $a, int $b):int{
144
145
		if($a === 0 || $b === 0){
146
			return 0;
147
		}
148
149
		return self::expTable[(self::logTable[$a] + self::logTable[$b]) % 255];
150
	}
151
152
}
153