octave: libinterp/corefcn/sub2ind.cc annotate

annotate libinterp/corefcn/sub2ind.cc @ 31605:e88a07dec498 stable

maint: Use macros to begin/end C++ namespaces. * oct-conf-post-public.in.h: Define two macros (OCTAVE_BEGIN_NAMESPACE, OCTAVE_END_NAMESPACE) that can be used to start/end a namespace. * mk-opts.pl, build-env.h, build-env.in.cc, __betainc__.cc, __contourc__.cc, __dsearchn__.cc, __eigs__.cc, __expint__.cc, __ftp__.cc, __gammainc__.cc, __ichol__.cc, __ilu__.cc, __isprimelarge__.cc, __lin_interpn__.cc, __magick_read__.cc, __pchip_deriv__.cc, __qp__.cc, amd.cc, auto-shlib.cc, auto-shlib.h, balance.cc, base-text-renderer.cc, base-text-renderer.h, besselj.cc, bitfcns.cc, bsxfun.cc, c-file-ptr-stream.cc, c-file-ptr-stream.h, call-stack.cc, call-stack.h, ccolamd.cc, cellfun.cc, chol.cc, colamd.cc, colloc.cc, conv2.cc, daspk.cc, dasrt.cc, dassl.cc, data.cc, data.h, debug.cc, defaults.cc, defaults.h, defun-int.h, defun.cc, det.cc, dirfns.cc, display.cc, display.h, dlmread.cc, dmperm.cc, dot.cc, dynamic-ld.cc, dynamic-ld.h, eig.cc, ellipj.cc, environment.cc, environment.h, error.cc, error.h, errwarn.h, event-manager.cc, event-manager.h, event-queue.cc, event-queue.h, fcn-info.cc, fcn-info.h, fft.cc, fft2.cc, fftn.cc, file-io.cc, filter.cc, find.cc, ft-text-renderer.cc, ft-text-renderer.h, gcd.cc, getgrent.cc, getpwent.cc, getrusage.cc, givens.cc, gl-render.cc, gl-render.h, gl2ps-print.cc, gl2ps-print.h, graphics-toolkit.cc, graphics-toolkit.h, graphics.cc, graphics.in.h, gsvd.cc, gtk-manager.cc, gtk-manager.h, hash.cc, help.cc, help.h, hess.cc, hex2num.cc, hook-fcn.cc, hook-fcn.h, input.cc, input.h, interpreter-private.cc, interpreter-private.h, interpreter.cc, interpreter.h, inv.cc, jsondecode.cc, jsonencode.cc, kron.cc, latex-text-renderer.cc, latex-text-renderer.h, load-path.cc, load-path.h, load-save.cc, load-save.h, lookup.cc, ls-ascii-helper.cc, ls-ascii-helper.h, ls-oct-text.cc, ls-utils.cc, ls-utils.h, lsode.cc, lu.cc, mappers.cc, matrix_type.cc, max.cc, mex-private.h, mex.cc, mgorth.cc, nproc.cc, oct-fstrm.cc, oct-fstrm.h, oct-hdf5-types.cc, oct-hdf5-types.h, oct-hist.cc, oct-hist.h, oct-iostrm.cc, oct-iostrm.h, oct-opengl.h, oct-prcstrm.cc, oct-prcstrm.h, oct-procbuf.cc, oct-procbuf.h, oct-process.cc, oct-process.h, oct-stdstrm.h, oct-stream.cc, oct-stream.h, oct-strstrm.cc, oct-strstrm.h, oct-tex-lexer.in.ll, oct-tex-parser.yy, ordqz.cc, ordschur.cc, pager.cc, pager.h, pinv.cc, pow2.cc, pr-flt-fmt.cc, pr-output.cc, procstream.cc, procstream.h, psi.cc, qr.cc, quad.cc, quadcc.cc, qz.cc, rand.cc, rcond.cc, regexp.cc, schur.cc, settings.cc, settings.h, sighandlers.cc, sighandlers.h, sparse-xdiv.cc, sparse-xdiv.h, sparse-xpow.cc, sparse-xpow.h, sparse.cc, spparms.cc, sqrtm.cc, stack-frame.cc, stack-frame.h, stream-euler.cc, strfind.cc, strfns.cc, sub2ind.cc, svd.cc, sylvester.cc, symbfact.cc, syminfo.cc, syminfo.h, symrcm.cc, symrec.cc, symrec.h, symscope.cc, symscope.h, symtab.cc, symtab.h, syscalls.cc, sysdep.cc, sysdep.h, text-engine.cc, text-engine.h, text-renderer.cc, text-renderer.h, time.cc, toplev.cc, tril.cc, tsearch.cc, typecast.cc, url-handle-manager.cc, url-handle-manager.h, urlwrite.cc, utils.cc, utils.h, variables.cc, variables.h, xdiv.cc, xdiv.h, xnorm.cc, xnorm.h, xpow.cc, xpow.h, __delaunayn__.cc, __fltk_uigetfile__.cc, __glpk__.cc, __init_fltk__.cc, __init_gnuplot__.cc, __ode15__.cc, __voronoi__.cc, audiodevinfo.cc, audioread.cc, convhulln.cc, fftw.cc, gzip.cc, mk-build-env-features.sh, mk-builtins.pl, cdef-class.cc, cdef-class.h, cdef-fwd.h, cdef-manager.cc, cdef-manager.h, cdef-method.cc, cdef-method.h, cdef-object.cc, cdef-object.h, cdef-package.cc, cdef-package.h, cdef-property.cc, cdef-property.h, cdef-utils.cc, cdef-utils.h, ov-base.cc, ov-base.h, ov-bool-mat.cc, ov-builtin.h, ov-cell.cc, ov-class.cc, ov-class.h, ov-classdef.cc, ov-classdef.h, ov-complex.cc, ov-fcn-handle.cc, ov-fcn-handle.h, ov-fcn.h, ov-java.cc, ov-java.h, ov-mex-fcn.h, ov-null-mat.cc, ov-oncleanup.cc, ov-struct.cc, ov-typeinfo.cc, ov-typeinfo.h, ov-usr-fcn.cc, ov-usr-fcn.h, ov.cc, ov.h, octave.cc, octave.h, mk-ops.sh, op-b-b.cc, op-b-bm.cc, op-b-sbm.cc, op-bm-b.cc, op-bm-bm.cc, op-bm-sbm.cc, op-cdm-cdm.cc, op-cell.cc, op-chm.cc, op-class.cc, op-cm-cm.cc, op-cm-cs.cc, op-cm-m.cc, op-cm-s.cc, op-cm-scm.cc, op-cm-sm.cc, op-cs-cm.cc, op-cs-cs.cc, op-cs-m.cc, op-cs-s.cc, op-cs-scm.cc, op-cs-sm.cc, op-dm-dm.cc, op-dm-scm.cc, op-dm-sm.cc, op-dm-template.cc, op-dms-template.cc, op-fcdm-fcdm.cc, op-fcm-fcm.cc, op-fcm-fcs.cc, op-fcm-fm.cc, op-fcm-fs.cc, op-fcn.cc, op-fcs-fcm.cc, op-fcs-fcs.cc, op-fcs-fm.cc, op-fcs-fs.cc, op-fdm-fdm.cc, op-fm-fcm.cc, op-fm-fcs.cc, op-fm-fm.cc, op-fm-fs.cc, op-fs-fcm.cc, op-fs-fcs.cc, op-fs-fm.cc, op-fs-fs.cc, op-i16-i16.cc, op-i32-i32.cc, op-i64-i64.cc, op-i8-i8.cc, op-int-concat.cc, op-m-cm.cc, op-m-cs.cc, op-m-m.cc, op-m-s.cc, op-m-scm.cc, op-m-sm.cc, op-mi.cc, op-pm-pm.cc, op-pm-scm.cc, op-pm-sm.cc, op-pm-template.cc, op-range.cc, op-s-cm.cc, op-s-cs.cc, op-s-m.cc, op-s-s.cc, op-s-scm.cc, op-s-sm.cc, op-sbm-b.cc, op-sbm-bm.cc, op-sbm-sbm.cc, op-scm-cm.cc, op-scm-cs.cc, op-scm-m.cc, op-scm-s.cc, op-scm-scm.cc, op-scm-sm.cc, op-sm-cm.cc, op-sm-cs.cc, op-sm-m.cc, op-sm-s.cc, op-sm-scm.cc, op-sm-sm.cc, op-str-m.cc, op-str-s.cc, op-str-str.cc, op-struct.cc, op-ui16-ui16.cc, op-ui32-ui32.cc, op-ui64-ui64.cc, op-ui8-ui8.cc, ops.h, anon-fcn-validator.cc, anon-fcn-validator.h, bp-table.cc, bp-table.h, comment-list.cc, comment-list.h, filepos.h, lex.h, lex.ll, oct-lvalue.cc, oct-lvalue.h, oct-parse.yy, parse.h, profiler.cc, profiler.h, pt-anon-scopes.cc, pt-anon-scopes.h, pt-arg-list.cc, pt-arg-list.h, pt-args-block.cc, pt-args-block.h, pt-array-list.cc, pt-array-list.h, pt-assign.cc, pt-assign.h, pt-binop.cc, pt-binop.h, pt-bp.cc, pt-bp.h, pt-cbinop.cc, pt-cbinop.h, pt-cell.cc, pt-cell.h, pt-check.cc, pt-check.h, pt-classdef.cc, pt-classdef.h, pt-cmd.h, pt-colon.cc, pt-colon.h, pt-const.cc, pt-const.h, pt-decl.cc, pt-decl.h, pt-eval.cc, pt-eval.h, pt-except.cc, pt-except.h, pt-exp.cc, pt-exp.h, pt-fcn-handle.cc, pt-fcn-handle.h, pt-id.cc, pt-id.h, pt-idx.cc, pt-idx.h, pt-jump.h, pt-loop.cc, pt-loop.h, pt-mat.cc, pt-mat.h, pt-misc.cc, pt-misc.h, pt-pr-code.cc, pt-pr-code.h, pt-select.cc, pt-select.h, pt-spmd.cc, pt-spmd.h, pt-stmt.cc, pt-stmt.h, pt-tm-const.cc, pt-tm-const.h, pt-unop.cc, pt-unop.h, pt-vm-eval.cc, pt-walk.cc, pt-walk.h, pt.cc, pt.h, token.cc, token.h, Range.cc, Range.h, idx-vector.cc, idx-vector.h, range-fwd.h, CollocWt.cc, CollocWt.h, aepbalance.cc, aepbalance.h, chol.cc, chol.h, gepbalance.cc, gepbalance.h, gsvd.cc, gsvd.h, hess.cc, hess.h, lo-mappers.cc, lo-mappers.h, lo-specfun.cc, lo-specfun.h, lu.cc, lu.h, oct-convn.cc, oct-convn.h, oct-fftw.cc, oct-fftw.h, oct-norm.cc, oct-norm.h, oct-rand.cc, oct-rand.h, oct-spparms.cc, oct-spparms.h, qr.cc, qr.h, qrp.cc, qrp.h, randgamma.cc, randgamma.h, randmtzig.cc, randmtzig.h, randpoisson.cc, randpoisson.h, schur.cc, schur.h, sparse-chol.cc, sparse-chol.h, sparse-lu.cc, sparse-lu.h, sparse-qr.cc, sparse-qr.h, svd.cc, svd.h, child-list.cc, child-list.h, dir-ops.cc, dir-ops.h, file-ops.cc, file-ops.h, file-stat.cc, file-stat.h, lo-sysdep.cc, lo-sysdep.h, lo-sysinfo.cc, lo-sysinfo.h, mach-info.cc, mach-info.h, oct-env.cc, oct-env.h, oct-group.cc, oct-group.h, oct-password.cc, oct-password.h, oct-syscalls.cc, oct-syscalls.h, oct-time.cc, oct-time.h, oct-uname.cc, oct-uname.h, action-container.cc, action-container.h, base-list.h, cmd-edit.cc, cmd-edit.h, cmd-hist.cc, cmd-hist.h, f77-fcn.h, file-info.cc, file-info.h, lo-array-errwarn.cc, lo-array-errwarn.h, lo-hash.cc, lo-hash.h, lo-ieee.h, lo-regexp.cc, lo-regexp.h, lo-utils.cc, lo-utils.h, oct-base64.cc, oct-base64.h, oct-glob.cc, oct-glob.h, oct-inttypes.h, oct-mutex.cc, oct-mutex.h, oct-refcount.h, oct-shlib.cc, oct-shlib.h, oct-sparse.cc, oct-sparse.h, oct-string.h, octave-preserve-stream-state.h, pathsearch.cc, pathsearch.h, quit.cc, quit.h, unwind-prot.cc, unwind-prot.h, url-transfer.cc, url-transfer.h : Use new macros to begin/end C++ namespaces.

