Mercurial > octave
view libinterp/octave-value/ov-base.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 | c5c8bf50449c |
children | aac27ad79be6 |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 1996-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_ov_base_h) #define octave_ov_base_h 1 #include "octave-config.h" #include <cstdlib> #include <iosfwd> #include <list> #include <memory> #include <string> #include "Range.h" #include "data-conv.h" #include "mx-base.h" #include "str-vec.h" #include "auto-shlib.h" #include "oct-hdf5-types.h" #include "oct-stream.h" OCTAVE_BEGIN_NAMESPACE(octave) class stack_frame; class type_info; // FIXME: This is not ideal, but it avoids including // interpreter-private.h here and bringing in a lot of unnecessary // symbols that require even more header files. Since the typeinfo // object is required to load a user-defined octave_value object, // maybe this function should be declared in a public header file? extern OCTINTERP_API type_info& __get_type_info__ (void); // For now just preserve the old interface and don't mark it as deprecated. // This function is currently an internal, private function. Additional // changes may be made before version 8 is finally released. inline type_info& __get_type_info__ (const std::string&) { return __get_type_info__ (); } OCTAVE_END_NAMESPACE(octave) class Cell; class float_display_format; class mxArray; class octave_map; class octave_scalar_map; class octave_value; class octave_value_list; class octave_classdef; class octave_function; class octave_user_function; class octave_user_script; class octave_user_code; class octave_fcn_handle; class octave_value_list; enum builtin_type_t { btyp_double, btyp_float, btyp_complex, btyp_float_complex, btyp_int8, btyp_int16, btyp_int32, btyp_int64, btyp_uint8, btyp_uint16, btyp_uint32, btyp_uint64, btyp_bool, btyp_char, btyp_struct, btyp_cell, btyp_func_handle, btyp_unknown, btyp_num_types = btyp_unknown }; extern OCTINTERP_API std::string btyp_class_name []; inline bool btyp_isnumeric (builtin_type_t btyp) { return btyp <= btyp_uint64; } inline bool btyp_isinteger (builtin_type_t btyp) { return btyp >= btyp_int8 && btyp <= btyp_uint64; } inline bool btyp_isfloat (builtin_type_t btyp) { return btyp <= btyp_float_complex; } inline bool btyp_isarray (builtin_type_t btyp) { return btyp <= btyp_char; } //! Determine the resulting type for a possible mixed-type operation. //! //! Rules for the resulting type: //! - bool -> double //! - single + double -> single //! - real + complex -> complex //! - integer + real -> integer //! - uint + uint -> uint (the bigger one) //! - sint + sint -> sint (the bigger one) //! //! @return The resulting type or "unknown type", if the resulting type cannot //! be determined. extern OCTINTERP_API builtin_type_t btyp_mixed_numeric (builtin_type_t x, builtin_type_t y); template <typename T> struct class_to_btyp { static const builtin_type_t btyp = btyp_unknown; }; template <builtin_type_t BTYP> struct btyp_to_class { typedef void type; }; #define DEF_BTYP_TRAITS(BTYP, CLASS) \ template <> \ struct class_to_btyp<CLASS> \ { \ static const builtin_type_t btyp = BTYP; \ }; \ \ template <> \ struct btyp_to_class<BTYP> \ { \ typedef CLASS type; \ } DEF_BTYP_TRAITS (btyp_double, double); DEF_BTYP_TRAITS (btyp_float, float); DEF_BTYP_TRAITS (btyp_complex, Complex); DEF_BTYP_TRAITS (btyp_float_complex, FloatComplex); DEF_BTYP_TRAITS (btyp_int8, octave_int8); DEF_BTYP_TRAITS (btyp_int16, octave_int16); DEF_BTYP_TRAITS (btyp_int32, octave_int32); DEF_BTYP_TRAITS (btyp_int64, octave_int64); DEF_BTYP_TRAITS (btyp_uint8, octave_uint8); DEF_BTYP_TRAITS (btyp_uint16, octave_uint16); DEF_BTYP_TRAITS (btyp_uint32, octave_uint32); DEF_BTYP_TRAITS (btyp_uint64, octave_uint64); DEF_BTYP_TRAITS (btyp_bool, bool); DEF_BTYP_TRAITS (btyp_char, char); // T_ID is the type id of struct objects, set by register_type(). // T_NAME is the type name of struct objects. #define OCTAVE_EMPTY_CPP_ARG /* empty */ #define DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA \ DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA2 (OCTAVE_EMPTY_CPP_ARG) #define DECLARE_OV_BASE_TYPEID_FUNCTIONS_AND_DATA \ DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA2(virtual) #define DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA2(VIRTUAL) \ public: \ VIRTUAL int type_id (void) const { return t_id; } \ VIRTUAL std::string type_name (void) const { return t_name; } \ VIRTUAL std::string class_name (void) const { return c_name; } \ static int static_type_id (void) { return t_id; } \ static std::string static_type_name (void) { return t_name; } \ static std::string static_class_name (void) { return c_name; } \ static void register_type (void); \ static void register_type (octave::type_info&); \ \ private: \ static int t_id; \ static const std::string t_name; \ static const std::string c_name; #define DECLARE_TEMPLATE_OV_TYPEID_SPECIALIZATIONS(cls, type) \ template <> void cls<type>::register_type (void); \ template <> void cls<type>::register_type (octave::type_info&); \ template <> int cls<type>::t_id; \ template <> const std::string cls<type>::t_name; \ template <> const std::string cls<type>::c_name; #define DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA_INTERNAL(tspec, t, n, c) \ tspec int t::t_id (-1); \ tspec const std::string t::t_name (n); \ tspec const std::string t::c_name (c); \ tspec void t::register_type (void) \ { \ octave::type_info& type_info = octave::__get_type_info__ (); \ \ register_type (type_info); \ } \ tspec void t::register_type (octave::type_info& ti) \ { \ octave_value v (new t ()); \ t_id = ti.register_type (t::t_name, t::c_name, v); \ } #define DEFINE_TEMPLATE_OV_TYPEID_FUNCTIONS_AND_DATA(t, n, c) \ DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA_INTERNAL (template <>, t, n, c) #define DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA(t, n, c) \ DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA_INTERNAL ( , t, n, c) // A base value type, so that derived types only have to redefine what // they need (if they are derived from octave_base_value instead of // octave_value). class OCTINTERP_API octave_base_value { public: typedef octave_base_value * (*type_conv_fcn) (const octave_base_value&); // type conversion, including result type information class type_conv_info { public: type_conv_info (type_conv_fcn f = nullptr, int t = -1) : m_fcn (f), m_type_id (t) { } operator type_conv_fcn (void) const { return m_fcn; } octave_base_value * operator () (const octave_base_value& v) const { return (*m_fcn) (v); } int type_id (void) const { return m_type_id; } private: type_conv_fcn m_fcn; int m_type_id; }; friend class octave_value; octave_base_value (void) : count (1) { } octave_base_value (const octave_base_value&) : count (1) { } virtual ~octave_base_value (void) = default; // Unconditional clone. Always clones. virtual octave_base_value * clone (void) const { return new octave_base_value (*this); } // Empty clone. virtual octave_base_value * empty_clone (void) const; // Unique clone. Usually clones, but may be overridden to fake the // cloning when sharing copies is to be controlled from within an // instance (see octave_class). virtual octave_base_value * unique_clone (void) { return clone (); } virtual void break_closure_cycles (const std::shared_ptr<octave::stack_frame>&) { } virtual type_conv_info numeric_conversion_function (void) const { return type_conv_info (); } virtual type_conv_info numeric_demotion_function (void) const { return type_conv_info (); } virtual octave_value squeeze (void) const; virtual octave_value full_value (void) const; virtual octave_value as_double (void) const; virtual octave_value as_single (void) const; virtual octave_value as_int8 (void) const; virtual octave_value as_int16 (void) const; virtual octave_value as_int32 (void) const; virtual octave_value as_int64 (void) const; virtual octave_value as_uint8 (void) const; virtual octave_value as_uint16 (void) const; virtual octave_value as_uint32 (void) const; virtual octave_value as_uint64 (void) const; virtual octave_base_value * try_narrowing_conversion (void) { return nullptr; } virtual void maybe_economize (void) { } virtual Matrix size (void); virtual octave_idx_type xnumel (const octave_value_list&); // FIXME: Do we really need all three of these versions of subsref? virtual octave_value subsref (const std::string& type, const std::list<octave_value_list>& idx); virtual octave_value_list subsref (const std::string& type, const std::list<octave_value_list>& idx, int nargout); virtual octave_value subsref (const std::string& type, const std::list<octave_value_list>& idx, bool auto_add); virtual octave_value do_index_op (const octave_value_list& idx, bool resize_ok = false); virtual void assign (const std::string&, const octave_value&) { } virtual octave_value subsasgn (const std::string& type, const std::list<octave_value_list>& idx, const octave_value& rhs); virtual octave_value undef_subsasgn (const std::string& type, const std::list<octave_value_list>& idx, const octave_value& rhs); virtual octave::idx_vector index_vector (bool require_integers = false) const; virtual dim_vector dims (void) const { return dim_vector (); } octave_idx_type rows (void) const { const dim_vector dv = dims (); return dv(0); } octave_idx_type columns (void) const { const dim_vector dv = dims (); return dv(1); } virtual int ndims (void) const { return dims ().ndims (); } virtual octave_idx_type numel (void) const { return dims ().numel (); } virtual std::size_t byte_size (void) const { return 0; } virtual octave_idx_type nnz (void) const; virtual octave_idx_type nzmax (void) const; virtual octave_idx_type nfields (void) const; virtual octave_value reshape (const dim_vector&) const; virtual octave_value permute (const Array<int>& vec, bool = false) const; virtual octave_value resize (const dim_vector&, bool fill = false) const; virtual MatrixType matrix_type (void) const; virtual MatrixType matrix_type (const MatrixType& typ) const; virtual bool is_defined (void) const { return false; } virtual bool is_storable (void) const { return true; } virtual bool is_legacy_object (void) const { return false; } bool isempty (void) const { return (dims ().any_zero ()); } bool is_zero_by_zero (void) const { return dims().zero_by_zero (); } virtual bool iscell (void) const { return false; } virtual bool iscellstr (void) const { return false; } virtual bool is_real_scalar (void) const { return false; } virtual bool is_real_matrix (void) const { return false; } virtual bool is_complex_scalar (void) const { return false; } virtual bool is_complex_matrix (void) const { return false; } virtual bool is_bool_scalar (void) const { return false; } virtual bool is_bool_matrix (void) const { return false; } virtual bool is_char_matrix (void) const { return false; } virtual bool is_diag_matrix (void) const { return false; } virtual bool is_perm_matrix (void) const { return false; } virtual bool is_string (void) const { return false; } virtual bool is_sq_string (void) const { return false; } virtual bool is_range (void) const { return false; } virtual bool isstruct (void) const { return false; } virtual bool isobject (void) const { return false; } virtual bool is_classdef_meta (void) const { return false; } virtual bool is_classdef_superclass_ref (void) const { return false; } virtual bool is_classdef_object (void) const { return false; } virtual bool is_package (void) const { return false; } virtual bool isjava (void) const { return false; } virtual bool is_cs_list (void) const { return false; } virtual bool is_magic_colon (void) const { return false; } virtual bool is_all_va_args (void) const { return false; } virtual octave_value all (int = 0) const; virtual octave_value any (int = 0) const; virtual builtin_type_t builtin_type (void) const { return btyp_unknown; } virtual bool is_double_type (void) const { return false; } virtual bool is_single_type (void) const { return false; } virtual bool isfloat (void) const { return false; } virtual bool is_int8_type (void) const { return false; } virtual bool is_int16_type (void) const { return false; } virtual bool is_int32_type (void) const { return false; } virtual bool is_int64_type (void) const { return false; } virtual bool is_uint8_type (void) const { return false; } virtual bool is_uint16_type (void) const { return false; } virtual bool is_uint32_type (void) const { return false; } virtual bool is_uint64_type (void) const { return false; } virtual bool islogical (void) const { return false; } virtual bool isinteger (void) const { return false; } virtual bool isreal (void) const { return false; } virtual bool iscomplex (void) const { return false; } // Would be nice to get rid of the next four functions: virtual bool is_scalar_type (void) const { return false; } virtual bool is_matrix_type (void) const { return false; } virtual bool isnumeric (void) const { return false; } virtual bool issparse (void) const { return false; } virtual bool is_true (void) const { return false; } virtual bool is_magic_int (void) const { return false; } virtual bool isnull (void) const { return false; } virtual bool is_constant (void) const { return false; } virtual bool is_function_handle (void) const { return false; } virtual bool is_anonymous_function (void) const { return false; } virtual bool is_inline_function (void) const { return false; } virtual bool is_function (void) const { return false; } virtual bool is_user_script (void) const { return false; } virtual bool is_user_function (void) const { return false; } virtual bool is_user_code (void) const { return false; } virtual bool is_builtin_function (void) const { return false; } virtual bool is_dld_function (void) const { return false; } virtual bool is_mex_function (void) const { return false; } virtual void erase_subfunctions (void) { } virtual short int short_value (bool = false, bool = false) const; virtual unsigned short int ushort_value (bool = false, bool = false) const; virtual int int_value (bool = false, bool = false) const; virtual unsigned int uint_value (bool = false, bool = false) const; virtual int nint_value (bool = false) const; virtual long int long_value (bool = false, bool = false) const; virtual unsigned long int ulong_value (bool = false, bool = false) const; virtual int64_t int64_value (bool = false, bool = false) const; virtual uint64_t uint64_value (bool = false, bool = false) const; virtual double double_value (bool = false) const; virtual float float_value (bool = false) const; virtual double scalar_value (bool frc_str_conv = false) const { return double_value (frc_str_conv); } virtual float float_scalar_value (bool frc_str_conv = false) const { return float_value (frc_str_conv); } virtual Cell cell_value (void) const; virtual Matrix matrix_value (bool = false) const; virtual FloatMatrix float_matrix_value (bool = false) const; virtual NDArray array_value (bool = false) const; virtual FloatNDArray float_array_value (bool = false) const; virtual Complex complex_value (bool = false) const; virtual FloatComplex float_complex_value (bool = false) const; virtual ComplexMatrix complex_matrix_value (bool = false) const; virtual FloatComplexMatrix float_complex_matrix_value (bool = false) const; virtual ComplexNDArray complex_array_value (bool = false) const; virtual FloatComplexNDArray float_complex_array_value (bool = false) const; virtual bool bool_value (bool = false) const; virtual boolMatrix bool_matrix_value (bool = false) const; virtual boolNDArray bool_array_value (bool = false) const; virtual charMatrix char_matrix_value (bool force = false) const; virtual charNDArray char_array_value (bool = false) const; virtual SparseMatrix sparse_matrix_value (bool = false) const; virtual SparseComplexMatrix sparse_complex_matrix_value (bool = false) const; virtual SparseBoolMatrix sparse_bool_matrix_value (bool = false) const; virtual DiagMatrix diag_matrix_value (bool = false) const; virtual FloatDiagMatrix float_diag_matrix_value (bool = false) const; virtual ComplexDiagMatrix complex_diag_matrix_value (bool = false) const; virtual FloatComplexDiagMatrix float_complex_diag_matrix_value (bool = false) const; virtual PermMatrix perm_matrix_value (void) const; virtual octave_int8 int8_scalar_value (void) const; virtual octave_int16 int16_scalar_value (void) const; virtual octave_int32 int32_scalar_value (void) const; virtual octave_int64 int64_scalar_value (void) const; virtual octave_uint8 uint8_scalar_value (void) const; virtual octave_uint16 uint16_scalar_value (void) const; virtual octave_uint32 uint32_scalar_value (void) const; virtual octave_uint64 uint64_scalar_value (void) const; virtual int8NDArray int8_array_value (void) const; virtual int16NDArray int16_array_value (void) const; virtual int32NDArray int32_array_value (void) const; virtual int64NDArray int64_array_value (void) const; virtual uint8NDArray uint8_array_value (void) const; virtual uint16NDArray uint16_array_value (void) const; virtual uint32NDArray uint32_array_value (void) const; virtual uint64NDArray uint64_array_value (void) const; virtual string_vector string_vector_value (bool pad = false) const; virtual std::string string_value (bool force = false) const; virtual Array<std::string> cellstr_value (void) const; virtual octave::range<double> range_value (void) const; // For now, disable all but range<double>. #if 0 virtual octave::range<float> float_range_value (void) const; virtual octave::range<octave_int8> int8_range_value (void) const; virtual octave::range<octave_int16> int16_range_value (void) const; virtual octave::range<octave_int32> int32_range_value (void) const; virtual octave::range<octave_int64> int64_range_value (void) const; virtual octave::range<octave_uint8> uint8_range_value (void) const; virtual octave::range<octave_uint16> uint16_range_value (void) const; virtual octave::range<octave_uint32> uint32_range_value (void) const; virtual octave::range<octave_uint64> uint64_range_value (void) const; #endif virtual octave_map map_value (void) const; virtual octave_scalar_map scalar_map_value (void) const; virtual string_vector map_keys (void) const; virtual bool isfield (const std::string&) const; virtual std::size_t nparents (void) const; virtual std::list<std::string> parent_class_name_list (void) const; virtual string_vector parent_class_names (void) const; virtual octave_base_value * find_parent_class (const std::string&) { return nullptr; } virtual octave_base_value * unique_parent_class (const std::string&) { return nullptr; } virtual bool is_instance_of (const std::string&) const { return false; } virtual octave_classdef * classdef_object_value (bool silent = false); virtual octave_function * function_value (bool silent = false); virtual octave_user_function * user_function_value (bool silent = false); virtual octave_user_script * user_script_value (bool silent = false); virtual octave_user_code * user_code_value (bool silent = false); virtual octave_fcn_handle * fcn_handle_value (bool silent = false); virtual octave_value_list list_value (void) const; virtual octave_value convert_to_str (bool pad = false, bool force = false, char type = '\'') const; virtual octave_value convert_to_str_internal (bool pad, bool force, char type) const; virtual void convert_to_row_or_column_vector (void); // The following extractor functions don't perform any implicit type // conversions. virtual std::string xstring_value () const; virtual bool print_as_scalar (void) const { return false; } virtual void print (std::ostream& os, bool pr_as_read_syntax = false); virtual void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const; virtual bool print_name_tag (std::ostream& os, const std::string& name) const; virtual void print_with_name (std::ostream& output_buf, const std::string& name, bool print_padding = true); virtual void short_disp (std::ostream& os) const { os << "..."; } virtual float_display_format get_edit_display_format (void) const; virtual std::string edit_display (const float_display_format&, octave_idx_type, octave_idx_type) const { return "#VAL"; } virtual void print_info (std::ostream& os, const std::string& prefix) const; virtual bool save_ascii (std::ostream& os); virtual bool load_ascii (std::istream& is); virtual bool save_binary (std::ostream& os, bool save_as_floats); virtual bool load_binary (std::istream& is, bool swap, octave::mach_info::float_format fmt); virtual bool save_hdf5 (octave_hdf5_id loc_id, const char *name, bool save_as_floats); virtual bool load_hdf5 (octave_hdf5_id loc_id, const char *name); virtual int write (octave::stream& os, int block_size, oct_data_conv::data_type output_type, int skip, octave::mach_info::float_format flt_fmt) const; virtual const void * mex_get_data (void) const { return nullptr; } virtual const octave_idx_type * mex_get_ir (void) const { return nullptr; } virtual const octave_idx_type * mex_get_jc (void) const { return nullptr; } virtual mxArray * as_mxArray (bool interleaved) const; virtual octave_value diag (octave_idx_type k = 0) const; virtual octave_value diag (octave_idx_type m, octave_idx_type n) const; virtual octave_value sort (octave_idx_type dim = 0, sortmode mode = ASCENDING) const; virtual octave_value sort (Array<octave_idx_type>& sidx, octave_idx_type dim = 0, sortmode mode = ASCENDING) const; virtual sortmode issorted (sortmode mode = UNSORTED) const; virtual Array<octave_idx_type> sort_rows_idx (sortmode mode = ASCENDING) const; virtual sortmode is_sorted_rows (sortmode mode = UNSORTED) const; virtual void lock (void); virtual void unlock (void); virtual bool islocked (void) const { return false; } virtual void call_object_destructor (void) { } virtual octave_value dump (void) const; // Standard mappers. Register new ones here. enum unary_mapper_t { umap_abs, umap_acos, umap_acosh, umap_angle, umap_arg, umap_asin, umap_asinh, umap_atan, umap_atanh, umap_cbrt, umap_ceil, umap_conj, umap_cos, umap_cosh, umap_erf, umap_erfinv, umap_erfcinv, umap_erfc, umap_erfcx, umap_erfi, umap_dawson, umap_exp, umap_expm1, umap_isfinite, umap_fix, umap_floor, umap_gamma, umap_imag, umap_isinf, umap_isna, umap_isnan, umap_lgamma, umap_log, umap_log2, umap_log10, umap_log1p, umap_real, umap_round, umap_roundb, umap_signum, umap_sin, umap_sinh, umap_sqrt, umap_tan, umap_tanh, umap_xisalnum, umap_xisalpha, umap_xisascii, umap_xiscntrl, umap_xisdigit, umap_xisgraph, umap_xislower, umap_xisprint, umap_xispunct, umap_xisspace, umap_xisupper, umap_xisxdigit, umap_xsignbit, umap_xtolower, umap_xtoupper, umap_unknown, num_unary_mappers = umap_unknown }; virtual octave_value map (unary_mapper_t) const; // These are fast indexing & assignment shortcuts for extracting // or inserting a single scalar from/to an array. // Extract the n-th element, aka val(n). Result is undefined if val is not // an array type or n is out of range. Never error. virtual octave_value fast_elem_extract (octave_idx_type n) const; // Assign the n-th element, aka val(n) = x. Returns false if val is not an // array type, x is not a matching scalar type, or n is out of range. // Never error. virtual bool fast_elem_insert (octave_idx_type n, const octave_value& x); // This is a helper for the above, to be overridden in scalar types. The // whole point is to handle the insertion efficiently with just *two* VM // calls, which is basically the theoretical minimum. virtual bool fast_elem_insert_self (void *where, builtin_type_t btyp) const; protected: // This should only be called for derived types. OCTINTERP_API octave_value numeric_assign (const std::string& type, const std::list<octave_value_list>& idx, const octave_value& rhs); void reset_indent_level (void) const { s_curr_print_indent_level = 0; } void increment_indent_level (void) const { s_curr_print_indent_level += 2; } void decrement_indent_level (void) const { s_curr_print_indent_level -= 2; } int current_print_indent_level (void) const { return s_curr_print_indent_level; } OCTINTERP_API void indent (std::ostream& os) const; OCTINTERP_API void newline (std::ostream& os) const; OCTINTERP_API void reset (void) const; // A reference count. // NOTE: the declaration is octave_idx_type because with 64-bit indexing, // it is well possible to have more than MAX_INT copies of a single value // (think of an empty cell array with >2G elements). octave::refcount<octave_idx_type> count; OCTINTERP_API static const char * get_umap_name (unary_mapper_t); OCTINTERP_API void warn_load (const char *type) const; OCTINTERP_API void warn_save (const char *type) const; private: OCTINTERP_API void wrong_type_arg_error (void) const; //-------- static int s_curr_print_indent_level; static bool s_beginning_of_line; DECLARE_OV_BASE_TYPEID_FUNCTIONS_AND_DATA }; class OCTINTERP_API octave_base_dld_value : public octave_base_value { public: octave_base_dld_value (void) = default; ~octave_base_dld_value (void) { m_containing_dynamic_library.delete_later (); } octave_base_dld_value (const octave_base_dld_value&) = default; private: octave::auto_shlib m_containing_dynamic_library; }; OCTAVE_DEPRECATED (8, "Vsparse_auto_mutate is obsolete and is now always false") extern OCTINTERP_API bool Vsparse_auto_mutate; // Utility function to convert C++ arguments used in subsref/subsasgn into an // octave_value_list object that can be used to call a function/method in the // interpreter. extern OCTINTERP_API octave_value make_idx_args (const std::string& type, const std::list<octave_value_list>& idx, const std::string& who); // Tells whether some regular octave_value_base methods are being called from // within the "builtin" function. extern OCTINTERP_API bool called_from_builtin (void); #endif