ov-bool-mat.cc

Go to the documentation of this file.

////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 1996-2025 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 (HAVE_CONFIG_H)
#  include "config.h"
#endif
 
#include <istream>
#include <ostream>
#include <vector>
 
#include "dNDArray.h"
#include "fNDArray.h"
#include "int8NDArray.h"
#include "int16NDArray.h"
#include "int32NDArray.h"
#include "int64NDArray.h"
#include "uint8NDArray.h"
#include "uint16NDArray.h"
#include "uint32NDArray.h"
#include "uint64NDArray.h"
 
#include "lo-ieee.h"
#include "mx-base.h"
#include "oct-locbuf.h"
 
#include "defun.h"
#include "errwarn.h"
#include "mxarray.h"
#include "ovl.h"
#include "oct-hdf5.h"
#include "ops.h"
#include "ov-bool.h"
#include "ov-bool-mat.h"
#include "ov-re-mat.h"
#include "pr-output.h"
 
#include "byte-swap.h"
#include "ls-oct-text.h"
#include "ls-hdf5.h"
#include "ls-utils.h"
 
DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA (octave_bool_matrix,
                                     "bool matrix", "logical");
 
static octave_base_value *
default_numeric_conversion_function (const octave_base_value& a)
{
  const octave_bool_matrix& v = dynamic_cast<const octave_bool_matrix&> (a);
 
  return new octave_matrix (NDArray (v.bool_array_value ()));
}
 
octave_base_value::type_conv_info
octave_bool_matrix::numeric_conversion_function () const
{
  return octave_base_value::type_conv_info (default_numeric_conversion_function,
         octave_matrix::static_type_id ());
}
 
octave_base_value *
octave_bool_matrix::try_narrowing_conversion ()
{
  octave_base_value *retval = nullptr;
 
  if (m_matrix.ndims () == 2)
    {
      boolMatrix bm (m_matrix);
 
      octave_idx_type nr = bm.rows ();
      octave_idx_type nc = bm.cols ();
 
      if (nr == 1 && nc == 1)
        retval = new octave_bool (bm (0, 0));
    }
 
  return retval;
}
 
double
octave_bool_matrix::double_value (bool) const
{
  if (rows () == 0 || columns () == 0)
    err_invalid_conversion ("bool matrix", "real scalar");
 
  warn_implicit_conversion ("Octave:array-to-scalar",
                            "bool matrix", "real scalar");
 
  return m_matrix(0, 0);
}
 
float
octave_bool_matrix::float_value (bool) const
{
  if (rows () == 0 || columns () == 0)
    err_invalid_conversion ("bool matrix", "real scalar");
 
  warn_implicit_conversion ("Octave:array-to-scalar",
                            "bool matrix", "real scalar");
 
  return m_matrix(0, 0);
}
 
Complex
octave_bool_matrix::complex_value (bool) const
{
  if (rows () == 0 || columns () == 0)
    err_invalid_conversion ("bool matrix", "complex scalar");
 
  warn_implicit_conversion ("Octave:array-to-scalar",
                            "bool matrix", "complex scalar");
 
  return Complex (m_matrix(0, 0), 0);
}
 
FloatComplex
octave_bool_matrix::float_complex_value (bool) const
{
  float tmp = lo_ieee_float_nan_value ();
 
  FloatComplex retval (tmp, tmp);
 
  if (rows () == 0 || columns () == 0)
    err_invalid_conversion ("bool matrix", "complex scalar");
 
  warn_implicit_conversion ("Octave:array-to-scalar",
                            "bool matrix", "complex scalar");
 
  retval = m_matrix(0, 0);
 
  return retval;
}
 
octave_value
octave_bool_matrix::convert_to_str_internal (bool pad, bool force,
    char type) const
{
  octave_value tmp = octave_value (array_value ());
  return tmp.convert_to_str (pad, force, type);
}
 
octave_value
octave_bool_matrix::as_double () const
{
  return NDArray (m_matrix);
}
 
octave_value
octave_bool_matrix::as_single () const
{
  return FloatNDArray (m_matrix);
}
 
octave_value
octave_bool_matrix::as_int8 () const
{
  return int8NDArray (m_matrix);
}
 
