ov-complex.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_complex_h)
#define octave_ov_complex_h 1
 
#include "octave-config.h"
 
#include <cstdlib>
 
#include <iosfwd>
#include <string>
 
#include "lo-ieee.h"
#include "mx-base.h"
#include "str-vec.h"
 
#include "errwarn.h"
#include "error.h"
#include "ov-base.h"
#include "ov-cx-mat.h"
#include "ov-base-scalar.h"
#include "ov-typeinfo.h"
 
class octave_value_list;
 
// Complex scalar values.
 
class
OCTINTERP_API
octave_complex : public octave_base_scalar<Complex>
{
public:
 
  octave_complex ()
    : octave_base_scalar<Complex> () { }
 
  octave_complex (const Complex& c)
    : octave_base_scalar<Complex> (c) { }
 
  octave_complex (const octave_complex& c)
    : octave_base_scalar<Complex> (c) { }
 
  ~octave_complex () = default;
 
  octave_base_value * clone () const { return new octave_complex (*this); }
 
  // We return an octave_complex_matrix object here instead of an
  // octave_complex object 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_complex_matrix (); }
 
  type_conv_info numeric_demotion_function () const;
 
  octave_base_value * try_narrowing_conversion ();
 
  octave_value do_index_op (const octave_value_list& idx,
                            bool resize_ok = false);
 
  // Use this to give a more specific error message.
  octave::idx_vector index_vector (bool /* require_integers */ = false) const;
 
  octave_value any (int = 0) const
  {
    return (scalar != Complex (0, 0)
            && ! (lo_ieee_isnan (scalar.real ())
                  || lo_ieee_isnan (scalar.imag ())));
  }
 
  builtin_type_t builtin_type () const { return btyp_complex; }
 
  bool is_complex_scalar () const { return true; }
 
  bool iscomplex () const { return true; }
 
  bool is_double_type () const { return true; }
 
  bool isfloat () const { return true; }
 
  OCTINTERP_API double double_value (bool = false) const;
 
  OCTINTERP_API float float_value (bool = false) const;
 
  double scalar_value (bool frc_str_conv = false) const
  { return double_value (frc_str_conv); }
 
  float float_scalar_value (bool frc_str_conv = false) const
  { return float_value (frc_str_conv); }
 
  OCTINTERP_API Matrix matrix_value (bool = false) const;
 
  OCTINTERP_API FloatMatrix float_matrix_value (bool = false) const;
 
  OCTINTERP_API NDArray array_value (bool = false) const;
 
  OCTINTERP_API FloatNDArray float_array_value (bool = false) const;
 
  SparseMatrix sparse_matrix_value (bool = false) const
  { return SparseMatrix (matrix_value ()); }
 
  SparseComplexMatrix sparse_complex_matrix_value (bool = false) const
  { return SparseComplexMatrix (complex_matrix_value ()); }
 
  OCTINTERP_API octave_value
  resize (const dim_vector& dv, bool fill = false) const;
 
  OCTINTERP_API Complex complex_value (bool = false) const;
 
  OCTINTERP_API FloatComplex float_complex_value (bool = false) const;
 
  OCTINTERP_API ComplexMatrix complex_matrix_value (bool = false) const;
 
  OCTINTERP_API FloatComplexMatrix
  float_complex_matrix_value (bool = false) const;
 
  OCTINTERP_API ComplexNDArray complex_array_value (bool = false) const;
 
  OCTINTERP_API FloatComplexNDArray
  float_complex_array_value (bool = false) const;
 
  bool bool_value (bool warn = false) const
  {
    if (octave::math::isnan (scalar))
      octave::err_nan_to_logical_conversion ();
    if (warn && scalar != 0.0 && scalar != 1.0)
      warn_logical_conversion ();
 
    return scalar != 0.0;
  }
 
  boolNDArray bool_array_value (bool warn = false) const
  {
    if (octave::math::isnan (scalar))
      octave::err_nan_to_logical_conversion ();
    if (warn && scalar != 0.0 && scalar != 1.0)
      warn_logical_conversion ();
 
    return boolNDArray (dim_vector (1, 1), scalar != 0.0);
  }
 
  OCTINTERP_API octave_value as_double () const;
  OCTINTERP_API octave_value as_single () 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<Complex>::diag;
 
  OCTINTERP_API octave_value diag (octave_idx_type m, octave_idx_type n) const;
 
  void increment () { scalar += 1.0; }
 
  void decrement () { scalar -= 1.0; }
 
  OCTINTERP_API bool save_ascii (std::ostream& os);
 
  OCTINTERP_API bool load_ascii (std::istream& is);
 
  OCTINTERP_API bool save_binary (std::ostream& os, bool save_as_floats);
 
  OCTINTERP_API bool
  load_binary (std::istream& is, bool swap,
               octave::mach_info::float_format fmt);
 
  OCTINTERP_API bool
  save_hdf5 (octave_hdf5_id loc_id, const char *name, bool save_as_floats);
 
  OCTINTERP_API 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
  {
    // Yes, for compatibility, we drop the imaginary part here.
    return os.write (array_value (true), block_size, output_type,
                     skip, flt_fmt);
  }
 
  OCTINTERP_API mxArray * as_mxArray (bool interleaved) const;
 
  OCTINTERP_API octave_value map (unary_mapper_t umap) const;
 
private:
 
  DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA
};
 
typedef octave_complex octave_complex_scalar;
 
#endif