Mercurial > octave

comparison libinterp/octave-value/ov-cell.cc @ 21966:112b20240c87

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 aab79a1885cc
children 278fc29b69ca
comparison
equal deleted inserted replaced
21965:da218a61ce4a 21966:112b20240c87
1178 1178
1179 return retval; 1179 return retval;
1180 } 1180 }
1181 1181
1182 DEFUN (iscell, args, , 1182 DEFUN (iscell, args, ,
1183 "-*- texinfo -*-\n\ 1183 doc: /* -*- texinfo -*-
1184 @deftypefn {} {} iscell (@var{x})\n\ 1184 @deftypefn {} {} iscell (@var{x})
1185 Return true if @var{x} is a cell array object.\n\ 1185 Return true if @var{x} is a cell array object.
1186 @seealso{ismatrix, isstruct, iscellstr, isa}\n\ 1186 @seealso{ismatrix, isstruct, iscellstr, isa}
1187 @end deftypefn") 1187 @end deftypefn */)
1188 { 1188 {
1189 if (args.length () != 1) 1189 if (args.length () != 1)
1190 print_usage (); 1190 print_usage ();
1191 1191
1192 return ovl (args(0).is_cell ()); 1192 return ovl (args(0).is_cell ());
1193 } 1193 }
1194 1194
1195 DEFUN (cell, args, , 1195 DEFUN (cell, args, ,
1196 "-*- texinfo -*-\n\ 1196 doc: /* -*- texinfo -*-
1197 @deftypefn {} {} cell (@var{n})\n\ 1197 @deftypefn {} {} cell (@var{n})
1198 @deftypefnx {} {} cell (@var{m}, @var{n})\n\ 1198 @deftypefnx {} {} cell (@var{m}, @var{n})
1199 @deftypefnx {} {} cell (@var{m}, @var{n}, @var{k}, @dots{})\n\ 1199 @deftypefnx {} {} cell (@var{m}, @var{n}, @var{k}, @dots{})
1200 @deftypefnx {} {} cell ([@var{m} @var{n} @dots{}])\n\ 1200 @deftypefnx {} {} cell ([@var{m} @var{n} @dots{}])
1201 Create a new cell array object.\n\ 1201 Create a new cell array object.
1202 \n\ 1202
1203 If invoked with a single scalar integer argument, return a square\n\ 1203 If invoked with a single scalar integer argument, return a square
1204 @nospell{NxN} cell array. If invoked with two or more scalar integer\n\ 1204 @nospell{NxN} cell array. If invoked with two or more scalar integer
1205 arguments, or a vector of integer values, return an array with the given\n\ 1205 arguments, or a vector of integer values, return an array with the given
1206 dimensions.\n\ 1206 dimensions.
1207 @seealso{cellstr, mat2cell, num2cell, struct2cell}\n\ 1207 @seealso{cellstr, mat2cell, num2cell, struct2cell}
1208 @end deftypefn") 1208 @end deftypefn */)
1209 { 1209 {
1210 int nargin = args.length (); 1210 int nargin = args.length ();
1211 1211
1212 dim_vector dims; 1212 dim_vector dims;
1213 1213
1238 1238
1239 return ovl (Cell (dims, Matrix ())); 1239 return ovl (Cell (dims, Matrix ()));
1240 } 1240 }
1241 1241
1242 DEFUN (iscellstr, args, , 1242 DEFUN (iscellstr, args, ,
1243 "-*- texinfo -*-\n\ 1243 doc: /* -*- texinfo -*-
1244 @deftypefn {} {} iscellstr (@var{cell})\n\ 1244 @deftypefn {} {} iscellstr (@var{cell})
1245 Return true if every element of the cell array @var{cell} is a character\n\ 1245 Return true if every element of the cell array @var{cell} is a character
1246 string.\n\ 1246 string.
1247 @seealso{ischar}\n\ 1247 @seealso{ischar}
1248 @end deftypefn") 1248 @end deftypefn */)
1249 { 1249 {
1250 if (args.length () != 1) 1250 if (args.length () != 1)
1251 print_usage (); 1251 print_usage ();
1252 1252
1253 return ovl (args(0).is_cellstr ()); 1253 return ovl (args(0).is_cellstr ());
1257 // Fiscellstr defined first (to provide a declaration) and also we 1257 // Fiscellstr defined first (to provide a declaration) and also we
1258 // should keep it in the same file (so we don't have to provide a 1258 // should keep it in the same file (so we don't have to provide a
1259 // declaration) and so we don't have to use feval to call it. 1259 // declaration) and so we don't have to use feval to call it.
1260 1260
1261 DEFUN (cellstr, args, , 1261 DEFUN (cellstr, args, ,
1262 "-*- texinfo -*-\n\ 1262 doc: /* -*- texinfo -*-
1263 @deftypefn {} {@var{cstr} =} cellstr (@var{strmat})\n\ 1263 @deftypefn {} {@var{cstr} =} cellstr (@var{strmat})
1264 Create a new cell array object from the elements of the string array\n\ 1264 Create a new cell array object from the elements of the string array
1265 @var{strmat}.\n\ 1265 @var{strmat}.
1266 \n\ 1266
1267 Each row of @var{strmat} becomes an element of @var{cstr}. Any trailing\n\ 1267 Each row of @var{strmat} becomes an element of @var{cstr}. Any trailing
1268 spaces in a row are deleted before conversion.\n\ 1268 spaces in a row are deleted before conversion.
1269 \n\ 1269
1270 To convert back from a cellstr to a character array use @code{char}.\n\ 1270 To convert back from a cellstr to a character array use @code{char}.
1271 @seealso{cell, char}\n\ 1271 @seealso{cell, char}
1272 @end deftypefn") 1272 @end deftypefn */)
1273 { 1273 {
1274 if (args.length () != 1) 1274 if (args.length () != 1)
1275 print_usage (); 1275 print_usage ();
1276 1276
1277 octave_value_list tmp = Fiscellstr (args, 1); 1277 octave_value_list tmp = Fiscellstr (args, 1);
1286 : Cell (s, true)); 1286 : Cell (s, true));
1287 } 1287 }
1288 } 1288 }
1289 1289
1290 DEFUN (struct2cell, args, , 1290 DEFUN (struct2cell, args, ,
1291 "-*- texinfo -*-\n\ 1291 doc: /* -*- texinfo -*-
1292 @deftypefn {} {@var{c} =} struct2cell (@var{s})\n\ 1292 @deftypefn {} {@var{c} =} struct2cell (@var{s})
1293 Create a new cell array from the objects stored in the struct object.\n\ 1293 Create a new cell array from the objects stored in the struct object.
1294 \n\ 1294
1295 If @var{f} is the number of fields in the structure, the resulting cell\n\ 1295 If @var{f} is the number of fields in the structure, the resulting cell
1296 array will have a dimension vector corresponding to\n\ 1296 array will have a dimension vector corresponding to
1297 @code{[@var{f} size(@var{s})]}. For example:\n\ 1297 @code{[@var{f} size(@var{s})]}. For example:
1298 \n\ 1298
1299 @example\n\ 1299 @example
1300 @group\n\ 1300 @group
1301 s = struct (\"name\", @{\"Peter\", \"Hannah\", \"Robert\"@},\n\ 1301 s = struct ("name", @{"Peter", "Hannah", "Robert"@},
1302 \"age\", @{23, 16, 3@});\n\ 1302 "age", @{23, 16, 3@});
1303 c = struct2cell (s)\n\ 1303 c = struct2cell (s)
1304 @result{} c = @{2x1x3 Cell Array@}\n\ 1304 @result{} c = @{2x1x3 Cell Array@}
1305 c(1,1,:)(:)\n\ 1305 c(1,1,:)(:)
1306 @result{}\n\ 1306 @result{}
1307 @{\n\ 1307 @{
1308 [1,1] = Peter\n\ 1308 [1,1] = Peter
1309 [2,1] = Hannah\n\ 1309 [2,1] = Hannah
1310 [3,1] = Robert\n\ 1310 [3,1] = Robert
1311 @}\n\ 1311 @}
1312 c(2,1,:)(:)\n\ 1312 c(2,1,:)(:)
1313 @result{}\n\ 1313 @result{}
1314 @{\n\ 1314 @{
1315 [1,1] = 23\n\ 1315 [1,1] = 23
1316 [2,1] = 16\n\ 1316 [2,1] = 16
1317 [3,1] = 3\n\ 1317 [3,1] = 3
1318 @}\n\ 1318 @}
1319 @end group\n\ 1319 @end group
1320 @end example\n\ 1320 @end example
1321 \n\ 1321
1322 @seealso{cell2struct, fieldnames}\n\ 1322 @seealso{cell2struct, fieldnames}
1323 @end deftypefn") 1323 @end deftypefn */)
1324 { 1324 {
1325 if (args.length () != 1) 1325 if (args.length () != 1)
1326 print_usage (); 1326 print_usage ();
1327 1327
1328 const octave_map m = args(0).xmap_value ("struct2cell: argument S must be a structure"); 1328 const octave_map m = args(0).xmap_value ("struct2cell: argument S must be a structure");