octave_value
octave_bool_matrix::as_int16 () const
{
  return int16NDArray (m_matrix);
}
 
octave_value
octave_bool_matrix::as_int32 () const
{
  return int32NDArray (m_matrix);
}
 
octave_value
octave_bool_matrix::as_int64 () const
{
  return int64NDArray (m_matrix);
}
 
octave_value
octave_bool_matrix::as_uint8 () const
{
  return uint8NDArray (m_matrix);
}
 
octave_value
octave_bool_matrix::as_uint16 () const
{
  return uint16NDArray (m_matrix);
}
 
octave_value
octave_bool_matrix::as_uint32 () const
{
  return uint32NDArray (m_matrix);
}
 
octave_value
octave_bool_matrix::as_uint64 () const
{
  return uint64NDArray (m_matrix);
}
 
void
octave_bool_matrix::print_raw (std::ostream& os,
                               bool pr_as_read_syntax) const
{
  octave_print_internal (os, m_matrix, pr_as_read_syntax,
                         current_print_indent_level ());
}
 
bool
octave_bool_matrix::save_ascii (std::ostream& os)
{
  const dim_vector& dv = dims ();
  if (dv.ndims () > 2)
    {
      NDArray tmp = array_value ();
      os << "# ndims: " << dv.ndims () << "\n";
 
      for (int i = 0; i < dv.ndims (); i++)
        os << ' ' << dv(i);
 
      os << "\n" << tmp;
    }
  else
    {
      // Keep this case, rather than use generic code above for backward
      // compatibility.  Makes load_ascii much more complex!!
      os << "# rows: " << rows () << "\n"
         << "# columns: " << columns () << "\n";
 
      Matrix tmp = matrix_value ();
 
      os << tmp;
    }
 
  return true;
}
 
bool
octave_bool_matrix::load_ascii (std::istream& is)
{
  string_vector keywords (2);
 
  keywords[0] = "ndims";
  keywords[1] = "rows";
 
  std::string kw;
  octave_idx_type val = 0;
 
  if (! extract_keyword (is, keywords, kw, val, true))
    error ("load: failed to extract number of rows and columns");
 
  if (kw == "ndims")
    {
      int mdims = static_cast<int> (val);
 
      if (mdims < 0)
        error ("load: failed to extract number of dimensions");
 
      dim_vector dv;
      dv.resize (mdims);
 
      for (int i = 0; i < mdims; i++)
        is >> dv(i);
 
      if (! is)
        error ("load: failed to extract dimensions");
 
      boolNDArray btmp (dv);
 
      if (btmp.isempty ())
        m_matrix = btmp;
      else
        {
          NDArray tmp(dv);
          is >> tmp;
 
          if (! is)
            error ("load: failed to load matrix constant");
 
          for (octave_idx_type i = 0; i < btmp.numel (); i++)
            btmp.elem (i) = (tmp.elem (i) != 0.);
 
          m_matrix = btmp;
        }
    }
  else if (kw == "rows")
    {
      octave_idx_type nr = val;
      octave_idx_type nc = 0;
 
      if (nr < 0 || ! extract_keyword (is, "columns", nc) || nc < 0)
        error ("load: failed to extract number of rows and columns");
 
      if (nr > 0 && nc > 0)
        {
          Matrix tmp (nr, nc);
          is >> tmp;
          if (! is)
            error ("load: failed to load matrix constant");
 
          boolMatrix btmp (nr, nc);
          for (octave_idx_type j = 0; j < nc; j++)
            for (octave_idx_type i = 0; i < nr; i++)
              btmp.elem (i, j) = (tmp.elem (i, j) != 0.);
 
          m_matrix = btmp;
        }
      else if (nr == 0 || nc == 0)
        m_matrix = boolMatrix (nr, nc);
      else
        error ("unexpected dimensions in octave_bool_matrix::load_ascii - please report this bug");
    }
  else
    error ("unexpected dimensions keyword (= '%s') octave_bool_matrix::load_ascii - please report this bug", kw.c_str ());
 
  return true;
}
 
