Mercurial > octave-antonio
view scripts/miscellaneous/computer.m @ 20164:df437a52bcaf stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed miscellaneous, sparse, strings in scripts directory.
* scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m,
scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m,
scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m,
scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m,
scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m,
scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m,
scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m,
scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m,
scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m,
scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m,
scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m,
scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m,
scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m,
scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m,
scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m,
scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m,
scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m,
scripts/sparse/treeplot.m, scripts/strings/base2dec.m,
scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m,
scripts/strings/deblank.m, scripts/strings/dec2base.m,
scripts/strings/dec2bin.m, scripts/strings/dec2hex.m,
scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m,
scripts/strings/isletter.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/ostrsplit.m,
scripts/strings/regexptranslate.m, scripts/strings/rindex.m,
scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m,
scripts/strings/strjoin.m, scripts/strings/strjust.m,
scripts/strings/strmatch.m, scripts/strings/strsplit.m,
scripts/strings/strtok.m, scripts/strings/strtrim.m,
scripts/strings/strtrunc.m, scripts/strings/substr.m,
scripts/strings/untabify.m, scripts/time/datenum.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 04 May 2015 14:22:02 -0700 |
parents | 4197fc428c7d |
children |
line wrap: on
line source
## Copyright (C) 2004-2015 John W. Eaton ## ## 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/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} computer () ## @deftypefnx {Function File} {@var{c} =} computer () ## @deftypefnx {Function File} {[@var{c}, @var{maxsize}] =} computer () ## @deftypefnx {Function File} {[@var{c}, @var{maxsize}, @var{endian}] =} computer () ## @deftypefnx {Function File} {@var{arch} =} computer ("arch") ## Print or return a string of the form @var{cpu}-@var{vendor}-@var{os} that ## identifies the type of computer that Octave is running on. ## ## If invoked with an output argument, the value is returned instead of ## printed. For example: ## ## @example ## @group ## computer () ## @print{} i586-pc-linux-gnu ## ## mycomp = computer () ## @result{} mycomp = "i586-pc-linux-gnu" ## @end group ## @end example ## ## If two output arguments are requested, also return the maximum number of ## elements for an array. This will depend on whether Octave has been ## compiled with 32-bit or 64-bit index vectors. ## ## If three output arguments are requested, also return the byte order of the ## current system as a character (@qcode{"B"} for big-endian or @qcode{"L"} ## for little-endian). ## ## If the argument @qcode{"arch"} is specified, return a string indicating the ## architecture of the computer on which Octave is running. ## @seealso{isunix, ismac, ispc} ## @end deftypefn function [c, maxsize, endian] = computer (a) if (nargin > 1) print_usage (); elseif (nargin == 1 && ! strcmpi (a, "arch")) error ('computer: "arch" is only valid argument'); endif if (nargin == 0) msg = octave_config_info ("canonical_host_type"); if (strcmp (msg, "unknown")) msg = "Hi Dave, I'm a HAL-9000"; endif if (nargout == 0) disp (msg); else c = msg; if (isargout (2)) if (strcmp (octave_config_info ("USE_64_BIT_IDX_T"), "true")) maxsize = 2^63-1; else maxsize = 2^31-1; endif endif if (isargout (3)) if (octave_config_info ("words_big_endian")) endian = "B"; elseif (octave_config_info ("words_little_endian")) endian = "L"; else endian = "?"; endif endif endif else ## "arch" argument asked for tmp = ostrsplit (octave_config_info ("canonical_host_type"), "-"); if (numel (tmp) == 4) c = sprintf ("%s-%s-%s", tmp{4}, tmp{3}, tmp{1}); else c = sprintf ("%s-%s", tmp{3}, tmp{1}); endif endif endfunction %!assert (ischar (computer ())) %!assert (computer (), octave_config_info ("canonical_host_type")) %!assert (ischar (computer ("arch"))) %!error computer (1,2) %!error <"arch" is only valid argument> computer ("xyz")