boolNDArray Class Reference

#include "boolNDArray.h"

Inheritance diagram for boolNDArray:

Public Types
typedef boolMatrix	matrix_type
Public Types inherited from Array< bool >
typedef bool(*	compare_fcn_type) (typename ref_param< bool >::type, typename ref_param< bool >::type)
typedef ref_param< bool >::type	crefT
typedef bool	element_type
typedef octave_idx_type	size_type
	Used for operator(), and returned by numel() and size() (beware: signed integer)
typedef bool	value_type

Public Member Functions
	boolNDArray ()
	boolNDArray (const Array< bool > &a)
	boolNDArray (const boolNDArray &a)
	boolNDArray (const dim_vector &dv)
	boolNDArray (const dim_vector &dv, const bool &val)
	~boolNDArray ()=default
boolNDArray	all (int dim=-1) const
boolNDArray	any (int dim=-1) const
bool	any_element_is_nan () const
boolNDArray	concat (const boolNDArray &rb, const Array< octave_idx_type > &ra_idx)
boolNDArray	diag (octave_idx_type k=0) const
boolNDArray	diag (octave_idx_type m, octave_idx_type n) const
boolNDArray &	insert (const boolNDArray &a, const Array< octave_idx_type > &ra_idx)
boolNDArray &	insert (const boolNDArray &a, octave_idx_type r, octave_idx_type c)
boolNDArray &	invert ()
boolNDArray	operator! () const
boolNDArray &	operator= (const boolNDArray &a)
boolNDArray	squeeze () const
Public Member Functions inherited from Array< bool >
	Array ()
	Empty ctor (0 by 0).
	Array (Array< bool, Alloc > &&a)
	Array (bool *ptr, const dim_vector &dv, const Alloc &xallocator=Alloc())
	Array (const Array< bool, Alloc > &a)
	No type conversion case.
	Array (const Array< bool, Alloc > &a, const dim_vector &dv)
	Reshape constructor.
	Array (const Array< U, A > &a)
	Type conversion case.
	Array (const Container< bool > &a, const dim_vector &dv)
	Constructor from standard library sequence containers.
	Array (const dim_vector &dv)
	nD uninitialized ctor.
	Array (const dim_vector &dv, const bool &val)
	nD initialized ctor.
virtual	~Array ()
Array< bool, Alloc >	as_column () const
	Return the array as a column vector.
Array< bool, Alloc >	as_matrix () const
	Return the array as a matrix.
Array< bool, Alloc >	as_row () const
	Return the array as a row vector.
void	clear ()
void	clear (const dim_vector &dv)
void	clear (octave_idx_type r, octave_idx_type c)
void	fill (const bool &val)
Array< octave_idx_type >	find (octave_idx_type, bool) const
Array< octave_idx_type >	find (octave_idx_type, bool) const
sortmode	is_sorted_rows (sortmode) const
sortmode	is_sorted_rows (sortmode) const
sortmode	issorted (sortmode) const
sortmode	issorted (sortmode) const
Array< octave_idx_type >	lookup (const Array< octave::cdef_object > &, sortmode) const
Array< octave_idx_type >	lookup (const Array< octave::idx_vector > &, sortmode) const
octave_idx_type	lookup (octave::cdef_object const &, sortmode) const
octave_idx_type	lookup (octave::idx_vector const &, sortmode) const
void	make_unique ()
octave_idx_type	nnz () const
octave_idx_type	nnz () const
Array< octave::cdef_object >	nth_element (const octave::idx_vector &, int) const
Array< octave::idx_vector >	nth_element (const octave::idx_vector &, int) const
octave_idx_type	numel () const
	Number of elements in the array.
Array< bool, Alloc > &	operator= (Array< bool, Alloc > &&a)
Array< bool, Alloc > &	operator= (const Array< bool, Alloc > &a)
Array< octave::cdef_object >	sort (Array< octave_idx_type > &sidx, int, sortmode) const
Array< octave::idx_vector >	sort (Array< octave_idx_type > &sidx, int, sortmode) const
Array< octave::cdef_object >	sort (int, sortmode) const
Array< octave::idx_vector >	sort (int, sortmode) const
Array< octave_idx_type >	sort_rows_idx (sortmode) const
Array< octave_idx_type >	sort_rows_idx (sortmode) const
octave_idx_type	dim1 () const
octave_idx_type	rows () const
octave_idx_type	dim2 () const
octave_idx_type	cols () const
octave_idx_type	columns () const
octave_idx_type	dim3 () const
	Size of the specified dimension.
