* add the Hklquaternnion documentation
[hkl.git] / Documentation / api / hkl-sections.txt
blobb66de42125578ad24258b75f88a46e2d273e0ffe
1 <SECTION>
2 <FILE>hkl-pseudoaxis-zaxis</FILE>
3 hkl_pseudo_axis_engine_zaxis_hkl_new
4 </SECTION>
6 <SECTION>
7 <FILE>hkl-pseudoaxis-common-eulerians</FILE>
8 hkl_pseudo_axis_engine_eulerians_new
9 </SECTION>
11 <SECTION>
12 <FILE>hkl-pseudoaxis-e6c</FILE>
13 hkl_pseudo_axis_engine_e6c_hkl_new
14 hkl_pseudo_axis_engine_e6c_psi_new
15 </SECTION>
17 <SECTION>
18 <FILE>hkl-detector</FILE>
19 HklDetector
20 hkl_detector_new
21 hkl_detector_new_copy
22 hkl_detector_free
23 hkl_detector_attach_to_holder
24 hkl_detector_compute_kf
25 </SECTION>
27 <SECTION>
28 <FILE>hkl-interval</FILE>
29 HklInterval
30 hkl_interval_cmp
31 hkl_interval_plus_interval
32 hkl_interval_plus_double
33 hkl_interval_minus_interval
34 hkl_interval_minus_double
35 hkl_interval_times_interval
36 hkl_interval_times_double
37 hkl_interval_divides_double
38 hkl_interval_contain_zero
39 hkl_interval_cos
40 hkl_interval_acos
41 hkl_interval_sin
42 hkl_interval_asin
43 hkl_interval_tan
44 hkl_interval_atan
45 hkl_interval_length
46 hkl_interval_angle_restrict_symm
47 </SECTION>
49 <SECTION>
50 <FILE>hkl-detector-factory</FILE>
51 hkl_detector_factory_new
52 </SECTION>
54 <SECTION>
55 <FILE>hkl-quaternion</FILE>
56 HklQuaternion
57 hkl_quaternion_init
58 hkl_quaternion_init_from_vector
59 hkl_quaternion_init_from_angle_and_axe
60 hkl_quaternion_fprintf
61 hkl_quaternion_cmp
62 hkl_quaternion_minus_quaternion
63 hkl_quaternion_times_quaternion
64 hkl_quaternion_norm2
65 hkl_quaternion_conjugate
66 hkl_quaternion_to_matrix
67 hkl_quaternion_to_angle_and_axe
68 </SECTION>
70 <SECTION>
71 <FILE>hkl-pseudoaxis-k4cv</FILE>
72 hkl_pseudo_axis_engine_k4cv_hkl_new
73 hkl_pseudo_axis_engine_k4cv_psi_new
74 </SECTION>
76 <SECTION>
77 <FILE>hkl-error</FILE>
78 HklError
79 hkl_error_new
80 hkl_error_new_literal
81 hkl_error_new_valist
82 hkl_error_free
83 hkl_error_new_copy
84 hkl_error_set
85 hkl_error_set_literal
86 hkl_error_propagate
87 hkl_error_clear
88 hkl_error_prefix
89 hkl_error_propagate_prefixed
90 </SECTION>
92 <SECTION>
93 <FILE>hkl-parameter</FILE>
94 HklParameter
95 hkl_parameter_new
96 hkl_parameter_new_copy
97 hkl_parameter_init
98 hkl_parameter_free
99 hkl_parameter_set_value
100 hkl_parameter_get_value_unit
101 hkl_parameter_set_value_unit
102 hkl_parameter_get_max
103 hkl_parameter_get_range_unit
104 hkl_parameter_set_range
105 hkl_parameter_set_range_unit
106 hkl_parameter_randomize
107 hkl_parameter_is_valid
108 hkl_parameter_fprintf
109 </SECTION>
111 <SECTION>
112 <FILE>hkl-pseudoaxis</FILE>
113 HklPseudoAxis
114 HklPseudoAxisEngineMode
115 HklPseudoAxisEngine
116 HklPseudoAxisEngineList
117 HklPseudoAxisEngineModeFunc
118 HklFunction
119 hkl_pseudo_axis_new
120 hkl_pseudo_axis_init
121 hkl_pseudo_axis_free
122 hkl_pseudo_axis_fprintf
123 hkl_pseudo_axis_engine_mode_new
124 hkl_pseudo_axis_engine_mode_init
125 hkl_pseudo_axis_engine_mode_free
126 hkl_pseudo_axis_engine_new
127 hkl_pseudo_axis_engine_free
128 hkl_pseudo_axis_engine_add_mode
129 hkl_pseudo_axis_engine_add_geometry
130 hkl_pseudo_axis_engine_select_mode
131 hkl_pseudo_axis_engine_initialize
132 hkl_pseudo_axis_engine_set
133 hkl_pseudo_axis_engine_get
134 hkl_pseudo_axis_engine_fprintf
135 hkl_pseudo_axis_engine_list_new
136 hkl_pseudo_axis_engine_list_free
137 hkl_pseudo_axis_engine_list_add
138 hkl_pseudo_axis_engine_list_get_by_name
139 hkl_pseudo_axis_engine_list_get_pseudo_axis_by_name
140 hkl_pseudo_axis_engine_list_clear
141 hkl_pseudo_axis_engine_list_init
142 hkl_pseudo_axis_engine_list_get
143 hkl_pseudo_axis_engine_list_fprintf
144 </SECTION>
146 <SECTION>
147 <FILE>hkl-geometry</FILE>
148 HklHolder
149 HklGeometry
150 HklGeometryList
151 HklGeometryListMultiplyFunction
152 hkl_holder_add_rotation_axis
153 hkl_geometry_new
154 hkl_geometry_new_copy
155 hkl_geometry_free
156 hkl_geometry_init_geometry
157 hkl_geometry_add_holder
158 hkl_geometry_update
159 hkl_geometry_get_axis_by_name
160 hkl_geometry_randomize
161 hkl_geometry_set_values_v
162 hkl_geometry_distance
163 hkl_geometry_distance_orthodromic
164 hkl_geometry_closest_from_geometry_with_range
165 hkl_geometry_is_valid
166 hkl_geometry_fprintf
167 hkl_geometry_list_new
168 hkl_geometry_list_free
169 hkl_geometry_list_add
170 hkl_geometry_list_reset
171 hkl_geometry_list_sort
172 hkl_geometry_list_fprintf
173 hkl_geometry_list_multiply
174 hkl_geometry_list_multiply_from_range
175 hkl_geometry_list_remove_invalid
176 </SECTION>
178 <SECTION>
179 <FILE>hkl-geometry-factory</FILE>
180 hkl_geometry_factory_new
181 </SECTION>
183 <SECTION>
184 <FILE>hkl-pseudoaxis-auto</FILE>
185 hkl_pseudo_axis_engine_mode_set_real
186 </SECTION>
188 <SECTION>
189 <FILE>hkl-pseudoaxis-e4cv</FILE>
190 hkl_pseudo_axis_engine_e4cv_hkl_new
191 hkl_pseudo_axis_engine_e4cv_psi_new
192 </SECTION>
194 <SECTION>
195 <FILE>hkl-macros</FILE>
196 HKL_BEGIN_DECLS
197 HKL_END_DECLS
198 INFINITY
199 M_PI
200 M_PI_2
201 HKL_MAJOR
202 HKL_MINOR
203 HKL_PATCH
204 HKL_VERSION
205 HKL_TRUE
206 HKL_FALSE
207 HKL_SUCCESS
208 HKL_FAIL
209 HKL_TINY
210 HKL_EPSILON
211 HKL_DEGTORAD
212 HKL_RADTODEG
213 HKL_TAU
214 HKL_EULERIAN_KAPPA_SOLUTION
215 hkl_assert
216 G_GNUC_PRINTF
217 alloc_nr
218 ALLOC_GROW
219 NORETURN
221 warning
222 hkl_printbt
223 HKL_MALLOC
224 </SECTION>
226 <SECTION>
227 <FILE>hkl-pseudoaxis-k6c</FILE>
228 hkl_pseudo_axis_engine_k6c_hkl_new
229 hkl_pseudo_axis_engine_k6c_psi_new
230 </SECTION>
232 <SECTION>
233 <FILE>hkl-source</FILE>
234 HKL_SOURCE_DEFAULT_WAVE_LENGTH
235 HklSource
236 hkl_source_init
237 hkl_source_cmp
238 hkl_source_compute_ki
239 hkl_source_get_wavelength
240 hkl_source_fprintf
241 </SECTION>
243 <SECTION>
244 <FILE>hkl-unit</FILE>
245 HklUnit
246 hkl_unit_compatible
247 hkl_unit_factor
248 </SECTION>
250 <SECTION>
251 <FILE>hkl-pseudoaxis-common-hkl</FILE>
252 RUBh_minus_Q_func
253 double_diffraction_func
254 psi_constant_vertical_func
255 RUBh_minus_Q
256 double_diffraction
257 hkl_pseudo_axis_engine_mode_get_hkl_real
258 hkl_pseudo_axis_engine_mode_init_psi_constant_vertical_real
259 hkl_pseudo_axis_engine_hkl_new
260 </SECTION>
262 <SECTION>
263 <FILE>hkl-matrix</FILE>
264 HklMatrix
265 hkl_matrix_init
266 hkl_matrix_fprintf
267 hkl_matrix_init_from_two_vector
268 hkl_matrix_init_from_euler
269 hkl_matrix_to_euler
270 hkl_matrix_cmp
271 hkl_matrix_times_matrix
272 hkl_matrix_times_vector
273 hkl_matrix_transpose
274 hkl_matrix_det
275 hkl_matrix_solve
276 hkl_matrix_is_null
277 </SECTION>
279 <SECTION>
280 <FILE>hkl</FILE>
281 </SECTION>
283 <SECTION>
284 <FILE>hkl-list</FILE>
285 HKL_LIST_LEN
286 HKL_LIST
287 HKL_LIST_INIT
288 HKL_LIST_ALLOC
289 HKL_LIST_COPY
290 HKL_LIST_FREE
291 HKL_LIST_FREE_DESTRUCTOR
292 HKL_LIST_RESIZE
293 HKL_LIST_ADD_VALUE
294 HKL_LIST_DEL
295 HKL_LIST_DEL_DESTRUCTOR
296 HKL_LIST_DEL_ITEM_DESTRUCTOR
297 </SECTION>
299 <SECTION>
300 <FILE>hkl-pseudoaxis-common</FILE>
301 hkl_pseudo_axis_engine_init_func
302 </SECTION>
304 <SECTION>
305 <FILE>hkl-sample</FILE>
306 HklSample
307 HklSampleReflection
308 HklSampleList
309 HklSampleType
310 hkl_sample_new
311 hkl_sample_new_copy
312 hkl_sample_free
313 hkl_sample_set_name
314 hkl_sample_set_lattice
315 hkl_sample_set_U_from_euler
316 hkl_sample_get_UB
317 hkl_sample_add_reflection
318 hkl_sample_get_ith_reflection
319 hkl_sample_del_reflection
320 hkl_sample_compute_UB_busing_levy
321 hkl_sample_affine
322 hkl_sample_get_reflection_mesured_angle
323 hkl_sample_get_reflection_theoretical_angle
324 hkl_sample_fprintf
325 hkl_sample_reflection_set_hkl
326 hkl_sample_reflection_set_flag
327 hkl_sample_reflection_set_geometry
328 hkl_sample_list_new
329 hkl_sample_list_free
330 hkl_sample_list_append
331 hkl_sample_list_clear
332 hkl_sample_list_del
333 hkl_sample_list_len
334 hkl_sample_list_get_ith
335 hkl_sample_list_get_by_name
336 hkl_sample_list_get_idx_from_name
337 hkl_sample_list_select_current
338 hkl_sample_list_fprintf
339 </SECTION>
341 <SECTION>
342 <FILE>hkl-axis</FILE>
343 HklAxis
344 hkl_axis_new
345 hkl_axis_free
346 hkl_axis_init
347 hkl_axis_get_name
348 hkl_axis_get_changed
349 hkl_axis_set_changed
350 hkl_axis_get_value
351 hkl_axis_get_value_unit
352 hkl_axis_get_value_closest
353 hkl_axis_get_value_closest_unit
354 hkl_axis_get_max
355 hkl_axis_get_range_unit
356 hkl_axis_set_value
357 hkl_axis_set_value_smallest_in_range
358 hkl_axis_set_value_unit
359 hkl_axis_set_range
360 hkl_axis_set_range_unit
361 hkl_axis_randomize
362 hkl_axis_get_quaternion
363 hkl_axis_is_value_compatible_with_range
364 hkl_axis_is_valid
365 hkl_axis_fprintf
366 </SECTION>
368 <SECTION>
369 <FILE>hkl-pseudoaxis-factory</FILE>
370 hkl_pseudo_axis_engine_list_factory
371 </SECTION>
373 <SECTION>
374 <FILE>hkl-pseudoaxis-common-psi</FILE>
375 HklPseudoAxisEngineModePsi
376 hkl_pseudo_axis_engine_mode_psi_new
377 hkl_pseudo_axis_engine_psi_new
378 </SECTION>
380 <SECTION>
381 <FILE>hkl-pseudoaxis-common-q</FILE>
382 hkl_pseudo_axis_engine_q_new
383 hkl_pseudo_axis_engine_q2_new
384 </SECTION>
386 <SECTION>
387 <FILE>hkl-lattice</FILE>
388 HklLattice
389 hkl_lattice_new
390 hkl_lattice_new_copy
391 hkl_lattice_new_default
392 hkl_lattice_free
393 hkl_lattice_set
394 hkl_lattice_get_B
395 hkl_lattice_reciprocal
396 hkl_lattice_randomize
397 hkl_lattice_fprintf
398 </SECTION>
400 <SECTION>
401 <FILE>hkl-vector</FILE>
402 HklMatrix
403 HklQuaternion
404 HklVector
405 hkl_vector_init
406 hkl_vector_fprintf
407 hkl_vector_cmp
408 hkl_vector_is_opposite
409 hkl_vector_add_vector
410 hkl_vector_minus_vector
411 hkl_vector_div_double
412 hkl_vector_times_double
413 hkl_vector_times_vector
414 hkl_vector_times_smatrix
415 hkl_vector_sum
416 hkl_vector_scalar_product
417 hkl_vector_vectorial_product
418 hkl_vector_angle
419 hkl_vector_oriented_angle
420 hkl_vector_norm2
421 hkl_vector_normalize
422 hkl_vector_is_colinear
423 hkl_vector_randomize
424 hkl_vector_randomize_vector
425 hkl_vector_randomize_vector_vector
426 hkl_vector_rotated_around_vector
427 hkl_vector_rotated_quaternion
428 hkl_vector_is_null
429 hkl_vector_project_on_plan
430 </SECTION>