/usr/share/gtk-doc/html/libgwyprocess/libgwyprocess-arithmetic.html is in libgwyddion20-doc 2.26-1ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>arithmetic</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Gwyddion Data Processing Library Reference Manual">
<link rel="up" href="index.html" title="Gwyddion Data Processing Library Reference Manual">
<link rel="prev" href="GwyCalData.html" title="GwyCalData">
<link rel="next" href="GwyCDLine.html" title="cdline">
<meta name="generator" content="GTK-Doc V1.8 (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="GwyCalData.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td> </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">Gwyddion Data Processing Library Reference Manual</th>
<td><a accesskey="n" href="GwyCDLine.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgwyprocess-arithmetic.synopsis" class="shortcut">Top</a>
|
<a href="#libgwyprocess-arithmetic.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgwyprocess-arithmetic"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgwyprocess-arithmetic.top_of_page"></a>arithmetic</span></h2>
<p>arithmetic — Arithmetic opetations on data fields</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgwyprocess-arithmetic.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libprocess/gwyprocess.h>
<a class="link" href="libgwyprocess-gwyprocessenums.html#GwyDataCompatibilityFlags" title="enum GwyDataCompatibilityFlags"><span class="returnvalue">GwyDataCompatibilityFlags</span></a> <a class="link" href="libgwyprocess-arithmetic.html#gwy-data-field-check-compatibility" title="gwy_data_field_check_compatibility ()">gwy_data_field_check_compatibility</a>
(<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field1</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field2</code></em>,
<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyDataCompatibilityFlags" title="enum GwyDataCompatibilityFlags"><span class="type">GwyDataCompatibilityFlags</span></a> check</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-arithmetic.html#gwy-data-field-divide-fields" title="gwy_data_field_divide_fields ()">gwy_data_field_divide_fields</a> (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *result</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *operand1</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *operand2</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-arithmetic.html#gwy-data-field-max-of-fields" title="gwy_data_field_max_of_fields ()">gwy_data_field_max_of_fields</a> (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *result</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *operand1</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *operand2</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-arithmetic.html#gwy-data-field-min-of-fields" title="gwy_data_field_min_of_fields ()">gwy_data_field_min_of_fields</a> (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *result</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *operand1</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *operand2</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-arithmetic.html#gwy-data-field-multiply-fields" title="gwy_data_field_multiply_fields ()">gwy_data_field_multiply_fields</a> (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *result</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *operand1</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *operand2</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-arithmetic.html#gwy-data-field-subtract-fields" title="gwy_data_field_subtract_fields ()">gwy_data_field_subtract_fields</a> (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *result</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *operand1</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *operand2</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyprocess-arithmetic.html#gwy-data-field-sum-fields" title="gwy_data_field_sum_fields ()">gwy_data_field_sum_fields</a> (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *result</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *operand1</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *operand2</code></em>);
<a class="link" href="libgwyprocess-gwyprocessenums.html#GwyDataCompatibilityFlags" title="enum GwyDataCompatibilityFlags"><span class="returnvalue">GwyDataCompatibilityFlags</span></a> <a class="link" href="libgwyprocess-arithmetic.html#gwy-data-line-check-compatibility" title="gwy_data_line_check_compatibility ()">gwy_data_line_check_compatibility</a>
(<em class="parameter"><code><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> *data_line1</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> *data_line2</code></em>,
<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyDataCompatibilityFlags" title="enum GwyDataCompatibilityFlags"><span class="type">GwyDataCompatibilityFlags</span></a> check</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgwyprocess-arithmetic.description"></a><h2>Description</h2>
<p>
Data arithmetic functions perform simple operations combining several data
fields. Their sizes have to be size-compatible, i.e.
gwy_data_field_check_compatibility(operand1, operand2, GWY_DATA_COMPATIBILITY_RES)
must pass and the same must hold for the data field to store the result to.
</p>
<p>
Functions <a class="link" href="libgwyprocess-arithmetic.html#gwy-data-field-check-compatibility" title="gwy_data_field_check_compatibility ()"><code class="function">gwy_data_field_check_compatibility()</code></a> and
<a class="link" href="libgwyprocess-arithmetic.html#gwy-data-line-check-compatibility" title="gwy_data_line_check_compatibility ()"><code class="function">gwy_data_line_check_compatibility()</code></a> simplify testing compatibility of data
fields and lines, respectively.
</p>
</div>
<div class="refsect1">
<a name="libgwyprocess-arithmetic.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="gwy-data-field-check-compatibility"></a><h3>gwy_data_field_check_compatibility ()</h3>
<pre class="programlisting"><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyDataCompatibilityFlags" title="enum GwyDataCompatibilityFlags"><span class="returnvalue">GwyDataCompatibilityFlags</span></a> gwy_data_field_check_compatibility
(<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field1</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *data_field2</code></em>,
<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyDataCompatibilityFlags" title="enum GwyDataCompatibilityFlags"><span class="type">GwyDataCompatibilityFlags</span></a> check</code></em>);</pre>
<p>
Checks whether two data fields are compatible.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_field1</code></em> :</span></p></td>
<td>A data field.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_field2</code></em> :</span></p></td>
<td>Another data field.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>check</code></em> :</span></p></td>
<td>The compatibility tests to perform.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Zero if all tested properties are compatible. Flags corresponding
to failed tests if data fields are not compatible.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-divide-fields"></a><h3>gwy_data_field_divide_fields ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_divide_fields (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *result</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *operand1</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *operand2</code></em>);</pre>
<p>
Divides one data field with another.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
<td>A data field to put the result to. May be one of <em class="parameter"><code>operand1</code></em>,
<em class="parameter"><code>operand2</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>operand1</code></em> :</span></p></td>
<td>First data field operand.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>operand2</code></em> :</span></p></td>
<td>Second data field operand.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-max-of-fields"></a><h3>gwy_data_field_max_of_fields ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_max_of_fields (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *result</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *operand1</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *operand2</code></em>);</pre>
<p>
Finds point-wise minima of two data fields.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
<td>A data field to put the result to. May be one of <em class="parameter"><code>operand1</code></em>,
<em class="parameter"><code>operand2</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>operand1</code></em> :</span></p></td>
<td>First data field operand.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>operand2</code></em> :</span></p></td>
<td>Second data field operand.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-min-of-fields"></a><h3>gwy_data_field_min_of_fields ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_min_of_fields (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *result</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *operand1</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *operand2</code></em>);</pre>
<p>
Finds point-wise maxima of two data fields.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
<td>A data field to put the result to. May be one of <em class="parameter"><code>operand1</code></em>,
<em class="parameter"><code>operand2</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>operand1</code></em> :</span></p></td>
<td>First data field operand.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>operand2</code></em> :</span></p></td>
<td>Second data field operand.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-multiply-fields"></a><h3>gwy_data_field_multiply_fields ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_multiply_fields (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *result</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *operand1</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *operand2</code></em>);</pre>
<p>
Multiplies two data fields.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
<td>A data field to put the result to. May be one of <em class="parameter"><code>operand1</code></em>,
<em class="parameter"><code>operand2</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>operand1</code></em> :</span></p></td>
<td>First data field operand.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>operand2</code></em> :</span></p></td>
<td>Second data field operand.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-subtract-fields"></a><h3>gwy_data_field_subtract_fields ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_subtract_fields (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *result</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *operand1</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *operand2</code></em>);</pre>
<p>
Subtracts one data field from another.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
<td>A data field to put the result to. May be one of <em class="parameter"><code>operand1</code></em>,
<em class="parameter"><code>operand2</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>operand1</code></em> :</span></p></td>
<td>First data field operand.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>operand2</code></em> :</span></p></td>
<td>Second data field operand.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-field-sum-fields"></a><h3>gwy_data_field_sum_fields ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_data_field_sum_fields (<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *result</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *operand1</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataField.html" title="GwyDataField"><span class="type">GwyDataField</span></a> *operand2</code></em>);</pre>
<p>
Sums two data fields.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
<td>A data field to put the result to. May be one of <em class="parameter"><code>operand1</code></em>,
<em class="parameter"><code>operand2</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>operand1</code></em> :</span></p></td>
<td>First data field operand.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>operand2</code></em> :</span></p></td>
<td>Second data field operand.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-data-line-check-compatibility"></a><h3>gwy_data_line_check_compatibility ()</h3>
<pre class="programlisting"><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyDataCompatibilityFlags" title="enum GwyDataCompatibilityFlags"><span class="returnvalue">GwyDataCompatibilityFlags</span></a> gwy_data_line_check_compatibility
(<em class="parameter"><code><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> *data_line1</code></em>,
<em class="parameter"><code><a class="link" href="GwyDataLine.html" title="GwyDataLine"><span class="type">GwyDataLine</span></a> *data_line2</code></em>,
<em class="parameter"><code><a class="link" href="libgwyprocess-gwyprocessenums.html#GwyDataCompatibilityFlags" title="enum GwyDataCompatibilityFlags"><span class="type">GwyDataCompatibilityFlags</span></a> check</code></em>);</pre>
<p>
Checks whether two data lines are compatible.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_line1</code></em> :</span></p></td>
<td>A data line.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_line2</code></em> :</span></p></td>
<td>Another data line.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>check</code></em> :</span></p></td>
<td>The compatibility tests to perform.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Zero if all tested properties are compatible. Flags corresponding
to failed tests if data lines are not compatible.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.8</div>
</body>
</html>
|