Codebase list ntl / upstream/11.0.0 doc / mat_GF2.cpp.html
upstream/11.0.0

Tree @upstream/11.0.0 (Download .tar.gz)

mat_GF2.cpp.html @upstream/11.0.0 — raw · history · blame 

  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
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>~/ntl-10.5.0test/doc/mat_GF2.cpp.html</title>
<meta name="Generator" content="Vim/8.0">
<meta name="plugin-version" content="vim7.4_v2">
<meta name="syntax" content="cpp">
<meta name="settings" content="use_css,pre_wrap,no_foldcolumn,expand_tabs,prevent_copy=">
<meta name="colorscheme" content="macvim">
<style type="text/css">
<!--
pre { white-space: pre-wrap; font-family: monospace; color: #000000; background-color: #ffffff; }
body { font-family: monospace; color: #000000; background-color: #ffffff; }
* { font-size: 1em; }
.String { color: #4a708b; }
.PreProc { color: #1874cd; }
.Statement { color: #b03060; font-weight: bold; }
.Comment { color: #0000ee; font-style: italic; }
.Type { color: #008b00; font-weight: bold; }
-->
</style>

<script type='text/javascript'>
<!--

-->
</script>
</head>
<body>
<pre id='vimCodeElement'>

<span class="Comment">/*</span><span class="Comment">*************************************************************************\</span>

<span class="Comment">MODULE: mat_GF2</span>

<span class="Comment">SUMMARY:</span>

<span class="Comment">Defines the class mat_GF2.</span>

<span class="Comment">\*************************************************************************</span><span class="Comment">*/</span>


<span class="PreProc">#include </span><span class="String">&lt;NTL/matrix.h&gt;</span>
<span class="PreProc">#include </span><span class="String">&lt;NTL/vec_vec_GF2.h&gt;</span>


<span class="Type">typedef</span> Mat&lt;GF2&gt; mat_GF2; <span class="Comment">// backward compatibility</span>


<span class="Type">void</span> conv(mat_GF2&amp; X, <span class="Type">const</span> vec_vec_GF2&amp; A);
mat_GF2 to_mat_GF2(<span class="Type">const</span> vec_vec_GF2&amp; A);
<span class="Comment">// convert a vector of vec_GF2's to a matrix</span>


<span class="Comment">// procedural arithmetic routines:</span>

<span class="Type">void</span> add(mat_GF2&amp; X, <span class="Type">const</span> mat_GF2&amp; A, <span class="Type">const</span> mat_GF2&amp; B);
<span class="Comment">// X = A + B</span>

<span class="Type">void</span> sub(mat_GF2&amp; X, <span class="Type">const</span> mat_GF2&amp; A, <span class="Type">const</span> mat_GF2&amp; B);
<span class="Comment">// X = A - B = A + B</span>

<span class="Type">void</span> negate(mat_GF2&amp; X, <span class="Type">const</span> mat_GF2&amp; A);
<span class="Comment">// X = -A = A </span>

<span class="Type">void</span> mul(mat_GF2&amp; X, <span class="Type">const</span> mat_GF2&amp; A, <span class="Type">const</span> mat_GF2&amp; B);
<span class="Comment">// X = A * B</span>

<span class="Type">void</span> mul(vec_GF2&amp; x, <span class="Type">const</span> mat_GF2&amp; A, <span class="Type">const</span> vec_GF2&amp; b);
<span class="Comment">// x = A * b</span>

<span class="Type">void</span> mul(vec_GF2&amp; x, <span class="Type">const</span> vec_GF2&amp; a, <span class="Type">const</span> mat_GF2&amp; B);
<span class="Comment">// x = a * B</span>


<span class="Type">void</span> mul(mat_GF2&amp; X, <span class="Type">const</span> mat_GF2&amp; A, GF2 b);
<span class="Type">void</span> mul(mat_GF2&amp; X, <span class="Type">const</span> mat_GF2&amp; A, <span class="Type">long</span> b);
<span class="Comment">// X = A * b</span>

<span class="Type">void</span> mul(mat_GF2&amp; X, GF2 a, <span class="Type">const</span> mat_GF2&amp; B);
<span class="Type">void</span> mul(mat_GF2&amp; X, <span class="Type">long</span> a, <span class="Type">const</span> mat_GF2&amp; B);
<span class="Comment">// X = a * B</span>

<span class="Type">void</span> determinant(GF2&amp; d, <span class="Type">const</span> mat_GF2&amp; A);
GF2 determinant(<span class="Type">const</span> mat_GF2&amp; A);
<span class="Comment">// d =  determinant of A</span>

<span class="Type">void</span> transpose(mat_GF2&amp; X, <span class="Type">const</span> mat_GF2&amp; A);
mat_GF2 transpose(<span class="Type">const</span> mat_GF2&amp; A);
<span class="Comment">// X = transpose of A</span>

<span class="Type">void</span> solve(GF2&amp; d, vec_GF2&amp; x, <span class="Type">const</span> mat_GF2&amp; A, <span class="Type">const</span> vec_GF2&amp; b);
<span class="Comment">// A is an n x n matrix, b is a length n vector.  Computes d = determinant(A).</span>
<span class="Comment">// If d != 0, solves x*A = b. </span>

<span class="Type">void</span> solve(GF2&amp; d, <span class="Type">const</span> mat_GF2&amp; A, vec_GF2&amp; x, <span class="Type">const</span> vec_GF2&amp; b);
<span class="Comment">// A is an n x n matrix, b is a length n vector.  Computes d = determinant(A).</span>
<span class="Comment">// If d != 0, solves A*x = b (so x and b are treated as a column vectors).</span>

<span class="Type">void</span> inv(GF2&amp; d, mat_GF2&amp; X, <span class="Type">const</span> mat_GF2&amp; A);
<span class="Comment">// A is an n x n matrix.  Computes d = det(A).  If d != 0,</span>
<span class="Comment">// computes X = A^{-1}. </span>

<span class="Type">void</span> sqr(mat_GF2&amp; X, <span class="Type">const</span> mat_GF2&amp; A);
mat_GF2 sqr(<span class="Type">const</span> mat_GF2&amp; A);
<span class="Comment">// X = A*A   </span>

<span class="Type">void</span> inv(mat_GF2&amp; X, <span class="Type">const</span> mat_GF2&amp; A);
mat_GF2 inv(<span class="Type">const</span> mat_GF2&amp; A);
<span class="Comment">// X = A^{-1}; error is raised if A is  singular</span>

<span class="Type">void</span> power(mat_GF2&amp; X, <span class="Type">const</span> mat_GF2&amp; A, <span class="Type">const</span> ZZ&amp; e);
mat_GF2 power(<span class="Type">const</span> mat_GF2&amp; A, <span class="Type">const</span> ZZ&amp; e);

<span class="Type">void</span> power(mat_GF2&amp; X, <span class="Type">const</span> mat_GF2&amp; A, <span class="Type">long</span> e);
mat_GF2 power(<span class="Type">const</span> mat_GF2&amp; A, <span class="Type">long</span> e);
<span class="Comment">// X = A^e; e may be negative (in which case A must be nonsingular).</span>


<span class="Type">void</span> ident(mat_GF2&amp; X, <span class="Type">long</span> n);
mat_GF2 ident_mat_GF2(<span class="Type">long</span> n);
<span class="Comment">// X = n x n identity matrix</span>

<span class="Type">long</span> IsIdent(<span class="Type">const</span> mat_GF2&amp; A, <span class="Type">long</span> n);
<span class="Comment">// test if A is n x n identity matrix</span>


<span class="Type">void</span> diag(mat_GF2&amp; X, <span class="Type">long</span> n, GF2 d);
mat_GF2 diag(<span class="Type">long</span> n, GF2 d);
<span class="Comment">// X = n x n diagonal matrix with diagonal element d</span>

<span class="Type">long</span> IsDiag(<span class="Type">const</span> mat_GF2&amp; A, <span class="Type">long</span> n, <span class="Type">long</span> d);
<span class="Comment">// test if X is an n x n diagonal matrix with diagonal element (d mod 2)</span>


<span class="Type">void</span> random(mat_GF2&amp; x, <span class="Type">long</span> n, <span class="Type">long</span> m);  <span class="Comment">// x = random n x m matrix</span>
mat_GF2 random_mat_GF2(<span class="Type">long</span> n, <span class="Type">long</span> m);

<span class="Type">long</span> gauss(mat_GF2&amp; M);
<span class="Type">long</span> gauss(mat_GF2&amp; M, <span class="Type">long</span> w);
<span class="Comment">// Performs unitary row operations so as to bring M into row echelon</span>
<span class="Comment">// form.  If the optional argument w is supplied, stops when first w</span>
<span class="Comment">// columns are in echelon form.  The return value is the rank (or the</span>
<span class="Comment">// rank of the first w columns).</span>

<span class="Type">void</span> image(mat_GF2&amp; X, <span class="Type">const</span> mat_GF2&amp; A);
<span class="Comment">// The rows of X are computed as basis of A's row space.  X is is row</span>
<span class="Comment">// echelon form</span>


<span class="Type">void</span> kernel(mat_GF2&amp; X, <span class="Type">const</span> mat_GF2&amp; A);
<span class="Comment">// Computes a basis for the kernel of the map x -&gt; x*A. where x is a</span>
<span class="Comment">// row vector.</span>

<span class="Comment">// miscellaneous:</span>


<span class="Type">void</span> clear(mat_GF2&amp; X);
<span class="Comment">// X = 0 (dimension unchanged)</span>

<span class="Type">long</span> IsZero(<span class="Type">const</span> mat_GF2&amp; A);
<span class="Comment">// test if A is the zero matrix (any dimension)</span>


<span class="Comment">// arithmetic operator notation:</span>

mat_GF2 <span class="Statement">operator</span>+(<span class="Type">const</span> mat_GF2&amp; a, <span class="Type">const</span> mat_GF2&amp; b);
mat_GF2 <span class="Statement">operator</span>-(<span class="Type">const</span> mat_GF2&amp; a, <span class="Type">const</span> mat_GF2&amp; b);
mat_GF2 <span class="Statement">operator</span>*(<span class="Type">const</span> mat_GF2&amp; a, <span class="Type">const</span> mat_GF2&amp; b);

mat_GF2 <span class="Statement">operator</span>-(<span class="Type">const</span> mat_GF2&amp; a);


<span class="Comment">// matrix/scalar multiplication:</span>

mat_GF2 <span class="Statement">operator</span>*(<span class="Type">const</span> mat_GF2&amp; a, GF2 b);
mat_GF2 <span class="Statement">operator</span>*(<span class="Type">const</span> mat_GF2&amp; a, <span class="Type">long</span> b);

mat_GF2 <span class="Statement">operator</span>*(GF2 a, <span class="Type">const</span> mat_GF2&amp; b);
mat_GF2 <span class="Statement">operator</span>*(<span class="Type">long</span> a, <span class="Type">const</span> mat_GF2&amp; b);

<span class="Comment">// matrix/vector multiplication:</span>

vec_GF2 <span class="Statement">operator</span>*(<span class="Type">const</span> mat_GF2&amp; a, <span class="Type">const</span> vec_GF2&amp; b);

vec_GF2 <span class="Statement">operator</span>*(<span class="Type">const</span> vec_GF2&amp; a, <span class="Type">const</span> mat_GF2&amp; b);


<span class="Comment">// assignment operator notation:</span>

mat_GF2&amp; <span class="Statement">operator</span>+=(mat_GF2&amp; x, <span class="Type">const</span> mat_GF2&amp; a);
mat_GF2&amp; <span class="Statement">operator</span>-=(mat_GF2&amp; x, <span class="Type">const</span> mat_GF2&amp; a);
mat_GF2&amp; <span class="Statement">operator</span>*=(mat_GF2&amp; x, <span class="Type">const</span> mat_GF2&amp; a);

mat_GF2&amp; <span class="Statement">operator</span>*=(mat_GF2&amp; x, GF2 a);
mat_GF2&amp; <span class="Statement">operator</span>*=(mat_GF2&amp; x, <span class="Type">long</span> a);

vec_GF2&amp; <span class="Statement">operator</span>*=(vec_GF2&amp; x, <span class="Type">const</span> mat_GF2&amp; a);


</pre>
</body>
</html>
<!-- vim: set foldmethod=manual : -->