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

#include "chNDArray.h"

Inheritance diagram for charNDArray:
Collaboration diagram for charNDArray:

Public Types

typedef bool(* compare_fcn_type) (typename ref_param< char >::type, typename ref_param< char >::type)
 
typedef ref_param< char >::type crefT
 
typedef char element_type
 
typedef charMatrix matrix_type
 
typedef octave_idx_type size_type
 Used for operator(), and returned by numel() and size() (beware: signed integer) More...
 
typedef char value_type
 

Public Member Functions

 charNDArray (void)
 
 charNDArray (const dim_vector &dv)
 
 charNDArray (const dim_vector &dv, char val)
 
 charNDArray (const charNDArray &a)
 
 charNDArray (const Array< char > &a)
 
 charNDArray (char c)
 
 charNDArray (const char *s)
 
 charNDArray (const std::string &s)
 
 charNDArray (const string_vector &s, char fill_value='\0')
 
boolNDArray all (int dim=-1) const
 
boolNDArray any (int dim=-1) const
 
bool any_element_is_nan (void) const
 
Array< char > as_column (void) const
 Return the array as a column vector. More...
 
Array< char > as_matrix (void) const
 Return the array as a matrix. More...
 
Array< char > as_row (void) const
 Return the array as a row vector. More...
 
size_t byte_size (void) const
 
char & checkelem (octave_idx_type n)
 
char & checkelem (octave_idx_type i, octave_idx_type j)
 
char & checkelem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 
char & checkelem (const Array< octave_idx_type > &ra_idx)
 
crefT checkelem (octave_idx_type n) const
 
crefT checkelem (octave_idx_type i, octave_idx_type j) const
 
crefT checkelem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 
crefT checkelem (const Array< octave_idx_type > &ra_idx) const
 
void clear (void)
 
void clear (const dim_vector &dv)
 
void clear (octave_idx_type r, octave_idx_type c)
 
Array< char > column (octave_idx_type k) const
 Extract column: A(:,k+1). More...
 
octave_idx_type compute_index (octave_idx_type i, octave_idx_type j) const
 
