ov-range.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_range_h)
#define octave_ov_range_h 1
 
#include "octave-config.h"
 
#include <cstdlib>
 
#include <iosfwd>
#include <string>
#include <type_traits>
 
#include "Array-fwd.h"
#include "Range.h"
 
#include "lo-mappers.h"
#include "lo-utils.h"
#include "mx-base.h"
#include "str-vec.h"
 
#include "error.h"
#include "oct-stream.h"
#include "ov-base.h"
#include "ov-range-traits.h"
#include "ov-re-mat.h"
#include "ov-typeinfo.h"
 
class octave_value_list;
 
 
class octave_trivial_range : public octave_base_value
{
public:
 
  octave_trivial_range (octave_idx_type numel, int base, int incr)
    : m_numel (numel), m_base (base), m_increment(incr) { }
 
  octave_trivial_range () {};
 
  octave_trivial_range (const octave_trivial_range&) = default;
 
  OCTINTERP_API octave_value
  vm_extract_forloop_value (octave_idx_type i)
  {
    if (i < m_numel - 1)
      return m_base + static_cast<int> (i) * m_increment;
    return m_base + (m_numel - 1) * m_increment;
  }
 
  double
  vm_extract_forloop_double (octave_idx_type i)
  {
    if (i < m_numel - 1)
      return m_base + static_cast<int> (i) * m_increment;
    return m_base + (m_numel - 1) * m_increment;
  }
 
  bool is_trivial_range () const { return true; };
 
private:
  int m_numel = 0;
  int m_base = 0;
  int m_increment = 0;
 
  DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA
};
 
// For now, we only need ov_range<double> but we don't attempt to
// enforce that restriction.
 
