GNU Octave  6.2.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
boolMatrix Class Reference

#include "boolMatrix.h"

Inheritance diagram for boolMatrix:
Collaboration diagram for boolMatrix:

Public Types

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 boolMatrix matrix_type
 
typedef octave_idx_type size_type
 Used for operator(), and returned by numel() and size() (beware: signed integer) More...
 
typedef bool value_type
 

Public Member Functions

 boolMatrix (const Array< bool > &a)
 
 boolMatrix (const boolMatrix &a)=default
 
 boolMatrix (const dim_vector &dv)
 
 boolMatrix (const dim_vector &dv, bool val)
 
 boolMatrix (octave_idx_type r, octave_idx_type c)
 
 boolMatrix (octave_idx_type r, octave_idx_type c, bool val)
 
 boolMatrix (void)=default
 
 ~boolMatrix (void)=default
 
boolNDArray all (int dim=-1) const
 
boolNDArray any (int dim=-1) const
 
bool any_element_is_nan (void) const
 
Array< bool > as_column (void) const
 Return the array as a column vector. More...
 
Array< bool > as_matrix (void) const
 Return the array as a matrix. More...
 
Array< bool > as_row (void) const
 Return the array as a row vector. More...
 
void clear (const dim_vector &dv)
 
void clear (octave_idx_type r, octave_idx_type c)
 
void clear (void)
 
boolNDArray concat (const boolNDArray &rb, const Array< octave_idx_type > &ra_idx)
 
boolMatrix diag (octave_idx_type k=0) const
 
boolNDArray diag (octave_idx_type m, octave_idx_type n) const
 
void fill (const bool &val)
 
Array< octave_idx_typefind (octave_idx_type, bool) const
 
boolMatrixinsert (const boolMatrix &a, octave_idx_type r, octave_idx_type c)
 
boolNDArrayinsert (const boolNDArray &a, const Array< octave_idx_type > &ra_idx)
 
boolNDArrayinsert (const boolNDArray &a, octave_idx_type r, octave_idx_type c)
 
boolNDArrayinvert (void)
 
sortmode is_sorted_rows (sortmode) const
 
OCTAVE_API sortmode issorted (sortmode mode) const
 
sortmode issorted (sortmode) const
 
Array< octave_idx_typelookup (const Array< idx_vector > &, sortmode) const
 
octave_idx_type lookup (idx_vector const &, sortmode) const
 
void make_unique (void)
 
octave_idx_type nnz (void) const
 
Array< idx_vectornth_element (const idx_vector &, int) const
 
octave_idx_type numel (void) const
 Number of elements in the array. More...
 
boolMatrix operator! (void) const
 
bool operator!= (const boolMatrix &a) const
 
boolMatrixoperator= (const boolMatrix &a)=default
 
bool operator== (const boolMatrix &a) const
 
void resize (octave_idx_type nr, octave_idx_type nc, bool rfv=false)
 
Array< idx_vectorsort (Array< octave_idx_type > &sidx, int, sortmode) const
 
Array< idx_vectorsort (int, sortmode) const
 
Array< octave_idx_typesort_rows_idx (sortmode) const
 
boolNDArray squeeze (void) const
 
boolMatrix transpose (void) const
 
First dimension

Get the first dimension of the array (number of rows)

octave_idx_type dim1 (void) const
 
octave_idx_type rows (void) const
 
Second dimension

Get the second dimension of the array (number of columns)

octave_idx_type dim2 (void) const
 
octave_idx_type cols (void) const
 
octave_idx_type columns (void) const
 

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)
 

Protected Attributes

dim_vector dimensions
 
Array< bool >::ArrayRep * rep
 
bool * slice_data
 
octave_idx_type slice_len
 

Private Member Functions

void instantiation_guard ()
 
void instantiation_guard ()
 
void instantiation_guard ()
 
void instantiation_guard ()
 
void instantiation_guard ()
 
void instantiation_guard ()
 
void instantiation_guard ()
 
void instantiation_guard ()
 
void instantiation_guard ()
 
void instantiation_guard ()
 
void instantiation_guard ()
 
void instantiation_guard ()
 
void instantiation_guard ()
 
void instantiation_guard ()
 

Static Private Member Functions

static Array< bool >::ArrayRep * nil_rep (void)
 

Third dimension

Get the third dimension of the array (number of pages)

Array< bool > & insert (const Array< bool > &a, const Array< octave_idx_type > &idx)
 Insert an array into another at a specified position. More...
 
Array< bool > & insert (const Array< bool > &a, octave_idx_type r, octave_idx_type c)
 This is just a special case for idx = [r c 0 ...]. More...
 
octave_idx_type compute_index (octave_idx_type i, octave_idx_type j) const
 Size of the specified dimension. More...
 
