Mercurial > octave
view liboctave/array/Range.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 | fc3bd70cd1be |
children | dfa5d9c3ae72 aac27ad79be6 |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 1993-2022 The Octave Project Developers // // See the file COPYRIGHT.md in the top-level directory of this // distribution or <https://octave.org/copyright/>. // // 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_Range_h) #define octave_Range_h 1 #include "octave-config.h" #include <iosfwd> #include <type_traits> #include "Array-fwd.h" #include "dMatrix.h" #include "dim-vector.h" #include "lo-error.h" #include "oct-sort.h" #include "range-fwd.h" OCTAVE_BEGIN_NAMESPACE(octave) // For now, only define for floating point types. However, we only // need range<float> as a temporary local variable in make_float_range // in ov.cc. template <typename T> class range<T, typename std::enable_if<std::is_floating_point<T>::value>::type> { public: range (void) : m_base (0), m_increment (0), m_limit (0), m_final (0), m_numel (0), m_reverse (false) { } // LIMIT is an upper limit and may be outside the range of actual // values. For floating point ranges, we perform a tolerant check // to attempt to capture limit in the set of values if it is "close" // to the value of base + a multiple of the increment. range (const T& base, const T& increment, const T& limit, bool reverse = false) : m_base (base), m_increment (increment), m_limit (limit), m_final (), m_numel (), m_reverse (reverse) { init (); } range (const T& base, const T& limit) : m_base (base), m_increment (1), m_limit (limit), m_final (), m_numel (), m_reverse (false) { init (); } // Allow conversion from (presumably) properly constructed Range // objects. The values of base, limit, increment, and numel must be // consistent. // FIXME: Actually check that base, limit, increment, and numel are // consistent? range (const T& base, const T& increment, const T& limit, octave_idx_type numel, bool reverse = false) : m_base (base), m_increment (increment), m_limit (limit), m_final (limit), m_numel (numel), m_reverse (reverse) { } // We don't use a constructor for this because it will conflict with // range<T> (base, limit, increment) when T is octave_idx_type. static range<T> make_n_element_range (const T& base, const T& increment, octave_idx_type numel, bool reverse = false) { // We could just make this constructor public, but it allows // inconsistent ranges to be constructed. And it is probably much // clearer to see "make_n_element_range" instead of puzzling over the // purpose of this strange constructor form. T final_val = (reverse ? base - (numel - 1) * increment : base + (numel - 1) * increment); return range<T> (base, increment, final_val, numel, reverse); } range (const range<T>& r) : m_base (r.m_base), m_increment (r.m_increment), m_limit (r.m_limit), m_final (r.m_final), m_numel (r.m_numel), m_reverse (r.m_reverse) { } range<T>& operator = (const range<T>& r) { if (this != &r) { m_base = r.m_base; m_increment = r.m_increment; m_limit = r.m_limit; m_final = r.m_final; m_numel = r.m_numel; m_reverse = r.m_reverse; } return *this; } ~range (void) = default; T base (void) const { return m_base; } T increment (void) const { return m_increment; } T limit (void) const { return m_limit; } bool reverse (void) const { return m_reverse; } T final_value (void) const { return m_final; } T min (void) const { return (m_numel > 0 ? ((m_reverse ? m_increment > T (0) : m_increment > T (0)) ? base () : final_value ()) : T (0)); } T max (void) const { return (m_numel > 0 ? ((m_reverse ? m_increment < T (0) : m_increment > T (0)) ? final_value () : base ()) : T (0)); } octave_idx_type numel (void) const { return m_numel; } // To support things like "for i = 1:Inf; ...; end" that are // required for Matlab compatibility, creation of a range object // like 1:Inf is allowed with m_numel set to // numeric_limits<octave_idx_type>::max(). However, it is not // possible to store these ranges. The following function allows // us to easily distinguish ranges with an infinite number of // elements. There are specializations for double and float. bool is_storable (void) const { return true; } dim_vector dims (void) const { return dim_vector (1, m_numel); } octave_idx_type rows (void) const { return 1; } octave_idx_type cols (void) const { return numel (); } octave_idx_type columns (void) const { return numel (); } bool isempty (void) const { return numel () == 0; } bool all_elements_are_ints (void) const { return true; } sortmode issorted (sortmode mode = ASCENDING) const { if (m_numel > 1 && (m_reverse ? m_increment < T (0) : m_increment > T (0))) mode = ((mode == DESCENDING) ? UNSORTED : ASCENDING); else if (m_numel > 1 && (m_reverse ? m_increment > T (0) : m_increment < T (0))) mode = ((mode == ASCENDING) ? UNSORTED : DESCENDING); else mode = ((mode == UNSORTED) ? ASCENDING : mode); return mode; } OCTAVE_API octave_idx_type nnz (void) const; // Support for single-index subscripting, without generating matrix cache. T checkelem (octave_idx_type i) const { if (i < 0 || i >= m_numel) err_index_out_of_range (2, 2, i+1, m_numel, dims ()); if (i == 0) // Required for proper NaN handling. return (m_numel == 1 ? final_value () : m_base); else if (i < m_numel - 1) return (m_reverse ? m_base + T (i) * m_increment : m_base + T (i) * m_increment); else return final_value (); } T checkelem (octave_idx_type i, octave_idx_type j) const { // Ranges are *always* row vectors. if (i != 0) err_index_out_of_range (1, 1, i+1, m_numel, dims ()); return checkelem (j); } T elem (octave_idx_type i) const { if (i == 0) // Required for proper NaN handling. return (m_numel == 1 ? final_value () : m_base); else if (i < m_numel - 1) return (m_reverse ? m_base - T (i) * m_increment : m_base + T (i) * m_increment); else return final_value (); } T elem (octave_idx_type /* i */, octave_idx_type j) const { return elem (j); } T operator () (octave_idx_type i) const { return elem (i); } T operator () (octave_idx_type i, octave_idx_type j) const { return elem (i, j); } Array<T> index (const idx_vector& idx) const { Array<T> retval; octave_idx_type n = m_numel; if (idx.is_colon ()) { retval = array_value ().reshape (dim_vector (m_numel, 1)); } else { if (idx.extent (n) != n) err_index_out_of_range (1, 1, idx.extent (n), n, dims ()); dim_vector idx_dims = idx.orig_dimensions (); octave_idx_type idx_len = idx.length (n); // taken from Array.cc. if (n != 1 && idx_dims.isvector ()) idx_dims = dim_vector (1, idx_len); retval.clear (idx_dims); // Loop over all values in IDX, executing the lambda // expression for each index value. T *array = retval.fortran_vec (); idx.loop (n, [=, &array] (octave_idx_type i) { if (i == 0) // Required for proper NaN handling. *array++ = (m_numel == 0 ? m_final : m_base); else if (i < m_numel - 1) *array++ = (m_reverse ? m_base - T (i) * m_increment : m_base + T (i) * m_increment); else *array++ = m_final; }); } return retval; } Array<T> diag (octave_idx_type k) const { return array_value ().diag (k); } Array<T> array_value (void) const { octave_idx_type nel = numel (); Array<T> retval (dim_vector (1, nel)); if (nel == 1) // Required for proper NaN handling. retval(0) = final_value (); else if (nel > 1) { // The first element must always be *exactly* the base. // E.g, -0 would otherwise become +0 in the loop (-0 + 0*increment). retval(0) = m_base; if (m_reverse) for (octave_idx_type i = 1; i < nel - 1; i++) retval.xelem (i) = m_base - i * m_increment; else for (octave_idx_type i = 1; i < nel - 1; i++) retval.xelem (i) = m_base + i * m_increment; retval.xelem (nel - 1) = final_value (); } return retval; } private: T m_base; T m_increment; T m_limit; T m_final; octave_idx_type m_numel; bool m_reverse; // Setting the number of elements to zero when the increment is zero // is intentional and matches the behavior of Matlab's colon // operator. // These calculations are appropriate for integer ranges. There are // specializations for double and float. void init (void) { if (m_reverse) { m_numel = ((m_increment == T (0) || (m_limit > m_base && m_increment > T (0)) || (m_limit < m_base && m_increment < T (0))) ? T (0) : (m_base - m_limit - m_increment) / m_increment); m_final = m_base - (m_numel - 1) * m_increment; } else { m_numel = ((m_increment == T (0) || (m_limit > m_base && m_increment < T (0)) || (m_limit < m_base && m_increment > T (0))) ? T (0) : (m_limit - m_base + m_increment) / m_increment); m_final = m_base + (m_numel - 1) * m_increment; } } }; // Specializations defined externally. template <> OCTAVE_API bool range<double>::all_elements_are_ints (void) const; template <> OCTAVE_API bool range<float>::all_elements_are_ints (void) const; template <> OCTAVE_API void range<double>::init (void); template <> OCTAVE_API void range<float>::init (void); // For now, only define for floating point types. However, we only // need range<float> as a temporary local variable in make_float_range // in ov.cc. #if 0 template <> OCTAVE_API void range<octave_int8>::init (void); template <> OCTAVE_API void range<octave_int16>::init (void); template <> OCTAVE_API void range<octave_int32>::init (void); template <> OCTAVE_API void range<octave_int64>::init (void); template <> OCTAVE_API void range<octave_uint8>::init (void); template <> OCTAVE_API void range<octave_uint16>::init (void); template <> OCTAVE_API void range<octave_uint32>::init (void); template <> OCTAVE_API void range<octave_uint64>::init (void); #endif template <> OCTAVE_API bool range<double>::is_storable (void) const; template <> OCTAVE_API bool range<float>::is_storable (void) const; template <> OCTAVE_API octave_idx_type range<double>::nnz (void) const; template <> OCTAVE_API octave_idx_type range<float>::nnz (void) const; OCTAVE_END_NAMESPACE(octave) class Range { public: OCTAVE_DEPRECATED (7, "use the 'octave::range<double>' class instead") Range (void) : m_base (0), m_limit (0), m_inc (0), m_numel (0) { } // Assume range is already properly constructed, so just copy internal // values. However, we set LIMIT to the computed final value because // that mimics the behavior of the other Range class constructors that // reset limit to the computed final value. OCTAVE_DEPRECATED (7, "use the 'octave::range<double>' class instead") Range (const octave::range<double>& r) : m_base (r.base ()), m_limit (r.final_value ()), m_inc (r.increment ()), m_numel (r.numel ()) { } Range (const Range& r) = default; Range& operator = (const Range& r) = default; ~Range (void) = default; OCTAVE_DEPRECATED (7, "use the 'octave::range<double>' class instead") Range (double b, double l) : m_base (b), m_limit (l), m_inc (1), m_numel (numel_internal ()) { if (! octave::math::isinf (m_limit)) m_limit = limit_internal (); } OCTAVE_DEPRECATED (7, "use the 'octave::range<double>' class instead") Range (double b, double l, double i) : m_base (b), m_limit (l), m_inc (i), m_numel (numel_internal ()) { if (! octave::math::isinf (m_limit)) m_limit = limit_internal (); } // NOTE: The following constructor may be deprecated and removed after // the arithmetic operators are removed. // For operators' usage (to preserve element count) and to create // constant row vectors (obsolete usage). OCTAVE_DEPRECATED (7, "use the 'octave::range<double>' class instead") Range (double b, double i, octave_idx_type n) : m_base (b), m_limit (b + (n-1) * i), m_inc (i), m_numel (n) { if (! octave::math::isinf (m_limit)) m_limit = limit_internal (); } // The range has a finite number of elements. bool ok (void) const { return (octave::math::isfinite (m_limit) && (m_numel >= 0 || m_numel == -2)); } double base (void) const { return m_base; } double limit (void) const { return m_limit; } double inc (void) const { return m_inc; } double increment (void) const { return m_inc; } // We adjust the limit to be the final value, so return that. We // could introduce a new variable to store the final value separately, // but it seems like that would just add confusion. If we changed // the meaning of the limit function, we would change the behavior of // programs that expect limit to be the final value instead of the // value of the limit when the range was created. This problem will // be fixed with the new template range class. double final_value (void) const { return m_limit; } octave_idx_type numel (void) const { return m_numel; } dim_vector dims (void) const { return dim_vector (1, m_numel); } octave_idx_type rows (void) const { return 1; } octave_idx_type cols (void) const { return numel (); } octave_idx_type columns (void) const { return numel (); } bool isempty (void) const { return numel () == 0; } OCTAVE_API bool all_elements_are_ints (void) const; OCTAVE_API Matrix matrix_value (void) const; OCTAVE_API double min (void) const; OCTAVE_API double max (void) const; OCTAVE_API void sort_internal (bool ascending = true); OCTAVE_API void sort_internal (Array<octave_idx_type>& sidx, bool ascending = true); OCTAVE_API Matrix diag (octave_idx_type k = 0) const; OCTAVE_API Range sort (octave_idx_type dim = 0, sortmode mode = ASCENDING) const; OCTAVE_API Range sort (Array<octave_idx_type>& sidx, octave_idx_type dim = 0, sortmode mode = ASCENDING) const; OCTAVE_API sortmode issorted (sortmode mode = ASCENDING) const; OCTAVE_API octave_idx_type nnz (void) const; // Support for single-index subscripting, without generating matrix cache. OCTAVE_API double checkelem (octave_idx_type i) const; OCTAVE_API double checkelem (octave_idx_type i, octave_idx_type j) const; OCTAVE_API double elem (octave_idx_type i) const; double elem (octave_idx_type /* i */, octave_idx_type j) const { return elem (j); } double operator () (octave_idx_type i) const { return elem (i); } double operator () (octave_idx_type i, octave_idx_type j) const { return elem (i, j); } OCTAVE_API Array<double> index (const octave::idx_vector& i) const; OCTAVE_API void set_base (double b); OCTAVE_API void set_limit (double l); OCTAVE_API void set_inc (double i); friend OCTAVE_API std::ostream& operator << (std::ostream& os, const Range& r); friend OCTAVE_API std::istream& operator >> (std::istream& is, Range& r); friend OCTAVE_API Range operator - (const Range& r); friend OCTAVE_API Range operator + (double x, const Range& r); friend OCTAVE_API Range operator + (const Range& r, double x); friend OCTAVE_API Range operator - (double x, const Range& r); friend OCTAVE_API Range operator - (const Range& r, double x); friend OCTAVE_API Range operator * (double x, const Range& r); friend OCTAVE_API Range operator * (const Range& r, double x); private: double m_base; double m_limit; double m_inc; octave_idx_type m_numel; OCTAVE_API octave_idx_type numel_internal (void) const; OCTAVE_API double limit_internal (void) const; OCTAVE_API void init (void); protected: // NOTE: The following constructor may be removed when the arithmetic // operators are removed. // For operators' usage (to allow all values to be set directly). Range (double b, double l, double i, octave_idx_type n) : m_base (b), m_limit (l), m_inc (i), m_numel (n) { } }; #if defined (OCTAVE_PROVIDE_DEPRECATED_SYMBOLS) OCTAVE_DEPRECATED (7, "arithmetic operations on Range objects are unreliable") extern OCTAVE_API Range operator - (const Range& r); OCTAVE_DEPRECATED (7, "arithmetic operations on Range objects are unreliable") extern OCTAVE_API Range operator + (double x, const Range& r); OCTAVE_DEPRECATED (7, "arithmetic operations on Range objects are unreliable") extern OCTAVE_API Range operator + (const Range& r, double x); OCTAVE_DEPRECATED (7, "arithmetic operations on Range objects are unreliable") extern OCTAVE_API Range operator - (double x, const Range& r); OCTAVE_DEPRECATED (7, "arithmetic operations on Range objects are unreliable") extern OCTAVE_API Range operator - (const Range& r, double x); OCTAVE_DEPRECATED (7, "arithmetic operations on Range objects are unreliable") extern OCTAVE_API Range operator * (double x, const Range& r); OCTAVE_DEPRECATED (7, "arithmetic operations on Range objects are unreliable") extern OCTAVE_API Range operator * (const Range& r, double x); #endif #endif