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

#include "boolNDArray.h"

Inheritance diagram for boolNDArray:
Collaboration diagram for boolNDArray:

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

 boolNDArray (const Array< bool > &a)
 
 boolNDArray (const boolNDArray &a)
 
 boolNDArray (const dim_vector &dv)
 
 boolNDArray (const dim_vector &dv, const bool &val)
 
 boolNDArray (void)
 
OCTAVE_API boolNDArray all (int dim=-1) const
 
OCTAVE_API boolNDArray any (int dim=-1) const
 
bool any_element_is_nan (void) const
 
Array< bool, Allocas_column (void) const
 Return the array as a column vector. More...
 
Array< bool, Allocas_matrix (void) const
 Return the array as a matrix. More...
 
Array< bool, Allocas_row (void) const
 Return the array as a row vector. More...
 
OCTARRAY_API void clear (const dim_vector &dv)
 
void clear (octave_idx_type r, octave_idx_type c)
 
OCTARRAY_API void clear (void)
 
OCTAVE_API boolNDArray concat (const boolNDArray &rb, const Array< octave_idx_type > &ra_idx)
 
OCTAVE_API boolNDArray diag (octave_idx_type k=0) const
 
OCTAVE_API boolNDArray diag (octave_idx_type m, octave_idx_type n) const
 
OCTARRAY_API void fill (const bool &val)
 
OCTAVE_API Array< octave_idx_typefind (octave_idx_type, bool) const
 
OCTAVE_API boolNDArrayinsert (const boolNDArray &a, const Array< octave_idx_type > &ra_idx)
 
OCTAVE_API boolNDArrayinsert (const boolNDArray &a, octave_idx_type r, octave_idx_type c)
 
OCTAVE_API boolNDArrayinvert (void)
 
OCTAVE_API sortmode is_sorted_rows (sortmode) const
 
OCTAVE_API sortmode issorted (sortmode) const
 
OCTAVE_API Array< octave_idx_typelookup (const Array< octave::idx_vector > &, sortmode) const
 
OCTAVE_API octave_idx_type lookup (octave::idx_vector const &, sortmode) const
 
void make_unique (void)
 
OCTAVE_API octave_idx_type nnz (void) const
 
OCTAVE_API Array< octave::idx_vectornth_element (const octave::idx_vector &, int) const
 
octave_idx_type numel (void) const
 Number of elements in the array. More...
 
OCTAVE_API boolNDArray operator! (void) const
 
boolNDArrayoperator= (const boolNDArray &a)
 
OCTAVE_API Array< octave::idx_vectorsort (Array< octave_idx_type > &sidx, int, sortmode) const
 
OCTAVE_API Array< octave::idx_vectorsort (int, sortmode) const
 
OCTAVE_API Array< octave_idx_typesort_rows_idx (sortmode) const
 
