source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRING/isnumber.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 5.2 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>isnumber.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="isnumber.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../../ToBeReviewed/STRING//isnumber.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="getwrd.html">&lt;&lt;prev file</a> | <a href="lenstr.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="isnumber.html" target="_TOP">view single page</a> | <a href="./../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/STRING/</a></h1>
82      <h2 class="pro_file">isnumber.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Determine if a text string is a valid number.
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_isnumber">
105
106          <h2><a class="top" href="#container">top</a>isnumber <span class="categories">
107</span></h2>
108       
109          <p class="header">
110            <span class="result">result = </span>isnumber(<span class="result"><a href="#_isnumber_param_txt0">txt0</a>, <a href="#_isnumber_param_x">x</a></span>, <a href="#_isnumber_keyword_HELP">HELP</a>=<span class="result">HELP</span>)</p>
111       
112          <div class="comments">
113</div>
114
115          <h3>Return value</h3><div class="preformat">
116       x = optionaly returned numeric value if valid. 
117       i = test flag:                                 
118           0: not a number.
119           1: txt is a long integer.
120           2: txt is a float.
121           -1: first word of txt is a long integer.
122           -2: first word of txt is a float.
123 </div>
124
125         
126            <h3>Parameters</h3>
127       
128           
129            <h4 id="_isnumber_param_txt0">txt0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
130              <span class="attr">in</span>
131             
132             
133              <span class="attr">required</span>
134             
135             
136             
137             
138            </h4>
139       
140          <div class="comments">
141 text string to test.
142</div>
143           
144            <h4 id="_isnumber_param_x">x&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
145              <span class="attr">in</span>
146             
147             
148              <span class="attr">required</span>
149             
150             
151             
152             
153            </h4>
154       
155          <div class="comments">
156</div>
157           
158
159         
160
161         
162
163            <h3>Keywords</h3>
164           
165            <h4 id="_isnumber_keyword_HELP">HELP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
166             
167             
168             
169             
170             
171             
172             
173             
174            </h4>
175       
176            <div class="comments">
177</div>
178           
179         
180
181         
182          <h3>Version history</h3>
183         
184          <h4>Version</h4><div class="preformat">
185 $Id: isnumber.pro 325 2007-12-06 10:04:53Z pinsard $
186</div>
187          <h4>History</h4><div class="preformat">
188       R. Sterner.  15 Oct, 1986.
189       Johns Hopkins Applied Physics Lab.
190       R. Sterner, 12 Mar, 1990 --- upgraded.
191       Richard Garrett, 14 June, 1992 --- fixed bug in returned float value.
192       R. Sterner, 1999 Nov 30 --- Fixed a bug found by Kristian Kjaer, Denmark
193
194 Copyright (C) 1986, Johns Hopkins University/Applied Physics Laboratory
195 This software may be used, copied, or redistributed as long as it is not
196 sold and this copyright notice is reproduced on each copy made.  This
197 routine is provided as is without any express or implied warranties
198 whatsoever.  Other limitations apply as described in the file disclaimer.txt.
199</div>
200         
201         
202         
203         
204         
205         
206         
207       
208         
209         
210         
211         
212         
213         
214         
215       
216          <h3>Statistics</h3>
217          <table class="statistics">
218            <tr><td>McCabe cyclic</td><td>          23</td></tr>
219            <tr><td>McCabe essential</td><td>           1</td></tr>
220            <tr><td>McCabe modular design</td><td>           1</td></tr>
221          </table>
222         
223       
224        </div>
225       
226      </div>
227
228     
229
230      <div id="tagline">Produced by IDLdoc 2.0.</div>
231
232    </div>
233
234  </body>
235</html>
Note: See TracBrowser for help on using the repository browser.