octave_idx_type compute_index (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 
octave_idx_type compute_index (const Array< octave_idx_type > &ra_idx) const
 
octave_idx_type compute_index_unchecked (const Array< octave_idx_type > &ra_idx) const
 
charNDArray concat (const charNDArray &rb, const Array< octave_idx_type > &ra_idx)
 
charNDArray concat (const NDArray &rb, const Array< octave_idx_type > &ra_idx)
 
const char * data (void) const
 
charNDArray diag (octave_idx_type k=0) const
 
charNDArray diag (octave_idx_type m, octave_idx_type n) const
 
const dim_vectordims (void) const
 Return a const-reference so that dims ()(i) works efficiently. More...
 
char & elem (octave_idx_type n)
 
char & elem (octave_idx_type i, octave_idx_type j)
 
char & elem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 
char & elem (const Array< octave_idx_type > &ra_idx)
 
crefT elem (octave_idx_type n) const
 
crefT elem (octave_idx_type i, octave_idx_type j) const
 
crefT elem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 
crefT elem (const Array< octave_idx_type > &ra_idx) const
 
void fill (const char &val)
 
Array< octave_idx_typefind (octave_idx_type, bool) const
 
Array< octave_idx_typefind (octave_idx_type n=-1, bool backward=false) const
 Find indices of (at most n) nonzero elements. More...
 
const char * fortran_vec (void) const
 
char * fortran_vec (void)
 
Array< char > hermitian (char(*fcn)(const char &)=nullptr) const
 
charNDArrayinsert (const charNDArray &a, octave_idx_type r, octave_idx_type c)
 
charNDArrayinsert (const charNDArray &a, const Array< octave_idx_type > &ra_idx)
 
Array< char > & insert (const Array< char > &a, const Array< octave_idx_type > &idx)
 Insert an array into another at a specified position. More...
 
Array< char > & insert (const Array< char > &a, octave_idx_type r, octave_idx_type c)
 This is just a special case for idx = [r c 0 ...]. More...
 
Array< char > ipermute (const Array< octave_idx_type > &vec) const
 
bool is_empty (void) const
 
bool is_nd_vector (void) const
 
bool is_shared (void)
 
sortmode is_sorted (sortmode mode=UNSORTED) const
 
sortmode is_sorted_rows (sortmode) const
 
sortmode is_sorted_rows (sortmode mode=UNSORTED) const
 Ordering is auto-detected or can be specified. More...
 
bool is_square (void) const
 
bool is_vector (void) const
 
bool isempty (void) const
 
sortmode issorted (sortmode) const
 
sortmode issorted (sortmode mode=UNSORTED) const
 Ordering is auto-detected or can be specified. More...
 
bool issquare (void) const
 
bool isvector (void) const
 
Array< char > 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...
 
octave_idx_type lookup (idx_vector const &, sortmode) const
 
Array< octave_idx_typelookup (const Array< idx_vector > &, sortmode) const
 
octave_idx_type lookup (const char &value, sortmode mode=UNSORTED) const
 Do a binary lookup in a sorted array. More...
 
Array< octave_idx_typelookup (const Array< char > &values, sortmode mode=UNSORTED) const
 Ditto, but for an array of values, specializing on the case when values are sorted. More...
 
void make_unique (void)
 
Array< U > map (F fcn) const
 Apply function fcn to each element of the Array<T>. More...
 
charNDArray max (int dim=-1) const
 
charNDArray max (Array< octave_idx_type > &index, int dim=-1) const
 
void maybe_economize (void)
 
void * mex_get_data (void) const
 Give a pointer to the data in mex format. More...
 
charNDArray min (int dim=-1) const
 
charNDArray min (Array< octave_idx_type > &index, int dim=-1) const
 
int ndims (void) const
 
octave_idx_type nnz (void) const
 
octave_idx_type nnz (void) const
 Count nonzero elements. More...
 
Array< idx_vectornth_element (const idx_vector &, int) const
 
Array< char > 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...
 
char & operator() (octave_idx_type n)
 
char & operator() (octave_idx_type i, octave_idx_type j)
 
char & operator() (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 
char & operator() (const Array< octave_idx_type > &ra_idx)
 
crefT operator() (octave_idx_type n) const
 
crefT operator() (octave_idx_type i, octave_idx_type j) const
 
crefT operator() (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 
crefT operator() (const Array< octave_idx_type > &ra_idx) const
 
charNDArrayoperator= (const charNDArray &a)
 
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...
 
Array< char > page (octave_idx_type k) const
 Extract page: A(:,:,k+1). More...
 
Array< char > permute (const Array< octave_idx_type > &vec, bool inv=false) const
 
void print_info (std::ostream &os, const std::string &prefix) const
 
Array< char > reshape (octave_idx_type nr, octave_idx_type nc) const
 
Array< char > reshape (const dim_vector &new_dims) const
 
virtual char resize_fill_value (void) const
 
size_type size (const size_type d) const
 Size of the specified dimension. More...
 
Array< idx_vectorsort (Array< octave_idx_type > &sidx, int, sortmode) const
 
Array< idx_vectorsort (int, sortmode) const
 
Array< char > sort (int dim=0, sortmode mode=ASCENDING) const
 
Array< char > sort (Array< octave_idx_type > &sidx, int dim=0, sortmode mode=ASCENDING) const
 
Array< octave_idx_typesort_rows_idx (sortmode) const
 
Array< octave_idx_typesort_rows_idx (sortmode mode=ASCENDING) const
 Sort by rows returns only indices. More...
 
charNDArray squeeze (void) const
 
bool test (F fcn) const
 Generic any/all test functionality with arbitrary predicate. More...
 
Array< char > transpose (void) const
 
char & xelem (octave_idx_type n)
 
crefT xelem (octave_idx_type n) const
 
char & xelem (octave_idx_type i, octave_idx_type j)
 
crefT xelem (octave_idx_type i, octave_idx_type j) const
 
char & xelem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 
crefT xelem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 
char & xelem (const Array< octave_idx_type > &ra_idx)
 
crefT xelem (const Array< octave_idx_type > &ra_idx) const
 
octave_idx_type capacity (void) const
 Number of elements in the array. More...
 
octave_idx_type length (void) const
 Number of elements in the array. More...
 
octave_idx_type nelem (void) const
 Number of elements in the array. More...
 
octave_idx_type numel (void) const
 Number of elements in the array. More...
 
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
 
Third dimension

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

octave_idx_type dim3 (void) const
 
octave_idx_type pages (void) const
 
Array< char > index (const idx_vector &i) const
 Indexing without resizing. More...
 
Array< char > index (const idx_vector &i, const idx_vector &j) const
 Indexing without resizing. More...
 
Array< char > index (const Array< idx_vector > &ia) const
 Indexing without resizing. More...
 
Array< char > index (const idx_vector &i, bool resize_ok, const char &rfv) const
 Indexing with possible resizing and fill. More...
 
Array< char > index (const idx_vector &i, bool resize_ok) const
 Indexing with possible resizing and fill. More...
 
Array< char > index (const idx_vector &i, const idx_vector &j, bool resize_ok, const char &rfv) const
 Indexing with possible resizing and fill. More...
 
Array< char > index (const idx_vector &i, const idx_vector &j, bool resize_ok) const
 Indexing with possible resizing and fill. More...
 
Array< char > index (const Array< idx_vector > &ia, bool resize_ok, const char &rfv) const
 Indexing with possible resizing and fill. More...
 
Array< char > index (const Array< idx_vector > &ia, bool resize_ok) const
 Indexing with possible resizing and fill. More...
 
void resize2 (octave_idx_type nr, octave_idx_type nc, const char &rfv)
 Resizing (with fill). More...
 
void resize2 (octave_idx_type nr, octave_idx_type nc)
 Resizing (with fill). More...
 
void resize1 (octave_idx_type n, const char &rfv)
 Resizing (with fill). More...
 
void resize1 (octave_idx_type n)
 Resizing (with fill). More...
 
void resize (const dim_vector &dv, const char &rfv)
 Resizing (with fill). More...
 
void resize (const dim_vector &dv)
 Resizing (with fill). More...
 
void assign (const idx_vector &i, const Array< char > &rhs, const char &rfv)
 Indexed assignment (always with resize & fill). More...
 
void assign (const idx_vector &i, const Array< char > &rhs)
 Indexed assignment (always with resize & fill). More...
 
void assign (const idx_vector &i, const idx_vector &j, const Array< char > &rhs, const char &rfv)
 Indexed assignment (always with resize & fill). More...
 
void assign (const idx_vector &i, const idx_vector &j, const Array< char > &rhs)
 Indexed assignment (always with resize & fill). More...
 
void assign (const Array< idx_vector > &ia, const Array< char > &rhs, const char &rfv)
 Indexed assignment (always with resize & fill). More...
 
void assign (const Array< idx_vector > &ia, const Array< char > &rhs)
 Indexed assignment (always with resize & fill). 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...
 
Array< U > map (U(&fcn)(char)) const
 Overloads for function references. More...
 
Array< U > map (U(&fcn)(const char &)) const
 Overloads for function references. More...
 
bool test_any (F fcn) const
 Simpler calls. More...
 
bool test_all (F fcn) const
 Simpler calls. More...
 
bool test_any (bool(&fcn)(char)) const
 Overloads for function references. More...
 
bool test_any (bool(&fcn)(const char &)) const
 Overloads for function references. More...
 
bool test_all (bool(&fcn)(char)) const
 Overloads for function references. More...
 
bool test_all (bool(&fcn)(const char &)) const
 Overloads for function references. More...
 
int * jit_ref_count (void)
 WARNING: Only call these functions from jit. More...
 
char * jit_slice_data (void) const
 WARNING: Only call these functions from jit. More...
 
octave_idx_typejit_dimensions (void) const
 WARNING: Only call these functions from jit. More...
 
void * jit_array_rep (void) const
 WARNING: Only call these functions from jit. More...
 

Static Public Member Functions

static Array< char > cat (int dim, octave_idx_type n, const Array< char > *array_list)
 Concatenation along a specified (0-based) dimension, equivalent to cat(). More...
 
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< char >::ArrayRep * rep
 
char * slice_data
 
octave_idx_type slice_len
 

Detailed Description

Definition at line 34 of file chNDArray.h.

Member Typedef Documentation

◆ compare_fcn_type

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

Definition at line 211 of file Array.h.

◆ crefT

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

Definition at line 209 of file Array.h.

◆ element_type

typedef char Array< char >::element_type
inherited

Definition at line 201 of file Array.h.

◆ matrix_type

Definition at line 40 of file chNDArray.h.

◆ size_type

typedef octave_idx_type Array< char >::size_type
inherited

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

Definition at line 207 of file Array.h.

◆ value_type

typedef char Array< char >::value_type
inherited

Definition at line 203 of file Array.h.

Constructor & Destructor Documentation

◆ charNDArray() [1/9]

charNDArray::charNDArray ( void  )
inline

Definition at line 42 of file chNDArray.h.

◆ charNDArray() [2/9]

charNDArray::charNDArray ( const dim_vector dv)
inline

Definition at line 44 of file chNDArray.h.

◆ charNDArray() [3/9]

charNDArray::charNDArray ( const dim_vector dv,
char  val 
)
inline

Definition at line 46 of file chNDArray.h.

◆ charNDArray() [4/9]

charNDArray::charNDArray ( const charNDArray a)
inline

Definition at line 48 of file chNDArray.h.

◆ charNDArray() [5/9]

charNDArray::charNDArray ( const Array< char > &  a)
inline

Definition at line 50 of file chNDArray.h.

◆ charNDArray() [6/9]

charNDArray::charNDArray ( char  c)

Definition at line 39 of file chNDArray.cc.

References c, Array< char >::elem(), and Array< char >::resize1().

◆ charNDArray() [7/9]

charNDArray::charNDArray ( const char *  s)

Definition at line 49 of file chNDArray.cc.

References Array< char >::elem(), i, Array< char >::resize1(), s, and strlen().

◆ charNDArray() [8/9]

charNDArray::charNDArray ( const std::string s)

Definition at line 60 of file chNDArray.cc.

References Array< char >::elem(), i, Array< char >::resize1(), and s.

◆ charNDArray() [9/9]

charNDArray::charNDArray ( const string_vector s,
char  fill_value = '\0' 
)

Definition at line 71 of file chNDArray.cc.

References Array< char >::elem(), i, Array< char >::rows(), s, and string.

Member Function Documentation

◆ all()

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

Definition at line 88 of file chNDArray.cc.

References mx_inline_all().

◆ any()

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

Definition at line 94 of file chNDArray.cc.

References mx_inline_any().

◆ any_element_is_nan()

bool charNDArray::any_element_is_nan ( void  ) const
inline

Definition at line 66 of file chNDArray.h.

◆ as_column()

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

Return the array as a column vector.

Definition at line 370 of file Array.h.

◆ as_matrix()

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

Return the array as a matrix.

Definition at line 390 of file Array.h.

◆ as_row()

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

Return the array as a row vector.

Definition at line 380 of file Array.h.

◆ assign() [1/6]

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

Indexed assignment (always with resize & fill).

Definition at line 1115 of file Array.cc.

◆ assign() [2/6]

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

Indexed assignment (always with resize & fill).

Definition at line 649 of file Array.h.

◆ assign() [3/6]

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

Indexed assignment (always with resize & fill).

Definition at line 1162 of file Array.cc.

◆ assign() [4/6]

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

Indexed assignment (always with resize & fill).

Definition at line 656 of file Array.h.

◆ assign() [5/6]

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

Indexed assignment (always with resize & fill).

Definition at line 1266 of file Array.cc.

◆ assign() [6/6]

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

Indexed assignment (always with resize & fill).

Definition at line 662 of file Array.h.

◆ byte_size()

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

Definition at line 438 of file Array.h.

◆ capacity()

octave_idx_type Array< char >::capacity ( void  ) const
inlineinherited

Number of elements in the array.

Synonymous with numel().

Note
This method is deprecated in favour of numel().

Definition at line 343 of file Array.h.

◆ cat()

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

◆ checkelem() [1/8]

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

Definition at line 191 of file Array.cc.

◆ checkelem() [2/8]

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

Definition at line 204 of file Array.cc.

◆ checkelem() [3/8]

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

Definition at line 211 of file Array.cc.

◆ checkelem() [4/8]

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

Definition at line 218 of file Array.cc.

◆ checkelem() [5/8]

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

Definition at line 225 of file Array.cc.

◆ checkelem() [6/8]

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

Definition at line 238 of file Array.cc.

◆ checkelem() [7/8]

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

Definition at line 245 of file Array.cc.

◆ checkelem() [8/8]

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

Definition at line 253 of file Array.cc.

◆ clear() [1/3]

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

Definition at line 86 of file Array.cc.

◆ clear() [2/3]

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

Definition at line 101 of file Array.cc.

◆ clear() [3/3]

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

Definition at line 334 of file Array.h.

◆ cols()

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

Definition at line 412 of file Array.h.

Referenced by charMatrix::insert(), charMatrix::operator==(), and charMatrix::row_as_string().

◆ column()

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

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

Definition at line 260 of file Array.cc.

◆ columns()

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

Definition at line 413 of file Array.h.

◆ compute_index() [1/4]

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

Definition at line 185 of file chNDArray.cc.

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

◆ compute_index() [2/4]

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

Definition at line 169 of file Array.cc.

◆ compute_index() [3/4]

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

Definition at line 176 of file Array.cc.

◆ compute_index() [4/4]

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

Definition at line 184 of file Array.cc.

◆ compute_index_unchecked()

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

Definition at line 452 of file Array.h.

◆ concat() [1/2]

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

Definition at line 100 of file chNDArray.cc.

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

◆ concat() [2/2]

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

◆ data()

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

Definition at line 582 of file Array.h.

Referenced by charMatrix::operator==().

◆ delete_elements() [1/3]

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

Deleting elements.

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

Definition at line 1389 of file Array.cc.

◆ delete_elements() [2/3]

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

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

Definition at line 1429 of file Array.cc.

◆ delete_elements() [3/3]

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

Dispatcher to the above two.

Definition at line 1485 of file Array.cc.

◆ diag() [1/2]

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

Definition at line 192 of file chNDArray.cc.

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

◆ diag() [2/2]

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

Definition at line 198 of file chNDArray.cc.

References Array< T >::diag().

◆ dim1()

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

Definition at line 403 of file Array.h.

◆ dim2()

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

Definition at line 411 of file Array.h.

◆ dim3()

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

Definition at line 420 of file Array.h.

◆ dims()

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

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

Definition at line 442 of file Array.h.

◆ elem() [1/8]

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

◆ elem() [2/8]

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

Definition at line 494 of file Array.h.

◆ elem() [3/8]

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

Definition at line 496 of file Array.h.

◆ elem() [4/8]

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

Definition at line 499 of file Array.h.

◆ elem() [5/8]

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

Definition at line 518 of file Array.h.

◆ elem() [6/8]

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

Definition at line 520 of file Array.h.

◆ elem() [7/8]

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

Definition at line 523 of file Array.h.

◆ elem() [8/8]

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

Definition at line 526 of file Array.h.

◆ fill()

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

Definition at line 72 of file Array.cc.

◆ find() [1/2]

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

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

◆ find() [2/2]

Array< octave_idx_type > Array< char >::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 2227 of file Array.cc.

◆ fortran_vec() [1/2]

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

Definition at line 584 of file Array.h.

◆ fortran_vec() [2/2]

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

Definition at line 1739 of file Array.cc.

◆ hermitian()

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

Definition at line 1641 of file Array.cc.

◆ increment_index()

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

Definition at line 177 of file chNDArray.cc.

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

◆ index() [1/9]

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

Indexing without resizing.

Definition at line 697 of file Array.cc.

◆ index() [2/9]

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

Indexing without resizing.

Definition at line 764 of file Array.cc.

◆ index() [3/9]

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

Indexing without resizing.

Definition at line 822 of file Array.cc.

◆ index() [4/9]

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

Indexing with possible resizing and fill.

Definition at line 1032 of file Array.cc.

◆ index() [5/9]

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

Indexing with possible resizing and fill.

Definition at line 625 of file Array.h.

◆ index() [6/9]

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

Indexing with possible resizing and fill.

Definition at line 1056 of file Array.cc.

◆ index() [7/9]

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

Indexing with possible resizing and fill.

Definition at line 632 of file Array.h.

◆ index() [8/9]

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

Indexing with possible resizing and fill.

Definition at line 1084 of file Array.cc.

◆ index() [9/9]

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

Indexing with possible resizing and fill.

Definition at line 640 of file Array.h.

◆ insert() [1/4]

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

Definition at line 163 of file chNDArray.cc.

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

Referenced by concat().

◆ insert() [2/4]

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

Definition at line 170 of file chNDArray.cc.

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

◆ insert() [3/4]

Array< char > & Array< char >::insert ( const Array< char > &  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 1583 of file Array.cc.

◆ insert() [4/4]

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

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

Definition at line 1562 of file Array.cc.

◆ ipermute()

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

Definition at line 556 of file Array.h.

◆ is_empty()

bool Array< char >::is_empty ( void  ) const
inlineinherited

Definition at line 568 of file Array.h.

◆ is_nd_vector()

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

Definition at line 577 of file Array.h.

◆ is_shared()

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

Definition at line 588 of file Array.h.

◆ is_sorted()

sortmode Array< char >::is_sorted ( sortmode  mode = UNSORTED) const
inlineinherited

Definition at line 716 of file Array.h.

◆ is_sorted_rows() [1/2]

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

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

◆ is_sorted_rows() [2/2]

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

Ordering is auto-detected or can be specified.

Definition at line 2086 of file Array.cc.

◆ is_square()

bool Array< char >::is_square ( void  ) const
inlineinherited

Definition at line 562 of file Array.h.

◆ is_vector()

bool Array< char >::is_vector ( void  ) const
inlineinherited

Definition at line 574 of file Array.h.

◆ isempty()

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

Definition at line 565 of file Array.h.

◆ issorted() [1/2]

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

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

◆ issorted() [2/2]

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

Ordering is auto-detected or can be specified.

Definition at line 2033 of file Array.cc.

◆ issquare()

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

Definition at line 559 of file Array.h.

◆ isvector()

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

Definition at line 571 of file Array.h.

◆ jit_array_rep()

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

WARNING: Only call these functions from jit.

Definition at line 854 of file Array.h.

◆ jit_dimensions()

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

WARNING: Only call these functions from jit.

Definition at line 852 of file Array.h.

◆ jit_ref_count()

int* Array< char >::jit_ref_count ( void  )
inlineinherited

WARNING: Only call these functions from jit.

Definition at line 848 of file Array.h.

◆ jit_slice_data()

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

WARNING: Only call these functions from jit.

Definition at line 850 of file Array.h.

◆ length()

octave_idx_type Array< char >::length ( void  ) const
inlineinherited

Number of elements in the array.

Synonymous with numel().

Note
This method is deprecated in favour of numel().
This is not the same as length() at the Octave interpreter. At the Octave interpreter, the function length() returns the length of the greatest dimension. This method returns the total number of elements.

Definition at line 357 of file Array.h.

◆ linear_slice()

Array< char > Array< char >::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 280 of file Array.cc.

◆ lookup() [1/4]

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

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

◆ lookup() [2/4]

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

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

◆ lookup() [3/4]

octave_idx_type Array< char >::lookup ( const char &  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 2147 of file Array.cc.

◆ lookup() [4/4]

Array< octave_idx_type > Array< char >::lookup ( const Array< char > &  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 2168 of file Array.cc.

◆ make_unique()

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

Definition at line 187 of file Array.h.

◆ map() [1/3]

Array<U> Array< char >::map ( F  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 764 of file Array.h.

◆ map() [2/3]

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

Overloads for function references.

Definition at line 796 of file Array.h.

◆ map() [3/3]

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

Overloads for function references.

Definition at line 801 of file Array.h.

◆ max() [1/2]

charNDArray charNDArray::max ( int  dim = -1) const

Definition at line 139 of file chNDArray.cc.

References mx_inline_max().

◆ max() [2/2]

charNDArray charNDArray::max ( Array< octave_idx_type > &  index,
int  dim = -1 
) const

Definition at line 145 of file chNDArray.cc.

References mx_inline_max().

◆ maybe_economize()

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

Definition at line 690 of file Array.h.

◆ mex_get_data()

void* Array< char >::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 706 of file Array.h.

◆ min() [1/2]

charNDArray charNDArray::min ( int  dim = -1) const

Definition at line 151 of file chNDArray.cc.

References mx_inline_min().

◆ min() [2/2]

charNDArray charNDArray::min ( Array< octave_idx_type > &  index,
int  dim = -1 
) const

Definition at line 157 of file chNDArray.cc.

References mx_inline_min().

◆ ndims()

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

Definition at line 590 of file Array.h.

◆ nelem()

octave_idx_type Array< char >::nelem ( void  ) const
inlineinherited

Number of elements in the array.

Synonymous with numel().

Note
This method is deprecated in favour of numel().

Definition at line 363 of file Array.h.

◆ nnz() [1/2]

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

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

◆ nnz() [2/2]

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

Count nonzero elements.

Definition at line 2212 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 39 of file Array-idx-vec.cc.

◆ nth_element() [2/2]

Array< char > Array< char >::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 2308 of file Array.cc.

◆ numel()

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

Number of elements in the array.

Definition at line 366 of file Array.h.

Referenced by charMatrix::operator==().

◆ operator()() [1/8]

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

Definition at line 502 of file Array.h.

◆ operator()() [2/8]

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

Definition at line 503 of file Array.h.

◆ operator()() [3/8]

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

Definition at line 504 of file Array.h.

◆ operator()() [4/8]

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

Definition at line 506 of file Array.h.

◆ operator()() [5/8]

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

Definition at line 529 of file Array.h.

◆ operator()() [6/8]

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

Definition at line 530 of file Array.h.

◆ operator()() [7/8]

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

Definition at line 532 of file Array.h.

◆ operator()() [8/8]

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

Definition at line 535 of file Array.h.

◆ operator=()

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

Definition at line 60 of file chNDArray.h.

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

◆ optimize_dimensions()

bool Array< char >::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 2751 of file Array.cc.

◆ page()

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

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

Definition at line 269 of file Array.cc.

◆ pages()

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

Definition at line 421 of file Array.h.

◆ permute()

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

Definition at line 430 of file Array.cc.

◆ print_info()

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

Definition at line 2735 of file Array.cc.

◆ reshape() [1/2]

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

Definition at line 549 of file Array.h.

◆ reshape() [2/2]

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

Definition at line 552 of file Array.h.

◆ resize() [1/2]

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

Resizing (with fill).

Definition at line 1010 of file Array.cc.

◆ resize() [2/2]

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

Resizing (with fill).

Definition at line 615 of file Array.h.

◆ resize1() [1/2]

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

Resizing (with fill).

Definition at line 897 of file Array.cc.

Referenced by charNDArray().

◆ resize1() [2/2]

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

Resizing (with fill).

Definition at line 612 of file Array.h.

◆ resize2() [1/2]

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

Resizing (with fill).

Definition at line 968 of file Array.cc.

◆ resize2() [2/2]

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

Resizing (with fill).

Definition at line 606 of file Array.h.

◆ resize_fill_value()

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

Definition at line 886 of file Array.cc.

◆ rows()

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

◆ size()

size_type Array< char >::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 431 of file Array.h.

◆ sort() [1/4]

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

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

◆ sort() [2/4]

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

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

◆ sort() [3/4]

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

Definition at line 1756 of file Array.cc.

◆ sort() [4/4]

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

Definition at line 1872 of file Array.cc.

◆ sort_rows_idx() [1/2]

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

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

◆ sort_rows_idx() [2/2]

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

Sort by rows returns only indices.

Definition at line 2068 of file Array.cc.

◆ squeeze()

charNDArray charNDArray::squeeze ( void  ) const
inline

Definition at line 86 of file chNDArray.h.

References Array< T >::squeeze().

◆ test()

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

Generic any/all test functionality with arbitrary predicate.

Definition at line 807 of file Array.h.

◆ test_all() [1/3]

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

Simpler calls.

Definition at line 819 of file Array.h.

◆ test_all() [2/3]

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

Overloads for function references.

Definition at line 831 of file Array.h.

◆ test_all() [3/3]

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

Overloads for function references.

Definition at line 834 of file Array.h.

◆ test_any() [1/3]

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

Simpler calls.

Definition at line 815 of file Array.h.

◆ test_any() [2/3]

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

Overloads for function references.

Definition at line 825 of file Array.h.

◆ test_any() [3/3]

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

Overloads for function references.

Definition at line 828 of file Array.h.

◆ transpose()

Array< char > Array< char >::transpose ( void  ) const
inherited

Definition at line 1598 of file Array.cc.

◆ xelem() [1/8]

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

Definition at line 458 of file Array.h.

◆ xelem() [2/8]

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

Definition at line 459 of file Array.h.

◆ xelem() [3/8]

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

Definition at line 461 of file Array.h.

◆ xelem() [4/8]

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

Definition at line 463 of file Array.h.

◆ xelem() [5/8]

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

Definition at line 466 of file Array.h.

◆ xelem() [6/8]

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

Definition at line 468 of file Array.h.

◆ xelem() [7/8]

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

Definition at line 471 of file Array.h.

◆ xelem() [8/8]

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

Definition at line 474 of file Array.h.

Member Data Documentation

◆ dimensions

dim_vector Array< char >::dimensions
protectedinherited

Definition at line 216 of file Array.h.

Referenced by compute_index(), and increment_index().

◆ rep

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

Definition at line 218 of file Array.h.

◆ slice_data

char * Array< char >::slice_data
protectedinherited

Definition at line 227 of file Array.h.

◆ slice_len

octave_idx_type Array< char >::slice_len
protectedinherited

Definition at line 228 of file Array.h.


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