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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>WCSLIB 4.8.2: wcsutil.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>wcsutil.h File Reference</h1>
<p>
<a href="wcsutil_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="wcsutil_8h.html#38322fa65b3bad54552d374d873ad037">wcsutil_blank_fill</a> (int n, char c[])</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fill a character string with blanks. <a href="#38322fa65b3bad54552d374d873ad037"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="wcsutil_8h.html#9d96f343fc444f8c6f1fa01367c4d765">wcsutil_null_fill</a> (int n, char c[])</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fill a character string with NULLs. <a href="#9d96f343fc444f8c6f1fa01367c4d765"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="wcsutil_8h.html#4c7c5a686aaa39f511598b32e944ac68">wcsutil_allEq</a> (int nvec, int nelem, const double *first)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test for equality of a particular vector element. <a href="#4c7c5a686aaa39f511598b32e944ac68"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="wcsutil_8h.html#fe7f963c2038673015bbce204c4a8171">wcsutil_setAll</a> (int nvec, int nelem, double *first)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a particular vector element. <a href="#fe7f963c2038673015bbce204c4a8171"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="wcsutil_8h.html#b32722081f8cda184d7ada6d734c637c">wcsutil_setAli</a> (int nvec, int nelem, int *first)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a particular vector element. <a href="#b32722081f8cda184d7ada6d734c637c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="wcsutil_8h.html#0d982911e7f694a751f2887ea38890e4">wcsutil_setBit</a> (int nelem, const int *sel, int bits, int *array)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set bits in selected elements of an array. <a href="#0d982911e7f694a751f2887ea38890e4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="wcsutil_8h.html#9bc774de065f8937aa9bbffa2df6089c">wcsutil_fptr2str</a> (int(*func)(), char hext[])</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Simple utility functions for <b>internal use only</b> by WCSLIB. They are documented here solely as an aid to understanding the code. They are not intended for external use - the API may change without notice! <hr><h2>Function Documentation</h2>
<a class="anchor" name="38322fa65b3bad54552d374d873ad037"></a><!-- doxytag: member="wcsutil.h::wcsutil_blank_fill" ref="38322fa65b3bad54552d374d873ad037" args="(int n, char c[])" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wcsutil_blank_fill </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"> <em>c</em>[]</td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>INTERNAL USE ONLY.</b><p>
<b>wcsutil_blank_fill</b>() pads a character string with blanks starting with the terminating NULL character.<p>
Used by the Fortran wrapper functions in translating C character strings into Fortran CHARACTER variables.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>n</em> </td><td>Length of the character array, c[].</td></tr>
<tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>c</em> </td><td>The character string. It will not be null-terminated on return.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd></dd></dl>
</div>
</div><p>
<a class="anchor" name="9d96f343fc444f8c6f1fa01367c4d765"></a><!-- doxytag: member="wcsutil.h::wcsutil_null_fill" ref="9d96f343fc444f8c6f1fa01367c4d765" args="(int n, char c[])" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wcsutil_null_fill </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"> <em>c</em>[]</td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>INTERNAL USE ONLY.</b><p>
<b>wcsutil_null_fill</b>() strips off trailing blanks and pads the character array holding the string with NULL characters.<p>
Used mainly to make character strings intelligible in the GNU debugger which prints the rubbish following the terminating NULL, obscuring the valid part of the string.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>n</em> </td><td>Number of characters.</td></tr>
<tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>c</em> </td><td>The character string.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd></dd></dl>
</div>
</div><p>
<a class="anchor" name="4c7c5a686aaa39f511598b32e944ac68"></a><!-- doxytag: member="wcsutil.h::wcsutil_allEq" ref="4c7c5a686aaa39f511598b32e944ac68" args="(int nvec, int nelem, const double *first)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int wcsutil_allEq </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nvec</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nelem</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const double * </td>
<td class="paramname"> <em>first</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>INTERNAL USE ONLY.</b><p>
<b>wcsutil_allEq</b>() tests for equality of a particular element in a set of vectors.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nvec</em> </td><td>The number of vectors. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nelem</em> </td><td>The length of each vector. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>first</em> </td><td>Pointer to the first element to test in the array. The elements tested for equality are <div class="fragment"><pre class="fragment"> *first == *(first + nelem)
== *(first + nelem*2)
:
== *(first + nelem*(nvec-1));
</pre></div> <br>
The array might be dimensioned as <div class="fragment"><pre class="fragment"> <span class="keywordtype">double</span> v[nvec][nelem];
</pre></div></td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Status return value:<ul>
<li>0: Not all equal.</li><li>1: All equal. </li></ul>
</dd></dl>
</div>
</div><p>
<a class="anchor" name="fe7f963c2038673015bbce204c4a8171"></a><!-- doxytag: member="wcsutil.h::wcsutil_setAll" ref="fe7f963c2038673015bbce204c4a8171" args="(int nvec, int nelem, double *first)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wcsutil_setAll </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nvec</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nelem</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double * </td>
<td class="paramname"> <em>first</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>INTERNAL USE ONLY.</b><p>
<b>wcsutil_setAll</b>() sets the value of a particular element in a set of vectors.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nvec</em> </td><td>The number of vectors. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nelem</em> </td><td>The length of each vector.</td></tr>
<tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>first</em> </td><td>Pointer to the first element in the array, the value of which is used to set the others <div class="fragment"><pre class="fragment"> *(first + nelem) = *first;
*(first + nelem*2) = *first;
:
*(first + nelem*(nvec-1)) = *first;
</pre></div> <br>
The array might be dimensioned as <div class="fragment"><pre class="fragment"> <span class="keywordtype">double</span> v[nvec][nelem];
</pre></div></td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd></dd></dl>
</div>
</div><p>
<a class="anchor" name="b32722081f8cda184d7ada6d734c637c"></a><!-- doxytag: member="wcsutil.h::wcsutil_setAli" ref="b32722081f8cda184d7ada6d734c637c" args="(int nvec, int nelem, int *first)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wcsutil_setAli </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nvec</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nelem</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>first</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>INTERNAL USE ONLY.</b><p>
<b>wcsutil_setAli</b>() sets the value of a particular element in a set of vectors.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nvec</em> </td><td>The number of vectors. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nelem</em> </td><td>The length of each vector.</td></tr>
<tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>first</em> </td><td>Pointer to the first element in the array, the value of which is used to set the others <div class="fragment"><pre class="fragment"> *(first + nelem) = *first;
*(first + nelem*2) = *first;
:
*(first + nelem*(nvec-1)) = *first;
</pre></div> <br>
The array might be dimensioned as <div class="fragment"><pre class="fragment"> <span class="keywordtype">int</span> v[nvec][nelem];
</pre></div></td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd></dd></dl>
</div>
</div><p>
<a class="anchor" name="0d982911e7f694a751f2887ea38890e4"></a><!-- doxytag: member="wcsutil.h::wcsutil_setBit" ref="0d982911e7f694a751f2887ea38890e4" args="(int nelem, const int *sel, int bits, int *array)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wcsutil_setBit </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nelem</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int * </td>
<td class="paramname"> <em>sel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>bits</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>array</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<b>INTERNAL USE ONLY.</b><p>
<b>wcsutil_setBit</b>() sets bits in selected elements of an array.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>nelem</em> </td><td>Number of elements in the array. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>sel</em> </td><td>Address of a selection array of length nelem. May be specified as the null pointer in which case all elements are selected. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>bits</em> </td><td>Bit mask.</td></tr>
<tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>array</em> </td><td>Address of the array of length nelem.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd></dd></dl>
</div>
</div><p>
<a class="anchor" name="9bc774de065f8937aa9bbffa2df6089c"></a><!-- doxytag: member="wcsutil.h::wcsutil_fptr2str" ref="9bc774de065f8937aa9bbffa2df6089c" args="(int(*func)(), char hext[])" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* wcsutil_fptr2str </td>
<td>(</td>
<td class="paramtype">int(*)() </td>
<td class="paramname"> <em>func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"> <em>hext</em>[]</td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Oct 4 19:02:30 2011 for WCSLIB 4.8.2 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
|
