Mercurial > octave
view libinterp/corefcn/nproc.cc @ 30888:32d2b6604a9f
doc: Ensure documentation lists output argument when it exists for functions in libinterp/
For new users of Octave it is best to show explicit calling forms
in the documentation and to show a return argument when it exists.
* __ftp__.cc, __magick_read__.cc, __pchip_deriv__.cc, bitfcns.cc, bsxfun.cc,
call-stack.cc, cellfun.cc, chol.cc, conv2.cc, data.cc, debug.cc, defaults.cc,
det.cc, dirfns.cc, display.cc, dot.cc, error.cc, event-manager.cc, fft.cc,
fft2.cc, fftn.cc, file-io.cc, getgrent.cc, getpwent.cc, getrusage.cc,
graphics.cc, hash.cc, help.cc, input.cc, interpreter.cc, kron.cc, load-path.cc,
mappers.cc, max.cc, nproc.cc, oct-hist.cc, pager.cc, pinv.cc, psi.cc, rand.cc,
settings.cc, sighandlers.cc, stream-euler.cc, strfns.cc, symtab.cc,
syscalls.cc, sysdep.cc, time.cc, toplev.cc, utils.cc, variables.cc,
__fltk_uigetfile__.cc, audiodevinfo.cc, audioread.cc, fftw.cc, ov-bool-mat.cc,
ov-cell.cc, ov-class.cc, ov-classdef.cc, ov-fcn-handle.cc, ov-java.cc,
ov-struct.cc, ov-typeinfo.cc, ov-usr-fcn.cc, ov.cc, octave.cc, profiler.cc:
Add return arguments to @deftypefn macros where they were missing.
Attempt to use standard naming convention for return variables.
Occasionally improved the docstring itself by re-wording or adding code
examples.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 04 Apr 2022 10:31:48 -0700 |
parents | 796f54d4ddbf |
children | 932e43d948a6 |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 2012-2022 The Octave Project Developers // // See the file COPYRIGHT.md in the top-level directory of this // distribution or <https://octave.org/copyright/>. // // 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 // <https://www.gnu.org/licenses/>. // //////////////////////////////////////////////////////////////////////// #if defined (HAVE_CONFIG_H) # include "config.h" #endif #include "nproc-wrapper.h" #include "defun.h" #include "error.h" OCTAVE_NAMESPACE_BEGIN DEFUN (nproc, args, , doc: /* -*- texinfo -*- @deftypefn {} {@var{n} =} nproc () @deftypefnx {} {@var{n} =} nproc (@var{query}) Return the current number of available processors. If called with the optional argument @var{query}, modify how processors are counted as follows: @table @code @item all total number of processors. @item current processors available to the current process. @item overridable same as @code{current}, but overridable through the @w{@env{OMP_NUM_THREADS}} environment variable. @end table @end deftypefn */) { int nargin = args.length (); if (nargin > 1) print_usage (); octave_nproc_query query = OCTAVE_NPROC_CURRENT_OVERRIDABLE; if (nargin == 1) { std::string arg = args(0).string_value (); std::transform (arg.begin (), arg.end (), arg.begin (), tolower); if (arg == "all") query = OCTAVE_NPROC_ALL; else if (arg == "current") query = OCTAVE_NPROC_CURRENT; else if (arg == "overridable") query = OCTAVE_NPROC_CURRENT_OVERRIDABLE; else error ("nproc: invalid value for QUERY"); } return ovl (octave_num_processors_wrapper (query)); } /* ## Must always report at least 1 cpu available %!assert (nproc () >= 1) %!assert (nproc ("all") >= 1) %!assert (nproc ("current") >= 1) ## Test that "overridable" is the default %!assert (nproc ("overridable"), nproc ()) %!test %! c = nproc ("current"); %! unwind_protect %! old_val = getenv ("OMP_NUM_THREADS"); %! new_val = c + 1; %! setenv ("OMP_NUM_THREADS", num2str (new_val)); %! assert (nproc ("overridable"), new_val); %! unwind_protect_cleanup %! if (! isempty (old_val)) %! setenv ("OMP_NUM_THREADS", old_val); %! else %! unsetenv ("OMP_NUM_THREADS"); %! endif %! end_unwind_protect %!error nproc ("no_valid_option") */ OCTAVE_NAMESPACE_END