bool
octave_bool_matrix::save_binary (std::ostream& os, bool /* save_as_floats */)
{
 
  const dim_vector& dv = dims ();
  if (dv.ndims () < 1)
    return false;
 
  // Use negative value for ndims to differentiate with old format!!
  int32_t tmp = - dv.ndims ();
  os.write (reinterpret_cast<char *> (&tmp), 4);
  for (int i = 0; i < dv.ndims (); i++)
    {
      tmp = dv(i);
      os.write (reinterpret_cast<char *> (&tmp), 4);
    }
 
  const bool *mtmp = m_matrix.data ();
  octave_idx_type nel = m_matrix.numel ();
  os.write (reinterpret_cast<const char *> (mtmp), nel);
 
  return true;
}
 
bool
octave_bool_matrix::load_binary (std::istream& is, bool swap,
                                 octave::mach_info::float_format /* fmt */)
{
  int32_t mdims;
  if (! is.read (reinterpret_cast<char *> (&mdims), 4))
    return false;
  if (swap)
    swap_bytes<4> (&mdims);
  if (mdims >= 0)
    return false;
 
  // mdims is negative for consistency with other matrices, where it is
  // negative to allow the positive value to be used for rows/cols for
  // backward compatibility
  mdims = - mdims;
  int32_t di;
  dim_vector dv;
  dv.resize (mdims);
 
  for (int i = 0; i < mdims; i++)
    {
      if (! is.read (reinterpret_cast<char *> (&di), 4))
        return false;
      if (swap)
        swap_bytes<4> (&di);
      dv(i) = di;
    }
 
  // Convert an array with a single dimension to be a row vector.
  // Octave should never write files like this, other software
  // might.
 
  if (mdims == 1)
    {
      mdims = 2;
      dv.resize (mdims);
      dv(1) = dv(0);
      dv(0) = 1;
    }
 
  octave_idx_type nel = dv.numel ();
  OCTAVE_LOCAL_BUFFER (char, htmp, nel);
  if (! is.read (htmp, nel))
    return false;
  boolNDArray m(dv);
  bool *mtmp = m.rwdata ();
  for (octave_idx_type i = 0; i < nel; i++)
    mtmp[i] = (htmp[i] ? 1 : 0);
  m_matrix = m;
 
  return true;
}
 
bool
octave_bool_matrix::save_hdf5 (octave_hdf5_id loc_id, const char *name,
                               bool /* save_as_floats */)
{
  bool retval = true;
 
#if defined (HAVE_HDF5)
 
  const dim_vector& dv = dims ();
  int empty = save_hdf5_empty (loc_id, name, dv);
  if (empty)
    return (empty > 0);
 
  int rank = dv.ndims ();
  hid_t space_hid, data_hid;
  space_hid = data_hid = -1;
 
  OCTAVE_LOCAL_BUFFER (hsize_t, hdims, rank);
 
  // Octave uses column-major, while HDF5 uses row-major ordering
  for (int i = 0; i < rank; i++)
    hdims[i] = dv(rank-i-1);
 
  space_hid = H5Screate_simple (rank, hdims, nullptr);
  if (space_hid < 0) return false;
#if defined (HAVE_HDF5_18)
  data_hid = H5Dcreate (loc_id, name, H5T_NATIVE_HBOOL, space_hid,
                        octave_H5P_DEFAULT, octave_H5P_DEFAULT,
                        octave_H5P_DEFAULT);
#else
  data_hid = H5Dcreate (loc_id, name, H5T_NATIVE_HBOOL, space_hid,
                        octave_H5P_DEFAULT);
#endif
  if (data_hid < 0)
    {
      H5Sclose (space_hid);
      return false;
    }
 
  const bool *mtmp = m_matrix.data ();
 
  retval = H5Dwrite (data_hid, H5T_NATIVE_HBOOL, octave_H5S_ALL, octave_H5S_ALL,
                     octave_H5P_DEFAULT,
                     reinterpret_cast<const char *> (mtmp)) >= 0;
 
  H5Dclose (data_hid);
  H5Sclose (space_hid);
 
#else
  octave_unused_parameter (loc_id);
  octave_unused_parameter (name);
 
  warn_save ("hdf5");
#endif
 
  return retval;
}
 
