Mercurial > octave
annotate libinterp/corefcn/nproc.cc @ 21547:ad0599a0acc6
doc: Wrap C++ docstrings to 79 characters + newline (80 total).
* besselj.cc, bitfcns.cc, cellfun.cc, data.cc, debug.cc, error.cc,
file-io.cc, graphics.cc, input.cc, lu.cc, matrix_type.cc, nproc.cc,
pr-output.cc, quadcc.cc, regexp.cc, schur.cc, sparse.cc, strfind.cc, strfns.cc,
syscalls.cc, urlwrite.cc, variables.cc, __osmesa_print__.cc, audiodevinfo.cc,
audioread.cc, ccolamd.cc, chol.cc, colamd.cc, convhulln.cc, qr.cc, symbfact.cc,
ov-java.cc, ov-struct.cc, ov-usr-fcn.cc, pt-arg-list.cc:
doc: Wrap C++ docstrings to 79 characters + newline (80 total).
author | Rik <rik@octave.org> |
---|---|
date | Sun, 27 Mar 2016 20:39:19 -0700 |
parents | a4faec57f4c8 |
children | 6fab85c1538f |
rev | line source |
---|---|
12510
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
1 /* |
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
2 |
19697
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
19168
diff
changeset
|
3 Copyright (C) 2012-2015 Iain Murray |
12510
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
4 |
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
5 This file is part of Octave. |
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
6 |
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
7 Octave is free software; you can redistribute it and/or modify it |
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
8 under the terms of the GNU General Public License as published by the |
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
9 Free Software Foundation; either version 3 of the License, or (at your |
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
10 option) any later version. |
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
11 |
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
12 Octave is distributed in the hope that it will be useful, but WITHOUT |
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
15 for more details. |
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
16 |
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
17 You should have received a copy of the GNU General Public License |
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
18 along with Octave; see the file COPYING. If not, see |
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
19 <http://www.gnu.org/licenses/>. |
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
20 |
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
21 */ |
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
22 |
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
23 #ifdef HAVE_CONFIG_H |
21301
40de9f8f23a6
Use '#include "config.h"' rather than <config.h>.
Rik <rik@octave.org>
parents:
21200
diff
changeset
|
24 # include "config.h" |
12510
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
25 #endif |
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
26 |
15039
e753177cde93
maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents:
14501
diff
changeset
|
27 #include "defun.h" |
12512
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
28 #include "nproc.h" |
12510
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
29 |
20915
a3359fe50966
remove unused nargout variables
John W. Eaton <jwe@octave.org>
parents:
20909
diff
changeset
|
30 DEFUN (nproc, args, , |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
31 "-*- texinfo -*-\n\ |
20853
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20831
diff
changeset
|
32 @deftypefn {} {} nproc ()\n\ |
1142cf6abc0d
2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents:
20831
diff
changeset
|
33 @deftypefnx {} {} nproc (@var{query})\n\ |
12512
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
34 Return the current number of available processors.\n\ |
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
35 \n\ |
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
36 If called with the optional argument @var{query}, modify how processors\n\ |
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
37 are counted as follows:\n\ |
14366
b76f0740940e
doc: Periodic grammar check of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
38 \n\ |
12512
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
39 @table @code\n\ |
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
40 @item all\n\ |
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
41 total number of processors.\n\ |
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
42 \n\ |
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
43 @item current\n\ |
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
44 processors available to the current process.\n\ |
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
45 \n\ |
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
46 @item overridable\n\ |
21547
ad0599a0acc6
doc: Wrap C++ docstrings to 79 characters + newline (80 total).
Rik <rik@octave.org>
parents:
21317
diff
changeset
|
47 same as @code{current}, but overridable through the\n\ |
ad0599a0acc6
doc: Wrap C++ docstrings to 79 characters + newline (80 total).
Rik <rik@octave.org>
parents:
21317
diff
changeset
|
48 @w{@env{OMP_NUM_THREADS}} environment variable.\n\ |
12512
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
49 @end table\n\ |
12510
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
50 @end deftypefn") |
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
51 { |
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
52 int nargin = args.length (); |
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
53 |
20909
03e4ddd49396
omit unnecessary nargout checks
John W. Eaton <jwe@octave.org>
parents:
20853
diff
changeset
|
54 if (nargin > 1) |
20801
a542a9bf177e
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20172
diff
changeset
|
55 print_usage (); |
12510
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
56 |
12512
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
57 nproc_query query = NPROC_CURRENT; |
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
58 if (nargin == 1) |
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
59 { |
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
60 std::string arg = args(0).string_value (); |
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
61 |
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
62 std::transform (arg.begin (), arg.end (), arg.begin (), tolower); |
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
63 |
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
64 if (arg == "all") |
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
65 query = NPROC_ALL; |
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
66 else if (arg == "current") |
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
67 query = NPROC_CURRENT; |
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
68 else if (arg == "overridable") |
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
69 query = NPROC_CURRENT_OVERRIDABLE; |
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
70 else |
20831
35241c4b696c
eliminate return statements after calls to error
John W. Eaton <jwe@octave.org>
parents:
20801
diff
changeset
|
71 error ("nproc: invalid value for QUERY"); |
12512
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
72 } |
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
73 |
20939
b17fda023ca6
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20915
diff
changeset
|
74 return ovl (num_processors (query)); |
12510
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
75 } |
a1b2da4967ac
Add nproc, nproc_conf utility functions for determining number of available processors.
Iain Murray <iain@iainmurray.net>
parents:
diff
changeset
|
76 |
12512
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
77 /* |
14501
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14366
diff
changeset
|
78 ## Must always report at least 1 cpu available |
21317
a4faec57f4c8
maint: remove semicolon after %!assert tests to follow Octave conventions.
Rik <rik@octave.org>
parents:
21301
diff
changeset
|
79 %!assert (nproc () >= 1) |
a4faec57f4c8
maint: remove semicolon after %!assert tests to follow Octave conventions.
Rik <rik@octave.org>
parents:
21301
diff
changeset
|
80 %!assert (nproc ("all") >= 1) |
a4faec57f4c8
maint: remove semicolon after %!assert tests to follow Octave conventions.
Rik <rik@octave.org>
parents:
21301
diff
changeset
|
81 %!assert (nproc ("current") >= 1) |
19136
10c57204fd72
nproc.cc: codesprint: adding tests
Andreas Weber <andy.weber.aw@gmail.com>
parents:
17787
diff
changeset
|
82 |
10c57204fd72
nproc.cc: codesprint: adding tests
Andreas Weber <andy.weber.aw@gmail.com>
parents:
17787
diff
changeset
|
83 %!test |
10c57204fd72
nproc.cc: codesprint: adding tests
Andreas Weber <andy.weber.aw@gmail.com>
parents:
17787
diff
changeset
|
84 %! c = nproc ("current"); |
10c57204fd72
nproc.cc: codesprint: adding tests
Andreas Weber <andy.weber.aw@gmail.com>
parents:
17787
diff
changeset
|
85 %! unwind_protect |
10c57204fd72
nproc.cc: codesprint: adding tests
Andreas Weber <andy.weber.aw@gmail.com>
parents:
17787
diff
changeset
|
86 %! old_val = getenv ("OMP_NUM_THREADS"); |
10c57204fd72
nproc.cc: codesprint: adding tests
Andreas Weber <andy.weber.aw@gmail.com>
parents:
17787
diff
changeset
|
87 %! new_val = c + 1; |
10c57204fd72
nproc.cc: codesprint: adding tests
Andreas Weber <andy.weber.aw@gmail.com>
parents:
17787
diff
changeset
|
88 %! setenv ("OMP_NUM_THREADS", num2str (new_val)); |
10c57204fd72
nproc.cc: codesprint: adding tests
Andreas Weber <andy.weber.aw@gmail.com>
parents:
17787
diff
changeset
|
89 %! assert (nproc ("overridable"), new_val); |
10c57204fd72
nproc.cc: codesprint: adding tests
Andreas Weber <andy.weber.aw@gmail.com>
parents:
17787
diff
changeset
|
90 %! unwind_protect_cleanup |
10c57204fd72
nproc.cc: codesprint: adding tests
Andreas Weber <andy.weber.aw@gmail.com>
parents:
17787
diff
changeset
|
91 %! if (! isempty (old_val)) |
10c57204fd72
nproc.cc: codesprint: adding tests
Andreas Weber <andy.weber.aw@gmail.com>
parents:
17787
diff
changeset
|
92 %! setenv ("OMP_NUM_THREADS", old_val); |
19145
b5c03bcc640a
nproc: Fix unwind_protect_cleanup block in %!test
Mike Miller <mtmiller@ieee.org>
parents:
19136
diff
changeset
|
93 %! else |
19168
9163a6e9b096
Use unsetenv to fix libgomp error created by nproc BIST testing.
Rik <rik@octave.org>
parents:
19145
diff
changeset
|
94 %! unsetenv ("OMP_NUM_THREADS"); |
19136
10c57204fd72
nproc.cc: codesprint: adding tests
Andreas Weber <andy.weber.aw@gmail.com>
parents:
17787
diff
changeset
|
95 %! endif |
10c57204fd72
nproc.cc: codesprint: adding tests
Andreas Weber <andy.weber.aw@gmail.com>
parents:
17787
diff
changeset
|
96 %! end_unwind_protect |
10c57204fd72
nproc.cc: codesprint: adding tests
Andreas Weber <andy.weber.aw@gmail.com>
parents:
17787
diff
changeset
|
97 |
10c57204fd72
nproc.cc: codesprint: adding tests
Andreas Weber <andy.weber.aw@gmail.com>
parents:
17787
diff
changeset
|
98 %!error nproc ("no_valid_option"); |
12512
77b14e634166
Replace nprocs with nproc function. Use gnulib module for portability across platforms.
Iain Murray <iain@iainmurray.net>
parents:
12510
diff
changeset
|
99 */ |