Mercurial > octave
view liboctave/array/dim-vector.h @ 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 | 796f54d4ddbf |
children | 597f3ee61a48 |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 2003-2022 The Octave Project Developers // // See the file COPYRIGHT.md in the top-level directory of this // or <https://octave.org/copyright/>. // // Copyirght (C) 2009, 2010 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 // <https://www.gnu.org/licenses/>. // //////////////////////////////////////////////////////////////////////// #if ! defined (octave_dim_vector_h) #define octave_dim_vector_h 1 #include "octave-config.h" #include <cassert> #include <algorithm> #include <initializer_list> #include <string> #include "Array-fwd.h" #include "oct-atomic.h" #include "oct-refcount.h" //! Vector representing the dimensions (size) of an Array. //! //! A dim_vector is used to represent dimensions of an Array. It is used //! on its constructor to specify its size, or when reshaping it. //! //! @code{.cc} //! // Matrix with 10 rows and 20 columns. //! Matrix m Matrix (dim_vector (10, 20)); //! //! // Change its size to 5 rows and 40 columns. //! Matrix m2 = m.reshape (dim_vector (5, 40)); //! //! // Five dimensional Array of length 10, 20, 3, 8, 7 on each dimension. //! NDArray a (dim_vector (10, 20, 3, 8, 7)); //! //! // Uninitialized array of same size as other. //! NDArray b (a.dims ()); //! @endcode //! //! The main thing to understand about this class, is that methods such as //! ndims() and numel(), return the value for an Array of these dimensions, //! not the actual number of elements in the dim_vector. //! //! @code{.cc} //! dim_vector d (10, 5, 3); //! octave_idx_type n = d.numel (); // returns 150 //! octave_idx_type nd = d.ndims (); // returns 3 //! @endcode //! //! ## Implementation details ## //! //! This implementation is more tricky than Array, but the big plus is that //! dim_vector requires only one allocation instead of two. It is (slightly) //! patterned after GCC's basic_string implementation. rep is a pointer to an //! array of memory, comprising count, length, and the data: //! //! @verbatim //! <count> //! <ndims> //! rep --> <dims[0]> //! <dims[1]> //! ... //! @endverbatim //! //! The inlines count(), ndims() recover this data from the rep. Note //! that rep points to the beginning of dims to grant faster access //! (reinterpret_cast is assumed to be an inexpensive operation). class OCTAVE_API dim_vector { private: octave_idx_type m_num_dims; octave_idx_type *m_dims; public: //! Construct dim_vector for a N dimensional array. //! //! Each argument to constructor defines the length of an additional //! dimension. A dim_vector always represents a minimum of 2 dimensions //! (just like an Array has at least 2 dimensions) and there is no //! upper limit on the number of dimensions. //! //! @code{.cc} //! dim_vector dv (7, 5); //! Matrix mat (dv); //! @endcode //! //! The constructed dim_vector @c dv will have two elements, @f$[7, 5]@f$, //! one for each dimension. It can then be used to construct a Matrix //! with such dimensions, i.e., 7 rows and 5 columns. //! //! @code{.cc} //! NDArray x (dim_vector (7, 5, 10)); //! @endcode //! //! This will construct a 3 dimensional NDArray of lengths 7, 5, and 10, //! on the first, second, and third dimension (rows, columns, and pages) //! respectively. //! //! Note that that there is no constructor that accepts only one //! dimension length to avoid confusion. The source for such confusion //! is that constructor could mean: //! - a column vector, i.e., assume @f$[N, 1]@f$; //! - a square matrix, i.e., as is common in Octave interpreter; //! - support for a 1 dimensional Array (does not exist); //! //! Using r, c, and lengths... as arguments, allow us to check at compile //! time that there's at least 2 dimensions specified, while maintaining //! type safety. template <typename... Ints> dim_vector (const octave_idx_type r, const octave_idx_type c, Ints... lengths) : m_num_dims (2 + sizeof... (Ints)), m_dims (new octave_idx_type [m_num_dims]) { std::initializer_list<octave_idx_type> all_lengths = {r, c, lengths...}; octave_idx_type *ptr = m_dims; for (const octave_idx_type l: all_lengths) *ptr++ = l; } // Fast access with absolutely no checking octave_idx_type& xelem (int i) { return m_dims[i]; } octave_idx_type xelem (int i) const { return m_dims[i]; } // Safe access to to elements octave_idx_type& elem (int i) { return xelem (i); } octave_idx_type elem (int i) const { return xelem (i); } void chop_trailing_singletons (void) { while (m_num_dims > 2 && xelem(m_num_dims-1) == 1) m_num_dims--; } OCTAVE_API void chop_all_singletons (void); private: explicit dim_vector (octave_idx_type ndims) : m_num_dims (ndims < 2 ? 2 : ndims), m_dims (new octave_idx_type [m_num_dims]) { std::fill_n (m_dims, m_num_dims, 0); } public: static OCTAVE_API octave_idx_type dim_max (void); explicit dim_vector (void) : m_num_dims (2), m_dims (new octave_idx_type [m_num_dims]) { std::fill_n (m_dims, m_num_dims, 0); } dim_vector (const dim_vector& dv) : m_num_dims (dv.m_num_dims), m_dims (new octave_idx_type [m_num_dims]) { std::copy_n (dv.m_dims, m_num_dims, m_dims); } dim_vector (dim_vector&& dv) : m_num_dims (0), m_dims (nullptr) { *this = std::move (dv); } static dim_vector alloc (int n) { return dim_vector (n); } dim_vector& operator = (const dim_vector& dv) { if (&dv != this) { delete [] m_dims; m_num_dims = dv.m_num_dims; m_dims = new octave_idx_type [m_num_dims]; std::copy_n (dv.m_dims, m_num_dims, m_dims); } return *this; } dim_vector& operator = (dim_vector&& dv) { if (&dv != this) { // Because we define a move constructor and a move assignment // operator, m_dims may be a nullptr here. We should only need to // protect the destructor in a similar way. delete [] m_dims; m_num_dims = dv.m_num_dims; m_dims = dv.m_dims; dv.m_num_dims = 0; dv.m_dims = nullptr; } return *this; } ~dim_vector (void) { // Because we define a move constructor and a move assignment // operator, m_dims may be a nullptr here. We should only need to // protect the move assignment operator in a similar way. delete [] m_dims; } //! Number of dimensions. //! //! Returns the number of dimensions of the dim_vector. This is number of //! elements in the dim_vector including trailing singletons. It is also //! the number of dimensions an Array with this dim_vector would have. octave_idx_type ndims (void) const { return m_num_dims; } //! Number of dimensions. //! Synonymous with ndims(). //! //! While this method is not officially deprecated, consider using ndims() //! instead to avoid confusion. Array does not have length because of its //! odd definition as length of the longest dimension. int length (void) const { return ndims (); } octave_idx_type& operator () (int i) { return elem (i); } octave_idx_type operator () (int i) const { return elem (i); } void resize (int n, int fill_value = 0) { if (n < 2) n = 2; if (n == m_num_dims) return; if (n < m_num_dims) { m_num_dims = n; return; } octave_idx_type *new_rep = new octave_idx_type [n]; std::copy_n (m_dims, m_num_dims, new_rep); std::fill_n (new_rep + m_num_dims, n - m_num_dims, fill_value); delete [] m_dims; m_dims = new_rep; m_num_dims = n; } OCTAVE_API std::string str (char sep = 'x') const; bool all_zero (void) const { return std::all_of (m_dims, m_dims + ndims (), [] (octave_idx_type dim) { return dim == 0; }); } bool empty_2d (void) const { return ndims () == 2 && (xelem (0) == 0 || xelem (1) == 0); } bool zero_by_zero (void) const { return ndims () == 2 && xelem (0) == 0 && xelem (1) == 0; } bool any_zero (void) const { return std::any_of (m_dims, m_dims + ndims (), [] (octave_idx_type dim) { return dim == 0; }); } OCTAVE_API int num_ones (void) const; bool all_ones (void) const { return (num_ones () == ndims ()); } //! Number of elements that a matrix with this dimensions would have. //! //! Return the number of elements that a matrix with this dimension //! vector would have, NOT the number of dimensions (elements in the //! dimension vector). octave_idx_type numel (int n = 0) const { int n_dims = ndims (); octave_idx_type retval = 1; for (int i = n; i < n_dims; i++) retval *= elem (i); return retval; } //! The following function will throw a std::bad_alloc () //! exception if the requested size is larger than can be indexed by //! octave_idx_type. This may be smaller than the actual amount of //! memory that can be safely allocated on a system. However, if we //! don't fail here, we can end up with a mysterious crash inside a //! function that is iterating over an array using octave_idx_type //! indices. OCTAVE_API octave_idx_type safe_numel (void) const; bool any_neg (void) const { return std::any_of (m_dims, m_dims + ndims (), [] (octave_idx_type dim) { return dim < 0; }); } OCTAVE_API dim_vector squeeze (void) const; //! This corresponds to cat(). OCTAVE_API bool concat (const dim_vector& dvb, int dim); //! This corresponds to [,] (horzcat, dim = 0) and [;] (vertcat, dim = 1). // The rules are more relaxed here. OCTAVE_API bool hvcat (const dim_vector& dvb, int dim); //! Force certain dimensionality, preserving numel (). Missing //! dimensions are set to 1, redundant are folded into the trailing //! one. If n = 1, the result is 2d and the second dim is 1 //! (dim_vectors are always at least 2D). OCTAVE_API dim_vector redim (int n) const; dim_vector as_column (void) const { if (ndims () == 2 && xelem (1) == 1) return *this; else return dim_vector (numel (), 1); } dim_vector as_row (void) const { if (ndims () == 2 && xelem (0) == 1) return *this; else return dim_vector (1, numel ()); } bool isvector (void) const { return (ndims () == 2 && (xelem (0) == 1 || xelem (1) == 1)); } bool is_nd_vector (void) const { int num_non_one = 0; for (int i = 0; i < ndims (); i++) { if (xelem (i) != 1) { num_non_one++; if (num_non_one > 1) break; } } return num_non_one == 1; } // Create a vector with length N. If this object is a vector, // preserve the orientation, otherwise, create a column vector. dim_vector make_nd_vector (octave_idx_type n) const { dim_vector orig_dims; if (is_nd_vector ()) { orig_dims = *this; for (int i = 0; i < orig_dims.ndims (); i++) { if (orig_dims(i) != 1) { orig_dims(i) = n; break; } } } else orig_dims = dim_vector (n, 1); return orig_dims; } int first_non_singleton (int def = 0) const { for (int i = 0; i < ndims (); i++) { if (xelem (i) != 1) return i; } return def; } //! Linear index from an index tuple. octave_idx_type compute_index (const octave_idx_type *idx) const { return compute_index (idx, ndims ()); } //! Linear index from an incomplete index tuple (nidx < length ()). octave_idx_type compute_index (const octave_idx_type *idx, int nidx) const { octave_idx_type k = 0; for (int i = nidx - 1; i >= 0; i--) k = xelem(i) * k + idx[i]; return k; } //! Increment a multi-dimensional index tuple, optionally starting //! from an offset position and return the index of the last index //! position that was changed, or length () if just cycled over. int increment_index (octave_idx_type *idx, int start = 0) const { int i; for (i = start; i < ndims (); i++) { if (++(*idx) == xelem(i)) *idx++ = 0; else break; } return i; } //! Return cumulative dimensions. dim_vector cumulative (void) const { int nd = ndims (); dim_vector retval = alloc (nd); octave_idx_type k = 1; for (int i = 0; i < nd; i++) retval.xelem(i) = (k *= xelem(i)); return retval; } //! Compute a linear index from an index tuple. Dimensions are //! required to be cumulative. octave_idx_type cum_compute_index (const octave_idx_type *idx) const { octave_idx_type k = idx[0]; for (int i = 1; i < ndims (); i++) k += xelem(i-1) * idx[i]; return k; } friend OCTAVE_API bool operator == (const dim_vector& a, const dim_vector& b); OCTAVE_API Array<octave_idx_type> as_array (void) const; }; inline bool operator == (const dim_vector& a, const dim_vector& b) { // Fast case. if (a.m_dims == b.m_dims) return true; int a_len = a.ndims (); int b_len = b.ndims (); if (a_len != b_len) return false; return std::equal (a.m_dims, a.m_dims + a_len, b.m_dims); } inline bool operator != (const dim_vector& a, const dim_vector& b) { return ! operator == (a, b); } #endif