boolNDArray.h

Go to the documentation of this file.

////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 2003-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 (octave_boolNDArray_h)
#define octave_boolNDArray_h 1
 
#include "octave-config.h"
 
#include "Array.h"
#include "bsxfun-decl.h"
#include "mx-defs.h"
#include "mx-op-decl.h"
 
class OCTAVE_API boolNDArray : public Array<bool>
{
public:
 
  typedef boolMatrix matrix_type;
 
  boolNDArray () : Array<bool> () { }
 
  boolNDArray (const dim_vector& dv) : Array<bool> (dv) { }
 
  boolNDArray (const dim_vector& dv, const bool& val)
    : Array<bool> (dv, val) { }
 
  boolNDArray (const boolNDArray& a) : Array<bool> (a) { }
 
  boolNDArray (const Array<bool>& a) : Array<bool> (a) { }
 
  boolNDArray& operator = (const boolNDArray& a)
  {
    Array<bool>::operator = (a);
    return *this;
  }
 
  ~boolNDArray () = default;
 
  // unary operations
 
  OCTAVE_API boolNDArray operator ! () const;
 
  OCTAVE_API boolNDArray& invert ();
 
  bool any_element_is_nan () const { return false; }
 
  // FIXME: this is not quite the right thing.
 
  OCTAVE_API boolNDArray all (int dim = -1) const;
  OCTAVE_API boolNDArray any (int dim = -1) const;
 
  OCTAVE_API boolNDArray
  concat (const boolNDArray& rb, const Array<octave_idx_type>& ra_idx);
 
  OCTAVE_API boolNDArray&
  insert (const boolNDArray& a, octave_idx_type r, octave_idx_type c);
  OCTAVE_API boolNDArray&
  insert (const boolNDArray& a, const Array<octave_idx_type>& ra_idx);
 
  boolNDArray squeeze () const { return Array<bool>::squeeze (); }
 
  static OCTAVE_API void
  increment_index (Array<octave_idx_type>& ra_idx,
                   const dim_vector& dimensions, int start_dimension = 0);
 
  static OCTAVE_API octave_idx_type
  compute_index (Array<octave_idx_type>& ra_idx,
                 const dim_vector& dimensions);
 
  // i/o
 
  // friend std::ostream& operator << (std::ostream& os, const NDArray& a);
  // friend std::istream& operator >> (std::istream& is, NDArray& a);
 
  //  bool all_elements_are_real () const;
  //  bool all_integers (double& max_val, double& min_val) const;
 
  OCTAVE_API boolNDArray diag (octave_idx_type k = 0) const;
 
  OCTAVE_API boolNDArray diag (octave_idx_type m, octave_idx_type n) const;
};
 
NDND_BOOL_OP_DECLS (boolNDArray, boolNDArray, OCTAVE_API)
NDND_CMP_OP_DECLS (boolNDArray, boolNDArray, OCTAVE_API)
 
NDS_BOOL_OP_DECLS (boolNDArray, bool, OCTAVE_API)
NDS_CMP_OP_DECLS (boolNDArray, bool, OCTAVE_API)
 
SND_BOOL_OP_DECLS (bool, boolNDArray, OCTAVE_API)
SND_CMP_OP_DECLS (bool, boolNDArray, OCTAVE_API)
 
extern OCTAVE_API boolNDArray&
mx_el_and_assign (boolNDArray& m, const boolNDArray& a);
extern OCTAVE_API boolNDArray&
mx_el_or_assign (boolNDArray& m, const boolNDArray& a);
 
BSXFUN_OP_DECL (and, boolNDArray, OCTAVE_API);
BSXFUN_OP_DECL (or, boolNDArray, OCTAVE_API);
 
#endif