Mercurial > octave
diff libinterp/corefcn/hex2num.cc @ 21966:112b20240c87
move docstrings in C++ files out of C strings and into comments
* __contourc__.cc, __dispatch__.cc, __dsearchn__.cc, __ichol__.cc,
__ilu__.cc, __lin_interpn__.cc, __luinc__.cc, __magick_read__.cc,
__pchip_deriv__.cc, __qp__.cc, balance.cc, besselj.cc, betainc.cc,
bitfcns.cc, bsxfun.cc, cellfun.cc, colloc.cc, conv2.cc, daspk.cc,
dasrt.cc, dassl.cc, data.cc, debug.cc, defaults.cc, det.cc, dirfns.cc,
dlmread.cc, dot.cc, eig.cc, ellipj.cc, error.cc, fft.cc, fft2.cc,
fftn.cc, file-io.cc, filter.cc, find.cc, gammainc.cc, gcd.cc,
getgrent.cc, getpwent.cc, getrusage.cc, givens.cc, graphics.cc,
hash.cc, help.cc, hess.cc, hex2num.cc, input.cc, inv.cc, kron.cc,
load-path.cc, load-save.cc, lookup.cc, ls-oct-text.cc, lsode.cc,
lu.cc, mappers.cc, matrix_type.cc, max.cc, mgorth.cc, nproc.cc,
oct-hist.cc, octave-link.cc, ordschur.cc, pager.cc, pinv.cc,
pr-output.cc, profiler.cc, psi.cc, pt-jit.cc, quad.cc, quadcc.cc,
qz.cc, rand.cc, rcond.cc, regexp.cc, schur.cc, sighandlers.cc,
sparse.cc, spparms.cc, sqrtm.cc, str2double.cc, strfind.cc, strfns.cc,
sub2ind.cc, svd.cc, sylvester.cc, symtab.cc, syscalls.cc, sysdep.cc,
time.cc, toplev.cc, tril.cc, tsearch.cc, typecast.cc, urlwrite.cc,
utils.cc, variables.cc, __delaunayn__.cc, __eigs__.cc,
__fltk_uigetfile__.cc, __glpk__.cc, __init_fltk__.cc,
__init_gnuplot__.cc, __osmesa_print__.cc, __voronoi__.cc, amd.cc,
audiodevinfo.cc, audioread.cc, ccolamd.cc, chol.cc, colamd.cc,
convhulln.cc, dmperm.cc, fftw.cc, qr.cc, symbfact.cc, symrcm.cc,
ov-base.cc, ov-bool-mat.cc, ov-cell.cc, ov-class.cc, ov-classdef.cc,
ov-fcn-handle.cc, ov-fcn-inline.cc, ov-flt-re-mat.cc, ov-int16.cc,
ov-int32.cc, ov-int64.cc, ov-int8.cc, ov-java.cc, ov-null-mat.cc,
ov-oncleanup.cc, ov-range.cc, ov-re-mat.cc, ov-struct.cc,
ov-typeinfo.cc, ov-uint16.cc, ov-uint32.cc, ov-uint64.cc, ov-uint8.cc,
ov-usr-fcn.cc, ov.cc, octave.cc, pt-arg-list.cc, pt-binop.cc,
pt-eval.cc, pt-mat.cc, lex.ll, oct-parse.in.yy:
Docstrings are now comments instead of C strings.
* build-aux/mk-opts.pl: Emit docstrings as comments instead of C
strings.
* DASPK-opts.in, LSODE-opts.in: Don't quote " in docstring fragments.
* builtins.h: Include builtin-defun-decls.h unconditionally.
* defun.h (DEFUN, DEFUNX, DEFCONSTFUN): Simply emit declaration.
(DEFALIAS): Always expand to nothing.
* defun-dld.h: No special macro expansions for MAKE_BUILTINS.
(DEFUN_DLD): Use FORWARD_DECLARE_FUN.
(DEFUNX_DLD): Use FORWARD_DECLARE_FUNX.
* defun-int.h: No special macro expansions for MAKE_BUILTINS.
(FORWARD_DECLARE_FUN, FORWARD_DECLARE_FUNX): New macros.
(DEFINE_FUN_INSTALLER_FUN): If compiling an Octave source file, pass
"external-doc" to DEFINE_FUNX_INSTALLER_FUN.
(DEFUN_INTERNAL, DEFCONSTFUN_INTERNAL, DEFUNX_INTERNAL,
DEFALIAS_INTERNAL): Delete.
* common.mk (move_if_change_rule): New macro.
(simple_move_if_change_rule): Define using move_if_change_rule.
* find-defun-files.sh (DEFUN_PATTERN): Update. Don't transform file
name extension to ".df".
* libinterp/mk-pkg-add, gendoc.pl: Operate directly on source files.
* mkbuiltins: New argument, SRCDIR. Operate directly on source files.
* mkdefs: Delete.
* libinterp/module.mk (BUILT_SOURCES): Update list to contain only
files included in other source files.
(GENERATED_MAKE_BUILTINS_INCS, DEF_FILES): Delete.
(LIBINTERP_BUILT_DISTFILES): Include $(OPT_HANDLERS) here.
(LIBINTERP_BUILT_NODISTFILES): Not here. Remove $(ALL_DEF_FILES from
the list.
(libinterp_EXTRA_DIST): Remove mkdefs from the list.
(FOUND_DEFUN_FILES): Rename from SRC_DEF_FILES.
(DLDFCN_DEFUN_FILES): Rename from DLDFCN_DEF_FILES.
(SRC_DEFUN_FILES): Rename from SRC_DEF_FILES.
(ALL_DEFUN_FILES): Rename from ALL_DEF_FILES.
(%.df: %.cc): Delete pattern rule.
(libinterp/build-env-features.cc, libinterp/builtins.cc,
libinterp/dldfcn/PKG_ADD): Use mv instead of move-if-change.
(libinterp/builtins.cc, libinterp/builtin-defun-decls.h):
Update mkbuiltins command.
($(srcdir)/libinterp/DOCSTRINGS): Update gendoc.pl command.
* liboctave/module.mk (BUILT_SOURCES): Don't include
liboctave-build-info.cc in the list.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Tue, 21 Jun 2016 16:07:51 -0400 |
parents | 6b4f6339df91 |
children | bac0d6f07a3e |
line wrap: on
line diff
--- a/libinterp/corefcn/hex2num.cc Tue Jun 21 13:08:25 2016 -0700 +++ b/libinterp/corefcn/hex2num.cc Tue Jun 21 16:07:51 2016 -0400 @@ -33,37 +33,37 @@ #include "utils.h" DEFUN (hex2num, args, , - "-*- texinfo -*-\n\ -@deftypefn {} {@var{n} =} hex2num (@var{s})\n\ -@deftypefnx {} {@var{n} =} hex2num (@var{s}, @var{class})\n\ -Typecast the 16 character hexadecimal character string to an IEEE 754\n\ -double precision number.\n\ -\n\ -If fewer than 16 characters are given the strings are right padded with\n\ -@qcode{'0'} characters.\n\ -\n\ -Given a string matrix, @code{hex2num} treats each row as a separate number.\n\ -\n\ -@example\n\ -@group\n\ -hex2num ([\"4005bf0a8b145769\"; \"4024000000000000\"])\n\ - @result{} [2.7183; 10.000]\n\ -@end group\n\ -@end example\n\ -\n\ -The optional argument @var{class} can be passed as the string\n\ -@qcode{\"single\"} to specify that the given string should be interpreted as\n\ -a single precision number. In this case, @var{s} should be an 8 character\n\ -hexadecimal string. For example:\n\ -\n\ -@example\n\ -@group\n\ -hex2num ([\"402df854\"; \"41200000\"], \"single\")\n\ - @result{} [2.7183; 10.000]\n\ -@end group\n\ -@end example\n\ -@seealso{num2hex, hex2dec, dec2hex}\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {@var{n} =} hex2num (@var{s}) +@deftypefnx {} {@var{n} =} hex2num (@var{s}, @var{class}) +Typecast the 16 character hexadecimal character string to an IEEE 754 +double precision number. + +If fewer than 16 characters are given the strings are right padded with +@qcode{'0'} characters. + +Given a string matrix, @code{hex2num} treats each row as a separate number. + +@example +@group +hex2num (["4005bf0a8b145769"; "4024000000000000"]) + @result{} [2.7183; 10.000] +@end group +@end example + +The optional argument @var{class} can be passed as the string +@qcode{"single"} to specify that the given string should be interpreted as +a single precision number. In this case, @var{s} should be an 8 character +hexadecimal string. For example: + +@example +@group +hex2num (["402df854"; "41200000"], "single") + @result{} [2.7183; 10.000] +@end group +@end example +@seealso{num2hex, hex2dec, dec2hex} +@end deftypefn */) { int nargin = args.length (); @@ -173,37 +173,37 @@ */ DEFUN (num2hex, args, , - "-*- texinfo -*-\n\ -@deftypefn {} {@var{s} =} num2hex (@var{n})\n\ -Typecast a double or single precision number or vector to a 8 or 16\n\ -character hexadecimal string of the IEEE 754 representation of the number.\n\ -\n\ -For example:\n\ -\n\ -@example\n\ -@group\n\ -num2hex ([-1, 1, e, Inf])\n\ -@result{} \"bff0000000000000\n\ - 3ff0000000000000\n\ - 4005bf0a8b145769\n\ - 7ff0000000000000\"\n\ -@end group\n\ -@end example\n\ -\n\ -If the argument @var{n} is a single precision number or vector, the returned\n\ -string has a length of 8. For example:\n\ -\n\ -@example\n\ -@group\n\ -num2hex (single ([-1, 1, e, Inf]))\n\ -@result{} \"bf800000\n\ - 3f800000\n\ - 402df854\n\ - 7f800000\"\n\ -@end group\n\ -@end example\n\ -@seealso{hex2num, hex2dec, dec2hex}\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {@var{s} =} num2hex (@var{n}) +Typecast a double or single precision number or vector to a 8 or 16 +character hexadecimal string of the IEEE 754 representation of the number. + +For example: + +@example +@group +num2hex ([-1, 1, e, Inf]) +@result{} "bff0000000000000 + 3ff0000000000000 + 4005bf0a8b145769 + 7ff0000000000000" +@end group +@end example + +If the argument @var{n} is a single precision number or vector, the returned +string has a length of 8. For example: + +@example +@group +num2hex (single ([-1, 1, e, Inf])) +@result{} "bf800000 + 3f800000 + 402df854 + 7f800000" +@end group +@end example +@seealso{hex2num, hex2dec, dec2hex} +@end deftypefn */) { if (args.length () != 1) print_usage ();