Mercurial > octave
view libinterp/corefcn/sub2ind.cc @ 21100:e39e05d90788
Switch gripe_XXX to either err_XXX or warn_XXX naming scheme.
* libinterp/corefcn/errwarn.h, libinterp/corefcn/errwarn.cc: New header and .cc
file with common errors and warnings for libinterp.
* libinterp/corefcn/module.mk: Add errwarn.h, errwarn.cc to build system.
* liboctave/util/lo-array-errwarn.h, liboctave/util/lo-array-errwarn.cc: New
header and .cc file with common errors and warnings for liboctave.
* liboctave/util/module.mk: Add lo-array-errwarn.h, lo-array-errwarn.cc to
build system.
* lo-array-gripes.h: #include "lo-array-errwarn.h" for access to class
index_exception. Remove const char *error_id_XXX prototypes.
* lo-array-gripes.cc: Remove const char *error_id_XXX initializations.
Remove index_exception method definitions.
* Cell.cc, __pchip_deriv__.cc, __qp__.cc, balance.cc, betainc.cc, cellfun.cc,
daspk.cc, dasrt.cc, dassl.cc, data.cc, debug.cc, defaults.cc, det.cc,
dirfns.cc, eig.cc, fft.cc, fft2.cc, fftn.cc, find.cc, gammainc.cc, gcd.cc,
getgrent.cc, getpwent.cc, graphics.in.h, help.cc, hess.cc, hex2num.cc,
input.cc, inv.cc, jit-typeinfo.cc, load-save.cc, lookup.cc, ls-hdf5.cc,
ls-mat-ascii.cc, ls-mat4.cc, ls-mat5.cc, ls-oct-binary.cc, ls-oct-text.cc,
lsode.cc, lu.cc, luinc.cc, max.cc, mgorth.cc, oct-hist.cc, oct-procbuf.cc,
oct-stream.cc, oct.h, pager.cc, pinv.cc, pr-output.cc, quad.cc, qz.cc, rand.cc,
rcond.cc, regexp.cc, schur.cc, sparse-xdiv.cc, sparse-xpow.cc, sparse.cc,
spparms.cc, sqrtm.cc, str2double.cc, strfind.cc, strfns.cc, sub2ind.cc, svd.cc,
sylvester.cc, syscalls.cc, typecast.cc, utils.cc, variables.cc, xdiv.cc,
xnorm.cc, xpow.cc, __eigs__.cc, __glpk__.cc, __magick_read__.cc,
__osmesa_print__.cc, audiodevinfo.cc, audioread.cc, chol.cc, dmperm.cc,
fftw.cc, qr.cc, symbfact.cc, symrcm.cc, ov-base-diag.cc, ov-base-int.cc,
ov-base-mat.cc, ov-base-scalar.cc, ov-base-sparse.cc, ov-base.cc,
ov-bool-mat.cc, ov-bool-sparse.cc, ov-bool.cc, ov-builtin.cc, ov-cell.cc,
ov-ch-mat.cc, ov-class.cc, ov-complex.cc, ov-complex.h, ov-cs-list.cc,
ov-cx-diag.cc, ov-cx-mat.cc, ov-cx-sparse.cc, ov-fcn-handle.cc,
ov-fcn-inline.cc, ov-float.cc, ov-float.h, ov-flt-complex.cc, ov-flt-complex.h,
ov-flt-cx-diag.cc, ov-flt-cx-mat.cc, ov-flt-re-mat.cc, ov-int16.cc,
ov-int32.cc, ov-int64.cc, ov-int8.cc, ov-intx.h, ov-mex-fcn.cc, ov-perm.cc,
ov-range.cc, ov-re-mat.cc, ov-re-sparse.cc, ov-scalar.cc, ov-scalar.h,
ov-str-mat.cc, ov-struct.cc, ov-type-conv.h, ov-uint16.cc, ov-uint32.cc,
ov-uint64.cc, ov-uint8.cc, ov-usr-fcn.cc, ov.cc, 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-dms-template.cc, op-double-conv.cc, op-fcdm-fcdm.cc, op-fcdm-fdm.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-float-conv.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-int-conv.cc,
op-int.h, 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-pm-pm.cc, op-pm-scm.cc, op-pm-sm.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, lex.ll, pt-assign.cc, pt-eval.cc, pt-idx.cc, pt-loop.cc, pt-mat.cc,
pt-stmt.cc, Array-util.cc, Array-util.h, Array.cc, CColVector.cc,
CDiagMatrix.cc, CMatrix.cc, CNDArray.cc, CRowVector.cc, CSparse.cc,
DiagArray2.cc, MDiagArray2.cc, MSparse.cc, PermMatrix.cc, Range.cc, Sparse.cc,
dColVector.cc, dDiagMatrix.cc, dMatrix.cc, dNDArray.cc, dRowVector.cc,
dSparse.cc, fCColVector.cc, fCDiagMatrix.cc, fCMatrix.cc, fCNDArray.cc,
fCRowVector.cc, fColVector.cc, fDiagMatrix.cc, fMatrix.cc, fNDArray.cc,
fRowVector.cc, idx-vector.cc, CmplxGEPBAL.cc, dbleGEPBAL.cc, fCmplxGEPBAL.cc,
floatGEPBAL.cc, Sparse-diag-op-defs.h, Sparse-op-defs.h, Sparse-perm-op-defs.h,
mx-inlines.cc, mx-op-defs.h, oct-binmap.h:
Replace 'include "gripes.h"' with 'include "errwarn.h". Change all gripe_XXX
to err_XXX or warn_XXX or errwarn_XXX.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 18 Jan 2016 18:28:06 -0800 |
parents | 5e00ed38a58b |
children | fcac5dbbf9ed |
line wrap: on
line source
/* Copyright (C) 2009-2015 VZLU Prague This file is part of Octave. Octave is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. Octave is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with Octave; see the file COPYING. If not, see <http://www.gnu.org/licenses/>. */ #ifdef HAVE_CONFIG_H #include <config.h> #endif #include "Array-util.h" #include "oct-locbuf.h" #include "quit.h" #include "defun.h" #include "error.h" #include "errwarn.h" #include "ovl.h" static dim_vector get_dim_vector (const octave_value& val, const char *name) { RowVector dimsv = val.row_vector_value (false, true); dim_vector dv; octave_idx_type n = dimsv.numel (); if (n < 1) error ("%s: dimension vector DIMS must not be empty", name); dv.resize (std::max (n, static_cast<octave_idx_type> (2))); dv(1) = 1; for (octave_idx_type i = 0; i < n; i++) { octave_idx_type ii = dimsv(i); if (ii == dimsv(i) && ii >= 0) dv(i) = ii; else error ("%s: dimension vector DIMS must contain integers", name); } return dv; } DEFUN (sub2ind, args, , "-*- texinfo -*-\n\ @deftypefn {} {@var{ind} =} sub2ind (@var{dims}, @var{i}, @var{j})\n\ @deftypefnx {} {@var{ind} =} sub2ind (@var{dims}, @var{s1}, @var{s2}, @dots{}, @var{sN})\n\ Convert subscripts to a linear index.\n\ \n\ The following example shows how to convert the two-dimensional index\n\ @code{(2,3)} of a 3-by-3 matrix to a linear index. The matrix is linearly\n\ indexed moving from one column to next, filling up all rows in each column.\n\ \n\ @example\n\ @group\n\ linear_index = sub2ind ([3, 3], 2, 3)\n\ @result{} 8\n\ @end group\n\ @end example\n\ @seealso{ind2sub}\n\ @end deftypefn") { int nargin = args.length (); if (nargin < 2) print_usage (); dim_vector dv = get_dim_vector (args(0), "sub2ind"); Array<idx_vector> idxa (dim_vector (nargin-1, 1)); dv = dv.redim (nargin - 1); for (int j = 0; j < nargin - 1; j++) { if (! args(j+1).is_numeric_type ()) error ("sub2ind: subscripts must be numeric"); try { idxa(j) = args(j+1).index_vector (); if (j > 0 && args(j+1).dims () != args(1).dims ()) error ("sub2ind: all subscripts must be of the same size"); } catch (index_exception& e) { e.set_pos_if_unset (nargin-1, j+1); e.set_var (); std::string msg = e.message (); error_with_id (e.err_id (), msg.c_str ()); } } return ovl (sub2ind (dv, idxa)); } /* ## Test evaluation %!test %! s1 = [ 1 1 1 1 ; 2 2 2 2 ]; %! s2 = [ 1 1 2 2 ; 1 1 2 2 ]; %! s3 = [ 1 2 1 2 ; 1 2 1 2 ]; %! in = [ 1 101 11 111 ; 2 102 12 112 ]; %! assert (sub2ind ([10 10 10], s1, s2, s3), in); # Test low index %!assert (sub2ind ([10 10 10], 1, 1, 1), 1) %!error <index \(0,_,_\)> sub2ind ([10 10 10], 0, 1, 1) %!error <index \(_,0,_\)> sub2ind ([10 10 10], 1, 0, 1) %!error <index \(_,_,0\)> sub2ind ([10 10 10], 1, 1, 0) # Test high index %!assert (sub2ind ([10 10 10], 10, 10, 10), 1000) %!error <index \(11,_,_\): out of bound 10> sub2ind ([10 10 10], 11, 10, 10) %!error <index \(_,11,_\): out of bound 10> sub2ind ([10 10 10], 10, 11, 10) %!error <index \(_,_,11\): out of bound 10> sub2ind ([10 10 10], 10, 10, 11) # Test high index in the trailing dimensions %!assert (sub2ind ([10, 1], 2, 1, 1), 2) %!error <index \(_,2,_\): out of bound 1> sub2ind ([10, 1], 1, 2, 1) %!error <index \(_,_,2\): out of bound 1> sub2ind ([10, 1], 1, 1, 2) %!assert (sub2ind ([10 10], 2, 2, 1), 12) %!error <index \(_,_,2\): out of bound 1> sub2ind ([10 10], 2, 1, 2) %!error <index \(_,_,2\): out of bound 1> sub2ind ([10 10], 1, 2, 2) # Test handling of empty arguments %!assert (sub2ind ([10 10], zeros (0,0), zeros (0,0)), zeros (0,0)) %!assert (sub2ind ([10 10], zeros (2,0), zeros (2,0)), zeros (2,0)) %!assert (sub2ind ([10 10], zeros (0,2), zeros (0,2)), zeros (0,2)) %!error <all subscripts .* same size> sub2ind ([10 10 10], zeros (0,2), zeros (2,0)) # Test handling of arguments of different size %!error <all subscripts .* same size> sub2ind ([10 10], ones (1,2), ones (1,3)) %!error <all subscripts .* same size> sub2ind ([10 10], ones (1,2), ones (2,1)) ## Test input validation %!error <dimension vector> sub2ind ([10 10.5], 1, 1) %!error <index \(1.5,_\)> sub2ind ([10 10], 1.5, 1) %!error <index \(_,1.5\)> sub2ind ([10 10], 1, 1.5) */ DEFUN (ind2sub, args, nargout, "-*- texinfo -*-\n\ @deftypefn {} {[@var{s1}, @var{s2}, @dots{}, @var{sN}] =} ind2sub (@var{dims}, @var{ind})\n\ Convert a linear index to subscripts.\n\ \n\ The following example shows how to convert the linear index @code{8}\n\ in a 3-by-3 matrix into a subscript. The matrix is linearly indexed\n\ moving from one column to next, filling up all rows in each column.\n\ \n\ @example\n\ @group\n\ [r, c] = ind2sub ([3, 3], 8)\n\ @result{} r = 2\n\ @result{} c = 3\n\ @end group\n\ @end example\n\ @seealso{sub2ind}\n\ @end deftypefn") { if (args.length () != 2) print_usage (); octave_value_list retval; dim_vector dv = get_dim_vector (args(0), "ind2sub"); try { idx_vector idx = args(1).index_vector (); if (nargout > dv.length ()) dv = dv.redim (nargout); retval = Array<octave_value> (ind2sub (dv, idx)); } catch (const index_exception& e) { std::string idx = e.idx (); std::string msg = e.details (); error ("ind2sub: Invalid index %s. %s", idx.c_str (), msg.c_str ()); } return retval; }