ov-scalar.h

Go to the documentation of this file.

////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 1996-2024 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_scalar_h)
#define octave_ov_scalar_h 1
 
#include "octave-config.h"
 
#include <cstdlib>
 
#include <iosfwd>
#include <string>
 
#include "lo-ieee.h"
#include "lo-mappers.h"
#include "lo-utils.h"
#include "mx-base.h"
#include "str-vec.h"
 
#include "errwarn.h"
#include "ov-base.h"
#include "ov-re-mat.h"
#include "ov-base-scalar.h"
#include "ov-typeinfo.h"
 
class octave_value_list;
 
// Real scalar values.
 
class
OCTINTERP_API
octave_scalar : public octave_base_scalar<double>
{
public:
 
  octave_scalar ()
    : octave_base_scalar<double> (0.0) { }
 
  octave_scalar (double d)
    : octave_base_scalar<double> (d) { }
 
  octave_scalar (const octave_scalar& s)
    : octave_base_scalar<double> (s) { }
 
  ~octave_scalar () = default;
 
  octave_base_value * clone () const { return new octave_scalar (*this); }
 
  // 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 (); }
 
  octave_value do_index_op (const octave_value_list& idx,
                            bool resize_ok = false);
 
  type_conv_info numeric_demotion_function () const;
 
  octave::idx_vector index_vector (bool /* require_integers */ = false) const
  { return octave::idx_vector (scalar); }
 
  octave_value any (int = 0) const
  { return (scalar != 0 && ! lo_ieee_isnan (scalar)); }
 
  builtin_type_t builtin_type () const { return btyp_double; }
 
  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), scalar); }
 
  int16NDArray
  int16_array_value () const
  { return int16NDArray (dim_vector (1, 1), scalar); }
 
  int32NDArray
  int32_array_value () const
  { return int32NDArray (dim_vector (1, 1), scalar); }
 
  int64NDArray
  int64_array_value () const
  { return int64NDArray (dim_vector (1, 1), scalar); }
 
  uint8NDArray
  uint8_array_value () const
  { return uint8NDArray (dim_vector (1, 1), scalar); }
 
  uint16NDArray
  uint16_array_value () const
  { return uint16NDArray (dim_vector (1, 1), scalar); }
 
  uint32NDArray
  uint32_array_value () const
  { return uint32NDArray (dim_vector (1, 1), scalar); }
 
  uint64NDArray
  uint64_array_value () const
  { return uint64NDArray (dim_vector (1, 1), scalar); }
 
#define DEFINE_INT_SCALAR_VALUE(TYPE)           \
  octave_ ## TYPE                               \
  TYPE ## _scalar_value () const            \
  {                                             \
    return octave_ ## TYPE (scalar);            \
  }
 
  DEFINE_INT_SCALAR_VALUE (int8)
  DEFINE_INT_SCALAR_VALUE (int16)
  DEFINE_INT_SCALAR_VALUE (int32)
  DEFINE_INT_SCALAR_VALUE (int64)
  DEFINE_INT_SCALAR_VALUE (uint8)
  DEFINE_INT_SCALAR_VALUE (uint16)
  DEFINE_INT_SCALAR_VALUE (uint32)
  DEFINE_INT_SCALAR_VALUE (uint64)
 
#undef DEFINE_INT_SCALAR_VALUE
 
  double double_value (bool = false) const { return scalar; }
 
  float float_value (bool = false) const
  { return static_cast<float> (scalar); }
 
  double scalar_value (bool = false) const { return scalar; }
 
  float float_scalar_value (bool = false) const
  { return float_value (); }
 
  Matrix matrix_value (bool = false) const
  { return Matrix (1, 1, scalar); }
 
  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), scalar); }
 
  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, scalar)); }
 
  // 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 scalar; }
 
  FloatComplex float_complex_value (bool = false) const
  { return FloatComplex (float_value ()); }
 
  ComplexMatrix complex_matrix_value (bool = false) const
  { return ComplexMatrix (1, 1, Complex (scalar)); }
 
  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 (scalar)); }
 
  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> (scalar);
    return retval;
  }
 
  bool bool_value (bool warn = false) const
  {
    if (octave::math::isnan (scalar))
      octave::err_nan_to_logical_conversion ();
    if (warn && scalar != 0 && scalar != 1)
      warn_logical_conversion ();
 
    return scalar;
  }
 
  boolNDArray bool_array_value (bool warn = false) const
  {
    if (octave::math::isnan (scalar))
      octave::err_nan_to_logical_conversion ();
    if (warn && scalar != 0 && scalar != 1)
      warn_logical_conversion ();
 
    return boolNDArray (dim_vector (1, 1), scalar);
  }
 
  octave_value as_double_or_copy ();
 
  bool maybe_update_double (double d)
  {
    if (m_count != 1)
      return false;
    scalar = d;
    return true;
  }
 
  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<double>::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; }
 
  void decrement () { --scalar; }
 
  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 (unary_mapper_t umap) const;
 
  bool fast_elem_insert_self (void *where, builtin_type_t btyp) const;
 
private:
 
  DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA
};
 
#endif