template <typename T>
class
ov_range : public octave_base_value
{
public:
 
  ov_range ()
    : octave_base_value (), m_range (), m_idx_cache () { }
 
  ov_range (const octave::range<T>& r)
    : octave_base_value (), m_range (r), m_idx_cache ()
  {
    if (numel () < 0 && numel () != -2)
      error ("invalid range");
  }
 
  ov_range (const ov_range<T>& r)
    : octave_base_value (), m_range (r.m_range),
      m_idx_cache (r.m_idx_cache
                   ? new octave::idx_vector (*r.m_idx_cache) : nullptr)
  { }
 
  ov_range (const octave::range<T>& r, const octave::idx_vector& cache)
    : octave_base_value (), m_range (r), m_idx_cache ()
  {
    set_idx_cache (cache);
  }
 
  // No assignment.
  ov_range& operator = (const ov_range&) = delete;
 
  ~ov_range () { clear_cached_info (); }
 
  octave_base_value * clone () const
  {
    return new ov_range (*this);
  }
 
  // A range is really just a special kind of real matrix object.  In
  // the places where we need to call empty_clone, it makes more sense
  // to create an empty matrix (0x0) instead of an empty range (1x0).
 
  octave_base_value * empty_clone () const
  {
    return new typename octave_value_range_traits<T>::matrix_type ();
  }
 
  OCTINTERP_API type_conv_info numeric_conversion_function () const;
 
  OCTINTERP_API octave_base_value * try_narrowing_conversion ();
 
  builtin_type_t builtin_type () const { return class_to_btyp<T>::btyp; }
 
  // We don't need to override all three forms of subsref.  The using
  // declaration will avoid warnings about partially-overloaded virtual
  // functions.
  using octave_base_value::subsref;
 
  octave_value subsref (const std::string& type,
                        const std::list<octave_value_list>& idx);
 
  octave_value_list subsref (const std::string& type,
                             const std::list<octave_value_list>& idx, int)
  { return subsref (type, idx); }
 
  OCTINTERP_API octave_value
  do_index_op (const octave_value_list& idx, bool resize_ok = false);
 
  OCTINTERP_API octave::idx_vector index_vector (bool require_integers = false) const;
 
  dim_vector dims () const
  {
    octave_idx_type n = numel ();
    return dim_vector (n > 0, n);
  }
 
  OCTINTERP_API octave_value as_trivial_range ();
  OCTINTERP_API bool could_be_trivial_range ();
 
  OCTINTERP_API octave_value
  vm_extract_forloop_value (octave_idx_type idx);
 
  octave_idx_type numel () const { return m_range.numel (); }
 
  octave_idx_type nnz () const
  {
    // FIXME: this is a potential waste of memory.
 
    octave_value tmp (raw_array_value ());
    return tmp.nnz ();
  }
 
  OCTINTERP_API octave_value
  resize (const dim_vector& dv, bool fill = false) const;
 
  std::size_t byte_size () const { return 3 * sizeof (T); }
 
  octave_value reshape (const dim_vector& new_dims) const
  {
    return raw_array_value ().reshape (new_dims);
  }
 
  octave_value permute (const Array<int>& vec, bool inv = false) const
  {
    return raw_array_value ().permute (vec, inv);
  }
 
  octave_value squeeze () const { return m_range; }
 
  octave_value full_value () const { return raw_array_value (); }
 
  bool is_defined () const { return true; }
 
  bool is_storable () const { return m_range.is_storable (); }
 
  bool is_constant () const { return true; }
 
  bool is_range () const { return true; }
 
  bool vm_need_storable_call () const { return true; }
 
  bool is_double_type () const { return builtin_type () == btyp_double; }
 
  bool is_single_type () const { return builtin_type () == btyp_float; }
 
  bool isfloat () const { return btyp_isfloat (builtin_type ()); }
 
  bool is_int8_type () const { return builtin_type () == btyp_int8; }
 
  bool is_int16_type () const { return builtin_type () == btyp_int16; }
 
  bool is_int32_type () const { return builtin_type () == btyp_int32; }
 
  bool is_int64_type () const { return builtin_type () == btyp_int64; }
 
  bool is_uint8_type () const { return builtin_type () == btyp_uint8; }
 
  bool is_uint16_type () const { return builtin_type () == btyp_uint16; }
 
  bool is_uint32_type () const { return builtin_type () == btyp_uint32; }
 
  bool is_uint64_type () const { return builtin_type () == btyp_uint64; }
 
  bool isinteger () const
  {
    return btyp_isinteger (builtin_type ());
  }
 
  bool isreal () const { return true; }
 
  bool isnumeric () const
  {
    return btyp_isnumeric (builtin_type ());
  }
 
  bool is_true () const { return nnz () == numel (); }
 
  octave_value all (int dim = 0) const
  {
    // FIXME: this is a potential waste of memory.
 
    typedef typename octave_value_range_traits<T>::matrix_type ov_mx_type;
    typename ov_mx_type::object_type m (raw_array_value ());
 
    return m.all (dim);
  }
 
  octave_value any (int dim = 0) const
  {
    // FIXME: this is a potential waste of memory.
 
    typedef typename octave_value_range_traits<T>::matrix_type ov_mx_type;
    typename ov_mx_type::object_type m (raw_array_value ());
 
    return m.any (dim);
  }
 
  octave_value diag (octave_idx_type k = 0) const
  {
    // FIXME: this is a potential waste of memory.
 
    return m_range.diag (k);
  }
 
  octave_value diag (octave_idx_type nr, octave_idx_type nc) const
  {
    // FIXME: this is a potential waste of memory.
 
    typedef typename octave_value_range_traits<T>::matrix_type ov_mx_type;
    typename ov_mx_type::object_type m (raw_array_value ());
 
    return m.diag (nr, nc);
  }
 
  octave_value sort (octave_idx_type dim = 0, sortmode mode = ASCENDING) const
  {
    Array<T> tmp = raw_array_value ();
    return tmp.sort (dim, mode);
  }
 
  octave_value sort (Array<octave_idx_type>& sidx, octave_idx_type dim = 0,
                     sortmode mode = ASCENDING) const
  {
    Array<T> tmp = raw_array_value ();
    return tmp.sort (sidx, dim, mode);
  }
 
  sortmode issorted (sortmode mode = UNSORTED) const
  {
    return m_range.issorted (mode);
  }
 
  Array<octave_idx_type> sort_rows_idx (sortmode) const
  {
    return Array<octave_idx_type> (dim_vector (1, 0));
  }
 
  sortmode is_sorted_rows (sortmode mode = UNSORTED) const
  {
    return (mode == UNSORTED) ? ASCENDING : mode;
  }
 
  Array<T> raw_array_value () const { return m_range.array_value (); }
 
  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);
  }
 
  Matrix matrix_value (bool = false) const
  {
    return raw_array_value ();
  }
 
  FloatMatrix float_matrix_value (bool = false) const
  {
    return raw_array_value ();
  }
 
  NDArray array_value (bool = false) const
  {
    return raw_array_value ();
  }
 
  FloatNDArray float_array_value (bool = false) const
  {
    return raw_array_value ();
  }
 
  OCTINTERP_API charNDArray char_array_value (bool = false) const;
 
  // FIXME: it would be better to have Range::intXNDArray_value
  // functions to avoid the intermediate conversion to a matrix
  // object.
 
  int8NDArray int8_array_value () const
  {
    return raw_array_value ();
  }
 
  int16NDArray int16_array_value () const
  {
    return raw_array_value ();
  }
 
  int32NDArray int32_array_value () const
  {
    return raw_array_value ();
  }
 
  int64NDArray int64_array_value () const
  {
    return raw_array_value ();
  }
 
  uint8NDArray uint8_array_value () const
  {
    return raw_array_value ();
  }
 
  uint16NDArray uint16_array_value () const
  {
    return raw_array_value ();
  }
 
  uint32NDArray uint32_array_value () const
  {
    return raw_array_value ();
  }
 
  uint64NDArray uint64_array_value () const
  {
    return raw_array_value ();
  }
 
  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 Complex complex_value (bool = false) const;
 
  OCTINTERP_API FloatComplex float_complex_value (bool = false) const;
 
  OCTINTERP_API boolNDArray bool_array_value (bool warn = false) const;
 
  ComplexMatrix complex_matrix_value (bool = false) const
  {
    return raw_array_value ();
  }
 
  FloatComplexMatrix float_complex_matrix_value (bool = false) const
  {
    return raw_array_value ();
  }
 
  ComplexNDArray complex_array_value (bool = false) const
  {
    return raw_array_value ();
  }
 
  FloatComplexNDArray float_complex_array_value (bool = false) const
  {
    return raw_array_value ();
  }
 
  OCTINTERP_API octave::range<double> range_value () const;
 
