libhkl-doc 4.99.99.1955-2 / usr / share / gtk-doc / html / hkl-4 / hkl-hkl-unit-private.html

This file is indexed.

/usr/share/gtk-doc/html/hkl-4/hkl-hkl-unit-private.html is in libhkl-doc 4.99.99.1955-2.

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
<!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-unit-private: hkl Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<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-types.html" title="hkl-types">
<link rel="next" href="hkl-hkl-vector-private.html" title="hkl-vector-private">
<meta name="generator" content="GTK-Doc V1.24 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#hkl-hkl-unit-private.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="hkl-hkl-types.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="hkl-hkl-vector-private.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="hkl-hkl-unit-private"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="hkl-hkl-unit-private.top_of_page"></a>hkl-unit-private</span></h2>
<p>hkl-unit-private</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="hkl-hkl-unit-private.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="hkl-hkl-unit-private.html#HklUnit" title="struct HklUnit"><span class="returnvalue">HklUnit</span></a> *
</td>
<td class="function_name">
<a class="link" href="hkl-hkl-unit-private.html#hkl-unit-dup" title="hkl_unit_dup ()">hkl_unit_dup</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="hkl-hkl-unit-private.html#hkl-unit-free" title="hkl_unit_free ()">hkl_unit_free</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="hkl-hkl-unit-private.html#hkl-unit-compatible" title="hkl_unit_compatible ()">hkl_unit_compatible</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">double</span>
</td>
<td class="function_name">
<a class="link" href="hkl-hkl-unit-private.html#hkl-unit-factor" title="hkl_unit_factor ()">hkl_unit_factor</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="hkl-hkl-unit-private.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="hkl-hkl-unit-private.html#HklUnitType" title="enum HklUnitType">HklUnitType</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="hkl-hkl-unit-private.html#HklUnit" title="struct HklUnit">HklUnit</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="hkl-hkl-unit-private.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="hkl-hkl-unit-private.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="hkl-unit-dup"></a><h3>hkl_unit_dup ()</h3>
<pre class="programlisting"><a class="link" href="hkl-hkl-unit-private.html#HklUnit" title="struct HklUnit"><span class="returnvalue">HklUnit</span></a> *
hkl_unit_dup (<em class="parameter"><code>const <a class="link" href="hkl-hkl-unit-private.html#HklUnit" title="struct HklUnit"><span class="type">HklUnit</span></a> *self</code></em>);</pre>
<p>copy an <span class="type">Hklunit</span></p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="id-1.2.30.6.2.6"></a><h4>Returns</h4>
<p> the copied <a class="link" href="hkl-hkl-unit-private.html#HklUnit" title="struct HklUnit"><span class="type">HklUnit</span></a> (memory must be release with
hkl_unit_free)</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="hkl-unit-free"></a><h3>hkl_unit_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
hkl_unit_free (<em class="parameter"><code><a class="link" href="hkl-hkl-unit-private.html#HklUnit" title="struct HklUnit"><span class="type">HklUnit</span></a> *self</code></em>);</pre>
<p>release the memory of an <a class="link" href="hkl-hkl-unit-private.html#HklUnit" title="struct HklUnit"><span class="type">HklUnit</span></a></p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
</div>
<hr>
<div class="refsect2">
<a name="hkl-unit-compatible"></a><h3>hkl_unit_compatible ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
hkl_unit_compatible (<em class="parameter"><code>const <a class="link" href="hkl-hkl-unit-private.html#HklUnit" title="struct HklUnit"><span class="type">HklUnit</span></a> *self</code></em>,
                     <em class="parameter"><code>const <a class="link" href="hkl-hkl-unit-private.html#HklUnit" title="struct HklUnit"><span class="type">HklUnit</span></a> *unit</code></em>);</pre>
<p>check if two units are compatible.</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="id-1.2.30.6.4.6"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the first <em class="parameter"><code>HklUnit</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>unit</p></td>
<td class="parameter_description"><p>the second <em class="parameter"><code>HklUnit</code></em>
to check</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.30.6.4.7"></a><h4>Returns</h4>
<p> TRUE or FALSE</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="hkl-unit-factor"></a><h3>hkl_unit_factor ()</h3>
<pre class="programlisting"><span class="returnvalue">double</span>
hkl_unit_factor (<em class="parameter"><code>const <a class="link" href="hkl-hkl-unit-private.html#HklUnit" title="struct HklUnit"><span class="type">HklUnit</span></a> *self</code></em>,
                 <em class="parameter"><code>const <a class="link" href="hkl-hkl-unit-private.html#HklUnit" title="struct HklUnit"><span class="type">HklUnit</span></a> *unit</code></em>);</pre>
<p>compute the factor to convert from one <em class="parameter"><code>Hklunit</code></em>
 to another one.
<em class="parameter"><code>self</code></em>
 * factor =  <em class="parameter"><code>unit</code></em>
</p>
<div class="refsect3">
<a name="id-1.2.30.6.5.5"></a><h4>Returns</h4>
<p> the factor of the conversion.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="hkl-hkl-unit-private.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="HklUnitType"></a><h3>enum HklUnitType</h3>
<div class="refsect3">
<a name="id-1.2.30.7.2.3"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="HKL-UNIT-ANGLE-DEG:CAPS"></a>HKL_UNIT_ANGLE_DEG</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="HKL-UNIT-ANGLE-RAD:CAPS"></a>HKL_UNIT_ANGLE_RAD</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="HKL-UNIT-LENGTH-NM:CAPS"></a>HKL_UNIT_LENGTH_NM</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="HklUnit"></a><h3>struct HklUnit</h3>
<pre class="programlisting">struct HklUnit {
	HklUnitType type;
	char const *name;
	char const *repr;
};
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.