ov-lazy-idx.h

Go to the documentation of this file.

////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 2010-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_lazy_idx_h)
#define octave_ov_lazy_idx_h 1
 
#include "octave-config.h"
 
#include "ov-re-mat.h"
 
// Lazy indices that stay in idx_vector form until the conversion to NDArray is
// actually needed.
 
class
OCTINTERP_API
octave_lazy_index : public octave_base_value
{
public:
 
  octave_lazy_index ()
    : octave_base_value (), m_index (), m_value () { }
 
  octave_lazy_index (const octave::idx_vector& idx)
    : octave_base_value (), m_index (idx), m_value () { }
 
  octave_lazy_index (const octave_lazy_index& i)
    : octave_base_value (), m_index (i.m_index), m_value (i.m_value) { }
 
  ~octave_lazy_index () = default;
 
  octave_base_value * clone () const
  { return new octave_lazy_index (*this); }
  octave_base_value * empty_clone () const { return new octave_matrix (); }
 
  type_conv_info numeric_conversion_function () const;
 
  octave_base_value * try_narrowing_conversion ();
 
  octave_value fast_elem_extract (octave_idx_type n) const;
 
  std::size_t byte_size () const
  { return numel () * sizeof (octave_idx_type); }
 
  octave_value squeeze () const;
 
  octave_value full_value () const { return make_value (); }
 
  octave::idx_vector index_vector (bool /* require_integers */ = false) const
  { return m_index; }
 
  builtin_type_t builtin_type () const { return btyp_double; }
 
  bool is_real_matrix () const { return true; }
 
  bool isreal () const { return true; }
 
  bool is_double_type () const { return true; }
 
  bool isfloat () const { return true; }
 
  // 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)
  { return make_value ().subsref (type, idx); }
 
  octave_value_list subsref (const std::string& type,
                             const std::list<octave_value_list>& idx, int)
  { return subsref (type, idx); }
 
  octave_value do_index_op (const octave_value_list& idx,
                            bool resize_ok = false)
  { return make_value ().index_op (idx, resize_ok); }
 
  dim_vector dims () const { return m_index.orig_dimensions (); }
 
  octave_idx_type numel () const { return m_index.length (0); }
 
  octave_idx_type nnz () const { return numel (); }
 
  octave_value reshape (const dim_vector& new_dims) const;
 
  octave_value permute (const Array<int>& vec, bool inv = false) const;
 
  octave_value resize (const dim_vector& dv, bool fill = false) const
  { return make_value ().resize (dv, fill); }
 
  octave_value all (int dim = 0) const { return make_value ().all (dim); }
  octave_value any (int dim = 0) const { return make_value ().any (dim); }
 
  MatrixType matrix_type () const { return make_value ().matrix_type (); }
  MatrixType matrix_type (const MatrixType& _typ) const
  { return make_value ().matrix_type (_typ); }
 
  octave_value sort (octave_idx_type dim = 0, sortmode mode = ASCENDING) const;
 
  octave_value sort (Array<octave_idx_type>& sidx, octave_idx_type dim = 0,
                     sortmode mode = ASCENDING) const;
 
  sortmode issorted (sortmode mode = UNSORTED) const;
 
  Array<octave_idx_type> sort_rows_idx (sortmode mode = ASCENDING) const;
 
  sortmode is_sorted_rows (sortmode mode = UNSORTED) const;
 
  bool is_matrix_type () const { return true; }
 
  bool isnumeric () const { return true; }
 
  bool is_defined () const { return true; }
 
  bool is_constant () const { return true; }
 
  bool is_true () const
  { return make_value ().is_true (); }
 
  bool print_as_scalar () const
  { return make_value ().print_as_scalar (); }
 
  void print (std::ostream& os, bool pr_as_read_syntax = false)
  { make_value ().print (os, pr_as_read_syntax); }
 
  void print_info (std::ostream& os, const std::string& prefix) const
  { make_value ().print_info (os, prefix); }
 
#define FORWARD_VALUE_QUERY(TYPE, NAME)         \
  TYPE NAME () const                        \
  {                                             \
    return make_value ().NAME ();               \
  }
 
  FORWARD_VALUE_QUERY (int8NDArray,  int8_array_value)
  FORWARD_VALUE_QUERY (int16NDArray, int16_array_value)
  FORWARD_VALUE_QUERY (int32NDArray, int32_array_value)
  FORWARD_VALUE_QUERY (int64NDArray, int64_array_value)
  FORWARD_VALUE_QUERY (uint8NDArray,  uint8_array_value)
  FORWARD_VALUE_QUERY (uint16NDArray, uint16_array_value)
  FORWARD_VALUE_QUERY (uint32NDArray, uint32_array_value)
  FORWARD_VALUE_QUERY (uint64NDArray, uint64_array_value)
 
#define FORWARD_VALUE_QUERY1(TYPE, NAME)        \
  TYPE NAME (bool flag = false) const           \
  {                                             \
    return make_value ().NAME (flag);           \
  }
 
  FORWARD_VALUE_QUERY1 (double, double_value)
  FORWARD_VALUE_QUERY1 (float, float_value)
  FORWARD_VALUE_QUERY1 (double, scalar_value)
  FORWARD_VALUE_QUERY1 (Matrix, matrix_value)
  FORWARD_VALUE_QUERY1 (FloatMatrix, float_matrix_value)
  FORWARD_VALUE_QUERY1 (Complex, complex_value)
  FORWARD_VALUE_QUERY1 (FloatComplex, float_complex_value)
  FORWARD_VALUE_QUERY1 (ComplexMatrix, complex_matrix_value)
  FORWARD_VALUE_QUERY1 (FloatComplexMatrix, float_complex_matrix_value)
  FORWARD_VALUE_QUERY1 (ComplexNDArray, complex_array_value)
  FORWARD_VALUE_QUERY1 (FloatComplexNDArray, float_complex_array_value)
  FORWARD_VALUE_QUERY1 (boolNDArray, bool_array_value)
  FORWARD_VALUE_QUERY1 (charNDArray, char_array_value)
  FORWARD_VALUE_QUERY1 (NDArray, array_value)
  FORWARD_VALUE_QUERY1 (FloatNDArray, float_array_value)
  FORWARD_VALUE_QUERY1 (SparseMatrix, sparse_matrix_value)
  FORWARD_VALUE_QUERY1 (SparseComplexMatrix, sparse_complex_matrix_value)
 
  // 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_value::diag;
 
  octave_value diag (octave_idx_type k = 0) const
  {
    return make_value ().diag (k);
  }
 
  octave_value convert_to_str_internal (bool pad, bool force, char type) const
  {
    return make_value ().convert_to_str_internal (pad, force, type);
  }
 
  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;
 
  void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const
  {
    return make_value ().print_raw (os, pr_as_read_syntax);
  }
 
  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);
 
  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 make_value ().write (os, block_size, output_type, skip, flt_fmt);
  }
 
  // This function exists to support the MEX interface.
  // You should not use it anywhere else.
  const void * mex_get_data () const
  {
    return make_value ().mex_get_data ();
  }
 
  mxArray * as_mxArray (bool interleaved) const
  {
    return make_value ().as_mxArray (interleaved);
  }
 
  octave_value map (unary_mapper_t umap) const
  {
    return make_value ().map (umap);
  }
 
private:
 
  const octave_value& make_value () const
  {
    if (m_value.is_undefined ())
      m_value = octave_value (m_index, false);
 
    return m_value;
  }
 
  octave_value& make_value ()
  {
    if (m_value.is_undefined ())
      m_value = octave_value (m_index, false);
 
    return m_value;
  }
 
  octave::idx_vector m_index;
  mutable octave_value m_value;
 
  static octave_base_value *
  numeric_conversion_function (const octave_base_value&);
 
  DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA
};
 
#endif