bool
octave_bool_matrix::load_hdf5 (octave_hdf5_id loc_id, const char *name)
{
  bool retval = false;
 
#if defined (HAVE_HDF5)
 
  dim_vector dv;
  int empty = load_hdf5_empty (loc_id, name, dv);
  if (empty > 0)
    m_matrix.resize (dv);
  if (empty)
    return (empty > 0);
 
#if defined (HAVE_HDF5_18)
  hid_t data_hid = H5Dopen (loc_id, name, octave_H5P_DEFAULT);
#else
  hid_t data_hid = H5Dopen (loc_id, name);
#endif
  hid_t space_id = H5Dget_space (data_hid);
 
  hsize_t rank = H5Sget_simple_extent_ndims (space_id);
 
  if (rank < 1)
    {
      H5Dclose (data_hid);
      return false;
    }
 
  OCTAVE_LOCAL_BUFFER (hsize_t, hdims, rank);
  OCTAVE_LOCAL_BUFFER (hsize_t, maxdims, rank);
 
  H5Sget_simple_extent_dims (space_id, hdims, maxdims);
 
  // Octave uses column-major, while HDF5 uses row-major ordering
  if (rank == 1)
    {
      dv.resize (2);
      dv(0) = 1;
      dv(1) = hdims[0];
    }
  else
    {
      dv.resize (rank);
      for (hsize_t i = 0, j = rank - 1; i < rank; i++, j--)
        dv(j) = hdims[i];
    }
 
  octave_idx_type nel = dv.numel ();
  OCTAVE_LOCAL_BUFFER (hbool_t, htmp, nel);
  if (H5Dread (data_hid, H5T_NATIVE_HBOOL, octave_H5S_ALL, octave_H5S_ALL,
               octave_H5P_DEFAULT, htmp)
      >= 0)
    {
      retval = true;
 
      boolNDArray btmp (dv);
      for (octave_idx_type i = 0; i < nel; i++)
        btmp.elem (i) = htmp[i];
 
      m_matrix = btmp;
    }
 
  H5Dclose (data_hid);
 
#else
  octave_unused_parameter (loc_id);
  octave_unused_parameter (name);
 
  warn_load ("hdf5");
#endif
 
  return retval;
}
 
mxArray *
octave_bool_matrix::as_mxArray (bool interleaved) const
{
  mxArray *retval = new mxArray (interleaved, mxLOGICAL_CLASS, dims (), mxREAL);
 
  mxLogical *pd = static_cast<mxLogical *> (retval->get_data ());
 
  mwSize nel = numel ();
 
  const bool *pdata = m_matrix.data ();
 
  for (mwIndex i = 0; i < nel; i++)
    pd[i] = pdata[i];
 
  return retval;
}
 
OCTAVE_BEGIN_NAMESPACE(octave)
 
DEFUN (logical, args, ,
       doc: /* -*- texinfo -*-
@deftypefn {} {@var{TF} =} logical (@var{x})
Convert the numeric object @var{x} to logical type.
 
Any nonzero values will be converted to true (1) while zero values will be
converted to false (0).  The non-numeric value NaN cannot be converted and will
produce an error.
 
Compatibility Note: Octave accepts complex values as input, whereas @sc{matlab}
issues an error.
@seealso{double, single, char}
@end deftypefn */)
{
  if (args.length () != 1)
    print_usage ();
 
  octave_value retval;
 
  octave_value arg = args(0);
 
  if (arg.islogical ())
    retval = arg;
  else if (arg.isnumeric ())
    {
      if (arg.issparse ())
        retval = arg.sparse_bool_matrix_value ();
      else if (arg.is_scalar_type ())
        retval = arg.bool_value ();
      else
        retval = arg.bool_array_value ();
    }
  else
    err_wrong_type_arg ("logical", arg);
 
  return retval;
}
 
/*
%!test
%! m = eye (2) != 0;
%! s = ! 0;
%! c = {"double", "single", "int8", "int16", "int32", "int64", "uint8", "uint16", "uint32", "uint64", "logical"};
%! for i = 1:numel (c)
%!   assert (logical (eye (2, c{i})), m);
%!   assert (logical (eye (1, c{i})), s);
%! endfor
*/
 
OCTAVE_END_NAMESPACE(octave)