Mercurial > octave
view libinterp/corefcn/sub2ind.cc @ 21139:538b57866b90
consistently use "typename" intead of "class" in template declarations
* Object.h, QtHandlesUtils.cc, QtHandlesUtils.h, ToolBarButton.cc,
ToolBarButton.h, Cell.h, __lin_interpn__.cc, bitfcns.cc, bsxfun.cc,
cellfun.cc, data.cc, filter.cc, gcd.cc, graphics.cc, help.cc, kron.cc,
lookup.cc, ls-mat5.cc, ls-oct-text.h, lu.cc, max.cc, mgorth.cc,
oct-map.cc, oct-map.h, oct-stream.cc, oct-stream.h, octave-link.h,
pr-output.cc, profiler.h, schur.cc, sparse-xdiv.cc, sparse-xpow.cc,
sqrtm.cc, symtab.h, tril.cc, typecast.cc, variables.cc, xdiv.cc,
zfstream.h, __init_fltk__.cc, __magick_read__.cc, chol.cc, qr.cc,
ov-base-diag.cc, ov-base-diag.h, ov-base-int.cc, ov-base-int.h,
ov-base-mat.cc, ov-base-mat.h, ov-base-scalar.cc, ov-base-scalar.h,
ov-base-sparse.cc, ov-base-sparse.h, ov-base.h, ov-classdef.cc,
ov-int-traits.h, ov-java.h, ov-usr-fcn.h, ov.cc, ov.h,
op-dms-template.cc, oct-parse.in.yy, parse.h, pt-mat.cc, Array-b.cc,
Array.cc, Array.h, CDiagMatrix.h, CMatrix.h, CNDArray.h,
DiagArray2.cc, DiagArray2.h, MArray.cc, MArray.h, MDiagArray2.cc,
MDiagArray2.h, MSparse.cc, MSparse.h, MatrixType.cc, Sparse.cc,
Sparse.h, dDiagMatrix.h, dMatrix.h, dNDArray.h, fCDiagMatrix.h,
fCMatrix.h, fCNDArray.h, fDiagMatrix.h, fMatrix.h, fNDArray.h,
idx-vector.cc, idx-vector.h, intNDArray.cc, intNDArray.h, DET.h,
base-aepbal.h, base-lu.cc, base-lu.h, base-qr.cc, base-qr.h,
bsxfun-defs.cc, eigs-base.cc, lo-mappers.h, lo-specfun.cc,
lo-specfun.h, oct-convn.cc, oct-fftw.cc, oct-norm.cc,
sparse-base-chol.cc, sparse-base-chol.h, sparse-base-lu.cc,
sparse-base-lu.h, sparse-dmsolve.cc, mx-inlines.cc,
action-container.h, base-list.h, lo-traits.h, lo-utils.h,
oct-base64.h, oct-binmap.h, oct-cmplx.h, oct-inttypes.cc,
oct-inttypes.h, oct-locbuf.h, oct-refcount.h, oct-sort.cc, oct-sort.h:
Use "typename" instead of "class" in template declarations.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Sun, 24 Jan 2016 13:50:04 -0500 |
parents | e39e05d90788 |
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; }