-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathcheck.html
387 lines (312 loc) · 19.6 KB
/
check.html
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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
<!-- -*- mode: jinja2 -*- -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="A community driven standard library for (modern) Fortran">
<meta name="author" content="fortran-lang/stdlib contributors" >
<link rel="icon" href="../favicon.png">
<title>check – Fortran-lang/stdlib</title>
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/css/bootstrap.min.css" rel="stylesheet"
integrity="sha384-1BmE4kWBq78iYhFldvKuhfTAU6auU8tT94WrHftjDbrCEXSU1oBoqyl2QvZ6jIW3" crossorigin="anonymous">
<link href="../css/pygments.css" rel="stylesheet">
<link href="../css/font-awesome.min.css" rel="stylesheet">
<link href="../css/local.css" rel="stylesheet">
<link href="../tipuesearch/tipuesearch.css" rel="stylesheet">
<script src="https://code.jquery.com/jquery-3.7.1.min.js" integrity="sha256-/JqT3SQfawRcv/BIHPThkBvs0OEvtFFmqPF/lYI/Cxo=" crossorigin="anonymous"></script>
<script src="../js/svg-pan-zoom.min.js"></script>
</head>
<body>
<!-- Fixed navbar -->
<div class="container-fluid mb-sm-4 mb-xl-2">
<nav class="navbar navbar-expand-lg navbar-dark bg-dark fixed-top">
<div class="container">
<a class="navbar-brand" href="../index.html">Fortran-lang/stdlib </a>
<button type="button" class="navbar-toggler" data-bs-toggle="collapse" data-bs-target="#navbar"
aria-expanded="false" aria-controls="navbar" aria-label="Toggle navigation">
<span class="navbar-toggler-icon">
</button>
<div id="navbar" class="navbar-collapse collapse">
<ul class="navbar-nav">
<li class="nav-item"><a class="nav-link" href="../page/index.html">Contributing and specs</a></li>
<li class="nav-item">
<a class="nav-link" href="../lists/files.html">Source Files</a>
</li>
<li class="nav-item">
<a class="nav-link" href="../lists/modules.html">Modules</a>
</li>
<li class="nav-item">
<a class="nav-link" href="../lists/procedures.html">Procedures</a>
</li>
<li class="nav-item">
<a class="nav-link" href="../lists/absint.html">Abstract Interfaces</a>
</li>
<li class="nav-item">
<a class="nav-link" href="../lists/types.html">Derived Types</a>
</li>
</ul>
<div class="d-flex align-items-end flex-grow-1">
<form action="../search.html" role="search" class="ms-auto">
<input type="text" class="form-control" aria-label="Search" placeholder="Search" name="q" id="tipue_search_input" autocomplete="off" required>
</form>
</div>
</div><!--/.nav-collapse -->
</div>
</nav>
</div>
<div class="container">
<div class="row">
<h1>check
<small>Subroutine</small>
</h1>
<div class="container p-2 mb-4 bg-light border rounded-3">
<div class="row align-items-center justify-content-between" id="info-bar">
<div class="col">
<ul class="list-inline" style="margin-bottom:0px;display:inline">
<li class="list-inline-item" id="meta-license"><i class="fa fa-legal"></i> <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/80x15.png" /></a></li>
<li class="list-inline-item" id="meta-version"><i class="fa fa-barcode"></i> experimental</li>
<li class="list-inline-item" id="statements"><i class="fa fa-list-ol"></i>
<a data-bs-toggle="tooltip"
data-bs-placement="bottom" data-html="true"
title=" 0.0% of total for procedures.">14 statements</a>
</li>
<li class="list-inline-item" id="source-file">
<i class="fa fa-code"></i>
<a href="../src/stdlib_error.fypp"> Source File</a>
</li>
</ul>
</div>
<div class="col">
<nav aria-label="breadcrumb">
<ol class="breadcrumb justify-content-end mb-0">
<li class="breadcrumb-item"><a href='../sourcefile/stdlib_error.fypp.html'>stdlib_error.fypp</a></li>
<li class="breadcrumb-item"><a href='../module/stdlib_error.html'>stdlib_error</a></li>
<li class="breadcrumb-item active" aria-current="page">check</li>
</ol>
</nav>
</div>
</div>
</div>
<script>
$(function () {
$('[data-bs-toggle="tooltip"]').tooltip()
})
</script>
</div>
<div class="row">
<div class="col-md-3 hidden-xs hidden-sm visible-md visible-lg">
<div id="sidebar">
<h3>Contents</h3>
<div class="card card-primary">
<div class="card-header text-left"><h3 class="card-title">Source Code</h3></div>
<div class="list-group">
<a class="list-group-item" href="../proc/check.html#src">check</a>
</div>
</div>
</div>
</div>
<div class="col-md-9" id='text'>
<h2>public subroutine check(condition, msg, code, warn)
</h2>
<p>Checks the value of a logical condition
(<a href="../page/specs/stdlib_error.html#description">Specification</a>)</p>
<h5 id="behavior">Behavior</h5>
<p>If <code>condition == .false.</code> and:</p>
<ul>
<li>No other arguments are provided, it stops the program with the default
message and exit code <code>1</code>;</li>
<li><code>msg</code> is provided, it prints the value of <code>msg</code>;</li>
<li><code>code</code> is provided, it stops the program with the given exit code;</li>
<li><code>warn</code> is provided and <code>.true.</code>, it doesn't stop the program and prints
the message.</li>
</ul>
<h5 id="examples">Examples</h5>
<ul>
<li>If <code>a /= 5</code>, stops the program with exit code <code>1</code>
and prints <code>Check failed.</code></li>
</ul>
<div class="codehilite"><pre><span></span><code><span class="w"> </span><span class="k">call </span><span class="n">check</span><span class="p">(</span><span class="n">a</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="mi">5</span><span class="p">)</span>
</code></pre></div>
<ul>
<li>As above, but prints <code>a == 5 failed</code>.</li>
</ul>
<div class="codehilite"><pre><span></span><code><span class="w"> </span><span class="k">call </span><span class="n">check</span><span class="p">(</span><span class="n">a</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span><span class="w"> </span><span class="n">msg</span><span class="o">=</span><span class="s1">'a == 5 failed.'</span><span class="p">)</span>
</code></pre></div>
<ul>
<li>As above, but doesn't stop the program.</li>
</ul>
<div class="codehilite"><pre><span></span><code><span class="w"> </span><span class="k">call </span><span class="n">check</span><span class="p">(</span><span class="n">a</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span><span class="w"> </span><span class="n">msg</span><span class="o">=</span><span class="s1">'a == 5 failed.'</span><span class="p">,</span><span class="w"> </span><span class="n">warn</span><span class="o">=</span><span class="p">.</span><span class="n">true</span><span class="p">.)</span>
</code></pre></div>
<ul>
<li>As example #2, but stops the program with exit code <code>77</code></li>
</ul>
<div class="codehilite"><pre><span></span><code><span class="w"> </span><span class="k">call </span><span class="n">check</span><span class="p">(</span><span class="n">a</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span><span class="w"> </span><span class="n">msg</span><span class="o">=</span><span class="s1">'a == 5 failed.'</span><span class="p">,</span><span class="w"> </span><span class="n">code</span><span class="o">=</span><span class="mi">77</span><span class="p">)</span>
</code></pre></div>
<h3>Arguments</h3>
<table class="table table-striped varlist">
<thead>
<tr>
<th scope="col">Type</th>
<th scope="col">Intent</th><th scope="col">Optional</th> <th scope="col">Attributes</th>
<th scope="col"></th>
<th scope="col">Name</th>
<th scope="col"></th>
</thead>
<tbody>
<tr>
<td>
<span class="anchor" id="variable-condition"></span>
logical,
</td>
<td>intent(in)</td>
<td></td> <td>
</td>
<td>::</td>
<td><strong>condition</strong></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-msg~32"></span>
character(len=*),
</td>
<td>intent(in),</td>
<td>optional</td> <td>
</td>
<td>::</td>
<td><strong>msg</strong></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-code~7"></span>
integer,
</td>
<td>intent(in),</td>
<td>optional</td> <td>
</td>
<td>::</td>
<td><strong>code</strong></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="anchor" id="variable-warn"></span>
logical,
</td>
<td>intent(in),</td>
<td>optional</td> <td>
</td>
<td>::</td>
<td><strong>warn</strong></td>
<td>
</td>
</tr>
</tbody>
</table>
<br>
<section>
<h2><span class="anchor" id="src"></span>Source Code</h2>
<div class="hl codehilite"><pre><span></span><span class="w"> </span><span class="k">subroutine </span><span class="n">check</span><span class="p">(</span><span class="n">condition</span><span class="p">,</span><span class="w"> </span><span class="n">msg</span><span class="p">,</span><span class="w"> </span><span class="n">code</span><span class="p">,</span><span class="w"> </span><span class="n">warn</span><span class="p">)</span>
<span class="w"> </span><span class="c">!! version: experimental</span>
<span class="w"> </span><span class="c">!!</span>
<span class="w"> </span><span class="c">!! Checks the value of a logical condition</span>
<span class="w"> </span><span class="c">!! ([Specification](../page/specs/stdlib_error.html#description))</span>
<span class="w"> </span><span class="c">!!</span>
<span class="w"> </span><span class="c">!!##### Behavior</span>
<span class="w"> </span><span class="c">!!</span>
<span class="w"> </span><span class="c">!! If `condition == .false.` and:</span>
<span class="w"> </span><span class="c">!!</span>
<span class="w"> </span><span class="c">!! * No other arguments are provided, it stops the program with the default</span>
<span class="w"> </span><span class="c">!! message and exit code `1`;</span>
<span class="w"> </span><span class="c">!! * `msg` is provided, it prints the value of `msg`;</span>
<span class="w"> </span><span class="c">!! * `code` is provided, it stops the program with the given exit code;</span>
<span class="w"> </span><span class="c">!! * `warn` is provided and `.true.`, it doesn't stop the program and prints</span>
<span class="w"> </span><span class="c">!! the message.</span>
<span class="w"> </span><span class="c">!!</span>
<span class="w"> </span><span class="c">!!##### Examples</span>
<span class="w"> </span><span class="c">!!</span>
<span class="w"> </span><span class="c">!!* If `a /= 5`, stops the program with exit code `1`</span>
<span class="w"> </span><span class="c">!! and prints `Check failed.`</span>
<span class="w"> </span><span class="c">!!``` fortran</span>
<span class="w"> </span><span class="c">!! call check(a == 5)</span>
<span class="w"> </span><span class="c">!!```</span>
<span class="w"> </span><span class="c">!!</span>
<span class="w"> </span><span class="c">!!* As above, but prints `a == 5 failed`.</span>
<span class="w"> </span><span class="c">!!``` fortran</span>
<span class="w"> </span><span class="c">!! call check(a == 5, msg='a == 5 failed.')</span>
<span class="w"> </span><span class="c">!!```</span>
<span class="w"> </span><span class="c">!!</span>
<span class="w"> </span><span class="c">!!* As above, but doesn't stop the program.</span>
<span class="w"> </span><span class="c">!!``` fortran</span>
<span class="w"> </span><span class="c">!! call check(a == 5, msg='a == 5 failed.', warn=.true.)</span>
<span class="w"> </span><span class="c">!!```</span>
<span class="w"> </span><span class="c">!!</span>
<span class="w"> </span><span class="c">!!* As example #2, but stops the program with exit code `77`</span>
<span class="w"> </span><span class="c">!!``` fortran</span>
<span class="w"> </span><span class="c">!! call check(a == 5, msg='a == 5 failed.', code=77)</span>
<span class="w"> </span><span class="c">!!```</span>
<span class="w"> </span><span class="c">!</span>
<span class="w"> </span><span class="c">! Arguments</span>
<span class="w"> </span><span class="c">! ---------</span>
<span class="w"> </span><span class="kt">logical</span><span class="p">,</span><span class="w"> </span><span class="k">intent</span><span class="p">(</span><span class="n">in</span><span class="p">)</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="n">condition</span>
<span class="w"> </span><span class="kt">character</span><span class="p">(</span><span class="o">*</span><span class="p">),</span><span class="w"> </span><span class="k">intent</span><span class="p">(</span><span class="n">in</span><span class="p">),</span><span class="w"> </span><span class="k">optional</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="n">msg</span>
<span class="w"> </span><span class="kt">integer</span><span class="p">,</span><span class="w"> </span><span class="k">intent</span><span class="p">(</span><span class="n">in</span><span class="p">),</span><span class="w"> </span><span class="k">optional</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="n">code</span>
<span class="w"> </span><span class="kt">logical</span><span class="p">,</span><span class="w"> </span><span class="k">intent</span><span class="p">(</span><span class="n">in</span><span class="p">),</span><span class="w"> </span><span class="k">optional</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="n">warn</span>
<span class="w"> </span><span class="kt">character</span><span class="p">(</span><span class="o">*</span><span class="p">),</span><span class="w"> </span><span class="k">parameter</span><span class="w"> </span><span class="kd">::</span><span class="w"> </span><span class="n">msg_default</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'Check failed.'</span>
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(.</span><span class="nb">not</span><span class="p">.</span><span class="w"> </span><span class="n">condition</span><span class="p">)</span><span class="w"> </span><span class="k">then</span>
<span class="k"> if</span><span class="w"> </span><span class="p">(</span><span class="n">optval</span><span class="p">(</span><span class="n">warn</span><span class="p">,</span><span class="w"> </span><span class="p">.</span><span class="n">false</span><span class="p">.))</span><span class="w"> </span><span class="k">then</span>
<span class="k"> write</span><span class="p">(</span><span class="n">stderr</span><span class="p">,</span><span class="o">*</span><span class="p">)</span><span class="w"> </span><span class="n">optval</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span><span class="w"> </span><span class="n">msg_default</span><span class="p">)</span>
<span class="w"> </span><span class="k">else</span>
<span class="k"> call </span><span class="n">error_stop</span><span class="p">(</span><span class="n">optval</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span><span class="w"> </span><span class="n">msg_default</span><span class="p">),</span><span class="w"> </span><span class="n">optval</span><span class="p">(</span><span class="n">code</span><span class="p">,</span><span class="w"> </span><span class="mi">1</span><span class="p">))</span>
<span class="w"> </span><span class="k">end if</span>
<span class="k"> end if</span>
<span class="k"> end subroutine </span><span class="n">check</span>
</pre></div>
</section>
<br>
</div>
</div>
<hr>
</div> <!-- /container -->
<footer>
<div class="container">
<div class="row justify-content-between">
<div class="col"><p>Fortran-lang/stdlib was developed by fortran-lang/stdlib contributors<br>© 2025 <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/80x15.png" /></a>
<br /><small>d8fd7b21</small></p>
</div>
<div class="col">
<p class="text-end">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2025-04-22 02:50 </p>
</div>
</div>
<br>
</div> <!-- /container -->
</footer>
<!-- Bootstrap core JavaScript -->
<!-- Placed at the end of the document so the pages load faster -->
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/js/bootstrap.bundle.min.js"
integrity="sha384-ka7Sk0Gln4gmtz2MlQnikT1wXgYsOg+OMhuP+IlRH9sENBO0LRn5q+8nbTov4+1p" crossorigin="anonymous"></script>
<!-- MathJax JavaScript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
TeX: { extensions: ['AMSmath.js','AMSsymbols.js','noErrors.js','noUndefined.js'], equationNumbers: { autoNumber: 'AMS' } },
jax: ['input/TeX','input/MathML','output/HTML-CSS'],
extensions: ['tex2jax.js','mml2jax.js','MathMenu.js','MathZoom.js']
});
</script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script src="../tipuesearch/tipuesearch_content.js"></script>
<script src="../tipuesearch/tipuesearch_set.js"></script>
<script src="../tipuesearch/tipuesearch.js"></script>
</body>
</html>