octave_idx_type compute_index (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 Size of the specified dimension. More...
 
octave_idx_type compute_index (const Array< octave_idx_type > &ra_idx) const
 Size of the specified dimension. More...
 
octave_idx_type dim3 (void) const
 Size of the specified dimension. More...
 
octave_idx_type pages (void) const
 Size of the specified dimension. More...
 
size_type size (const size_type d) const
 Size of the specified dimension. More...
 
size_t byte_size (void) const
 Size of the specified dimension. More...
 
const dim_vectordims (void) const
 Return a const-reference so that dims ()(i) works efficiently. More...
 
octave_idx_type compute_index_unchecked (const Array< octave_idx_type > &ra_idx) const
 Size of the specified dimension. More...
 
bool & xelem (octave_idx_type n)
 Size of the specified dimension. More...
 
crefT xelem (octave_idx_type n) const
 Size of the specified dimension. More...
 
bool & xelem (octave_idx_type i, octave_idx_type j)
 Size of the specified dimension. More...
 
crefT xelem (octave_idx_type i, octave_idx_type j) const
 Size of the specified dimension. More...
 
bool & xelem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 Size of the specified dimension. More...
 
crefT xelem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 Size of the specified dimension. More...
 
bool & xelem (const Array< octave_idx_type > &ra_idx)
 Size of the specified dimension. More...
 
crefT xelem (const Array< octave_idx_type > &ra_idx) const
 Size of the specified dimension. More...
 
bool & checkelem (octave_idx_type n)
 Size of the specified dimension. More...
 
bool & checkelem (octave_idx_type i, octave_idx_type j)
 Size of the specified dimension. More...
 
bool & checkelem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 Size of the specified dimension. More...
 
bool & checkelem (const Array< octave_idx_type > &ra_idx)
 Size of the specified dimension. More...
 
crefT checkelem (octave_idx_type n) const
 Size of the specified dimension. More...
 
crefT checkelem (octave_idx_type i, octave_idx_type j) const
 Size of the specified dimension. More...
 
crefT checkelem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 Size of the specified dimension. More...
 
crefT checkelem (const Array< octave_idx_type > &ra_idx) const
 Size of the specified dimension. More...
 
bool & elem (octave_idx_type n)
 Size of the specified dimension. More...
 
bool & elem (octave_idx_type i, octave_idx_type j)
 Size of the specified dimension. More...
 
bool & elem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 Size of the specified dimension. More...
 
bool & elem (const Array< octave_idx_type > &ra_idx)
 Size of the specified dimension. More...
 
crefT elem (octave_idx_type n) const
 Size of the specified dimension. More...
 
crefT elem (octave_idx_type i, octave_idx_type j) const
 Size of the specified dimension. More...
 
crefT elem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 Size of the specified dimension. More...
 
crefT elem (const Array< octave_idx_type > &ra_idx) const
 Size of the specified dimension. More...
 
bool & operator() (octave_idx_type n)
 Size of the specified dimension. More...
 
bool & operator() (octave_idx_type i, octave_idx_type j)
 Size of the specified dimension. More...
 
bool & operator() (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 Size of the specified dimension. More...
 
bool & operator() (const Array< octave_idx_type > &ra_idx)
 Size of the specified dimension. More...
 
crefT operator() (octave_idx_type n) const
 Size of the specified dimension. More...
 
crefT operator() (octave_idx_type i, octave_idx_type j) const
 Size of the specified dimension. More...
 
crefT operator() (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 Size of the specified dimension. More...
 
crefT operator() (const Array< octave_idx_type > &ra_idx) const
 Size of the specified dimension. More...
 
Array< bool > column (octave_idx_type k) const
 Extract column: A(:,k+1). More...
 
Array< bool > page (octave_idx_type k) const
 Extract page: A(:,:,k+1). More...
 
Array< bool > 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). More...
 
Array< bool > reshape (octave_idx_type nr, octave_idx_type nc) const
 Size of the specified dimension. More...
 
Array< bool > reshape (const dim_vector &new_dims) const
 Size of the specified dimension. More...
 
Array< bool > permute (const Array< octave_idx_type > &vec, bool inv=false) const
 Size of the specified dimension. More...
 
Array< bool > ipermute (const Array< octave_idx_type > &vec) const
 Size of the specified dimension. More...
 
bool issquare (void) const
 Size of the specified dimension. More...
 
bool isempty (void) const
 Size of the specified dimension. More...
 
bool isvector (void) const
 Size of the specified dimension. More...
 
bool is_nd_vector (void) const
 Size of the specified dimension. More...
 
Array< bool > hermitian (bool(*fcn)(const bool &)=nullptr) const
 Size of the specified dimension. More...
 
const bool * data (void) const
 Size of the specified dimension. More...
 
const bool * fortran_vec (void) const
 Size of the specified dimension. More...
 
bool * fortran_vec (void)
 Size of the specified dimension. More...
 
bool is_shared (void)
 Size of the specified dimension. More...
 
int ndims (void) const
 Size of the specified dimension. More...
 
Array< bool > index (const idx_vector &i) const
 Indexing without resizing. More...
 
Array< bool > index (const idx_vector &i, const idx_vector &j) const
 Size of the specified dimension. More...
 
Array< bool > index (const Array< idx_vector > &ia) const
 Size of the specified dimension. More...
 
Array< bool > index (const idx_vector &i, bool resize_ok, const bool &rfv) const
 Indexing with possible resizing and fill. More...
 
Array< bool > index (const idx_vector &i, bool resize_ok) const
 Size of the specified dimension. More...
 
Array< bool > index (const idx_vector &i, const idx_vector &j, bool resize_ok, const bool &rfv) const
 Size of the specified dimension. More...
 
Array< bool > index (const idx_vector &i, const idx_vector &j, bool resize_ok) const
 Size of the specified dimension. More...
 
Array< bool > index (const Array< idx_vector > &ia, bool resize_ok, const bool &rfv) const
 Size of the specified dimension. More...
 
Array< bool > index (const Array< idx_vector > &ia, bool resize_ok) const
 Size of the specified dimension. More...
 
virtual bool resize_fill_value (void) const
 Size of the specified dimension. More...
 
void resize2 (octave_idx_type nr, octave_idx_type nc, const bool &rfv)
 Resizing (with fill). More...
 
void resize2 (octave_idx_type nr, octave_idx_type nc)
 Size of the specified dimension. More...
 
void resize1 (octave_idx_type n, const bool &rfv)
 Size of the specified dimension. More...
 
void resize1 (octave_idx_type n)
 Size of the specified dimension. More...
 
void resize (const dim_vector &dv, const bool &rfv)
 Size of the specified dimension. More...
 
void resize (const dim_vector &dv)
 Size of the specified dimension. More...
 
void assign (const idx_vector &i, const Array< bool > &rhs, const bool &rfv)
 Indexed assignment (always with resize & fill). More...
 
void assign (const idx_vector &i, const Array< bool > &rhs)
 Size of the specified dimension. More...
 
void assign (const idx_vector &i, const idx_vector &j, const Array< bool > &rhs, const bool &rfv)
 Size of the specified dimension. More...
 
void assign (const idx_vector &i, const idx_vector &j, const Array< bool > &rhs)
 Size of the specified dimension. More...
 
void assign (const Array< idx_vector > &ia, const Array< bool > &rhs, const bool &rfv)
 Size of the specified dimension. More...
 
void assign (const Array< idx_vector > &ia, const Array< bool > &rhs)
 Size of the specified dimension. More...
 
void delete_elements (const idx_vector &i)
 Deleting elements. More...
 
void delete_elements (int dim, const idx_vector &i)
 A(:,...,I,...,:) = [] (>= 2 subscripts, one of them is non-colon) More...
 
void delete_elements (const Array< idx_vector > &ia)
 Dispatcher to the above two. More...
 
void maybe_economize (void)
 Size of the specified dimension. More...
 
void print_info (std::ostream &os, const std::string &prefix) const
 Size of the specified dimension. More...
 
void * mex_get_data (void) const
 Give a pointer to the data in mex format. More...
 
Array< bool > sort (int dim=0, sortmode mode=ASCENDING) const
 Size of the specified dimension. More...
 
Array< bool > sort (Array< octave_idx_type > &sidx, int dim=0, sortmode mode=ASCENDING) const
 Size of the specified dimension. More...
 
sortmode issorted (sortmode mode=UNSORTED) const
 Ordering is auto-detected or can be specified. More...
 
Array< octave_idx_typesort_rows_idx (sortmode mode=ASCENDING) const
 Sort by rows returns only indices. More...
 
sortmode is_sorted_rows (sortmode mode=UNSORTED) const
 Ordering is auto-detected or can be specified. More...
 
octave_idx_type lookup (const bool &value, sortmode mode=UNSORTED) const
 Do a binary lookup in a sorted array. More...
 
Array< octave_idx_typelookup (const Array< bool > &values, sortmode mode=UNSORTED) const
 Ditto, but for an array of values, specializing on the case when values are sorted. More...
 
octave_idx_type nnz (void) const
 Count nonzero elements. More...
 
Array< octave_idx_typefind (octave_idx_type n=-1, bool backward=false) const
 Find indices of (at most n) nonzero elements. More...
 
Array< bool > nth_element (const idx_vector &n, int dim=0) const
 Returns the n-th element in increasing order, using the same ordering as used for sort. More...
 
Array< U > map (F fcn) const
 Apply function fcn to each element of the Array<T>. More...
 
Array< U > map (U(&fcn)(bool)) const
 Overloads for function references. More...
 
Array< U > map (U(&fcn)(const bool &)) const
 Size of the specified dimension. More...
 
bool test (F fcn) const
 Generic any/all test functionality with arbitrary predicate. More...
 
bool test_any (F fcn) const
 Simpler calls. More...
 
bool test_any (bool(&fcn)(bool)) const
 Overloads for function references. More...
 
bool test_any (bool(&fcn)(const bool &)) const
 Size of the specified dimension. More...
 
bool test_all (F fcn) const
 Size of the specified dimension. More...
 
bool test_all (bool(&fcn)(bool)) const
 Size of the specified dimension. More...
 
bool test_all (bool(&fcn)(const bool &)) const
 Size of the specified dimension. More...
 
bool optimize_dimensions (const dim_vector &dv)
 Returns true if this->dims () == dv, and if so, replaces this->dimensions by a shallow copy of dv. More...
 
int jit_ref_count (void)
 WARNING: Only call these functions from jit. More...
 
bool * jit_slice_data (void) const
 Size of the specified dimension. More...
 
octave_idx_typejit_dimensions (void) const
 Size of the specified dimension. More...
 
void * jit_array_rep (void) const
 Size of the specified dimension. More...
 
static Array< bool > cat (int dim, octave_idx_type n, const Array< bool > *array_list)
 Concatenation along a specified (0-based) dimension, equivalent to cat(). More...
 
static void instantiation_guard ()
 Size of the specified dimension. More...
 

Detailed Description

Definition at line 36 of file boolMatrix.h.

Member Typedef Documentation

◆ compare_fcn_type

typedef bool(* Array< bool >::compare_fcn_type) (typename ref_param< bool >::type, typename ref_param< bool >::type)
inherited

Definition at line 212 of file Array.h.

◆ crefT

typedef ref_param<bool >::type Array< bool >::crefT
inherited

Definition at line 210 of file Array.h.

◆ element_type

typedef bool Array< bool >::element_type
inherited

Definition at line 202 of file Array.h.

◆ matrix_type

Definition at line 42 of file boolNDArray.h.

◆ size_type

typedef octave_idx_type Array< bool >::size_type
inherited

Used for operator(), and returned by numel() and size() (beware: signed integer)

Definition at line 208 of file Array.h.

◆ value_type

typedef bool Array< bool >::value_type
inherited

Definition at line 204 of file Array.h.

Constructor & Destructor Documentation

◆ boolMatrix() [1/7]

boolMatrix::boolMatrix ( void  )
default

◆ boolMatrix() [2/7]

boolMatrix::boolMatrix ( const boolMatrix a)
default

◆ ~boolMatrix()

boolMatrix::~boolMatrix ( void  )
default

◆ boolMatrix() [3/7]

boolMatrix::boolMatrix ( octave_idx_type  r,
octave_idx_type  c 
)
inline

Definition at line 50 of file boolMatrix.h.

◆ boolMatrix() [4/7]

boolMatrix::boolMatrix ( octave_idx_type  r,
octave_idx_type  c,
bool  val 
)
inline

Definition at line 53 of file boolMatrix.h.

◆ boolMatrix() [5/7]

boolMatrix::boolMatrix ( const dim_vector dv)
inline

Definition at line 56 of file boolMatrix.h.

◆ boolMatrix() [6/7]

boolMatrix::boolMatrix ( const dim_vector dv,
bool  val 
)
inline

Definition at line 58 of file boolMatrix.h.

◆ boolMatrix() [7/7]

boolMatrix::boolMatrix ( const Array< bool > &  a)
inline

Definition at line 61 of file boolMatrix.h.

Member Function Documentation

◆ all()

boolNDArray boolNDArray::all ( int  dim = -1) const
inherited

◆ any()

boolNDArray boolNDArray::any ( int  dim = -1) const
inherited

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 ( void  ) const
inlineinherited

Definition at line 67 of file boolNDArray.h.

◆ as_column()

Array<bool > Array< bool >::as_column ( void  ) const
inlineinherited

Return the array as a column vector.

Definition at line 381 of file Array.h.

◆ as_matrix()

Array<bool > Array< bool >::as_matrix ( void  ) const
inlineinherited

Return the array as a matrix.

Definition at line 401 of file Array.h.

◆ as_row()

Array<bool > Array< bool >::as_row ( void  ) const
inlineinherited

Return the array as a row vector.

Definition at line 391 of file Array.h.

◆ assign() [1/6]

void Array< bool >::assign ( const Array< idx_vector > &  ia,
const Array< bool > &  rhs 
)
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 661 of file Array.h.

◆ assign() [2/6]

void Array< bool >::assign ( const Array< idx_vector > &  ia,
const Array< bool > &  rhs,
const bool &  rfv 
)
inherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 660 of file Array.cc.

◆ assign() [3/6]

void Array< bool >::assign ( const idx_vector i,
const Array< bool > &  rhs 
)
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 648 of file Array.h.

◆ assign() [4/6]

void Array< bool >::assign ( const idx_vector i,
const Array< bool > &  rhs,
const bool &  rfv 
)
inherited

Indexed assignment (always with resize & fill).

Definition at line 647 of file Array.cc.

◆ assign() [5/6]

void Array< bool >::assign ( const idx_vector i,
const idx_vector j,
const Array< bool > &  rhs 
)
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 655 of file Array.h.

◆ assign() [6/6]

void Array< bool >::assign ( const idx_vector i,
const idx_vector j,
const Array< bool > &  rhs,
const bool &  rfv 
)
inherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 653 of file Array.cc.

◆ byte_size()

size_t Array< bool >::byte_size ( void  ) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 449 of file Array.h.

◆ cat()

Array< bool > Array< bool >::cat ( int  dim,
octave_idx_type  n,
const Array< bool > *  array_list 
)
staticinherited

Concatenation along a specified (0-based) dimension, equivalent to cat().

dim = -1 corresponds to dim = 0 and dim = -2 corresponds to dim = 1, but apply the looser matching rules of vertcat/horzcat.

Definition at line 753 of file Array.cc.

◆ checkelem() [1/8]

bool & Array< bool >::checkelem ( const Array< octave_idx_type > &  ra_idx)
inherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 497 of file Array.cc.

◆ checkelem() [2/8]

Array< bool >::crefT Array< bool >::checkelem ( const Array< octave_idx_type > &  ra_idx) const
inherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 527 of file Array.cc.

◆ checkelem() [3/8]

bool & Array< bool >::checkelem ( octave_idx_type  i,
octave_idx_type  j 
)
inherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 493 of file Array.cc.

◆ checkelem() [4/8]

Array< bool >::crefT Array< bool >::checkelem ( octave_idx_type  i,
octave_idx_type  j 
) const
inherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 522 of file Array.cc.

◆ checkelem() [5/8]

bool & Array< bool >::checkelem ( octave_idx_type  i,
octave_idx_type  j,
octave_idx_type  k 
)
inherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 495 of file Array.cc.

◆ checkelem() [6/8]

Array< bool >::crefT Array< bool >::checkelem ( octave_idx_type  i,
octave_idx_type  j,
octave_idx_type  k 
) const
inherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 524 of file Array.cc.

◆ checkelem() [7/8]

bool & Array< bool >::checkelem ( octave_idx_type  n)
inherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 491 of file Array.cc.

◆ checkelem() [8/8]

Array< bool >::crefT Array< bool >::checkelem ( octave_idx_type  n) const
inherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 520 of file Array.cc.

◆ clear() [1/3]

void Array< bool >::clear ( const dim_vector dv)
inherited

Definition at line 371 of file Array.cc.

◆ clear() [2/3]

void Array< bool >::clear ( octave_idx_type  r,
octave_idx_type  c 
)
inlineinherited

Definition at line 373 of file Array.h.

◆ clear() [3/3]

void Array< bool >::clear ( void  )
inherited

Definition at line 370 of file Array.cc.

◆ cols()

octave_idx_type Array< bool >::cols ( void  ) const
inlineinherited

Definition at line 423 of file Array.h.

◆ column()

Array< bool > Array< bool >::column ( octave_idx_type  k) const
inherited

Extract column: A(:,k+1).

Definition at line 552 of file Array.cc.

◆ columns()

octave_idx_type Array< bool >::columns ( void  ) const
inlineinherited

Definition at line 424 of file Array.h.

◆ compute_index() [1/4]

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

Definition at line 104 of file boolNDArray.cc.

References compute_index(), Array< bool >::dimensions, and ra_idx.

◆ compute_index() [2/4]

octave_idx_type Array< bool >::compute_index ( const Array< octave_idx_type > &  ra_idx) const
inherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 461 of file Array.cc.

◆ compute_index() [3/4]

octave_idx_type Array< bool >::compute_index ( octave_idx_type  i,
octave_idx_type  j 
) const
inherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 458 of file Array.cc.

◆ compute_index() [4/4]

octave_idx_type Array< bool >::compute_index ( octave_idx_type  i,
octave_idx_type  j,
octave_idx_type  k 
) const
inherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 459 of file Array.cc.

◆ compute_index_unchecked()

octave_idx_type Array< bool >::compute_index_unchecked ( const Array< octave_idx_type > &  ra_idx) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 463 of file Array.h.

◆ concat()

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

Definition at line 73 of file boolNDArray.cc.

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

◆ data()

const bool * Array< bool >::data ( void  ) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 581 of file Array.h.

◆ delete_elements() [1/3]

void Array< bool >::delete_elements ( const Array< idx_vector > &  ia)
inherited

Dispatcher to the above two.

Definition at line 677 of file Array.cc.

◆ delete_elements() [2/3]

void Array< bool >::delete_elements ( const idx_vector i)
inherited

Deleting elements.

A(I) = [] (with a single subscript)

Definition at line 671 of file Array.cc.

◆ delete_elements() [3/3]

void Array< bool >::delete_elements ( int  dim,
const idx_vector i 
)
inherited

A(:,...,I,...,:) = [] (>= 2 subscripts, one of them is non-colon)

Definition at line 674 of file Array.cc.

◆ diag() [1/2]

boolMatrix boolMatrix::diag ( octave_idx_type  k = 0) const

Definition at line 83 of file boolMatrix.cc.

References Array< T >::diag().

◆ diag() [2/2]

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

Definition at line 117 of file boolNDArray.cc.

References Array< T >::diag(), m, and n.

◆ dim1()

octave_idx_type Array< bool >::dim1 ( void  ) const
inlineinherited

Definition at line 414 of file Array.h.

◆ dim2()

octave_idx_type Array< bool >::dim2 ( void  ) const
inlineinherited

Definition at line 422 of file Array.h.

◆ dim3()

octave_idx_type Array< bool >::dim3 ( void  ) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 431 of file Array.h.

◆ dims()

const dim_vector& Array< bool >::dims ( void  ) const
inlineinherited

Return a const-reference so that dims ()(i) works efficiently.

Definition at line 453 of file Array.h.

◆ elem() [1/8]

bool & Array< bool >::elem ( const Array< octave_idx_type > &  ra_idx)
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 510 of file Array.h.

◆ elem() [2/8]

crefT Array< bool >::elem ( const Array< octave_idx_type > &  ra_idx) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 537 of file Array.h.

◆ elem() [3/8]

bool & Array< bool >::elem ( octave_idx_type  i,
octave_idx_type  j 
)
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 505 of file Array.h.

◆ elem() [4/8]

crefT Array< bool >::elem ( octave_idx_type  i,
octave_idx_type  j 
) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 531 of file Array.h.

◆ elem() [5/8]

bool & Array< bool >::elem ( octave_idx_type  i,
octave_idx_type  j,
octave_idx_type  k 
)
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 507 of file Array.h.

◆ elem() [6/8]

crefT Array< bool >::elem ( octave_idx_type  i,
octave_idx_type  j,
octave_idx_type  k 
) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 534 of file Array.h.

◆ elem() [7/8]

bool & Array< bool >::elem ( octave_idx_type  n)
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 499 of file Array.h.

◆ elem() [8/8]

crefT Array< bool >::elem ( octave_idx_type  n) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 529 of file Array.h.

◆ fill()

void Array< bool >::fill ( const bool &  val)
inherited

Definition at line 368 of file Array.cc.

◆ find() [1/2]

Array< octave_idx_type > Array< bool >::find ( octave_idx_type  n = -1,
bool  backward = false 
) const
inherited

Find indices of (at most n) nonzero elements.

If n is specified, backward specifies search from backward.

Definition at line 734 of file Array.cc.

◆ find() [2/2]

Array< octave_idx_type > Array< idx_vector >::find ( octave_idx_type  ,
bool   
) const
inherited

Definition at line 42 of file Array-idx-vec.cc.

◆ fortran_vec() [1/2]

bool * Array< bool >::fortran_vec ( void  )
inherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 585 of file Array.cc.

◆ fortran_vec() [2/2]

const bool * Array< bool >::fortran_vec ( void  ) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 583 of file Array.h.

◆ hermitian()

Array< bool > Array< bool >::hermitian ( bool (*)(const bool &)  fcn = nullptr) const
inherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 579 of file Array.cc.

◆ increment_index()

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

Definition at line 96 of file boolNDArray.cc.

References Array< bool >::dimensions, and ra_idx.

◆ index() [1/9]

Array< bool > Array< bool >::index ( const Array< idx_vector > &  ia) const
inherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 597 of file Array.cc.

◆ index() [2/9]

Array<bool > Array< bool >::index ( const Array< idx_vector > &  ia,
bool  resize_ok 
) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 639 of file Array.h.

◆ index() [3/9]

Array< bool > Array< bool >::index ( const Array< idx_vector > &  ia,
bool  resize_ok,
const bool &  rfv 
) const
inherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 637 of file Array.cc.

◆ index() [4/9]

Array< bool > Array< bool >::index ( const idx_vector i) const
inherited

Indexing without resizing.

Definition at line 593 of file Array.cc.

◆ index() [5/9]

Array<bool > Array< bool >::index ( const idx_vector i,
bool  resize_ok 
) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 624 of file Array.h.

◆ index() [6/9]

Array< bool > Array< bool >::index ( const idx_vector i,
bool  resize_ok,
const bool &  rfv 
) const
inherited

Indexing with possible resizing and fill.

Definition at line 623 of file Array.cc.

◆ index() [7/9]

Array< bool > Array< bool >::index ( const idx_vector i,
const idx_vector j 
) const
inherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 595 of file Array.cc.

◆ index() [8/9]

Array<bool > Array< bool >::index ( const idx_vector i,
const idx_vector j,
bool  resize_ok 
) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 631 of file Array.h.

◆ index() [9/9]

Array< bool > Array< bool >::index ( const idx_vector i,
const idx_vector j,
bool  resize_ok,
const bool &  rfv 
) const
inherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 629 of file Array.cc.

◆ insert() [1/5]

Array< bool > & Array< bool >::insert ( const Array< bool > &  a,
const Array< octave_idx_type > &  idx 
)
inherited

Insert an array into another at a specified position.

If size (a) is [d1 d2 ... dN] and idx is [i1 i2 ... iN], this method is equivalent to x(i1:i1+d1-1, i2:i2+d2-1, ... , iN:iN+dN-1) = a.

Definition at line 684 of file Array.cc.

◆ insert() [2/5]

Array< bool > & Array< bool >::insert ( const Array< bool > &  a,
octave_idx_type  r,
octave_idx_type  c 
)
inherited

This is just a special case for idx = [r c 0 ...].

Definition at line 687 of file Array.cc.

◆ insert() [3/5]

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

Definition at line 57 of file boolMatrix.cc.

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

◆ insert() [4/5]

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

Definition at line 89 of file boolNDArray.cc.

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

◆ insert() [5/5]

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

Definition at line 82 of file boolNDArray.cc.

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

Referenced by boolNDArray::concat().

◆ instantiation_guard() [1/15]

void Array< Complex >::instantiation_guard ( )
privateinherited

Definition at line 97 of file Array-C.cc.

◆ instantiation_guard() [2/15]

void Array< float >::instantiation_guard ( )
privateinherited

Definition at line 168 of file Array-f.cc.

◆ instantiation_guard() [3/15]

void Array< FloatComplex >::instantiation_guard ( )
privateinherited

Definition at line 97 of file Array-fC.cc.

◆ instantiation_guard() [4/15]

void Array< long >::instantiation_guard ( )
privateinherited

Definition at line 53 of file Array-i.cc.

◆ instantiation_guard() [5/15]

void Array< octave_int8 >::instantiation_guard ( )
privateinherited

Definition at line 63 of file Array-i.cc.

◆ instantiation_guard() [6/15]

void Array< octave_int16 >::instantiation_guard ( )
privateinherited

Definition at line 64 of file Array-i.cc.

◆ instantiation_guard() [7/15]

void Array< octave_int32 >::instantiation_guard ( )
privateinherited

Definition at line 65 of file Array-i.cc.

◆ instantiation_guard() [8/15]

void Array< octave_int64 >::instantiation_guard ( )
privateinherited

Definition at line 66 of file Array-i.cc.

◆ instantiation_guard() [9/15]

void Array< octave_uint8 >::instantiation_guard ( )
privateinherited

Definition at line 73 of file Array-i.cc.

◆ instantiation_guard() [10/15]

void Array< octave_uint16 >::instantiation_guard ( )
privateinherited

Definition at line 74 of file Array-i.cc.

◆ instantiation_guard() [11/15]

void Array< octave_uint32 >::instantiation_guard ( )
privateinherited

Definition at line 75 of file Array-i.cc.

◆ instantiation_guard() [12/15]

void Array< octave_uint64 >::instantiation_guard ( )
privateinherited

Definition at line 76 of file Array-i.cc.

◆ instantiation_guard() [13/15]

void Array< idx_vector >::instantiation_guard ( )
privateinherited

Definition at line 44 of file Array-idx-vec.cc.

◆ instantiation_guard() [14/15]

void Array< short >::instantiation_guard ( )
privateinherited

Definition at line 47 of file Array-s.cc.

◆ instantiation_guard() [15/15]

void Array< bool >::instantiation_guard
staticprivateinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 853 of file Array.cc.

◆ invert()

boolNDArray & boolNDArray::invert ( void  )
inherited

Definition at line 48 of file boolNDArray.cc.

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

◆ ipermute()

Array<bool > Array< bool >::ipermute ( const Array< octave_idx_type > &  vec) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 567 of file Array.h.

◆ is_nd_vector()

bool Array< bool >::is_nd_vector ( void  ) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 576 of file Array.h.

◆ is_shared()

bool Array< bool >::is_shared ( void  )
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 587 of file Array.h.

◆ is_sorted_rows() [1/2]

sortmode Array< bool >::is_sorted_rows ( sortmode  mode = UNSORTED) const
inherited

Ordering is auto-detected or can be specified.

Definition at line 718 of file Array.cc.

◆ is_sorted_rows() [2/2]

sortmode Array< idx_vector >::is_sorted_rows ( sortmode  ) const
inherited

Definition at line 42 of file Array-idx-vec.cc.

◆ isempty()

bool Array< bool >::isempty ( void  ) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 572 of file Array.h.

◆ issorted() [1/3]

OCTAVE_API sortmode Array< float >::issorted ( sortmode  mode) const
inherited

Definition at line 100 of file Array-f.cc.

◆ issorted() [2/3]

sortmode Array< bool >::issorted ( sortmode  mode = UNSORTED) const
inherited

Ordering is auto-detected or can be specified.

Definition at line 712 of file Array.cc.

◆ issorted() [3/3]

sortmode Array< idx_vector >::issorted ( sortmode  ) const
inherited

Definition at line 42 of file Array-idx-vec.cc.

◆ issquare()

bool Array< bool >::issquare ( void  ) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 570 of file Array.h.

◆ isvector()

bool Array< bool >::isvector ( void  ) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 574 of file Array.h.

◆ jit_array_rep()

void* Array< bool >::jit_array_rep ( void  ) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 849 of file Array.h.

◆ jit_dimensions()

octave_idx_type* Array< bool >::jit_dimensions ( void  ) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 847 of file Array.h.

◆ jit_ref_count()

int Array< bool >::jit_ref_count ( void  )
inlineinherited

WARNING: Only call these functions from jit.

Definition at line 843 of file Array.h.

◆ jit_slice_data()

bool * Array< bool >::jit_slice_data ( void  ) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 845 of file Array.h.

◆ linear_slice()

Array< bool > Array< bool >::linear_slice ( octave_idx_type  lo,
octave_idx_type  up 
) const
inherited

Extract a slice from this array as a column vector: A(:)(lo+1:up).

Must be 0 <= lo && up <= numel. May be up < lo.

Definition at line 558 of file Array.cc.

◆ lookup() [1/4]

Array< octave_idx_type > Array< bool >::lookup ( const Array< bool > &  values,
sortmode  mode = UNSORTED 
) const
inherited

Ditto, but for an array of values, specializing on the case when values are sorted.

NaNs get the value N.

Definition at line 726 of file Array.cc.

◆ lookup() [2/4]

Array< octave_idx_type > Array< idx_vector >::lookup ( const Array< idx_vector > &  ,
sortmode   
) const
inherited

Definition at line 42 of file Array-idx-vec.cc.

◆ lookup() [3/4]

octave_idx_type Array< bool >::lookup ( const bool &  value,
sortmode  mode = UNSORTED 
) const
inherited

Do a binary lookup in a sorted array.

Must not contain NaNs. Mode can be specified or is auto-detected by comparing 1st and last element.

Definition at line 722 of file Array.cc.

◆ lookup() [4/4]

octave_idx_type Array< idx_vector >::lookup ( idx_vector const &  ,
sortmode   
) const
inherited

Definition at line 42 of file Array-idx-vec.cc.

◆ make_unique()

void Array< bool >::make_unique ( void  )
inlineinherited

Definition at line 188 of file Array.h.

◆ map() [1/3]

Array<U> Array< bool >::map ( fcn) const
inlineinherited

Apply function fcn to each element of the Array<T>.

This function is optimized with a manually unrolled loop.

Definition at line 759 of file Array.h.

◆ map() [2/3]

Array<U> Array< bool >::map ( U(&)(bool )  fcn) const
inlineinherited

Overloads for function references.

Definition at line 791 of file Array.h.

◆ map() [3/3]

Array<U> Array< bool >::map ( U(&)(const bool &)  fcn) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 796 of file Array.h.

◆ maybe_economize()

void Array< bool >::maybe_economize ( void  )
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 689 of file Array.h.

◆ mex_get_data()

void* Array< bool >::mex_get_data ( void  ) const
inlineinherited

Give a pointer to the data in mex format.

Unsafe. This function exists to support the MEX interface. You should not use it anywhere else.

Definition at line 705 of file Array.h.

◆ ndims()

int Array< bool >::ndims ( void  ) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 589 of file Array.h.

◆ nil_rep()

Array< bool >::ArrayRep * Array< bool >::nil_rep ( void  )
staticprivateinherited

Definition at line 242 of file Array.cc.

◆ nnz() [1/2]

octave_idx_type Array< idx_vector >::nnz ( void  ) const
inherited

Definition at line 42 of file Array-idx-vec.cc.

◆ nnz() [2/2]

octave_idx_type Array< bool >::nnz ( void  ) const
inherited

Count nonzero elements.

Definition at line 730 of file Array.cc.

◆ nth_element() [1/2]

Array< idx_vector > Array< idx_vector >::nth_element ( const idx_vector ,
int   
) const
inherited

Definition at line 42 of file Array-idx-vec.cc.

◆ nth_element() [2/2]

Array< bool > Array< bool >::nth_element ( const idx_vector n,
int  dim = 0 
) const
inherited

Returns the n-th element in increasing order, using the same ordering as used for sort.

n can either be a scalar index or a contiguous range.

Definition at line 740 of file Array.cc.

◆ numel()

octave_idx_type Array< bool >::numel ( void  ) const
inlineinherited

Number of elements in the array.

Definition at line 377 of file Array.h.

◆ operator!()

boolMatrix boolMatrix::operator! ( void  ) const

◆ operator!=()

bool boolMatrix::operator!= ( const boolMatrix a) const

Definition at line 51 of file boolMatrix.cc.

◆ operator()() [1/8]

bool & Array< bool >::operator() ( const Array< octave_idx_type > &  ra_idx)
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 517 of file Array.h.

◆ operator()() [2/8]

crefT Array< bool >::operator() ( const Array< octave_idx_type > &  ra_idx) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 546 of file Array.h.

◆ operator()() [3/8]

bool & Array< bool >::operator() ( octave_idx_type  i,
octave_idx_type  j 
)
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 514 of file Array.h.

◆ operator()() [4/8]

crefT Array< bool >::operator() ( octave_idx_type  i,
octave_idx_type  j 
) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 541 of file Array.h.

◆ operator()() [5/8]

bool & Array< bool >::operator() ( octave_idx_type  i,
octave_idx_type  j,
octave_idx_type  k 
)
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 515 of file Array.h.

◆ operator()() [6/8]

crefT Array< bool >::operator() ( octave_idx_type  i,
octave_idx_type  j,
octave_idx_type  k 
) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 543 of file Array.h.

◆ operator()() [7/8]

bool & Array< bool >::operator() ( octave_idx_type  n)
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 513 of file Array.h.

◆ operator()() [8/8]

crefT Array< bool >::operator() ( octave_idx_type  n) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 540 of file Array.h.

◆ operator=()

boolMatrix& boolMatrix::operator= ( const boolMatrix a)
default

◆ operator==()

◆ optimize_dimensions()

bool Array< bool >::optimize_dimensions ( const dim_vector dv)
inherited

Returns true if this->dims () == dv, and if so, replaces this->dimensions by a shallow copy of dv.

This is useful for maintaining several arrays with supposedly equal dimensions (e.g. structs in the interpreter).

Definition at line 838 of file Array.cc.

◆ page()

Array< bool > Array< bool >::page ( octave_idx_type  k) const
inherited

Extract page: A(:,:,k+1).

Definition at line 554 of file Array.cc.

◆ pages()

octave_idx_type Array< bool >::pages ( void  ) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 432 of file Array.h.

◆ permute()

Array< bool > Array< bool >::permute ( const Array< octave_idx_type > &  vec,
bool  inv = false 
) const
inherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 566 of file Array.cc.

◆ print_info()

void Array< bool >::print_info ( std::ostream &  os,
const std::string &  prefix 
) const
inherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 700 of file Array.cc.

◆ reshape() [1/2]

Array<bool > Array< bool >::reshape ( const dim_vector new_dims) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 563 of file Array.h.

◆ reshape() [2/2]

Array<bool > Array< bool >::reshape ( octave_idx_type  nr,
octave_idx_type  nc 
) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 560 of file Array.h.

◆ resize() [1/3]

void Array< bool >::resize ( const dim_vector dv)
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 614 of file Array.h.

◆ resize() [2/3]

void Array< bool >::resize ( const dim_vector dv,
const bool &  rfv 
)
inherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 613 of file Array.cc.

◆ resize() [3/3]

void boolMatrix::resize ( octave_idx_type  nr,
octave_idx_type  nc,
bool  rfv = false 
)
inline

Definition at line 88 of file boolMatrix.h.

References Array< T >::resize().

◆ resize1() [1/2]

void Array< bool >::resize1 ( octave_idx_type  n)
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 611 of file Array.h.

◆ resize1() [2/2]

void Array< bool >::resize1 ( octave_idx_type  n,
const bool &  rfv 
)
inherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 610 of file Array.cc.

◆ resize2() [1/2]

void Array< bool >::resize2 ( octave_idx_type  nr,
octave_idx_type  nc 
)
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 605 of file Array.h.

◆ resize2() [2/2]

void Array< bool >::resize2 ( octave_idx_type  nr,
octave_idx_type  nc,
const bool &  rfv 
)
inherited

Resizing (with fill).

Definition at line 604 of file Array.cc.

◆ resize_fill_value()

bool Array< bool >::resize_fill_value ( void  ) const
virtualinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 600 of file Array.cc.

◆ rows()

octave_idx_type Array< bool >::rows ( void  ) const
inlineinherited

Definition at line 415 of file Array.h.

◆ size()

size_type Array< bool >::size ( const size_type  d) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 442 of file Array.h.

◆ sort() [1/4]

Array< bool > Array< bool >::sort ( Array< octave_idx_type > &  sidx,
int  dim = 0,
sortmode  mode = ASCENDING 
) const
inherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 708 of file Array.cc.

◆ sort() [2/4]

Array< idx_vector > Array< idx_vector >::sort ( Array< octave_idx_type > &  sidx,
int  ,
sortmode   
) const
inherited

Definition at line 42 of file Array-idx-vec.cc.

◆ sort() [3/4]

Array< bool > Array< bool >::sort ( int  dim = 0,
sortmode  mode = ASCENDING 
) const
inherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 707 of file Array.cc.

◆ sort() [4/4]

Array< idx_vector > Array< idx_vector >::sort ( int  ,
sortmode   
) const
inherited

Definition at line 42 of file Array-idx-vec.cc.

◆ sort_rows_idx() [1/2]

Array< octave_idx_type > Array< bool >::sort_rows_idx ( sortmode  mode = ASCENDING) const
inherited

Sort by rows returns only indices.

Definition at line 715 of file Array.cc.

◆ sort_rows_idx() [2/2]

Array< octave_idx_type > Array< idx_vector >::sort_rows_idx ( sortmode  ) const
inherited

Definition at line 42 of file Array-idx-vec.cc.

◆ squeeze()

boolNDArray boolNDArray::squeeze ( void  ) const
inlineinherited

Definition at line 82 of file boolNDArray.h.

References Array< T >::squeeze().

◆ test()

bool Array< bool >::test ( fcn) const
inlineinherited

Generic any/all test functionality with arbitrary predicate.

Definition at line 802 of file Array.h.

◆ test_all() [1/3]

bool Array< bool >::test_all ( bool(&)(bool )  fcn) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 826 of file Array.h.

◆ test_all() [2/3]

bool Array< bool >::test_all ( bool(&)(const bool &)  fcn) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 829 of file Array.h.

◆ test_all() [3/3]

bool Array< bool >::test_all ( fcn) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 814 of file Array.h.

◆ test_any() [1/3]

bool Array< bool >::test_any ( bool(&)(bool )  fcn) const
inlineinherited

Overloads for function references.

Definition at line 820 of file Array.h.

◆ test_any() [2/3]

bool Array< bool >::test_any ( bool(&)(const bool &)  fcn) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 823 of file Array.h.

◆ test_any() [3/3]

bool Array< bool >::test_any ( fcn) const
inlineinherited

Simpler calls.

Definition at line 810 of file Array.h.

◆ transpose()

boolMatrix boolMatrix::transpose ( void  ) const
inline

Definition at line 66 of file boolMatrix.h.

References Array< T >::transpose().

Referenced by oct_unop_transpose().

◆ xelem() [1/8]

bool & Array< bool >::xelem ( const Array< octave_idx_type > &  ra_idx)
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 482 of file Array.h.

◆ xelem() [2/8]

crefT Array< bool >::xelem ( const Array< octave_idx_type > &  ra_idx) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 485 of file Array.h.

◆ xelem() [3/8]

bool & Array< bool >::xelem ( octave_idx_type  i,
octave_idx_type  j 
)
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 472 of file Array.h.

◆ xelem() [4/8]

crefT Array< bool >::xelem ( octave_idx_type  i,
octave_idx_type  j 
) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 474 of file Array.h.

◆ xelem() [5/8]

bool & Array< bool >::xelem ( octave_idx_type  i,
octave_idx_type  j,
octave_idx_type  k 
)
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 477 of file Array.h.

◆ xelem() [6/8]

crefT Array< bool >::xelem ( octave_idx_type  i,
octave_idx_type  j,
octave_idx_type  k 
) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 479 of file Array.h.

◆ xelem() [7/8]

bool & Array< bool >::xelem ( octave_idx_type  n)
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 469 of file Array.h.

◆ xelem() [8/8]

crefT Array< bool >::xelem ( octave_idx_type  n) const
inlineinherited

Size of the specified dimension.

Dimensions beyond the Array number of dimensions return 1 as those are implicit singleton dimensions.

Equivalent to Octave's 'size (A, DIM)'

Definition at line 470 of file Array.h.

Member Data Documentation

◆ dimensions

dim_vector Array< bool >::dimensions
protectedinherited

Definition at line 217 of file Array.h.

◆ rep

Array<bool >::ArrayRep* Array< bool >::rep
protectedinherited

Definition at line 219 of file Array.h.

◆ slice_data

bool * Array< bool >::slice_data
protectedinherited

Definition at line 228 of file Array.h.

◆ slice_len

octave_idx_type Array< bool >::slice_len
protectedinherited

Definition at line 229 of file Array.h.


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