Mercurial > octave-nkf

comparison libinterp/corefcn/typecast.cc @ 20207:4f45eaf83908 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed libinterp/corefcn directory. * libinterp/corefcn/__ilu__.cc, libinterp/corefcn/balance.cc, libinterp/corefcn/besselj.cc, libinterp/corefcn/betainc.cc, libinterp/corefcn/bitfcns.cc, libinterp/corefcn/bsxfun.cc, libinterp/corefcn/cellfun.cc, libinterp/corefcn/colloc.cc, libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc, libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc, libinterp/corefcn/det.cc, libinterp/corefcn/dirfns.cc, libinterp/corefcn/dlmread.cc, libinterp/corefcn/dot.cc, libinterp/corefcn/eig.cc, libinterp/corefcn/error.cc, libinterp/corefcn/fft2.cc, libinterp/corefcn/fftn.cc, libinterp/corefcn/file-io.cc, libinterp/corefcn/filter.cc, libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc, libinterp/corefcn/gcd.cc, libinterp/corefcn/getgrent.cc, libinterp/corefcn/getpwent.cc, libinterp/corefcn/getrusage.cc, libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc, libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc, libinterp/corefcn/inv.cc, libinterp/corefcn/kron.cc, libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc, libinterp/corefcn/lookup.cc, libinterp/corefcn/ls-oct-ascii.cc, libinterp/corefcn/lsode.cc, libinterp/corefcn/lu.cc, libinterp/corefcn/luinc.cc, libinterp/corefcn/mappers.cc, libinterp/corefcn/matrix_type.cc, libinterp/corefcn/max.cc, libinterp/corefcn/md5sum.cc, libinterp/corefcn/mgorth.cc, libinterp/corefcn/nproc.cc, libinterp/corefcn/oct-hist.cc, libinterp/corefcn/ordschur.cc, libinterp/corefcn/pager.cc, libinterp/corefcn/pinv.cc, libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc, libinterp/corefcn/quad.cc, libinterp/corefcn/quadcc.cc, libinterp/corefcn/qz.cc, libinterp/corefcn/rand.cc, libinterp/corefcn/rcond.cc, libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc, libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc, libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc, libinterp/corefcn/strfind.cc, libinterp/corefcn/strfns.cc, libinterp/corefcn/sub2ind.cc, libinterp/corefcn/svd.cc, libinterp/corefcn/symtab.cc, libinterp/corefcn/syscalls.cc, libinterp/corefcn/sysdep.cc, libinterp/corefcn/time.cc, libinterp/corefcn/toplev.cc, libinterp/corefcn/tril.cc, libinterp/corefcn/tsearch.cc, libinterp/corefcn/typecast.cc, libinterp/corefcn/urlwrite.cc, libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc, scripts/polynomial/spline.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sat, 09 May 2015 17:19:30 -0700
parents 4197fc428c7d
children b2100e1659ac
comparison
equal deleted inserted replaced
20206:b70f8da6dcd3 20207:4f45eaf83908
89 89
90 90
91 DEFUN (typecast, args, , 91 DEFUN (typecast, args, ,
92 "-*- texinfo -*-\n\ 92 "-*- texinfo -*-\n\
93 @deftypefn {Built-in Function} {@var{y} =} typecast (@var{x}, \"@var{class}\")\n\ 93 @deftypefn {Built-in Function} {@var{y} =} typecast (@var{x}, \"@var{class}\")\n\
94 Return a new array @var{y} resulting from interpreting the data of\n\ 94 Return a new array @var{y} resulting from interpreting the data of @var{x}\n\
95 @var{x} in memory as data of the numeric class @var{class}.\n\ 95 in memory as data of the numeric class @var{class}.\n\
96 \n\ 96 \n\
97 Both the class of @var{x} and @var{class} must be one of the built-in\n\ 97 Both the class of @var{x} and @var{class} must be one of the built-in\n\
98 numeric classes:\n\ 98 numeric classes:\n\
99 \n\ 99 \n\
100 @example\n\ 100 @example\n\
115 \"single complex\"\n\ 115 \"single complex\"\n\
116 @end group\n\ 116 @end group\n\
117 @end example\n\ 117 @end example\n\
118 \n\ 118 \n\
119 @noindent\n\ 119 @noindent\n\
120 the last two are reserved for @var{class}; they indicate that a\n\ 120 the last two are only used with @var{class}; they indicate that a\n\
121 complex-valued result is requested. Complex arrays are stored in memory as\n\ 121 complex-valued result is requested. Complex arrays are stored in memory as\n\
122 consecutive pairs of real numbers. The sizes of integer types are given by\n\ 122 consecutive pairs of real numbers. The sizes of integer types are given by\n\
123 their bit counts. Both logical and char are typically one byte wide;\n\ 123 their bit counts. Both logical and char are typically one byte wide;\n\
124 however, this is not guaranteed by C++. If your system is IEEE conformant,\n\ 124 however, this is not guaranteed by C++. If your system is IEEE conformant,\n\
125 single and double will be 4 bytes and 8 bytes wide, respectively.\n\ 125 single and double will be 4 bytes and 8 bytes wide, respectively.\n\
126 @qcode{\"logical\"} is not allowed for @var{class}. If the input is a row\n\ 126 @qcode{\"logical\"} is not allowed for @var{class}.\n\
127 vector, the return value is a row vector, otherwise it is a column vector. \n\ 127 \n\
128 If the input is a row vector, the return value is a row vector, otherwise it\n\
129 is a column vector.\n\
130 \n\
128 If the bit length of @var{x} is not divisible by that of @var{class}, an\n\ 131 If the bit length of @var{x} is not divisible by that of @var{class}, an\n\
129 error occurs.\n\ 132 error occurs.\n\
130 \n\ 133 \n\
131 An example of the use of typecast on a little-endian machine is\n\ 134 An example of the use of typecast on a little-endian machine is\n\
132 \n\ 135 \n\
323 @end example\n\ 326 @end example\n\
324 \n\ 327 \n\
325 The number of elements of @var{x} should be divisible by the bit length of\n\ 328 The number of elements of @var{x} should be divisible by the bit length of\n\
326 @var{class}. If it is not, excess bits are discarded. Bits come in\n\ 329 @var{class}. If it is not, excess bits are discarded. Bits come in\n\
327 increasing order of significance, i.e., @code{x(1)} is bit 0, @code{x(2)} is\n\ 330 increasing order of significance, i.e., @code{x(1)} is bit 0, @code{x(2)} is\n\
328 bit 1, etc. The result is a row vector if @var{x} is a row vector, otherwise\n\ 331 bit 1, etc.\n\
329 it is a column vector.\n\ 332 \n\
333 The result is a row vector if @var{x} is a row vector, otherwise it is a\n\
334 column vector.\n\
330 @seealso{bitunpack, typecast}\n\ 335 @seealso{bitunpack, typecast}\n\
331 @end deftypefn") 336 @end deftypefn")
332 { 337 {
333 octave_value retval; 338 octave_value retval;
334 339