Mercurial > octave
changeset 31182:e217b44187a2 stable
doc: Clarify number of processors returned by "nproc" with hyperthreading.
* libinterp/corefcn/nproc.cc (Fnproc): Clarify that the number of processors
returned by this function might be higher than the number of physical cores
(for processors with hyperthreading).
See: https://octave.discourse.group/t/3121/20
| author | Markus Mützel <markus.muetzel@gmx.de> |
|---|---|
| date | Thu, 11 Aug 2022 09:36:52 +0200 |
| parents | 51311efef5dd |
| children | 932e43d948a6 84df79fb637d |
| files | libinterp/corefcn/nproc.cc |
| diffstat | 1 files changed, 4 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/libinterp/corefcn/nproc.cc Thu Aug 04 18:32:51 2022 +0200 +++ b/libinterp/corefcn/nproc.cc Thu Aug 11 09:36:52 2022 +0200 @@ -38,7 +38,10 @@ doc: /* -*- texinfo -*- @deftypefn {} {} nproc () @deftypefnx {} {} nproc (@var{query}) -Return the current number of available processors. +Return the current number of available (logical) processors. + +This returns the number of logical processors. For processors with +hyperthreading, this is larger than the number of physical cores. If called with the optional argument @var{query}, modify how processors are counted as follows: