comparison libinterp/corefcn/kron.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 aba2e6293dd8
children 278fc29b69ca
comparison
equal deleted inserted replaced
21965:da218a61ce4a 21966:112b20240c87
230 } 230 }
231 return retval; 231 return retval;
232 } 232 }
233 233
234 234
235 DEFUN (kron, args, , "-*- texinfo -*-\n\ 235 DEFUN (kron, args, ,
236 @deftypefn {} {} kron (@var{A}, @var{B})\n\ 236 doc: /* -*- texinfo -*-
237 @deftypefnx {} {} kron (@var{A1}, @var{A2}, @dots{})\n\ 237 @deftypefn {} {} kron (@var{A}, @var{B})
238 Form the Kronecker product of two or more matrices.\n\ 238 @deftypefnx {} {} kron (@var{A1}, @var{A2}, @dots{})
239 \n\ 239 Form the Kronecker product of two or more matrices.
240 This is defined block by block as\n\ 240
241 \n\ 241 This is defined block by block as
242 @example\n\ 242
243 x = [ a(i,j)*b ]\n\ 243 @example
244 @end example\n\ 244 x = [ a(i,j)*b ]
245 \n\ 245 @end example
246 For example:\n\ 246
247 \n\ 247 For example:
248 @example\n\ 248
249 @group\n\ 249 @example
250 kron (1:4, ones (3, 1))\n\ 250 @group
251 @result{} 1 2 3 4\n\ 251 kron (1:4, ones (3, 1))
252 1 2 3 4\n\ 252 @result{} 1 2 3 4
253 1 2 3 4\n\ 253 1 2 3 4
254 @end group\n\ 254 1 2 3 4
255 @end example\n\ 255 @end group
256 \n\ 256 @end example
257 If there are more than two input arguments @var{A1}, @var{A2}, @dots{},\n\ 257
258 @var{An} the Kronecker product is computed as\n\ 258 If there are more than two input arguments @var{A1}, @var{A2}, @dots{},
259 \n\ 259 @var{An} the Kronecker product is computed as
260 @example\n\ 260
261 kron (kron (@var{A1}, @var{A2}), @dots{}, @var{An})\n\ 261 @example
262 @end example\n\ 262 kron (kron (@var{A1}, @var{A2}), @dots{}, @var{An})
263 \n\ 263 @end example
264 @noindent\n\ 264
265 Since the Kronecker product is associative, this is well-defined.\n\ 265 @noindent
266 @end deftypefn") 266 Since the Kronecker product is associative, this is well-defined.
267 @end deftypefn */)
267 { 268 {
268 int nargin = args.length (); 269 int nargin = args.length ();
269 270
270 if (nargin < 2) 271 if (nargin < 2)
271 print_usage (); 272 print_usage ();