This file is indexed.

/usr/share/gtk-doc/html/hkl-4/hkl-hkl-quaternion.html is in libhkl-doc 4.0.3-4ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>hkl-quaternion</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="hkl Reference Manual">
<link rel="up" href="ch01.html" title="[Insert title here]">
<link rel="prev" href="hkl-hkl-detector-factory.html" title="hkl-detector-factory">
<link rel="next" href="hkl-hkl-pseudoaxis-k4cv.html" title="hkl-pseudoaxis-k4cv">
<meta name="generator" content="GTK-Doc V1.15 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="hkl-hkl-detector-factory.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">hkl Reference Manual</th>
<td><a accesskey="n" href="hkl-hkl-pseudoaxis-k4cv.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#hkl-hkl-quaternion.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#hkl-hkl-quaternion.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="hkl-quaternion">
<a name="hkl-hkl-quaternion"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="hkl-hkl-quaternion.top_of_page"></a>hkl-quaternion</span></h2>
<p>hkl-quaternion</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="hkl-hkl-quaternion.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">                    <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion">HklQuaternion</a>;
<span class="returnvalue">void</span>                <a class="link" href="hkl-hkl-quaternion.html#hkl-quaternion-init" title="hkl_quaternion_init ()">hkl_quaternion_init</a>                 (<em class="parameter"><code><a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> *self</code></em>,
                                                         <em class="parameter"><code><span class="type">double</span> a</code></em>,
                                                         <em class="parameter"><code><span class="type">double</span> b</code></em>,
                                                         <em class="parameter"><code><span class="type">double</span> c</code></em>,
                                                         <em class="parameter"><code><span class="type">double</span> d</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="hkl-hkl-quaternion.html#hkl-quaternion-init-from-vector" title="hkl_quaternion_init_from_vector ()">hkl_quaternion_init_from_vector</a>     (<em class="parameter"><code><a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> *self</code></em>,
                                                         <em class="parameter"><code>const <a class="link" href="hkl-hkl-vector.html#HklVector" title="HklVector"><span class="type">HklVector</span></a> *v</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="hkl-hkl-quaternion.html#hkl-quaternion-init-from-angle-and-axe" title="hkl_quaternion_init_from_angle_and_axe ()">hkl_quaternion_init_from_angle_and_axe</a>
                                                        (<em class="parameter"><code><a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> *self</code></em>,
                                                         <em class="parameter"><code><span class="type">double</span> angle</code></em>,
                                                         <em class="parameter"><code>const <a class="link" href="hkl-hkl-vector.html#HklVector" title="HklVector"><span class="type">HklVector</span></a> *v</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="hkl-hkl-quaternion.html#hkl-quaternion-fprintf" title="hkl_quaternion_fprintf ()">hkl_quaternion_fprintf</a>              (<em class="parameter"><code><span class="type">FILE</span> *file</code></em>,
                                                         <em class="parameter"><code>const <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> *self</code></em>);
<span class="returnvalue">int</span>                 <a class="link" href="hkl-hkl-quaternion.html#hkl-quaternion-cmp" title="hkl_quaternion_cmp ()">hkl_quaternion_cmp</a>                  (<em class="parameter"><code>const <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> *self</code></em>,
                                                         <em class="parameter"><code>const <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> *q</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="hkl-hkl-quaternion.html#hkl-quaternion-minus-quaternion" title="hkl_quaternion_minus_quaternion ()">hkl_quaternion_minus_quaternion</a>     (<em class="parameter"><code><a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> *self</code></em>,
                                                         <em class="parameter"><code>const <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> *q</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="hkl-hkl-quaternion.html#hkl-quaternion-times-quaternion" title="hkl_quaternion_times_quaternion ()">hkl_quaternion_times_quaternion</a>     (<em class="parameter"><code><a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> *self</code></em>,
                                                         <em class="parameter"><code>const <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> *q</code></em>);
<span class="returnvalue">double</span>              <a class="link" href="hkl-hkl-quaternion.html#hkl-quaternion-norm2" title="hkl_quaternion_norm2 ()">hkl_quaternion_norm2</a>                (<em class="parameter"><code>const <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> *self</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="hkl-hkl-quaternion.html#hkl-quaternion-conjugate" title="hkl_quaternion_conjugate ()">hkl_quaternion_conjugate</a>            (<em class="parameter"><code><a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> *self</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="hkl-hkl-quaternion.html#hkl-quaternion-to-matrix" title="hkl_quaternion_to_matrix ()">hkl_quaternion_to_matrix</a>            (<em class="parameter"><code>const <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> *self</code></em>,
                                                         <em class="parameter"><code><a class="link" href="hkl-hkl-matrix.html#HklMatrix" title="HklMatrix"><span class="type">HklMatrix</span></a> *m</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="hkl-hkl-quaternion.html#hkl-quaternion-to-angle-and-axe" title="hkl_quaternion_to_angle_and_axe ()">hkl_quaternion_to_angle_and_axe</a>     (<em class="parameter"><code>const <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> *self</code></em>,
                                                         <em class="parameter"><code><span class="type">double</span> *angle</code></em>,
                                                         <em class="parameter"><code><a class="link" href="hkl-hkl-vector.html#HklVector" title="HklVector"><span class="type">HklVector</span></a> *v</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="hkl-hkl-quaternion.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="hkl-hkl-quaternion.details"></a><h2>Details</h2>
<div class="refsect2" title="HklQuaternion">
<a name="HklQuaternion"></a><h3>HklQuaternion</h3>
<pre class="programlisting">typedef struct {
	double data[4];
} HklQuaternion;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="hkl_quaternion_init ()">
<a name="hkl-quaternion-init"></a><h3>hkl_quaternion_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                hkl_quaternion_init                 (<em class="parameter"><code><a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> *self</code></em>,
                                                         <em class="parameter"><code><span class="type">double</span> a</code></em>,
                                                         <em class="parameter"><code><span class="type">double</span> b</code></em>,
                                                         <em class="parameter"><code><span class="type">double</span> c</code></em>,
                                                         <em class="parameter"><code><span class="type">double</span> d</code></em>);</pre>
<p>
initialize the four elements of an <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> to initialize
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>a</code></em> :</span></p></td>
<td>the 1st element value
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>b</code></em> :</span></p></td>
<td>the 2nd element value
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>c</code></em> :</span></p></td>
<td>the 3rd element value
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>d</code></em> :</span></p></td>
<td>the 4th element value
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="hkl_quaternion_init_from_vector ()">
<a name="hkl-quaternion-init-from-vector"></a><h3>hkl_quaternion_init_from_vector ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                hkl_quaternion_init_from_vector     (<em class="parameter"><code><a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> *self</code></em>,
                                                         <em class="parameter"><code>const <a class="link" href="hkl-hkl-vector.html#HklVector" title="HklVector"><span class="type">HklVector</span></a> *v</code></em>);</pre>
<p>
initialize an <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> from an <a class="link" href="hkl-hkl-vector.html#HklVector" title="HklVector"><span class="type">HklVector</span></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> to set
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>v</code></em> :</span></p></td>
<td>the <a class="link" href="hkl-hkl-vector.html#HklVector" title="HklVector"><span class="type">HklVector</span></a> used to set the self <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="hkl_quaternion_init_from_angle_and_axe ()">
<a name="hkl-quaternion-init-from-angle-and-axe"></a><h3>hkl_quaternion_init_from_angle_and_axe ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                hkl_quaternion_init_from_angle_and_axe
                                                        (<em class="parameter"><code><a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> *self</code></em>,
                                                         <em class="parameter"><code><span class="type">double</span> angle</code></em>,
                                                         <em class="parameter"><code>const <a class="link" href="hkl-hkl-vector.html#HklVector" title="HklVector"><span class="type">HklVector</span></a> *v</code></em>);</pre>
<p>
initialize an <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> from a vector and a angle.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> to set
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>angle</code></em> :</span></p></td>
<td>the angles of the rotation
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>v</code></em> :</span></p></td>
<td>the axe of rotation
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="hkl_quaternion_fprintf ()">
<a name="hkl-quaternion-fprintf"></a><h3>hkl_quaternion_fprintf ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                hkl_quaternion_fprintf              (<em class="parameter"><code><span class="type">FILE</span> *file</code></em>,
                                                         <em class="parameter"><code>const <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> *self</code></em>);</pre>
<p>
print an <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> into a FILE stream
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
<td>the file to send the <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> into
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> to write into the file stream.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="hkl_quaternion_cmp ()">
<a name="hkl-quaternion-cmp"></a><h3>hkl_quaternion_cmp ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>                 hkl_quaternion_cmp                  (<em class="parameter"><code>const <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> *self</code></em>,
                                                         <em class="parameter"><code>const <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> *q</code></em>);</pre>
<p>
compare two <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the first <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>q</code></em> :</span></p></td>
<td>the second <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a class="link" href="hkl-hkl-macros.html#HKL-TRUE:CAPS" title="HKL_TRUE"><span class="type">HKL_TRUE</span></a> if both are equal, <a class="link" href="hkl-hkl-macros.html#HKL-FAIL:CAPS" title="HKL_FAIL"><span class="type">HKL_FAIL</span></a> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="hkl_quaternion_minus_quaternion ()">
<a name="hkl-quaternion-minus-quaternion"></a><h3>hkl_quaternion_minus_quaternion ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                hkl_quaternion_minus_quaternion     (<em class="parameter"><code><a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> *self</code></em>,
                                                         <em class="parameter"><code>const <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> *q</code></em>);</pre>
<p>
substract two <a href="hkl-hkl-vector.html#HklQuaternion"><span class="type">HklQuaternions</span></a>
Todo: test
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> to modify.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>q</code></em> :</span></p></td>
<td>the <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> to substract
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="hkl_quaternion_times_quaternion ()">
<a name="hkl-quaternion-times-quaternion"></a><h3>hkl_quaternion_times_quaternion ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                hkl_quaternion_times_quaternion     (<em class="parameter"><code><a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> *self</code></em>,
                                                         <em class="parameter"><code>const <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> *q</code></em>);</pre>
<p>
multiply two quaternions
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> to modify
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>q</code></em> :</span></p></td>
<td>the <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> to multiply by
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="hkl_quaternion_norm2 ()">
<a name="hkl-quaternion-norm2"></a><h3>hkl_quaternion_norm2 ()</h3>
<pre class="programlisting"><span class="returnvalue">double</span>              hkl_quaternion_norm2                (<em class="parameter"><code>const <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> *self</code></em>);</pre>
<p>
compute the norm2 of an <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the quaternion use to compute the norm
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the self <span class="type">hklquaternion</span> norm
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="hkl_quaternion_conjugate ()">
<a name="hkl-quaternion-conjugate"></a><h3>hkl_quaternion_conjugate ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                hkl_quaternion_conjugate            (<em class="parameter"><code><a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> *self</code></em>);</pre>
<p>
compute the conjugate of a quaternion
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> to conjugate
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="hkl_quaternion_to_matrix ()">
<a name="hkl-quaternion-to-matrix"></a><h3>hkl_quaternion_to_matrix ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                hkl_quaternion_to_matrix            (<em class="parameter"><code>const <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> *self</code></em>,
                                                         <em class="parameter"><code><a class="link" href="hkl-hkl-matrix.html#HklMatrix" title="HklMatrix"><span class="type">HklMatrix</span></a> *m</code></em>);</pre>
<p>
Compute the rotation matrix of a Quaternion.
</p>
<p>
compute the rotation matrix corresponding to the unitary quaternion.
\f$ q = a + b \cdot i + c \cdot j + d \cdot k \f$
</p>
<p>
\f$
\left(
 \begin{array}{ccc}
   a^2+b^2-c^2-d^2 &amp; 2bc-2ad         &amp; 2ac+2bd\\
   2ad+2bc         &amp; a^2-b^2+c^2-d^2 &amp; 2cd-2ab\\
   2bd-2ac         &amp; 2ab+2cd         &amp; a^2-b^2-c^2+d^2
 \end{array}
\right)
\f$
Todo: optimize
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> use to compute the <a class="link" href="hkl-hkl-matrix.html#HklMatrix" title="HklMatrix"><span class="type">HklMatrix</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>m</code></em> :</span></p></td>
<td>the <a class="link" href="hkl-hkl-matrix.html#HklMatrix" title="HklMatrix"><span class="type">HklMatrix</span></a> return.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="hkl_quaternion_to_angle_and_axe ()">
<a name="hkl-quaternion-to-angle-and-axe"></a><h3>hkl_quaternion_to_angle_and_axe ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                hkl_quaternion_to_angle_and_axe     (<em class="parameter"><code>const <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> *self</code></em>,
                                                         <em class="parameter"><code><span class="type">double</span> *angle</code></em>,
                                                         <em class="parameter"><code><a class="link" href="hkl-hkl-vector.html#HklVector" title="HklVector"><span class="type">HklVector</span></a> *v</code></em>);</pre>
<p>
compute the axe and angle of the unitary quaternion angle [-pi, pi]
if q is the (1, 0, 0, 0) quaternion return the (0,0,0) axe and a 0 angle
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>The <a class="link" href="hkl-hkl-quaternion.html#HklQuaternion" title="HklQuaternion"><span class="type">HklQuaternion</span></a> use to compute the angle and the roation axis.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>angle</code></em> :</span></p></td>
<td>the returned angle of the rotation.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>v</code></em> :</span></p></td>
<td>the returned axis of the rotation.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.15</div>
</body>
</html>