author	Rik <rik@octave.org>
date	Thu, 01 Dec 2022 14:23:45 -0800
parents	972959edc3ff
children	597f3ee61a48

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ////////////////////////////////////////////////////////////////////////
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 //
30564 796f54d4ddbf update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 29961 diff changeset	3 // Copyright (C) 2009-2022 The Octave Project Developers
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	4 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	7 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	9 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	14 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	19 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ////////////////////////////////////////////////////////////////////////
9479 d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	25
21724 aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef" John W. Eaton <jwe@octave.org> parents: 21660 diff changeset	26 #if defined (HAVE_CONFIG_H)
21301 40de9f8f23a6 Use '#include "config.h"' rather than <config.h>. Rik <rik@octave.org> parents: 21200 diff changeset	27 # include "config.h"
9479 d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	28 #endif
d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	29
30902 972959edc3ff Allow sub2ind() to accept indices outside the size of the input subscripts (bug #62184) John W. Eaton <jwe@octave.org> parents: 30866 diff changeset	30 #include <utility>
972959edc3ff Allow sub2ind() to accept indices outside the size of the input subscripts (bug #62184) John W. Eaton <jwe@octave.org> parents: 30866 diff changeset	31
19269 65554f5847ac don't include oct-locbuf.h in header files unnecessarily John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	32 #include "Array-util.h"
65554f5847ac don't include oct-locbuf.h in header files unnecessarily John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	33 #include "oct-locbuf.h"
9479 d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	34 #include "quit.h"
d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	35
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14501 diff changeset	36 #include "defun.h"
9479 d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	37 #include "error.h"
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21055 diff changeset	38 #include "errwarn.h"
20940 48b2ad5ee801 maint: Rename oct-obj.[cc\|h] to ovl.[cc\|h] for clarity. Rik <rik@octave.org> parents: 20939 diff changeset	39 #include "ovl.h"
9479 d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	40
31605 e88a07dec498 maint: Use macros to begin/end C++ namespaces. Rik <rik@octave.org> parents: 30902 diff changeset	41 OCTAVE_BEGIN_NAMESPACE(octave)
9479 d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	42
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11570 diff changeset	43 static dim_vector
10258 e317791645c4 64-bit fixes John W. Eaton <jwe@octave.org> parents: 9666 diff changeset	44 get_dim_vector (const octave_value& val, const char *name)
9479 d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	45 {
d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	46 RowVector dimsv = val.row_vector_value (false, true);
d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	47 dim_vector dv;
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20172 diff changeset	48 octave_idx_type n = dimsv.numel ();
9479 d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	49
9666 a531dec450c4 allow 1D case for sub2ind and ind2sub Jaroslav Hajek <highegg@gmail.com> parents: 9479 diff changeset	50 if (n < 1)
12483 7a5aacf65f81 Rewrite error strings in src/ to use variables named in documentation. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	51 error ("%s: dimension vector DIMS must not be empty", name);
21055 5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20956 diff changeset	52
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20956 diff changeset	53 dv.resize (std::max (n, static_cast<octave_idx_type> (2)));
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20956 diff changeset	54 dv(1) = 1;
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20956 diff changeset	55 for (octave_idx_type i = 0; i < n; i++)
9479 d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	56 {
21055 5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20956 diff changeset	57 octave_idx_type ii = dimsv(i);
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20956 diff changeset	58 if (ii == dimsv(i) && ii >= 0)
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20956 diff changeset	59 dv(i) = ii;
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20956 diff changeset	60 else
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20956 diff changeset	61 error ("%s: dimension vector DIMS must contain integers", name);
9479 d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	62 }
d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	63
d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	64 return dv;
d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	65 }
d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	66
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14501 diff changeset	67 DEFUN (sub2ind, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	68 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	69 @deftypefn {} {@var{ind} =} sub2ind (@var{dims}, @var{i}, @var{j})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	70 @deftypefnx {} {@var{ind} =} sub2ind (@var{dims}, @var{s1}, @var{s2}, @dots{}, @var{sN})
22086 67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	71 Convert subscripts to linear indices.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	72
22850 5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	73 The input @var{dims} is a dimension vector where each element is the size of
28961 d9d028b479ac doc: Use @code{} within alternate text for @xref,@pxref macros in libinterp/ Rik <rik@octave.org> parents: 28907 diff changeset	74 the array in the respective dimension (@pxref{XREFsize,,@code{size}}). The
d9d028b479ac doc: Use @code{} within alternate text for @xref,@pxref macros in libinterp/ Rik <rik@octave.org> parents: 28907 diff changeset	75 remaining inputs are scalars or vectors of subscripts to be converted.
22850 5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	76
5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	77 The output vector @var{ind} contains the converted linear indices.
5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	78
5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	79 Background: Array elements can be specified either by a linear index which
5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	80 starts at 1 and runs through the number of elements in the array, or they may
5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	81 be specified with subscripts for the row, column, page, etc. The functions
5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	82 @code{ind2sub} and @code{sub2ind} interconvert between the two forms.
5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	83
5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	84 The linear index traverses dimension 1 (rows), then dimension 2 (columns), then
23565 3a730821e4a2 doc: Peridoc grammarcheck of documentation. Rik <rik@octave.org> parents: 23220 diff changeset	85 dimension 3 (pages), etc.@: until it has numbered all of the elements.
3a730821e4a2 doc: Peridoc grammarcheck of documentation. Rik <rik@octave.org> parents: 23220 diff changeset	86 Consider the following 3-by-3 matrices:
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	87
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	88 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	89 @group
22086 67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	90 [(1,1), (1,2), (1,3)] [1, 4, 7]
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	91 [(2,1), (2,2), (2,3)] ==> [2, 5, 8]
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	92 [(3,1), (3,2), (3,3)] [3, 6, 9]
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	93 @end group
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	94 @end example
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	95
22850 5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	96 @noindent
5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	97 The left matrix contains the subscript tuples for each matrix element. The
5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	98 right matrix shows the linear indices for the same matrix.
5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	99
22086 67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	100 The following example shows how to convert the two-dimensional indices
22850 5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	101 @code{(2,1)} and @code{(2,3)} of a 3-by-3 matrix to linear indices with a
5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	102 single call to @code{sub2ind}.
22086 67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	103
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	104 @example
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	105 @group
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	106 s1 = [2, 2];
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	107 s2 = [1, 3];
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	108 ind = sub2ind ([3, 3], s1, s2)
22851 6eb581b597bc doc: Add missing change from cset 5e111d533c99 Rik <rik@octave.org> parents: 22850 diff changeset	109 @result{} ind = 2 8
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	110 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	111 @end example
22850 5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	112 @seealso{ind2sub, size}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	113 @end deftypefn */)
9479 d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	114 {
d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	115 int nargin = args.length ();
d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	116
9666 a531dec450c4 allow 1D case for sub2ind and ind2sub Jaroslav Hajek <highegg@gmail.com> parents: 9479 diff changeset	117 if (nargin < 2)
9479 d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	118 print_usage ();
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20795 diff changeset	119
28004 403df0b32204 update out_of_range error messages John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	120 dim_vector dv = get_dim_vector (args(0), "sub2ind");
403df0b32204 update out_of_range error messages John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	121
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	122 Array<idx_vector> idxa (dim_vector (nargin-1, 1));
9479 d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	123
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20795 diff changeset	124 for (int j = 0; j < nargin - 1; j++)
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20795 diff changeset	125 {
23586 f6c5db0a02e7 maint: Deprecate is_numeric_type and replace with isnumeric. Rik <rik@octave.org> parents: 23565 diff changeset	126 if (! args(j+1).isnumeric ())
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	127 error ("sub2ind: subscripts must be numeric");
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	128
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	129 try
9479 d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	130 {
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	131 idxa(j) = args(j+1).index_vector ();
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	132
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	133 if (j > 0 && args(j+1).dims () != args(1).dims ())
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	134 error ("sub2ind: all subscripts must be of the same size");
9479 d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	135 }
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	136 catch (index_exception& ie)
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	137 {
29163 8f67ad8b3103 maint: Updating naming conventions for exceptions and use const where possible. Rik <rik@octave.org> parents: 28961 diff changeset	138 ie.set_pos_if_unset (nargin-1, j+1);
8f67ad8b3103 maint: Updating naming conventions for exceptions and use const where possible. Rik <rik@octave.org> parents: 28961 diff changeset	139 ie.set_var ();
8f67ad8b3103 maint: Updating naming conventions for exceptions and use const where possible. Rik <rik@octave.org> parents: 28961 diff changeset	140 std::string msg = ie.message ();
8f67ad8b3103 maint: Updating naming conventions for exceptions and use const where possible. Rik <rik@octave.org> parents: 28961 diff changeset	141 error_with_id (ie.err_id (), "%s", msg.c_str ());
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	142 }
9479 d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	143 }
d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	144
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	145 return ovl (sub2ind (dv, idxa));
9479 d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	146 }
d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	147
d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	148 /*
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	149 ## Test evaluation
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	150 %!test
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	151 %! s1 = [ 1 1 1 1 ; 2 2 2 2 ];
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	152 %! s2 = [ 1 1 2 2 ; 1 1 2 2 ];
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	153 %! s3 = [ 1 2 1 2 ; 1 2 1 2 ];
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	154 %! in = [ 1 101 11 111 ; 2 102 12 112 ];
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	155 %! assert (sub2ind ([10 10 10], s1, s2, s3), in);
9479 d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	156
d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	157 # Test low index
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	158 %!assert (sub2ind ([10 10 10], 1, 1, 1), 1)
20542 dd6345fd8a97 use exceptions for better invalid index error reporting (bug #45957) Lachlan Andrew <lachlanbis@gmail.com> parents: 20232 diff changeset	159 %!error <index \(0,_,_\)> sub2ind ([10 10 10], 0, 1, 1)
dd6345fd8a97 use exceptions for better invalid index error reporting (bug #45957) Lachlan Andrew <lachlanbis@gmail.com> parents: 20232 diff changeset	160 %!error <index \(_,0,_\)> sub2ind ([10 10 10], 1, 0, 1)
dd6345fd8a97 use exceptions for better invalid index error reporting (bug #45957) Lachlan Andrew <lachlanbis@gmail.com> parents: 20232 diff changeset	161 %!error <index \(_,_,0\)> sub2ind ([10 10 10], 1, 1, 0)
9479 d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	162
d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	163 # Test high index
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	164 %!assert (sub2ind ([10 10 10], 10, 10, 10), 1000)
20795 ba2367658dc8 Use ':' rather than ';' in error messages from bad indexing (bug #46536). Rik <rik@octave.org> parents: 20715 diff changeset	165 %!error <index \(11,_,_\): out of bound 10> sub2ind ([10 10 10], 11, 10, 10)
ba2367658dc8 Use ':' rather than ';' in error messages from bad indexing (bug #46536). Rik <rik@octave.org> parents: 20715 diff changeset	166 %!error <index \(_,11,_\): out of bound 10> sub2ind ([10 10 10], 10, 11, 10)
ba2367658dc8 Use ':' rather than ';' in error messages from bad indexing (bug #46536). Rik <rik@octave.org> parents: 20715 diff changeset	167 %!error <index \(_,_,11\): out of bound 10> sub2ind ([10 10 10], 10, 10, 11)
9479 d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	168
d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	169 # Test high index in the trailing dimensions
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	170 %!assert (sub2ind ([10, 1], 2, 1, 1), 2)
20795 ba2367658dc8 Use ':' rather than ';' in error messages from bad indexing (bug #46536). Rik <rik@octave.org> parents: 20715 diff changeset	171 %!error <index \(_,2,_\): out of bound 1> sub2ind ([10, 1], 1, 2, 1)
ba2367658dc8 Use ':' rather than ';' in error messages from bad indexing (bug #46536). Rik <rik@octave.org> parents: 20715 diff changeset	172 %!error <index \(_,_,2\): out of bound 1> sub2ind ([10, 1], 1, 1, 2)
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	173 %!assert (sub2ind ([10 10], 2, 2, 1), 12)
20795 ba2367658dc8 Use ':' rather than ';' in error messages from bad indexing (bug #46536). Rik <rik@octave.org> parents: 20715 diff changeset	174 %!error <index \(_,_,2\): out of bound 1> sub2ind ([10 10], 2, 1, 2)
ba2367658dc8 Use ':' rather than ';' in error messages from bad indexing (bug #46536). Rik <rik@octave.org> parents: 20715 diff changeset	175 %!error <index \(_,_,2\): out of bound 1> sub2ind ([10 10], 1, 2, 2)
9479 d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	176
d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	177 # Test handling of empty arguments
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	178 %!assert (sub2ind ([10 10], zeros (0,0), zeros (0,0)), zeros (0,0))
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	179 %!assert (sub2ind ([10 10], zeros (2,0), zeros (2,0)), zeros (2,0))
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	180 %!assert (sub2ind ([10 10], zeros (0,2), zeros (0,2)), zeros (0,2))
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	181 %!error <all subscripts .* same size> sub2ind ([10 10 10], zeros (0,2), zeros (2,0))
9479 d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	182
d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	183 # Test handling of arguments of different size
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	184 %!error <all subscripts .* same size> sub2ind ([10 10], ones (1,2), ones (1,3))
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	185 %!error <all subscripts .* same size> sub2ind ([10 10], ones (1,2), ones (2,1))
9479 d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	186
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	187 ## Test input validation
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14360 diff changeset	188 %!error <dimension vector> sub2ind ([10 10.5], 1, 1)
20542 dd6345fd8a97 use exceptions for better invalid index error reporting (bug #45957) Lachlan Andrew <lachlanbis@gmail.com> parents: 20232 diff changeset	189 %!error <index \(1.5,_\)> sub2ind ([10 10], 1.5, 1)
dd6345fd8a97 use exceptions for better invalid index error reporting (bug #45957) Lachlan Andrew <lachlanbis@gmail.com> parents: 20232 diff changeset	190 %!error <index \(_,1.5\)> sub2ind ([10 10], 1, 1.5)
9479 d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	191 */
d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	192
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14501 diff changeset	193 DEFUN (ind2sub, args, nargout,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	194 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	195 @deftypefn {} {[@var{s1}, @var{s2}, @dots{}, @var{sN}] =} ind2sub (@var{dims}, @var{ind})
22086 67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	196 Convert linear indices to subscripts.
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	197
22850 5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	198 The input @var{dims} is a dimension vector where each element is the size of
28961 d9d028b479ac doc: Use @code{} within alternate text for @xref,@pxref macros in libinterp/ Rik <rik@octave.org> parents: 28907 diff changeset	199 the array in the respective dimension (@pxref{XREFsize,,@code{size}}). The
30866 a8d61c30f41a doc: Update copy&paste error in documentation for ind2sub. Rik <rik@octave.org> parents: 30564 diff changeset	200 second input @var{ind} contains linear indices to be converted.
22850 5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	201
5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	202 The outputs @var{s1}, @dots{}, @var{sN} contain the converted subscripts.
5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	203
5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	204 Background: Array elements can be specified either by a linear index which
5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	205 starts at 1 and runs through the number of elements in the array, or they may
5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	206 be specified with subscripts for the row, column, page, etc. The functions
5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	207 @code{ind2sub} and @code{sub2ind} interconvert between the two forms.
5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	208
5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	209 The linear index traverses dimension 1 (rows), then dimension 2 (columns), then
23565 3a730821e4a2 doc: Peridoc grammarcheck of documentation. Rik <rik@octave.org> parents: 23220 diff changeset	210 dimension 3 (pages), etc.@: until it has numbered all of the elements.
3a730821e4a2 doc: Peridoc grammarcheck of documentation. Rik <rik@octave.org> parents: 23220 diff changeset	211 Consider the following 3-by-3 matrices:
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	212
22086 67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	213 @example
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	214 @group
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	215 [1, 4, 7] [(1,1), (1,2), (1,3)]
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	216 [2, 5, 8] ==> [(2,1), (2,2), (2,3)]
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	217 [3, 6, 9] [(3,1), (3,2), (3,3)]
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	218 @end group
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	219 @end example
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	220
22850 5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	221 @noindent
5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	222 The left matrix contains the linear indices for each matrix element. The right
5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	223 matrix shows the subscript tuples for the same matrix.
5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	224
5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	225 The following example shows how to convert the linear indices @code{2} and
30866 a8d61c30f41a doc: Update copy&paste error in documentation for ind2sub. Rik <rik@octave.org> parents: 30564 diff changeset	226 @code{8} to appropriate subscripts of a 3-by-3 matrix.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	227
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	228 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	229 @group
22086 67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	230 ind = [2, 8];
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	231 [r, c] = ind2sub ([3, 3], ind)
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	232 @result{} r = 2 2
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	233 @result{} c = 1 3
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	234 @end group
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	235 @end example
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	236
22850 5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	237 If the number of output subscripts exceeds the number of dimensions, the
5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	238 exceeded dimensions are set to @code{1}. On the other hand, if fewer
5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	239 subscripts than dimensions are provided, the exceeding dimensions are merged
5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	240 into the final requested dimension. For clarity, consider the following
5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	241 examples:
22086 67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	242
23200 895b8edb4f3c doc: Fix build of docs broken in sub2ind (bug #50348). Ernst Reissner <rei3ner@arcor.de> parents: 23083 diff changeset	243 @example
22086 67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	244 @group
22850 5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	245 ind = [2, 8];
22086 67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	246 dims = [3, 3];
22850 5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	247 ## same as dims = [3, 3, 1]
22086 67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	248 [r, c, s] = ind2sub (dims, ind)
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	249 @result{} r = 2 2
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	250 @result{} c = 1 3
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	251 @result{} s = 1 1
22850 5e111d533c99 doc: Rewrite docstrings for sub2ind and ind2sub. Rik <rik@octave.org> parents: 22407 diff changeset	252 ## same as dims = [9]
22086 67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	253 r = ind2sub (dims, ind)
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	254 @result{} r = 2 8
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	255 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	256 @end example
29824 6e42c37fbc8a ind2sub: Fix typo in "see also" section of docstring (bug #60842). Markus Mützel <markus.muetzel@gmx.de> parents: 29358 diff changeset	257 @seealso{sub2ind, size}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	258 @end deftypefn */)
9479 d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	259 {
20819 f428cbe7576f eliminate unnecessary uses of nargin John W. Eaton <jwe@octave.org> parents: 20801 diff changeset	260 if (args.length () != 2)
9479 d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	261 print_usage ();
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20795 diff changeset	262
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	263 octave_value_list retval;
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20853 diff changeset	264
30902 972959edc3ff Allow sub2ind() to accept indices outside the size of the input subscripts (bug #62184) John W. Eaton <jwe@octave.org> parents: 30866 diff changeset	265 int nd = (nargout == 0) ? 1 : nargout;
972959edc3ff Allow sub2ind() to accept indices outside the size of the input subscripts (bug #62184) John W. Eaton <jwe@octave.org> parents: 30866 diff changeset	266
22086 67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	267 dim_vector dv = get_dim_vector (args(0), "ind2sub").redim (nargout);
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	268
30902 972959edc3ff Allow sub2ind() to accept indices outside the size of the input subscripts (bug #62184) John W. Eaton <jwe@octave.org> parents: 30866 diff changeset	269 // Redim for 1 will give us a column vector but we want a row vector.
972959edc3ff Allow sub2ind() to accept indices outside the size of the input subscripts (bug #62184) John W. Eaton <jwe@octave.org> parents: 30866 diff changeset	270 if (nd == 1)
972959edc3ff Allow sub2ind() to accept indices outside the size of the input subscripts (bug #62184) John W. Eaton <jwe@octave.org> parents: 30866 diff changeset	271 std::swap (dv(0), dv(1));
972959edc3ff Allow sub2ind() to accept indices outside the size of the input subscripts (bug #62184) John W. Eaton <jwe@octave.org> parents: 30866 diff changeset	272
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20795 diff changeset	273 try
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20795 diff changeset	274 {
22086 67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	275 retval = Array<octave_value> (ind2sub (dv, args(1).index_vector ()));
30902 972959edc3ff Allow sub2ind() to accept indices outside the size of the input subscripts (bug #62184) John W. Eaton <jwe@octave.org> parents: 30866 diff changeset	276
972959edc3ff Allow sub2ind() to accept indices outside the size of the input subscripts (bug #62184) John W. Eaton <jwe@octave.org> parents: 30866 diff changeset	277 if (nd == 1)
972959edc3ff Allow sub2ind() to accept indices outside the size of the input subscripts (bug #62184) John W. Eaton <jwe@octave.org> parents: 30866 diff changeset	278 retval(0) = retval(1);
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20795 diff changeset	279 }
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	280 catch (const index_exception& ie)
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20795 diff changeset	281 {
29163 8f67ad8b3103 maint: Updating naming conventions for exceptions and use const where possible. Rik <rik@octave.org> parents: 28961 diff changeset	282 error ("ind2sub: invalid index %s", ie.what ());
9479 d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	283 }
d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	284
d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	285 return retval;
d9716e3ee0dd supply optimized compiled sub2ind & ind2sub Jaroslav Hajek <highegg@gmail.com> parents: diff changeset	286 }
22086 67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	287
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	288 /*
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	289 ## Examples
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	290 %!test
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	291 %! [r, c] = ind2sub ([3, 3], [2, 8]);
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	292 %! assert (r, [2, 2]);
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	293 %! assert (c, [1, 3]);
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	294
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	295 %!test
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	296 %! [r, c, s] = ind2sub ([3, 3], [2, 8]);
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	297 %! assert (r, [2, 2]);
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	298 %! assert (c, [1, 3]);
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	299 %! assert (s, [1, 1]);
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	300 %! [r, c, s] = ind2sub ([3, 3, 1], [2, 8]);
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	301 %! assert (r, [2, 2]);
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	302 %! assert (c, [1, 3]);
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	303 %! assert (s, [1, 1]);
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	304
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	305 %!test
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	306 %! r = ind2sub ([3, 3], [2, 8]);
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	307 %! assert (r, [2, 8]);
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	308 %! r = ind2sub (9, [2, 8]);
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	309 %! assert (r, [2, 8]);
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	310
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	311 ## 3-dimensional test
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	312 %!test
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	313 %! [r, c, s] = ind2sub ([2, 2, 2], 1:8);
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	314 %! assert (r, [1, 2, 1, 2, 1, 2, 1, 2]);
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	315 %! assert (c, [1, 1, 2, 2, 1, 1, 2, 2]);
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	316 %! assert (s, [1, 1, 1, 1, 2, 2, 2, 2]);
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	317 %! [r, c] = ind2sub ([2, 2, 2], 1:8);
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	318 %! assert (r, [1, 2, 1, 2, 1, 2, 1, 2]);
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	319 %! assert (c, [1, 1, 2, 2, 3, 3, 4, 4]);
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	320 %! r = ind2sub ([2, 2, 2], 1:8);
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	321 %! assert (r, 1:8);
67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	322
30902 972959edc3ff Allow sub2ind() to accept indices outside the size of the input subscripts (bug #62184) John W. Eaton <jwe@octave.org> parents: 30866 diff changeset	323 ## Indexing beyond specified size (bug #62184)
972959edc3ff Allow sub2ind() to accept indices outside the size of the input subscripts (bug #62184) John W. Eaton <jwe@octave.org> parents: 30866 diff changeset	324 %!assert <*62184> (ind2sub (1, 2), 2)
972959edc3ff Allow sub2ind() to accept indices outside the size of the input subscripts (bug #62184) John W. Eaton <jwe@octave.org> parents: 30866 diff changeset	325 %!assert <*62184> (ind2sub ([3,3], 10), 10)
972959edc3ff Allow sub2ind() to accept indices outside the size of the input subscripts (bug #62184) John W. Eaton <jwe@octave.org> parents: 30866 diff changeset	326 %!test <*62184>
972959edc3ff Allow sub2ind() to accept indices outside the size of the input subscripts (bug #62184) John W. Eaton <jwe@octave.org> parents: 30866 diff changeset	327 %! [r,c] = ind2sub ([3,3], 10);
972959edc3ff Allow sub2ind() to accept indices outside the size of the input subscripts (bug #62184) John W. Eaton <jwe@octave.org> parents: 30866 diff changeset	328 %! assert ([r, c], [1, 4]);
972959edc3ff Allow sub2ind() to accept indices outside the size of the input subscripts (bug #62184) John W. Eaton <jwe@octave.org> parents: 30866 diff changeset	329 %!test <*62184>
972959edc3ff Allow sub2ind() to accept indices outside the size of the input subscripts (bug #62184) John W. Eaton <jwe@octave.org> parents: 30866 diff changeset	330 %! [r,c,p] = ind2sub ([3,3], 10);
972959edc3ff Allow sub2ind() to accept indices outside the size of the input subscripts (bug #62184) John W. Eaton <jwe@octave.org> parents: 30866 diff changeset	331 %! assert ([r, c, p], [1, 1, 2]);
972959edc3ff Allow sub2ind() to accept indices outside the size of the input subscripts (bug #62184) John W. Eaton <jwe@octave.org> parents: 30866 diff changeset	332
972959edc3ff Allow sub2ind() to accept indices outside the size of the input subscripts (bug #62184) John W. Eaton <jwe@octave.org> parents: 30866 diff changeset	333 ## Test input validation
28907 11f1207111c5 maint: Don't use semicolon at end of single-line BIST tests. Rik <rik@octave.org> parents: 28012 diff changeset	334 %!error <DIMS must contain integers> ind2sub ([2, -2], 3)
11f1207111c5 maint: Don't use semicolon at end of single-line BIST tests. Rik <rik@octave.org> parents: 28012 diff changeset	335 %!error <invalid index> ind2sub ([2, 2, 2], -1:8)
22086 67a44207da71 ind2sub: Ensure Matlab compatibility and improve documentation (bug #48092). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 21966 diff changeset	336 */
29958 32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 29826 diff changeset	337
31605 e88a07dec498 maint: Use macros to begin/end C++ namespaces. Rik <rik@octave.org> parents: 30902 diff changeset	338 OCTAVE_END_NAMESPACE(octave)

Mercurial > octave

annotate libinterp/corefcn/sub2ind.cc @ 31605:e88a07dec498 stable