octave_idx_type	pages () const
	Size of the specified dimension.
size_type	size (const size_type d) const
	Size of the specified dimension.
std::size_t	byte_size () const
	Size of the specified dimension.
const dim_vector &	dims () const
	Return a const-reference so that dims ()(i) works efficiently.
Array< bool, Alloc >	squeeze () const
	Chop off leading singleton dimensions.
octave_idx_type	compute_index (octave_idx_type i, octave_idx_type j) const
	Size of the specified dimension.
octave_idx_type	compute_index (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
	Size of the specified dimension.
octave_idx_type	compute_index (const Array< octave_idx_type > &ra_idx) const
	Size of the specified dimension.
octave_idx_type	compute_index_unchecked (const Array< octave_idx_type > &ra_idx) const
	Size of the specified dimension.
bool &	xelem (octave_idx_type n)
	Size of the specified dimension.
crefT	xelem (octave_idx_type n) const
	Size of the specified dimension.
bool &	xelem (octave_idx_type i, octave_idx_type j)
	Size of the specified dimension.
crefT	xelem (octave_idx_type i, octave_idx_type j) const
	Size of the specified dimension.
bool &	xelem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
	Size of the specified dimension.
crefT	xelem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
	Size of the specified dimension.
bool &	xelem (const Array< octave_idx_type > &ra_idx)
	Size of the specified dimension.
crefT	xelem (const Array< octave_idx_type > &ra_idx) const
	Size of the specified dimension.
bool &	checkelem (octave_idx_type n)
	Size of the specified dimension.
bool &	checkelem (octave_idx_type i, octave_idx_type j)
	Size of the specified dimension.
bool &	checkelem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
	Size of the specified dimension.
bool &	checkelem (const Array< octave_idx_type > &ra_idx)
	Size of the specified dimension.
crefT	checkelem (octave_idx_type n) const
	Size of the specified dimension.
crefT	checkelem (octave_idx_type i, octave_idx_type j) const
	Size of the specified dimension.
crefT	checkelem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
	Size of the specified dimension.
crefT	checkelem (const Array< octave_idx_type > &ra_idx) const
	Size of the specified dimension.
bool &	elem (octave_idx_type n)
	Size of the specified dimension.
bool &	elem (octave_idx_type i, octave_idx_type j)
	Size of the specified dimension.
bool &	elem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
	Size of the specified dimension.
bool &	elem (const Array< octave_idx_type > &ra_idx)
	Size of the specified dimension.
crefT	elem (octave_idx_type n) const
	Size of the specified dimension.
crefT	elem (octave_idx_type i, octave_idx_type j) const
	Size of the specified dimension.
crefT	elem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
	Size of the specified dimension.
crefT	elem (const Array< octave_idx_type > &ra_idx) const
	Size of the specified dimension.
bool &	operator() (octave_idx_type n)
	Size of the specified dimension.
bool &	operator() (octave_idx_type i, octave_idx_type j)
	Size of the specified dimension.
bool &	operator() (octave_idx_type i, octave_idx_type j, octave_idx_type k)
	Size of the specified dimension.
bool &	operator() (const Array< octave_idx_type > &ra_idx)
	Size of the specified dimension.
crefT	operator() (octave_idx_type n) const
	Size of the specified dimension.
crefT	operator() (octave_idx_type i, octave_idx_type j) const
	Size of the specified dimension.
crefT	operator() (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
	Size of the specified dimension.
crefT	operator() (const Array< octave_idx_type > &ra_idx) const
	Size of the specified dimension.
Array< bool, Alloc >	column (octave_idx_type k) const
	Extract column: A(:,k+1).
Array< bool, Alloc >	page (octave_idx_type k) const
	Extract page: A(:,:,k+1).
Array< bool, Alloc >	linear_slice (octave_idx_type lo, octave_idx_type up) const
	Extract a slice from this array as a column vector: A(:)(lo+1:up).
Array< bool, Alloc >	reshape (octave_idx_type nr, octave_idx_type nc) const
	Size of the specified dimension.
Array< bool, Alloc >	reshape (const dim_vector &new_dims) const
	Size of the specified dimension.
Array< bool, Alloc >	permute (const Array< octave_idx_type > &vec, bool inv=false) const
	Size of the specified dimension.
Array< bool, Alloc >	ipermute (const Array< octave_idx_type > &vec) const
	Size of the specified dimension.
bool	issquare () const
	Size of the specified dimension.
bool	isempty () const
	Size of the specified dimension.
bool	isvector () const
	Size of the specified dimension.
bool	is_nd_vector () const
	Size of the specified dimension.
Array< bool, Alloc >	transpose () const
	Size of the specified dimension.
Array< bool, Alloc >	hermitian (bool(*fcn)(const bool &)=nullptr) const
	Size of the specified dimension.
const bool *	data () const
	Size of the specified dimension.
bool *	rwdata ()
	Size of the specified dimension.
bool *	fortran_vec ()
	Size of the specified dimension.
bool	is_shared () const
	Size of the specified dimension.
int	ndims () const
	Size of the specified dimension.
Array< bool, Alloc >	index (const octave::idx_vector &i) const
	Indexing without resizing.
Array< bool, Alloc >	index (const octave::idx_vector &i, const octave::idx_vector &j) const
	Size of the specified dimension.
Array< bool, Alloc >	index (const Array< octave::idx_vector > &ia) const
	Size of the specified dimension.
Array< bool, Alloc >	index (const octave::idx_vector &i, bool resize_ok, const bool &rfv) const
	Indexing with possible resizing and fill.
Array< bool, Alloc >	index (const octave::idx_vector &i, bool resize_ok) const
	Size of the specified dimension.
Array< bool, Alloc >	index (const octave::idx_vector &i, const octave::idx_vector &j, bool resize_ok, const bool &rfv) const
	Size of the specified dimension.
Array< bool, Alloc >	index (const octave::idx_vector &i, const octave::idx_vector &j, bool resize_ok) const
	Size of the specified dimension.
Array< bool, Alloc >	index (const Array< octave::idx_vector > &ia, bool resize_ok, const bool &rfv) const
	Size of the specified dimension.
Array< bool, Alloc >	index (const Array< octave::idx_vector > &ia, bool resize_ok) const
	Size of the specified dimension.
virtual bool	resize_fill_value () const
	Size of the specified dimension.
void	resize2 (octave_idx_type nr, octave_idx_type nc, const bool &rfv)
	Resizing (with fill).
void	resize2 (octave_idx_type nr, octave_idx_type nc)
	Size of the specified dimension.
void	resize1 (octave_idx_type n, const bool &rfv)
	Size of the specified dimension.
void	resize1 (octave_idx_type n)
	Size of the specified dimension.
void	resize (const dim_vector &dv, const bool &rfv)
	Size of the specified dimension.
void	resize (const dim_vector &dv)
	Size of the specified dimension.
void	assign (const octave::idx_vector &i, const Array< bool, Alloc > &rhs, const bool &rfv)
	Indexed assignment (always with resize & fill).
void	assign (const octave::idx_vector &i, const Array< bool, Alloc > &rhs)
	Size of the specified dimension.
void	assign (const octave::idx_vector &i, const octave::idx_vector &j, const Array< bool, Alloc > &rhs, const bool &rfv)
	Size of the specified dimension.
void	assign (const octave::idx_vector &i, const octave::idx_vector &j, const Array< bool, Alloc > &rhs)
	Size of the specified dimension.
void	assign (const Array< octave::idx_vector > &ia, const Array< bool, Alloc > &rhs, const bool &rfv)
	Size of the specified dimension.
void	assign (const Array< octave::idx_vector > &ia, const Array< bool, Alloc > &rhs)
	Size of the specified dimension.
void	delete_elements (const octave::idx_vector &i)
	Deleting elements.
void	delete_elements (int dim, const octave::idx_vector &i)
	A(:,...,I,...,:) = [] (>= 2 subscripts, one of them is non-colon)
void	delete_elements (const Array< octave::idx_vector > &ia)
	Dispatcher to the above two.
Array< bool, Alloc > &	insert (const Array< bool, Alloc > &a, const Array< octave_idx_type > &idx)
	Insert an array into another at a specified position.
Array< bool, Alloc > &	insert (const Array< bool, Alloc > &a, octave_idx_type r, octave_idx_type c)
	This is just a special case for idx = [r c 0 ...].
void	maybe_economize ()
	Size of the specified dimension.
void	print_info (std::ostream &os, const std::string &prefix) const
	Size of the specified dimension.
Array< bool, Alloc >	sort (int dim=0, sortmode mode=ASCENDING) const
	Size of the specified dimension.
Array< bool, Alloc >	sort (Array< octave_idx_type > &sidx, int dim=0, sortmode mode=ASCENDING) const
	Size of the specified dimension.
sortmode	issorted (sortmode mode=UNSORTED) const
	Ordering is auto-detected or can be specified.
Array< octave_idx_type >	sort_rows_idx (sortmode mode=ASCENDING) const
	Sort by rows returns only indices.
sortmode	is_sorted_rows (sortmode mode=UNSORTED) const
	Ordering is auto-detected or can be specified.
octave_idx_type	lookup (const bool &value, sortmode mode=UNSORTED) const
	Do a binary lookup in a sorted array.
Array< octave_idx_type >	lookup (const Array< bool, Alloc > &values, sortmode mode=UNSORTED) const
	Ditto, but for an array of values, specializing on the case when values are sorted.
octave_idx_type	nnz () const
	Count nonzero elements.
Array< octave_idx_type >	find (octave_idx_type n=-1, bool backward=false) const
	Find indices of (at most n) nonzero elements.
Array< bool, Alloc >	nth_element (const octave::idx_vector &n, int dim=0) const
	Returns the n-th element in increasing order, using the same ordering as used for sort.
Array< bool, Alloc >	diag (octave_idx_type k=0) const
	Get the kth super or subdiagonal.
Array< bool, Alloc >	diag (octave_idx_type m, octave_idx_type n) const
	Size of the specified dimension.
Array< U, A >	map (F fcn) const
	Apply function fcn to each element of the Array<T, Alloc>.
Array< U, A >	map (U(&fcn)(bool)) const
	Overloads for function references.
Array< U, A >	map (U(&fcn)(const bool &)) const
	Size of the specified dimension.
bool	test (F fcn) const
	Generic any/all test functionality with arbitrary predicate.
bool	test_any (F fcn) const
	Simpler calls.
bool	test_any (bool(&fcn)(bool)) const
	Overloads for function references.
bool	test_any (bool(&fcn)(const bool &)) const
	Size of the specified dimension.
bool	test_all (F fcn) const
	Size of the specified dimension.
bool	test_all (bool(&fcn)(bool)) const
	Size of the specified dimension.
bool	test_all (bool(&fcn)(const bool &)) const
	Size of the specified dimension.
bool	optimize_dimensions (const dim_vector &dv)
	Returns true if this->dims () == dv, and if so, replaces this->m_dimensions by a shallow copy of dv.

Static Public Member Functions
static octave_idx_type	compute_index (Array< octave_idx_type > &ra_idx, const dim_vector &dimensions)
static void	increment_index (Array< octave_idx_type > &ra_idx, const dim_vector &dimensions, int start_dimension=0)
Static Public Member Functions inherited from Array< bool >
static Array< bool, Alloc >	cat (int dim, octave_idx_type n, const Array< bool, Alloc > *array_list)
	Concatenation along a specified (0-based) dimension, equivalent to cat().

Additional Inherited Members
Protected Member Functions inherited from Array< bool >
	Array (const Array< bool, Alloc > &a, const dim_vector &dv, octave_idx_type l, octave_idx_type u)
	slice constructor
Protected Attributes inherited from Array< bool >
dim_vector	m_dimensions
Array< bool, Alloc >::ArrayRep *	m_rep
bool *	m_slice_data
octave_idx_type	m_slice_len

Detailed Description

Definition at line 36 of file boolNDArray.h.

Member Typedef Documentation

matrix_type

typedef boolMatrix boolNDArray::matrix_type

Definition at line 40 of file boolNDArray.h.

Constructor & Destructor Documentation

boolNDArray() [1/5]

boolNDArray::boolNDArray ( )

inline

Definition at line 42 of file boolNDArray.h.

boolNDArray() [2/5]

boolNDArray::boolNDArray ( const dim_vector &  dv )

inline

Definition at line 44 of file boolNDArray.h.

boolNDArray() [3/5]

boolNDArray::boolNDArray ( const dim_vector &  dv, const bool &  val  )

inline

Definition at line 46 of file boolNDArray.h.

boolNDArray() [4/5]

boolNDArray::boolNDArray ( const boolNDArray &  a )

inline

Definition at line 49 of file boolNDArray.h.

boolNDArray() [5/5]

boolNDArray::boolNDArray ( const Array< bool > &  a )

inline

Definition at line 51 of file boolNDArray.h.

~boolNDArray()

boolNDArray::~boolNDArray ( )

default

Member Function Documentation

all()

boolNDArray boolNDArray::all

(

int

dim = -1

)

const

Definition at line 61 of file boolNDArray.cc.

References mx_inline_all().

Referenced by do_minmax_red_op< boolNDArray >(), Fprod(), and octave_base_matrix< MT >::is_true().

any()

boolNDArray boolNDArray::any

(

int

dim = -1

)

const

Definition at line 67 of file boolNDArray.cc.

References mx_inline_any().

Referenced by do_minmax_red_op< boolNDArray >(), and Fsum().

any_element_is_nan()

bool boolNDArray::any_element_is_nan ( ) const

inline

Definition at line 67 of file boolNDArray.h.

compute_index()

octave_idx_type boolNDArray::compute_index ( Array< octave_idx_type > &  ra_idx, const dim_vector &  dimensions  )

static

Definition at line 104 of file boolNDArray.cc.

References ra_idx.

concat()

boolNDArray boolNDArray::concat	(	const boolNDArray &	rb,
		const Array< octave_idx_type > &	ra_idx
	)

Definition at line 73 of file boolNDArray.cc.

References insert(), Array< T, Alloc >::numel(), and ra_idx.

diag() [1/2]

boolNDArray boolNDArray::diag

(

octave_idx_type

k = 0

)

const

Definition at line 111 of file boolNDArray.cc.

References Array< T, Alloc >::diag().

diag() [2/2]

boolNDArray boolNDArray::diag	(	octave_idx_type	m,
		octave_idx_type	n
	)		const

Definition at line 117 of file boolNDArray.cc.

References Array< T, Alloc >::diag().

increment_index()

void boolNDArray::increment_index ( Array< octave_idx_type > &  ra_idx, const dim_vector &  dimensions, int  start_dimension = 0  )

static

Definition at line 96 of file boolNDArray.cc.

References increment_index(), and ra_idx.

Referenced by increment_index().

insert() [1/2]

boolNDArray & boolNDArray::insert	(	const boolNDArray &	a,
		const Array< octave_idx_type > &	ra_idx
	)

Definition at line 89 of file boolNDArray.cc.

References Array< T, Alloc >::insert(), and ra_idx.

insert() [2/2]

boolNDArray & boolNDArray::insert	(	const boolNDArray &	a,
		octave_idx_type	r,
		octave_idx_type	c
	)

Definition at line 82 of file boolNDArray.cc.

References Array< T, Alloc >::insert().

Referenced by concat().

invert()

boolNDArray & boolNDArray::invert

(

)

Definition at line 48 of file boolNDArray.cc.

References Array< bool >::is_shared(), and mx_inline_not2().

operator!()

boolNDArray boolNDArray::operator!

(

)

const

Definition at line 42 of file boolNDArray.cc.

References mx_inline_not().

operator=()

boolNDArray & boolNDArray::operator= ( const boolNDArray &  a )

inline

Definition at line 53 of file boolNDArray.h.

References Array< T, Alloc >::operator=().

squeeze()

boolNDArray boolNDArray::squeeze ( ) const

inline

Definition at line 82 of file boolNDArray.h.

References Array< T, Alloc >::squeeze().

---

The documentation for this class was generated from the following files:

• liboctave/array/boolNDArray.h
• liboctave/array/boolNDArray.cc