Mercurial > octave
view libinterp/octave-value/ov-magic-int.h @ 32628:ae4e19c0a2b1
maint: Place class name and class keyword on one line.
* libinterp/corefcn/Cell.h, libinterp/corefcn/__magick_read__.cc,
libinterp/corefcn/auto-shlib.h, libinterp/corefcn/base-text-renderer.h,
libinterp/corefcn/c-file-ptr-stream.h, libinterp/corefcn/call-stack.h,
libinterp/corefcn/dynamic-ld.h, libinterp/corefcn/event-manager.h,
libinterp/corefcn/event-queue.h, libinterp/corefcn/ft-text-renderer.cc,
libinterp/corefcn/gl-render.cc, libinterp/corefcn/gl-render.h,
libinterp/corefcn/gl2ps-print.cc, libinterp/corefcn/graphics.cc,
libinterp/corefcn/graphics.in.h, libinterp/corefcn/input.cc,
libinterp/corefcn/latex-text-renderer.cc, libinterp/corefcn/load-path.h,
libinterp/corefcn/mx-type-traits.h, libinterp/corefcn/oct-errno.h,
libinterp/corefcn/oct-fstrm.h, libinterp/corefcn/oct-iostrm.h,
libinterp/corefcn/oct-prcstrm.h, libinterp/corefcn/oct-procbuf.h,
libinterp/corefcn/oct-process.h, libinterp/corefcn/oct-stdstrm.h,
libinterp/corefcn/oct-stream.cc, libinterp/corefcn/oct-stream.h,
libinterp/corefcn/oct-strstrm.h, libinterp/corefcn/pager.h,
libinterp/corefcn/pr-flt-fmt.h, libinterp/corefcn/pr-output.cc,
libinterp/corefcn/pr-output.h, libinterp/corefcn/procstream.h,
libinterp/corefcn/syminfo.h, libinterp/corefcn/text-engine.h,
libinterp/corefcn/text-renderer.h, libinterp/corefcn/utils.h,
libinterp/octave-value/cdef-class.h, libinterp/octave-value/cdef-manager.h,
libinterp/octave-value/cdef-method.h, libinterp/octave-value/cdef-object.h,
libinterp/octave-value/cdef-package.h, libinterp/octave-value/cdef-property.h,
libinterp/octave-value/ov-base-diag.h, libinterp/octave-value/ov-base-int.h,
libinterp/octave-value/ov-base-mat.h, libinterp/octave-value/ov-base-scalar.h,
libinterp/octave-value/ov-base-sparse.h, libinterp/octave-value/ov-base.h,
libinterp/octave-value/ov-bool-mat.h, libinterp/octave-value/ov-bool-sparse.h,
libinterp/octave-value/ov-bool.h, libinterp/octave-value/ov-builtin.h,
libinterp/octave-value/ov-cell.h, libinterp/octave-value/ov-ch-mat.h,
libinterp/octave-value/ov-class.cc, libinterp/octave-value/ov-class.h,
libinterp/octave-value/ov-classdef.h, libinterp/octave-value/ov-colon.h,
libinterp/octave-value/ov-complex.h, libinterp/octave-value/ov-cs-list.h,
libinterp/octave-value/ov-cx-diag.h, libinterp/octave-value/ov-cx-mat.h,
libinterp/octave-value/ov-cx-sparse.h, libinterp/octave-value/ov-dld-fcn.h,
libinterp/octave-value/ov-fcn-handle.h, libinterp/octave-value/ov-fcn.h,
libinterp/octave-value/ov-float.h, libinterp/octave-value/ov-flt-complex.h,
libinterp/octave-value/ov-flt-cx-diag.h,
libinterp/octave-value/ov-flt-cx-mat.h,
libinterp/octave-value/ov-flt-re-diag.h,
libinterp/octave-value/ov-flt-re-mat.h, libinterp/octave-value/ov-int-traits.h,
libinterp/octave-value/ov-intx.h, libinterp/octave-value/ov-lazy-idx.h,
libinterp/octave-value/ov-legacy-range.cc,
libinterp/octave-value/ov-legacy-range.h,
libinterp/octave-value/ov-magic-int.h, libinterp/octave-value/ov-mex-fcn.h,
libinterp/octave-value/ov-null-mat.h, libinterp/octave-value/ov-perm.h,
libinterp/octave-value/ov-range-traits.h, libinterp/octave-value/ov-range.h,
libinterp/octave-value/ov-re-diag.h, libinterp/octave-value/ov-re-mat.h,
libinterp/octave-value/ov-re-sparse.h, libinterp/octave-value/ov-scalar.h,
libinterp/octave-value/ov-str-mat.h, libinterp/octave-value/ov-struct.h,
libinterp/octave-value/ov-typeinfo.h, libinterp/octave-value/ov-usr-fcn.h,
libinterp/octave-value/ov.h, libinterp/octave-value/ovl.h,
libinterp/parse-tree/comment-list.h, libinterp/parse-tree/lex.h,
libinterp/parse-tree/profiler.h, libinterp/parse-tree/pt-anon-scopes.h,
liboctave/array/Array.h, liboctave/array/CColVector.h,
liboctave/array/CDiagMatrix.h, liboctave/array/CMatrix.h,
liboctave/array/CNDArray.h, liboctave/array/CRowVector.h,
liboctave/array/CSparse.h, liboctave/array/DiagArray2.h,
liboctave/array/MArray.h, liboctave/array/MDiagArray2.h,
liboctave/array/MSparse.h, liboctave/array/MatrixType.h,
liboctave/array/Range.h, liboctave/array/Sparse.h,
liboctave/array/boolMatrix.h, liboctave/array/boolNDArray.h,
liboctave/array/boolSparse.h, liboctave/array/chMatrix.h,
liboctave/array/chNDArray.h, liboctave/array/dColVector.h,
liboctave/array/dDiagMatrix.h, liboctave/array/dMatrix.h,
liboctave/array/dNDArray.h, liboctave/array/dRowVector.h,
liboctave/array/dSparse.h, liboctave/array/dim-vector.h,
liboctave/array/fCColVector.h, liboctave/array/fCDiagMatrix.h,
liboctave/array/fCMatrix.h, liboctave/array/fCNDArray.h,
liboctave/array/fCRowVector.h, liboctave/array/fColVector.h,
liboctave/array/fDiagMatrix.h, liboctave/array/fMatrix.h,
liboctave/array/fNDArray.h, liboctave/array/fRowVector.h,
liboctave/array/idx-vector.h, liboctave/array/intNDArray.h,
liboctave/numeric/DAE.h, liboctave/numeric/DAEFunc.h,
liboctave/numeric/DAERT.h, liboctave/numeric/DAERTFunc.h,
liboctave/numeric/DASPK.h, liboctave/numeric/DASRT.h,
liboctave/numeric/DASSL.h, liboctave/numeric/DET.h, liboctave/numeric/EIG.h,
liboctave/numeric/LSODE.h, liboctave/numeric/ODE.h,
liboctave/numeric/ODEFunc.h, liboctave/numeric/ODES.h,
liboctave/numeric/ODESFunc.h, liboctave/numeric/Quad.h,
liboctave/numeric/aepbalance.h, liboctave/numeric/base-dae.h,
liboctave/numeric/base-de.h, liboctave/numeric/chol.h,
liboctave/numeric/fEIG.h, liboctave/numeric/gepbalance.h,
liboctave/numeric/gsvd.h, liboctave/numeric/hess.h, liboctave/numeric/lu.h,
liboctave/numeric/oct-fftw.h, liboctave/numeric/qr.h, liboctave/numeric/qrp.h,
liboctave/numeric/schur.h, liboctave/numeric/sparse-chol.h,
liboctave/numeric/sparse-lu.h, liboctave/numeric/sparse-qr.cc,
liboctave/numeric/sparse-qr.h, liboctave/numeric/svd.cc,
liboctave/numeric/svd.h, liboctave/system/dir-ops.h,
liboctave/system/file-stat.h, liboctave/system/oct-env.h,
liboctave/system/oct-group.h, liboctave/system/oct-password.h,
liboctave/system/oct-time.h, liboctave/system/oct-uname.h,
liboctave/util/action-container.h, liboctave/util/base-list.h,
liboctave/util/cmd-edit.cc, liboctave/util/cmd-edit.h,
liboctave/util/cmd-hist.cc, liboctave/util/cmd-hist.h,
liboctave/util/data-conv.h, liboctave/util/glob-match.h,
liboctave/util/lo-regexp.h, liboctave/util/oct-inttypes.h,
liboctave/util/oct-mutex.cc, liboctave/util/oct-mutex.h,
liboctave/util/oct-shlib.cc, liboctave/util/oct-shlib.h,
liboctave/util/oct-sort.h, liboctave/util/oct-string.h,
liboctave/util/octave-preserve-stream-state.h, liboctave/util/pathsearch.h,
liboctave/util/singleton-cleanup.h, liboctave/util/str-vec.h,
liboctave/util/unwind-prot.h, liboctave/util/url-transfer.h:
Place class name and class keyword on one line.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 21 Dec 2023 11:22:26 -0800 |
parents | 0cafa72d1408 |
children | 4b601ca024d5 |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 2020-2023 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_magic_int_h) #define octave_ov_magic_int_h 1 #include "octave-config.h" #include <iosfwd> #include <string> #include "oct-inttypes-fwd.h" #include "ov-base.h" #include "ov-re-mat.h" #include "ov-base-scalar.h" #include "ov-typeinfo.h" class octave_value_list; // Large integer scalar values. The uint64 or int64 value they contain may be // accessed without loss of precision when needed (for example, when // directly converted to a uint64 or int64 value). Otherwise, they // behave like real scalars, so any operation on them will result in // type conversion. template <typename T> class octave_base_magic_int : public octave_base_scalar<T> { public: octave_base_magic_int () : octave_base_scalar<T> (0) { } octave_base_magic_int (const T& val) : octave_base_scalar<T> (val) { } ~octave_base_magic_int () = default; // We return an octave_matrix here instead of an octave_scalar so // that in expressions like A(2,2,2) = 2 (for A previously // undefined), A will be empty instead of a 1x1 object. octave_base_value * empty_clone () const { return new octave_matrix (); } // Although SCALAR is a protected member of the base class, it is not // directly visible here without the explicit octave_base_slalar<T>:: // qualification. Why not? const T& scalar_ref () const { return octave_base_scalar<T>::scalar; } T& scalar_ref () { return octave_base_scalar<T>::scalar; } octave_value do_index_op (const octave_value_list& idx, bool resize_ok = false); octave::idx_vector index_vector (bool require_integers = false) const; octave_value any (int = 0) const { return scalar_ref () != T (0); } builtin_type_t builtin_type () const { return btyp_double; } bool is_storable () const { return false; } bool is_magic_int () const { return true; } bool vm_need_storable_call () const { return true; } bool is_real_scalar () const { return true; } bool isreal () const { return true; } bool is_double_type () const { return true; } bool isfloat () const { return true; } int8NDArray int8_array_value () const { return int8NDArray (dim_vector (1, 1), double_value ()); } int16NDArray int16_array_value () const { return int16NDArray (dim_vector (1, 1), double_value ()); } int32NDArray int32_array_value () const { return int32NDArray (dim_vector (1, 1), double_value ()); } int64NDArray int64_array_value () const { return int64NDArray (dim_vector (1, 1), double_value ()); } uint8NDArray uint8_array_value () const { return uint8NDArray (dim_vector (1, 1), double_value ()); } uint16NDArray uint16_array_value () const { return uint16NDArray (dim_vector (1, 1), double_value ()); } uint32NDArray uint32_array_value () const { return uint32NDArray (dim_vector (1, 1), double_value ()); } uint64NDArray uint64_array_value () const { return uint64NDArray (dim_vector (1, 1), double_value ()); } octave_int8 int8_scalar_value () const { return octave_int8 (double_value ()); } octave_int16 int16_scalar_value () const { return octave_int16 (double_value ()); } octave_int32 int32_scalar_value () const { return octave_int32 (double_value ()); } octave_int64 int64_scalar_value () const { return octave_int64 (double_value ()); } octave_uint8 uint8_scalar_value () const { return octave_uint8 (double_value ()); } octave_uint16 uint16_scalar_value () const { return octave_uint16 (double_value ()); } octave_uint32 uint32_scalar_value () const { return octave_uint32 (double_value ()); } octave_uint64 uint64_scalar_value () const { return octave_uint64 (double_value ()); } double double_value (bool = false) const { return scalar_ref ().double_value (); } float float_value (bool = false) const { return static_cast<float> (double_value ()); } double scalar_value (bool = false) const { return double_value (); } float float_scalar_value (bool = false) const { return float_value (); } Matrix matrix_value (bool = false) const { return Matrix (1, 1, double_value ()); } FloatMatrix float_matrix_value (bool = false) const { return FloatMatrix (1, 1, float_value ()); } NDArray array_value (bool = false) const { return NDArray (dim_vector (1, 1), double_value ()); } FloatNDArray float_array_value (bool = false) const { return FloatNDArray (dim_vector (1, 1), float_value ()); } SparseMatrix sparse_matrix_value (bool = false) const { return SparseMatrix (Matrix (1, 1, double_value ())); } // FIXME: Need SparseComplexMatrix (Matrix) constructor! SparseComplexMatrix sparse_complex_matrix_value (bool = false) const { return SparseComplexMatrix (sparse_matrix_value ()); } octave_value resize (const dim_vector& dv, bool fill = false) const; Complex complex_value (bool = false) const { return double_value (); } FloatComplex float_complex_value (bool = false) const { return FloatComplex (float_value ()); } ComplexMatrix complex_matrix_value (bool = false) const { return ComplexMatrix (1, 1, Complex (double_value ())); } FloatComplexMatrix float_complex_matrix_value (bool = false) const { return FloatComplexMatrix (1, 1, FloatComplex (float_value ())); } ComplexNDArray complex_array_value (bool = false) const { return ComplexNDArray (dim_vector (1, 1), Complex (double_value ())); } FloatComplexNDArray float_complex_array_value (bool = false) const { return FloatComplexNDArray (dim_vector (1, 1), FloatComplex (float_value ())); } charNDArray char_array_value (bool = false) const { charNDArray retval (dim_vector (1, 1)); retval(0) = static_cast<char> (double_value ()); return retval; } bool bool_value (bool warn = false) const { if (warn && scalar_ref () != T (0) && scalar_ref () != T (1)) warn_logical_conversion (); return double_value (); } boolNDArray bool_array_value (bool warn = false) const { if (warn && scalar_ref () != T (0) && scalar_ref () != T (1)) warn_logical_conversion (); return boolNDArray (dim_vector (1, 1), double_value ()); } octave_value as_double () const; octave_value as_single () const; octave_value as_int8 () const; octave_value as_int16 () const; octave_value as_int32 () const; octave_value as_int64 () const; octave_value as_uint8 () const; octave_value as_uint16 () const; octave_value as_uint32 () const; octave_value as_uint64 () const; // We don't need to override both forms of the diag method. The using // declaration will avoid warnings about partially-overloaded virtual // functions. using octave_base_scalar<T>::diag; octave_value diag (octave_idx_type m, octave_idx_type n) const; octave_value convert_to_str_internal (bool pad, bool force, char type) const; void increment () { scalar_ref () += T (1); } void decrement () { scalar_ref () -= T (1); } bool save_ascii (std::ostream& os); bool load_ascii (std::istream& is); bool save_binary (std::ostream& os, bool save_as_floats); bool load_binary (std::istream& is, bool swap, octave::mach_info::float_format fmt); bool save_hdf5 (octave_hdf5_id loc_id, const char *name, bool save_as_floats); bool load_hdf5 (octave_hdf5_id loc_id, const char *name); 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 { return os.write (array_value (), block_size, output_type, skip, flt_fmt); } mxArray * as_mxArray (bool interleaved) const; octave_value map (octave_base_value::unary_mapper_t umap) const; }; class OCTINTERP_API octave_magic_uint : public octave_base_magic_int<octave_uint64> { public: octave_magic_uint () : octave_base_magic_int<octave_uint64> (0) { } octave_magic_uint (const octave_uint64& val) : octave_base_magic_int<octave_uint64> (val) { } ~octave_magic_uint () = default; octave_base_value * clone () const { return new octave_magic_uint (*this); } type_conv_info numeric_conversion_function () const; private: DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA }; class OCTINTERP_API octave_magic_int : public octave_base_magic_int<octave_int64> { public: octave_magic_int () : octave_base_magic_int<octave_int64> (0) { } octave_magic_int (const octave_int64& val) : octave_base_magic_int<octave_int64> (val) { } ~octave_magic_int () = default; octave_base_value * clone () const { return new octave_magic_int (*this); } type_conv_info numeric_conversion_function () const; private: DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA }; #endif