Mercurial > octave-nkf
view src/DLD-FUNCTIONS/nproc.cc @ 14501:60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
* __contourc__.cc, __delaunayn__.cc, __dispatch__.cc, __dsearchn__.cc,
__fltk_uigetfile__.cc, __glpk__.cc, __lin_interpn__.cc, __magick_read__.cc,
__pchip_deriv__.cc, __qp__.cc, __voronoi__.cc, besselj.cc, betainc.cc,
bsxfun.cc, cellfun.cc, chol.cc, conv2.cc, convhulln.cc, dassl.cc, det.cc,
dlmread.cc, dmperm.cc, dot.cc, eig.cc, eigs.cc, fft.cc, fft2.cc, filter.cc,
find.cc, gammainc.cc, gcd.cc, givens.cc, hess.cc, hex2num.cc, inv.cc, kron.cc,
lookup.cc, lsode.cc, lu.cc, luinc.cc, matrix_type.cc, max.cc, mgorth.cc,
nproc.cc, qr.cc, quad.cc, quadcc.cc, qz.cc, rand.cc, rcond.cc, regexp.cc,
schur.cc, spparms.cc, sqrtm.cc, str2double.cc, strfind.cc, sub2ind.cc, svd.cc,
syl.cc, time.cc, tril.cc, tsearch.cc: Update %!tests in DLD-FUNCTIONS/
directory with Octave coding conventions.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Tue, 27 Mar 2012 22:46:45 -0700 |
parents | b76f0740940e |
children |
line wrap: on
line source
/* Copyright (C) 2012 Iain Murray This file is part of Octave. Octave is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. Octave is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with Octave; see the file COPYING. If not, see <http://www.gnu.org/licenses/>. */ #ifdef HAVE_CONFIG_H #include <config.h> #endif #include "defun-dld.h" #include "nproc.h" DEFUN_DLD (nproc, args, nargout, "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {} nproc ()\n\ @deftypefnx {Loadable Function} {} nproc (@var{query})\n\ Return the current number of available processors.\n\ \n\ If called with the optional argument @var{query}, modify how processors\n\ are counted as follows:\n\ \n\ @table @code\n\ @item all\n\ total number of processors.\n\ \n\ @item current\n\ processors available to the current process.\n\ \n\ @item overridable\n\ likewise, but overridable through the @w{@env{OMP_NUM_THREADS}} environment\n\ variable.\n\ @end table\n\ @end deftypefn") { octave_value retval; int nargin = args.length (); if ((nargin != 0 && nargin != 1) || (nargout != 0 && nargout != 1)) { print_usage (); return retval; } nproc_query query = NPROC_CURRENT; if (nargin == 1) { std::string arg = args(0).string_value (); std::transform (arg.begin (), arg.end (), arg.begin (), tolower); if (arg == "all") query = NPROC_ALL; else if (arg == "current") query = NPROC_CURRENT; else if (arg == "overridable") query = NPROC_CURRENT_OVERRIDABLE; else { error ("nproc: invalid value for QUERY"); return retval; } } retval = num_processors (query); return retval; } /* ## Must always report at least 1 cpu available %!assert (nproc () >= 1); */