// For now, enable only ov_range<double>.
 
  OCTINTERP_API octave_value
  convert_to_str_internal (bool pad, bool force, char type) const;
 
  OCTINTERP_API octave_value as_double () const;
  OCTINTERP_API octave_value as_single () const;
 
  OCTINTERP_API octave_value as_int8 () const;
  OCTINTERP_API octave_value as_int16 () const;
  OCTINTERP_API octave_value as_int32 () const;
  OCTINTERP_API octave_value as_int64 () const;
 
  OCTINTERP_API octave_value as_uint8 () const;
  OCTINTERP_API octave_value as_uint16 () const;
  OCTINTERP_API octave_value as_uint32 () const;
  OCTINTERP_API octave_value as_uint64 () const;
 
  OCTINTERP_API void print (std::ostream& os, bool pr_as_read_syntax = false);
 
  OCTINTERP_API void
  print_raw (std::ostream& os, bool pr_as_read_syntax = false) const;
 
  OCTINTERP_API bool
  print_name_tag (std::ostream& os, const std::string& name) const;
 
  OCTINTERP_API void short_disp (std::ostream& os) const;
 
  OCTINTERP_API float_display_format get_edit_display_format () const;
 
  OCTINTERP_API std::string
  edit_display (const float_display_format& fmt,
                octave_idx_type i, octave_idx_type j) const;
 
  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 flag);
 
  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
  {
    // FIXME: could be more memory efficient by having a
    // special case of the octave::stream::write method for ranges.
 
    return os.write (matrix_value (), block_size, output_type, skip, flt_fmt);
  }
 
  OCTINTERP_API mxArray * as_mxArray (bool interleaved) const;
 
  octave_value map (unary_mapper_t umap) const
  {
    octave_value tmp (raw_array_value ());
    return tmp.map (umap);
  }
 
  OCTINTERP_API octave_value fast_elem_extract (octave_idx_type n) const;
 
protected:
 
  octave::range<T> m_range;
 
  octave::idx_vector set_idx_cache (const octave::idx_vector& idx) const
  {
    delete m_idx_cache;
    m_idx_cache = new octave::idx_vector (idx);
    return idx;
  }
 
  void clear_cached_info () const
  {
    delete m_idx_cache; m_idx_cache = nullptr;
  }
 
  mutable octave::idx_vector *m_idx_cache;
 
  static octave_hdf5_id hdf5_save_type;
 
  DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA
};
 
DECLARE_TEMPLATE_OV_TYPEID_SPECIALIZATIONS (ov_range, double)
 
// For now, enable only ov_range<double>.
 
// Specializations.
 
template <>
OCTINTERP_API octave::range<double>
ov_range<double>::range_value () const;
 
// For now, enable only ov_range<double>.
 
// The following specializations are here to preserve previous Range
// performance until solutions can be generalized for other types.
 
template <>
OCTINTERP_API octave::idx_vector
ov_range<double>::index_vector (bool require_integers) const;
 
template <>
OCTINTERP_API octave_idx_type
ov_range<double>::nnz () const;
 
// The following specialization is also historical baggage.  For double
// ranges, we can produce special double-valued diagnoal matrix objects
// but Octave currently provides only double and Complex diagonal matrix
// objects.
 
template <>
OCTINTERP_API octave_value
ov_range<double>::diag (octave_idx_type k) const;
 
template <>
OCTINTERP_API octave_value
ov_range<double>::diag (octave_idx_type nr, octave_idx_type nc) const;
 
template <>
OCTINTERP_API void
ov_range<double>::print_raw (std::ostream& os, bool pr_as_read_syntax) const;
 
typedef ov_range<double> octave_double_range;
 
// For now, enable only ov_range<double>.
 
typedef octave_double_range octave_range;
 
#endif