boolNDArray squeeze (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_API octave_idx_type compute_index (Array< octave_idx_type > &ra_idx, const dim_vector &dimensions)
 
static OCTAVE_API void increment_index (Array< octave_idx_type > &ra_idx, const dim_vector &dimensions, int start_dimension=0)
 

Protected Attributes

dim_vector m_dimensions
 
Array< bool, Alloc >::ArrayRep * m_rep
 
boolm_slice_data
 
octave_idx_type m_slice_len
 

Private Member Functions

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

Static Private Member Functions

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

Third dimension

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

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...
 
std::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...
 
OCTARRAY_API octave_idx_type compute_index (octave_idx_type i, octave_idx_type j) const
 Size of the specified dimension. More...
 
OCTARRAY_API octave_idx_type compute_index (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 Size of the specified dimension. More...
 
OCTARRAY_API octave_idx_type compute_index (const Array< octave_idx_type > &ra_idx) const
 Size of the specified dimension. More...
 
octave_idx_type compute_index_unchecked (const Array< octave_idx_type > &ra_idx) const
 Size of the specified dimension. More...
 
boolxelem (octave_idx_type n)
 Size of the specified dimension. More...
 
crefT xelem (octave_idx_type n) const
 Size of the specified dimension. More...
 
boolxelem (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...
 
boolxelem (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...
 
boolxelem (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...
 
OCTARRAY_API boolcheckelem (octave_idx_type n)
 Size of the specified dimension. More...
 
OCTARRAY_API boolcheckelem (octave_idx_type i, octave_idx_type j)
 Size of the specified dimension. More...
 
OCTARRAY_API boolcheckelem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 Size of the specified dimension. More...
 
OCTARRAY_API boolcheckelem (const Array< octave_idx_type > &ra_idx)
 Size of the specified dimension. More...
 
OCTARRAY_API crefT checkelem (octave_idx_type n) const
 Size of the specified dimension. More...
 
OCTARRAY_API crefT checkelem (octave_idx_type i, octave_idx_type j) const
 Size of the specified dimension. More...
 
OCTARRAY_API crefT checkelem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 Size of the specified dimension. More...
 
OCTARRAY_API crefT checkelem (const Array< octave_idx_type > &ra_idx) const
 Size of the specified dimension. More...
 
boolelem (octave_idx_type n)
 Size of the specified dimension. More...
 
boolelem (octave_idx_type i, octave_idx_type j)
 Size of the specified dimension. More...
 
boolelem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 Size of the specified dimension. More...
 
boolelem (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...
 
booloperator() (octave_idx_type n)
 Size of the specified dimension. More...
 
booloperator() (octave_idx_type i, octave_idx_type j)
 Size of the specified dimension. More...
 
booloperator() (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 Size of the specified dimension. More...
 
booloperator() (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...
 
OCTARRAY_API Array< bool, Alloccolumn (octave_idx_type k) const
 Extract column: A(:,k+1). More...
 
OCTARRAY_API Array< bool, Allocpage (octave_idx_type k) const
 Extract page: A(:,:,k+1). More...
 
OCTARRAY_API Array< bool, Alloclinear_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, Allocreshape (octave_idx_type nr, octave_idx_type nc) const
 Size of the specified dimension. More...
 
Array< bool, Allocreshape (const dim_vector &new_dims) const
 Size of the specified dimension. More...
 
OCTARRAY_API Array< bool, Allocpermute (const Array< octave_idx_type > &vec, bool inv=false) const
 Size of the specified dimension. More...
 
Array< bool, Allocipermute (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...
 
OCTARRAY_API Array< bool, Alloctranspose (void) const
 Size of the specified dimension. More...
 
OCTARRAY_API Array< bool, Allochermitian (bool(*fcn)(const bool &)=nullptr) const
 Size of the specified dimension. More...
 
const booldata (void) const
 Size of the specified dimension. More...
 
OCTARRAY_API boolfortran_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...
 
OCTARRAY_API Array< bool, Allocindex (const octave::idx_vector &i) const
 Indexing without resizing. More...
 
OCTARRAY_API Array< bool, Allocindex (const octave::idx_vector &i, const octave::idx_vector &j) const
 Size of the specified dimension. More...
 
OCTARRAY_API Array< bool, Allocindex (const Array< octave::idx_vector > &ia) const
 Size of the specified dimension. More...
 
OCTARRAY_API Array< bool, Allocindex (const octave::idx_vector &i, bool resize_ok, const bool &rfv) const
 Indexing with possible resizing and fill. More...
 
Array< bool, Allocindex (const octave::idx_vector &i, bool resize_ok) const
 Size of the specified dimension. More...
 
OCTARRAY_API Array< bool, Allocindex (const octave::idx_vector &i, const octave::idx_vector &j, bool resize_ok, const bool &rfv) const
 Size of the specified dimension. More...
 
Array< bool, Allocindex (const octave::idx_vector &i, const octave::idx_vector &j, bool resize_ok) const
 Size of the specified dimension. More...
 
OCTARRAY_API Array< bool, Allocindex (const Array< octave::idx_vector > &ia, bool resize_ok, const bool &rfv) const
 Size of the specified dimension. More...
 
Array< bool, Allocindex (const Array< octave::idx_vector > &ia, bool resize_ok) const
 Size of the specified dimension. More...
 
virtual OCTARRAY_API bool resize_fill_value (void) const
 Size of the specified dimension. More...
 
OCTARRAY_API 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...
 
OCTARRAY_API 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...
 
OCTARRAY_API 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...
 
OCTARRAY_API void assign (const octave::idx_vector &i, const Array< bool, Alloc > &rhs, const bool &rfv)
 Indexed assignment (always with resize & fill). More...
 
void assign (const octave::idx_vector &i, const Array< bool, Alloc > &rhs)
 Size of the specified dimension. More...
 
OCTARRAY_API 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. More...
 
void assign (const octave::idx_vector &i, const octave::idx_vector &j, const Array< bool, Alloc > &rhs)
 Size of the specified dimension. More...
 
OCTARRAY_API void assign (const Array< octave::idx_vector > &ia, const Array< bool, Alloc > &rhs, const bool &rfv)
 Size of the specified dimension. More...
 
void assign (const Array< octave::idx_vector > &ia, const Array< bool, Alloc > &rhs)
 Size of the specified dimension. More...
 
OCTARRAY_API void delete_elements (const octave::idx_vector &i)
 Deleting elements. More...
 
OCTARRAY_API void delete_elements (int dim, const octave::idx_vector &i)
 A(:,...,I,...,:) = [] (>= 2 subscripts, one of them is non-colon) More...
 
OCTARRAY_API void delete_elements (const Array< octave::idx_vector > &ia)
 Dispatcher to the above two. More...
 
OCTARRAY_API Array< bool, Alloc > & insert (const Array< bool, Alloc > &a, const Array< octave_idx_type > &idx)
 Insert an array into another at a specified position. More...
 
OCTARRAY_API 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 ...]. More...
 
void maybe_economize (void)
 Size of the specified dimension. More...
 
OCTARRAY_API void print_info (std::ostream &os, const std::string &prefix) const
 Size of the specified dimension. More...
 
OCTARRAY_API Array< bool, Allocsort (int dim=0, sortmode mode=ASCENDING) const
 Size of the specified dimension. More...
 
OCTARRAY_API Array< bool, Allocsort (Array< octave_idx_type > &sidx, int dim=0, sortmode mode=ASCENDING) const
 Size of the specified dimension. More...
 
OCTARRAY_API sortmode issorted (sortmode mode=UNSORTED) const
 Ordering is auto-detected or can be specified. More...
 
OCTARRAY_API Array< octave_idx_typesort_rows_idx (sortmode mode=ASCENDING) const
 Sort by rows returns only indices. More...
 
OCTARRAY_API sortmode is_sorted_rows (sortmode mode=UNSORTED) const
 Ordering is auto-detected or can be specified. More...
 
OCTARRAY_API octave_idx_type lookup (const bool &value, sortmode mode=UNSORTED) const
 Do a binary lookup in a sorted array. More...
 
OCTARRAY_API Array< octave_idx_typelookup (const Array< bool, Alloc > &values, sortmode mode=UNSORTED) const
 Ditto, but for an array of values, specializing on the case when values are sorted. More...
 
OCTARRAY_API octave_idx_type nnz (void) const
 Count nonzero elements. More...
 
OCTARRAY_API Array< octave_idx_typefind (octave_idx_type n=-1, bool backward=false) const
 Find indices of (at most n) nonzero elements. More...
 
OCTARRAY_API Array< bool, Allocnth_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. More...
 
Array< U, Amap (F fcn) const
 Apply function fcn to each element of the Array<T, Alloc>. More...
 
Array< U, Amap (U(&fcn)(bool)) const
 Overloads for function references. More...
 
Array< U, Amap (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...
 
OCTARRAY_API 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. More...
 
static OCTARRAY_API Array< bool, Alloccat (int dim, octave_idx_type n, const Array< bool, Alloc > *array_list)
 Concatenation along a specified (0-based) dimension, equivalent to cat(). More...
 
static OCTARRAY_API void instantiation_guard ()
 Size of the specified dimension. More...
 

Detailed Description

Definition at line 36 of file boolNDArray.h.

Member Typedef Documentation

◆ compare_fcn_type

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

Definition at line 239 of file Array.h.

◆ crefT

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

Definition at line 237 of file Array.h.

◆ element_type

typedef bool Array< bool , Alloc >::element_type
inherited

Definition at line 229 of file Array.h.

◆ matrix_type

Definition at line 42 of file boolNDArray.h.

◆ size_type

typedef octave_idx_type Array< bool , Alloc >::size_type
inherited

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

Definition at line 235 of file Array.h.

◆ value_type

typedef bool Array< bool , Alloc >::value_type
inherited

Definition at line 231 of file Array.h.

Constructor & Destructor Documentation

◆ boolNDArray() [1/5]

boolNDArray::boolNDArray ( void  )
inline

Definition at line 44 of file boolNDArray.h.

◆ boolNDArray() [2/5]

boolNDArray::boolNDArray ( const dim_vector dv)
inline

Definition at line 46 of file boolNDArray.h.

◆ boolNDArray() [3/5]

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

Definition at line 48 of file boolNDArray.h.

◆ boolNDArray() [4/5]

boolNDArray::boolNDArray ( const boolNDArray a)
inline

Definition at line 51 of file boolNDArray.h.

◆ boolNDArray() [5/5]

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

Definition at line 53 of file boolNDArray.h.

Member Function Documentation

◆ all()

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

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

Definition at line 67 of file boolNDArray.h.

◆ as_column()

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

Return the array as a column vector.

Definition at line 415 of file Array.h.

◆ as_matrix()

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

Return the array as a matrix.

Definition at line 435 of file Array.h.

◆ as_row()

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

Return the array as a row vector.

Definition at line 425 of file Array.h.

◆ assign() [1/6]

void Array< bool , Alloc >::assign ( const Array< octave::idx_vector > &  ia,
const Array< bool , Alloc > &  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 701 of file Array.h.

◆ assign() [2/6]

void Array< bool , Alloc >::assign ( const Array< octave::idx_vector > &  ia,
const Array< bool , Alloc > &  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 700 of file Array.cc.

◆ assign() [3/6]

void Array< bool , Alloc >::assign ( const octave::idx_vector i,
const Array< bool , Alloc > &  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 687 of file Array.h.

◆ assign() [4/6]

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

Indexed assignment (always with resize & fill).

Definition at line 686 of file Array.cc.

◆ assign() [5/6]

void Array< bool , Alloc >::assign ( const octave::idx_vector i,
const octave::idx_vector j,
const Array< bool , Alloc > &  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 695 of file Array.h.

◆ assign() [6/6]

void Array< bool , Alloc >::assign ( const octave::idx_vector i,
const octave::idx_vector j,
const Array< bool , Alloc > &  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 692 of file Array.cc.

◆ byte_size()

std::size_t Array< bool , Alloc >::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 483 of file Array.h.

◆ cat()

Array< bool , Alloc > Array< bool , Alloc >::cat ( int  dim,
octave_idx_type  n,
const Array< bool , Alloc > *  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 788 of file Array.cc.

◆ checkelem() [1/8]

bool & Array< bool , Alloc >::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 532 of file Array.cc.

◆ checkelem() [2/8]

Array< bool , Alloc >::crefT Array< bool , Alloc >::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 562 of file Array.cc.

◆ checkelem() [3/8]

bool & Array< bool , Alloc >::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 528 of file Array.cc.

◆ checkelem() [4/8]

Array< bool , Alloc >::crefT Array< bool , Alloc >::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 557 of file Array.cc.

◆ checkelem() [5/8]

bool & Array< bool , Alloc >::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 530 of file Array.cc.

◆ checkelem() [6/8]

Array< bool , Alloc >::crefT Array< bool , Alloc >::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 559 of file Array.cc.

◆ checkelem() [7/8]

bool & Array< bool , Alloc >::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 526 of file Array.cc.

◆ checkelem() [8/8]

Array< bool , Alloc >::crefT Array< bool , Alloc >::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 555 of file Array.cc.

◆ clear() [1/3]

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

Definition at line 405 of file Array.cc.

◆ clear() [2/3]

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

Definition at line 407 of file Array.h.

◆ clear() [3/3]

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

Definition at line 404 of file Array.cc.

◆ cols()

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

Definition at line 457 of file Array.h.

◆ column()

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

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

Definition at line 587 of file Array.cc.

◆ columns()

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

Definition at line 458 of file Array.h.

◆ compute_index() [1/4]

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 compute_index(), and ra_idx.

◆ compute_index() [2/4]

octave_idx_type Array< bool , Alloc >::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 495 of file Array.cc.

◆ compute_index() [3/4]

octave_idx_type Array< bool , Alloc >::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 492 of file Array.cc.

◆ compute_index() [4/4]

octave_idx_type Array< bool , Alloc >::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 493 of file Array.cc.

◆ compute_index_unchecked()

octave_idx_type Array< bool , Alloc >::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 497 of file Array.h.

◆ 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.

◆ data()

const bool * Array< bool , Alloc >::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 616 of file Array.h.

◆ delete_elements() [1/3]

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

Dispatcher to the above two.

Definition at line 717 of file Array.cc.

◆ delete_elements() [2/3]

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

Deleting elements.

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

Definition at line 711 of file Array.cc.

◆ delete_elements() [3/3]

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

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

Definition at line 714 of file Array.cc.

◆ 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().

◆ dim1()

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

Definition at line 448 of file Array.h.

◆ dim2()

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

Definition at line 456 of file Array.h.

◆ dim3()

octave_idx_type Array< bool , Alloc >::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 465 of file Array.h.

◆ dims()

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

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

Definition at line 487 of file Array.h.

◆ elem() [1/8]

bool & Array< bool , Alloc >::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 545 of file Array.h.

◆ elem() [2/8]

crefT Array< bool , Alloc >::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 572 of file Array.h.

◆ elem() [3/8]

bool & Array< bool , Alloc >::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 540 of file Array.h.

◆ elem() [4/8]

crefT Array< bool , Alloc >::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 566 of file Array.h.

◆ elem() [5/8]

bool & Array< bool , Alloc >::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 542 of file Array.h.

◆ elem() [6/8]

crefT Array< bool , Alloc >::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 569 of file Array.h.

◆ elem() [7/8]

bool & Array< bool , Alloc >::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 534 of file Array.h.

◆ elem() [8/8]

crefT Array< bool , Alloc >::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 564 of file Array.h.

◆ fill()

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

Definition at line 402 of file Array.cc.

◆ find() [1/2]

Array< octave_idx_type > Array< bool , Alloc >::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 769 of file Array.cc.

◆ find() [2/2]

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

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

◆ fortran_vec()

bool * Array< bool , Alloc >::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 623 of file Array.cc.

◆ hermitian()

Array< bool , Alloc > Array< bool , Alloc >::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 614 of file Array.cc.

◆ 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().

◆ index() [1/9]

Array< bool , Alloc > Array< bool , Alloc >::index ( const Array< octave::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 635 of file Array.cc.

◆ index() [2/9]

Array< bool , Alloc > Array< bool , Alloc >::index ( const Array< octave::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 678 of file Array.h.

◆ index() [3/9]

Array< bool , Alloc > Array< bool , Alloc >::index ( const Array< octave::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 676 of file Array.cc.

◆ index() [4/9]

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

Indexing without resizing.

Definition at line 631 of file Array.cc.

◆ index() [5/9]

Array< bool , Alloc > Array< bool , Alloc >::index ( const octave::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 662 of file Array.h.

◆ index() [6/9]

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

Indexing with possible resizing and fill.

Definition at line 661 of file Array.cc.

◆ index() [7/9]

Array< bool , Alloc > Array< bool , Alloc >::index ( const octave::idx_vector i,
const octave::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 633 of file Array.cc.

◆ index() [8/9]

Array< bool , Alloc > Array< bool , Alloc >::index ( const octave::idx_vector i,
const octave::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 670 of file Array.h.

◆ index() [9/9]

Array< bool , Alloc > Array< bool , Alloc >::index ( const octave::idx_vector i,
const octave::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 667 of file Array.cc.

◆ insert() [1/4]

Array< bool , Alloc > & Array< bool , Alloc >::insert ( const Array< bool , Alloc > &  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 724 of file Array.cc.

◆ insert() [2/4]

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

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

Definition at line 727 of file Array.cc.

◆ insert() [3/4]

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() [4/4]

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().

◆ instantiation_guard() [1/14]

OCTAVE_API void Array< signedchar >::instantiation_guard ( )
privateinherited

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

◆ instantiation_guard() [2/14]

OCTAVE_API void Array< long >::instantiation_guard ( )
privateinherited

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

◆ instantiation_guard() [3/14]

OCTAVE_API void Array< unsignedchar >::instantiation_guard ( )
privateinherited

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

◆ instantiation_guard() [4/14]

OCTAVE_API void Array< unsignedshort >::instantiation_guard ( )
privateinherited

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

◆ instantiation_guard() [5/14]

OCTAVE_API void Array< unsignedint >::instantiation_guard ( )
privateinherited

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

◆ instantiation_guard() [6/14]

OCTAVE_API void Array< octave_int8 >::instantiation_guard ( )
privateinherited

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

◆ instantiation_guard() [7/14]

OCTAVE_API void Array< octave_int16 >::instantiation_guard ( )
privateinherited

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

◆ instantiation_guard() [8/14]

OCTAVE_API void Array< octave_int32 >::instantiation_guard ( )
privateinherited

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

◆ instantiation_guard() [9/14]

OCTAVE_API void Array< octave_int64 >::instantiation_guard ( )
privateinherited

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

◆ instantiation_guard() [10/14]

OCTAVE_API void Array< octave_uint16 >::instantiation_guard ( )
privateinherited

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

◆ instantiation_guard() [11/14]

OCTAVE_API void Array< octave_uint32 >::instantiation_guard ( )
privateinherited

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

◆ instantiation_guard() [12/14]

OCTAVE_API void Array< octave::idx_vector >::instantiation_guard ( )
privateinherited

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

◆ instantiation_guard() [13/14]

OCTAVE_API void Array< short >::instantiation_guard ( )
privateinherited

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

◆ instantiation_guard() [14/14]

void Array< bool , Alloc >::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 889 of file Array.cc.

◆ invert()

boolNDArray & boolNDArray::invert ( void  )

Definition at line 48 of file boolNDArray.cc.

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

◆ ipermute()

Array< bool , Alloc > Array< bool , Alloc >::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 602 of file Array.h.

◆ is_nd_vector()

bool Array< bool , Alloc >::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 611 of file Array.h.

◆ is_shared()

bool Array< bool , Alloc >::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 625 of file Array.h.

◆ is_sorted_rows() [1/2]

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

Ordering is auto-detected or can be specified.

Definition at line 753 of file Array.cc.

◆ is_sorted_rows() [2/2]

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

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

◆ isempty()

bool Array< bool , Alloc >::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 607 of file Array.h.

◆ issorted() [1/2]

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

Ordering is auto-detected or can be specified.

Definition at line 747 of file Array.cc.

◆ issorted() [2/2]

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

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

◆ issquare()

bool Array< bool , Alloc >::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 605 of file Array.h.

◆ isvector()

bool Array< bool , Alloc >::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 609 of file Array.h.

◆ linear_slice()

Array< bool , Alloc > Array< bool , Alloc >::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 593 of file Array.cc.

◆ lookup() [1/4]

Array< octave_idx_type > Array< bool , Alloc >::lookup ( const Array< bool , Alloc > &  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 761 of file Array.cc.

◆ lookup() [2/4]

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

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

◆ lookup() [3/4]

octave_idx_type Array< bool , Alloc >::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 757 of file Array.cc.

◆ lookup() [4/4]

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

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

◆ make_unique()

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

Definition at line 215 of file Array.h.

◆ map() [1/3]

Array< U, A > Array< bool , Alloc >::map ( F  fcn) const
inlineinherited

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

This function is optimized with a manually unrolled loop.

Definition at line 799 of file Array.h.

◆ map() [2/3]

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

Overloads for function references.

Definition at line 835 of file Array.h.

◆ map() [3/3]

Array< U, A > Array< bool , Alloc >::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 844 of file Array.h.

◆ maybe_economize()

void Array< bool , Alloc >::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 729 of file Array.h.

◆ ndims()

int Array< bool , Alloc >::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 627 of file Array.h.

◆ nil_rep()

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

Definition at line 269 of file Array.cc.

◆ nnz() [1/2]

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

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

◆ nnz() [2/2]

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

Count nonzero elements.

Definition at line 765 of file Array.cc.

◆ nth_element() [1/2]

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

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

◆ nth_element() [2/2]

Array< bool , Alloc > Array< bool , Alloc >::nth_element ( const octave::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 775 of file Array.cc.

◆ numel()

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

Number of elements in the array.

Definition at line 411 of file Array.h.

◆ operator!()

boolNDArray boolNDArray::operator! ( void  ) const

Definition at line 42 of file boolNDArray.cc.

References mx_inline_not().

◆ operator()() [1/8]

bool & Array< bool , Alloc >::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 552 of file Array.h.

◆ operator()() [2/8]

crefT Array< bool , Alloc >::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 581 of file Array.h.

◆ operator()() [3/8]

bool & Array< bool , Alloc >::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 549 of file Array.h.

◆ operator()() [4/8]

crefT Array< bool , Alloc >::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 576 of file Array.h.

◆ operator()() [5/8]

bool & Array< bool , Alloc >::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 550 of file Array.h.

◆ operator()() [6/8]

crefT Array< bool , Alloc >::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 578 of file Array.h.

◆ operator()() [7/8]

bool & Array< bool , Alloc >::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 548 of file Array.h.

◆ operator()() [8/8]

crefT Array< bool , Alloc >::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 575 of file Array.h.

◆ operator=()

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

Definition at line 55 of file boolNDArray.h.

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

◆ optimize_dimensions()

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

Returns true if this->dims () == dv, and if so, replaces this->m_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 886 of file Array.cc.

◆ page()

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

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

Definition at line 589 of file Array.cc.

◆ pages()

octave_idx_type Array< bool , Alloc >::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 466 of file Array.h.

◆ permute()

Array< bool , Alloc > Array< bool , Alloc >::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 601 of file Array.cc.

◆ print_info()

void Array< bool , Alloc >::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 740 of file Array.cc.

◆ reshape() [1/2]

Array< bool , Alloc > Array< bool , Alloc >::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 598 of file Array.h.

◆ reshape() [2/2]

Array< bool , Alloc > Array< bool , Alloc >::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 595 of file Array.h.

◆ resize() [1/2]

void Array< bool , Alloc >::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 652 of file Array.h.

◆ resize() [2/2]

void Array< bool , Alloc >::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 651 of file Array.cc.

◆ resize1() [1/2]

void Array< bool , Alloc >::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 649 of file Array.h.

◆ resize1() [2/2]

void Array< bool , Alloc >::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 648 of file Array.cc.

◆ resize2() [1/2]

void Array< bool , Alloc >::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 643 of file Array.h.

◆ resize2() [2/2]

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

Resizing (with fill).

Definition at line 642 of file Array.cc.

◆ resize_fill_value()

bool Array< bool , Alloc >::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 638 of file Array.cc.

◆ rows()

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

Definition at line 449 of file Array.h.

◆ size()

size_type Array< bool , Alloc >::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 476 of file Array.h.

◆ sort() [1/4]

Array< bool , Alloc > Array< bool , Alloc >::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 743 of file Array.cc.

◆ sort() [2/4]

OCTAVE_API Array< octave::idx_vector > Array< octave::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 , Alloc > Array< bool , Alloc >::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 742 of file Array.cc.

◆ sort() [4/4]

OCTAVE_API Array< octave::idx_vector > Array< octave::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 , Alloc >::sort_rows_idx ( sortmode  mode = ASCENDING) const
inherited

Sort by rows returns only indices.

Definition at line 750 of file Array.cc.

◆ sort_rows_idx() [2/2]

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

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

◆ squeeze()

boolNDArray boolNDArray::squeeze ( void  ) const
inline

Definition at line 82 of file boolNDArray.h.

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

◆ test()

bool Array< bool , Alloc >::test ( F  fcn) const
inlineinherited

Generic any/all test functionality with arbitrary predicate.

Definition at line 850 of file Array.h.

◆ test_all() [1/3]

bool Array< bool , Alloc >::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 874 of file Array.h.

◆ test_all() [2/3]

bool Array< bool , Alloc >::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 877 of file Array.h.

◆ test_all() [3/3]

bool Array< bool , Alloc >::test_all ( F  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 862 of file Array.h.

◆ test_any() [1/3]

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

Overloads for function references.

Definition at line 868 of file Array.h.

◆ test_any() [2/3]

bool Array< bool , Alloc >::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 871 of file Array.h.

◆ test_any() [3/3]

bool Array< bool , Alloc >::test_any ( F  fcn) const
inlineinherited

Simpler calls.

Definition at line 858 of file Array.h.

◆ transpose()

Array< bool , Alloc > Array< bool , Alloc >::transpose ( void  ) 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 613 of file Array.cc.

◆ xelem() [1/8]

bool & Array< bool , Alloc >::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 517 of file Array.h.

◆ xelem() [2/8]

crefT Array< bool , Alloc >::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 520 of file Array.h.

◆ xelem() [3/8]

bool & Array< bool , Alloc >::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 507 of file Array.h.

◆ xelem() [4/8]

crefT Array< bool , Alloc >::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 509 of file Array.h.

◆ xelem() [5/8]

bool & Array< bool , Alloc >::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 512 of file Array.h.

◆ xelem() [6/8]

crefT Array< bool , Alloc >::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 514 of file Array.h.

◆ xelem() [7/8]

bool & Array< bool , Alloc >::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 504 of file Array.h.

◆ xelem() [8/8]

crefT Array< bool , Alloc >::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 505 of file Array.h.

Member Data Documentation

◆ m_dimensions

dim_vector Array< bool , Alloc >::m_dimensions
protectedinherited

Definition at line 244 of file Array.h.

◆ m_rep

Array<bool ,Alloc>::ArrayRep* Array< bool , Alloc >::m_rep
protectedinherited

Definition at line 246 of file Array.h.

◆ m_slice_data

bool * Array< bool , Alloc >::m_slice_data
protectedinherited

Definition at line 255 of file Array.h.

◆ m_slice_len

octave_idx_type Array< bool , Alloc >::m_slice_len
protectedinherited

Definition at line 256 of file Array.h.


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