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

#include "Cell.h"

Inheritance diagram for Cell:
Collaboration diagram for Cell:

Public Types

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

Public Member Functions

 Cell (const Array< octave_value > &c)
 
 Cell (const Array< octave_value > &c, octave_idx_type nr, octave_idx_type nc)
 
 Cell (const Array< std::string > &sa)
 
template<typename V , template< typename... > class C>
 Cell (const C< V > &container)
 
 Cell (const Cell &c)=default
 
 Cell (const dim_vector &dv, const octave_value &val=Matrix())
 
 Cell (const dim_vector &dv, const string_vector &sv, bool trim=false)
 
 Cell (const octave_value &val)
 
 Cell (const octave_value_list &ovl)
 
 Cell (const std::list< std::string > &sl)
 
 Cell (const string_vector &sv, bool trim=false)
 
 Cell (octave_idx_type n, octave_idx_type m, const octave_value &val=Matrix())
 
 Cell (void)=default
 
 ~Cell (void)=default
 
boolMatrix all (int=0) const
 
boolMatrix any (int=0) const
 
bool any_element_is_nan (void) const
 
OCTARRAY_OVERRIDABLE_FUNC_API Array< octave_value, Allocas_column (void) const
 Return the array as a column vector. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API Array< octave_value, Allocas_matrix (void) const
 Return the array as a matrix. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API Array< octave_value, Allocas_row (void) const
 Return the array as a row vector. More...
 
void assign (const octave_value_list &idx, const Cell &rhs, const octave_value &fill_val=Matrix())
 
Array< std::string > cellstr_value (void) const
 
OCTARRAY_API void clear (const dim_vector &dv)
 
void clear (octave_idx_type r, octave_idx_type c)
 
OCTARRAY_API void clear (void)
 
Cell column (octave_idx_type i) const
 
Cell concat (const Cell &rb, const Array< octave_idx_type > &ra_idx)
 
void delete_elements (const octave_value_list &idx)
 
Cell diag (octave_idx_type k=0) const
 
Cell diag (octave_idx_type m, octave_idx_type n) const
 
OCTARRAY_API void fill (const octave_value &val)
 
OCTINTERP_API Array< octave_idx_typefind (octave_idx_type, bool) const
 
OCTAVE_API Array< octave_idx_typefind (octave_idx_type, bool) const
 
Cell index (const octave_value_list &idx, bool resize_ok=false) const
 
Cellinsert (const Cell &a, const Array< octave_idx_type > &ra_idx)
 
Cellinsert (const Cell &a, octave_idx_type r, octave_idx_type c)
 
OCTINTERP_API sortmode is_sorted_rows (sortmode) const
 
OCTAVE_API sortmode is_sorted_rows (sortmode) const
 
bool is_true (void) const
 
bool iscellstr (void) const
 
OCTAVE_API sortmode issorted (sortmode mode) const
 
OCTINTERP_API sortmode issorted (sortmode) const
 
OCTAVE_API sortmode issorted (sortmode) const
 
OCTINTERP_API Array< octave_idx_typelookup (const Array< octave::cdef_object > &, sortmode) const
 
OCTAVE_API Array< octave_idx_typelookup (const Array< octave::idx_vector > &, sortmode) const
 
OCTINTERP_API octave_idx_type lookup (octave::cdef_object const &, sortmode) const
 
OCTAVE_API octave_idx_type lookup (octave::idx_vector const &, sortmode) const
 
OCTARRAY_OVERRIDABLE_FUNC_API void make_unique (void)
 
octave_idx_type nnz (void) const
 
OCTINTERP_API Array< octave::cdef_objectnth_element (const octave::idx_vector &, int) const
 
OCTAVE_API Array< octave::idx_vectornth_element (const octave::idx_vector &, int) const
 
OCTARRAY_OVERRIDABLE_FUNC_API octave_idx_type numel (void) const
 Number of elements in the array. More...
 
Celloperator= (const Cell &c)=default
 
Cell reshape (const dim_vector &new_dims) const
 
octave_value resize_fill_value (void) const
 Size of the specified dimension. More...
 
OCTINTERP_API Array< octave::cdef_objectsort (Array< octave_idx_type > &sidx, int, sortmode) const
 
OCTAVE_API Array< octave::idx_vectorsort (Array< octave_idx_type > &sidx, int, sortmode) const
 
OCTINTERP_API Array< octave::cdef_objectsort (int, sortmode) const
 
OCTAVE_API Array< octave::idx_vectorsort (int, sortmode) const
 
OCTINTERP_API Array< octave_idx_typesort_rows_idx (sortmode) const
 
OCTAVE_API Array< octave_idx_typesort_rows_idx (sortmode) const
 
string_vector string_vector_value (void) const
 
Cell xisalnum (void) const
 
Cell xisalpha (void) const
 
Cell xisascii (void) const
 
Cell xiscntrl (void) const
 
Cell xisdigit (void) const
 
Cell xisgraph (void) const
 
Cell xislower (void) const
 
Cell xisprint (void) const
 
Cell xispunct (void) const
 
Cell xisspace (void) const
 
Cell xisupper (void) const
 
Cell xisxdigit (void) const
 
Cell xtolower (void) const
 
Cell xtoupper (void) const
 
First dimension

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

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

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

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

Protected Attributes

dim_vector m_dimensions
 
Array< octave_value, Alloc >::ArrayRep * m_rep
 
octave_valuem_slice_data
 
octave_idx_type m_slice_len
 

Private Types

typedef octave_value(octave_value::* ctype_mapper) (void) const
 

Private Member Functions

OCTINTERP_CLASS_TEMPLATE_INSTANTIATION_API void instantiation_guard ()
 
OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void instantiation_guard ()
 
OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void instantiation_guard ()
 
OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void instantiation_guard ()
 
OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void instantiation_guard ()
 
OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void instantiation_guard ()
 
OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void instantiation_guard ()
 
OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void instantiation_guard ()
 
OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void instantiation_guard ()
 
OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void instantiation_guard ()
 
OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void instantiation_guard ()
 
OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void instantiation_guard ()
 
OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void instantiation_guard ()
 
OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void instantiation_guard ()
 
OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void instantiation_guard ()
 
OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void instantiation_guard ()
 
OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void instantiation_guard ()
 
OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void instantiation_guard ()
 
OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void instantiation_guard ()
 
OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void instantiation_guard ()
 
Cell map (ctype_mapper) const
 

Static Private Member Functions

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

Third dimension

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

OCTARRAY_OVERRIDABLE_FUNC_API octave_idx_type dim3 (void) const
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API octave_idx_type pages (void) const
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API size_type size (const size_type d) const
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API std::size_t byte_size (void) const
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API const dim_vectordims (void) const
 Return a const-reference so that dims ()(i) works efficiently. More...
 
OCTARRAY_API Array< octave_value, Allocsqueeze (void) const
 Chop off leading singleton dimensions. 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...
 
OCTARRAY_OVERRIDABLE_FUNC_API octave_idx_type compute_index_unchecked (const Array< octave_idx_type > &ra_idx) const
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API octave_valuexelem (octave_idx_type n)
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API crefT xelem (octave_idx_type n) const
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API octave_valuexelem (octave_idx_type i, octave_idx_type j)
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API crefT xelem (octave_idx_type i, octave_idx_type j) const
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API octave_valuexelem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API crefT xelem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API octave_valuexelem (const Array< octave_idx_type > &ra_idx)
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API crefT xelem (const Array< octave_idx_type > &ra_idx) const
 Size of the specified dimension. More...
 
OCTARRAY_API octave_valuecheckelem (octave_idx_type n)
 Size of the specified dimension. More...
 
OCTARRAY_API octave_valuecheckelem (octave_idx_type i, octave_idx_type j)
 Size of the specified dimension. More...
 
OCTARRAY_API octave_valuecheckelem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 Size of the specified dimension. More...
 
OCTARRAY_API octave_valuecheckelem (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...
 
OCTARRAY_OVERRIDABLE_FUNC_API octave_valueelem (octave_idx_type n)
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API octave_valueelem (octave_idx_type i, octave_idx_type j)
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API octave_valueelem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API octave_valueelem (const Array< octave_idx_type > &ra_idx)
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API crefT elem (octave_idx_type n) const
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API crefT elem (octave_idx_type i, octave_idx_type j) const
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API crefT elem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API crefT elem (const Array< octave_idx_type > &ra_idx) const
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API octave_valueoperator() (octave_idx_type n)
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API octave_valueoperator() (octave_idx_type i, octave_idx_type j)
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API octave_valueoperator() (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API octave_valueoperator() (const Array< octave_idx_type > &ra_idx)
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API crefT operator() (octave_idx_type n) const
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API crefT operator() (octave_idx_type i, octave_idx_type j) const
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API crefT operator() (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API crefT operator() (const Array< octave_idx_type > &ra_idx) const
 Size of the specified dimension. More...
 
OCTARRAY_API Array< octave_value, Allocpage (octave_idx_type k) const
 Extract page: A(:,:,k+1). More...
 
OCTARRAY_API Array< octave_value, 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...
 
OCTARRAY_OVERRIDABLE_FUNC_API Array< octave_value, Allocreshape (octave_idx_type nr, octave_idx_type nc) const
 Size of the specified dimension. More...
 
OCTARRAY_API Array< octave_value, Allocpermute (const Array< octave_idx_type > &vec, bool inv=false) const
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API Array< octave_value, Allocipermute (const Array< octave_idx_type > &vec) const
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API bool issquare (void) const
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API bool isempty (void) const
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API bool isvector (void) const
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API bool is_nd_vector (void) const
 Size of the specified dimension. More...
 
OCTARRAY_API Array< octave_value, Alloctranspose (void) const
 Size of the specified dimension. More...
 
OCTARRAY_API Array< octave_value, Allochermitian (octave_value(*fcn)(const octave_value &)=nullptr) const
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API const octave_valuedata (void) const
 Size of the specified dimension. More...
 
OCTARRAY_API octave_valuefortran_vec (void)
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API bool is_shared (void) const
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API int ndims (void) const
 Size of the specified dimension. More...
 
OCTARRAY_API Array< octave_value, Allocindex (const octave::idx_vector &i) const
 Indexing without resizing. More...
 
OCTARRAY_API Array< octave_value, Allocindex (const octave::idx_vector &i, const octave::idx_vector &j) const
 Size of the specified dimension. More...
 
OCTARRAY_API Array< octave_value, Allocindex (const Array< octave::idx_vector > &ia) const
 Size of the specified dimension. More...
 
OCTARRAY_API Array< octave_value, Allocindex (const octave::idx_vector &i, bool resize_ok, const octave_value &rfv) const
 Indexing with possible resizing and fill. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API Array< octave_value, Allocindex (const octave::idx_vector &i, bool resize_ok) const
 Size of the specified dimension. More...
 
OCTARRAY_API Array< octave_value, Allocindex (const octave::idx_vector &i, const octave::idx_vector &j, bool resize_ok, const octave_value &rfv) const
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API Array< octave_value, Allocindex (const octave::idx_vector &i, const octave::idx_vector &j, bool resize_ok) const
 Size of the specified dimension. More...
 
OCTARRAY_API Array< octave_value, Allocindex (const Array< octave::idx_vector > &ia, bool resize_ok, const octave_value &rfv) const
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API Array< octave_value, Allocindex (const Array< octave::idx_vector > &ia, bool resize_ok) const
 Size of the specified dimension. More...
 
OCTARRAY_API void resize2 (octave_idx_type nr, octave_idx_type nc, const octave_value &rfv)
 Resizing (with fill). More...
 
OCTARRAY_OVERRIDABLE_FUNC_API 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 octave_value &rfv)
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API void resize1 (octave_idx_type n)
 Size of the specified dimension. More...
 
OCTARRAY_API void resize (const dim_vector &dv, const octave_value &rfv)
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API void resize (const dim_vector &dv)
 Size of the specified dimension. More...
 
OCTARRAY_API void assign (const octave::idx_vector &i, const Array< octave_value, Alloc > &rhs, const octave_value &rfv)
 Indexed assignment (always with resize & fill). More...
 
OCTARRAY_OVERRIDABLE_FUNC_API void assign (const octave::idx_vector &i, const Array< octave_value, Alloc > &rhs)
 Size of the specified dimension. More...
 
OCTARRAY_API void assign (const octave::idx_vector &i, const octave::idx_vector &j, const Array< octave_value, Alloc > &rhs, const octave_value &rfv)
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API void assign (const octave::idx_vector &i, const octave::idx_vector &j, const Array< octave_value, Alloc > &rhs)
 Size of the specified dimension. More...
 
OCTARRAY_API void assign (const Array< octave::idx_vector > &ia, const Array< octave_value, Alloc > &rhs, const octave_value &rfv)
 Size of the specified dimension. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API void assign (const Array< octave::idx_vector > &ia, const Array< octave_value, 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< octave_value, Alloc > & insert (const Array< octave_value, Alloc > &a, const Array< octave_idx_type > &idx)
 Insert an array into another at a specified position. More...
 
OCTARRAY_API Array< octave_value, Alloc > & insert (const Array< octave_value, Alloc > &a, octave_idx_type r, octave_idx_type c)
 This is just a special case for idx = [r c 0 ...]. More...
 
OCTARRAY_OVERRIDABLE_FUNC_API 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< octave_value, Allocsort (int dim=0, sortmode mode=ASCENDING) const
 Size of the specified dimension. More...
 
OCTARRAY_API Array< octave_value, 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 octave_value &value, sortmode mode=UNSORTED) const
 Do a binary lookup in a sorted array. More...
 
OCTARRAY_API Array< octave_idx_typelookup (const Array< octave_value, Alloc > &values, sortmode mode=UNSORTED) const
 Ditto, but for an array of values, specializing on the case when values are sorted. 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< octave_value, 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)(octave_value)) const
 Overloads for function references. More...
 
Array< U, Amap (U(&fcn)(const octave_value &)) 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)(octave_value)) const
 Overloads for function references. More...
 
bool test_any (bool(&fcn)(const octave_value &)) const
 Size of the specified dimension. More...
 
bool test_all (F fcn) const
 Size of the specified dimension. More...
 
bool test_all (bool(&fcn)(octave_value)) const
 Size of the specified dimension. More...
 
bool test_all (bool(&fcn)(const octave_value &)) 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 void instantiation_guard ()
 Size of the specified dimension. More...
 
static OCTARRAY_API Array< octave_value, Alloccat (int dim, octave_idx_type n, const Array< octave_value, Alloc > *array_list)
 Concatenation along a specified (0-based) dimension, equivalent to cat(). More...
 

Detailed Description

Definition at line 40 of file Cell.h.

Member Typedef Documentation

◆ compare_fcn_type

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

Definition at line 240 of file Array.h.

◆ crefT

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

Definition at line 238 of file Array.h.

◆ ctype_mapper

typedef octave_value(octave_value::* Cell::ctype_mapper) (void) const
private

Definition at line 164 of file Cell.h.

◆ element_type

Definition at line 230 of file Array.h.

◆ size_type

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

Definition at line 236 of file Array.h.

◆ value_type

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

Definition at line 232 of file Array.h.

Constructor & Destructor Documentation

◆ Cell() [1/13]

Cell::Cell ( void  )
default

◆ Cell() [2/13]

Cell::Cell ( const Cell c)
default

◆ ~Cell()

Cell::~Cell ( void  )
default

◆ Cell() [3/13]

Cell::Cell ( const octave_value val)
inline

Definition at line 54 of file Cell.h.

◆ Cell() [4/13]

Cell::Cell ( const octave_value_list ovl)

Definition at line 37 of file Cell.cc.

◆ Cell() [5/13]

Cell::Cell ( octave_idx_type  n,
octave_idx_type  m,
const octave_value val = Matrix () 
)
inline

Definition at line 59 of file Cell.h.

◆ Cell() [6/13]

Cell::Cell ( const dim_vector dv,
const octave_value val = Matrix () 
)
inline

Definition at line 63 of file Cell.h.

◆ Cell() [7/13]

Cell::Cell ( const Array< octave_value > &  c)
inline

Definition at line 66 of file Cell.h.

◆ Cell() [8/13]

Cell::Cell ( const Array< octave_value > &  c,
octave_idx_type  nr,
octave_idx_type  nc 
)
inline

Definition at line 69 of file Cell.h.

◆ Cell() [9/13]

Cell::Cell ( const string_vector sv,
bool  trim = false 
)

◆ Cell() [10/13]

template<typename V , template< typename... > class C>
Cell::Cell ( const C< V > &  container)
inlineexplicit

Definition at line 78 of file Cell.h.

References elem, n, and octave_value_list::resize().

◆ Cell() [11/13]

Cell::Cell ( const std::list< std::string > &  sl)

Definition at line 66 of file Cell.cc.

References Array< octave_value >::fortran_vec(), n, and Array< octave_value >::resize().

◆ Cell() [12/13]

Cell::Cell ( const Array< std::string > &  sa)

◆ Cell() [13/13]

Cell::Cell ( const dim_vector dv,
const string_vector sv,
bool  trim = false 
)

Member Function Documentation

◆ all()

boolMatrix Cell::all ( int  = 0) const
inline

Definition at line 127 of file Cell.h.

References boolMatrix.

◆ any()

boolMatrix Cell::any ( int  = 0) const
inline

Definition at line 130 of file Cell.h.

References boolMatrix.

◆ any_element_is_nan()

bool Cell::any_element_is_nan ( void  ) const
inline

Definition at line 138 of file Cell.h.

◆ as_column()

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

Return the array as a column vector.

Definition at line 420 of file Array.h.

◆ as_matrix()

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

Return the array as a matrix.

Definition at line 442 of file Array.h.

◆ as_row()

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

Return the array as a row vector.

Definition at line 431 of file Array.h.

◆ assign() [1/7]

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

◆ assign() [2/7]

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

◆ assign() [3/7]

OCTARRAY_OVERRIDABLE_FUNC_API void Array< octave_value , Alloc >::assign ( const octave::idx_vector i,
const Array< octave_value , 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 747 of file Array.h.

◆ assign() [4/7]

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

Indexed assignment (always with resize & fill).

Definition at line 745 of file Array-base.cc.

◆ assign() [5/7]

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

◆ assign() [6/7]

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

◆ assign() [7/7]

void Cell::assign ( const octave_value_list idx,
const Cell rhs,
const octave_value fill_val = Matrix () 
)

Definition at line 242 of file Cell.cc.

References Array< T, Alloc >::assign(), len, octave_value_list::length(), and ra_idx.

Referenced by octave_map::assign().

◆ byte_size()

OCTARRAY_OVERRIDABLE_FUNC_API std::size_t Array< octave_value , 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 499 of file Array.h.

◆ cat()

Array< octave_value , Alloc > Array< octave_value , Alloc >::cat ( int  dim,
octave_idx_type  n,
const Array< octave_value , 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 854 of file Array-base.cc.

◆ cellstr_value()

◆ checkelem() [1/8]

octave_value & Array< octave_value , 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 560 of file Array-base.cc.

◆ checkelem() [2/8]

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

◆ checkelem() [3/8]

octave_value & Array< octave_value , 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 556 of file Array-base.cc.

◆ checkelem() [4/8]

Array< octave_value , Alloc >::crefT Array< octave_value , 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 588 of file Array-base.cc.

◆ checkelem() [5/8]

octave_value & Array< octave_value , 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 558 of file Array-base.cc.

◆ checkelem() [6/8]

Array< octave_value , Alloc >::crefT Array< octave_value , 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 590 of file Array-base.cc.

◆ checkelem() [7/8]

octave_value & Array< octave_value , 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 554 of file Array-base.cc.

◆ checkelem() [8/8]

Array< octave_value , Alloc >::crefT Array< octave_value , 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 586 of file Array-base.cc.

◆ clear() [1/3]

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

Definition at line 407 of file Array-base.cc.

◆ clear() [2/3]

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

Definition at line 409 of file Array.h.

◆ clear() [3/3]

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

Definition at line 406 of file Array-base.cc.

◆ cols()

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

Definition at line 469 of file Array.h.

◆ column()

◆ columns()

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

Definition at line 471 of file Array.h.

◆ compute_index() [1/3]

octave_idx_type Array< octave_value , 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 514 of file Array-base.cc.

◆ compute_index() [2/3]

octave_idx_type Array< octave_value , 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 510 of file Array-base.cc.

◆ compute_index() [3/3]

octave_idx_type Array< octave_value , 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 512 of file Array-base.cc.

◆ compute_index_unchecked()

OCTARRAY_OVERRIDABLE_FUNC_API octave_idx_type Array< octave_value , 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 517 of file Array.h.

◆ concat()

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

Definition at line 324 of file Cell.cc.

References insert(), and ra_idx.

◆ data()

OCTARRAY_OVERRIDABLE_FUNC_API const octave_value * Array< octave_value , 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 663 of file Array.h.

◆ delete_elements() [1/4]

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

Dispatcher to the above two.

Definition at line 781 of file Array-base.cc.

◆ delete_elements() [2/4]

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

Deleting elements.

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

Definition at line 775 of file Array-base.cc.

◆ delete_elements() [3/4]

void Cell::delete_elements ( const octave_value_list idx)

◆ delete_elements() [4/4]

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

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

Definition at line 778 of file Array-base.cc.

◆ diag() [1/2]

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

Definition at line 365 of file Cell.cc.

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

◆ diag() [2/2]

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

Definition at line 371 of file Cell.cc.

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

◆ dim1()

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

Definition at line 456 of file Array.h.

◆ dim2()

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

Definition at line 467 of file Array.h.

◆ dim3()

OCTARRAY_OVERRIDABLE_FUNC_API octave_idx_type Array< octave_value , 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 479 of file Array.h.

◆ dims()

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

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

Definition at line 503 of file Array.h.

◆ elem() [1/8]

OCTARRAY_OVERRIDABLE_FUNC_API octave_value & Array< octave_value , 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 574 of file Array.h.

◆ elem() [2/8]

OCTARRAY_OVERRIDABLE_FUNC_API crefT Array< octave_value , 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 607 of file Array.h.

◆ elem() [3/8]

OCTARRAY_OVERRIDABLE_FUNC_API octave_value & Array< octave_value , 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 568 of file Array.h.

◆ elem() [4/8]

OCTARRAY_OVERRIDABLE_FUNC_API crefT Array< octave_value , 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 599 of file Array.h.

◆ elem() [5/8]

OCTARRAY_OVERRIDABLE_FUNC_API octave_value & Array< octave_value , 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 571 of file Array.h.

◆ elem() [6/8]

OCTARRAY_OVERRIDABLE_FUNC_API crefT Array< octave_value , 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 603 of file Array.h.

◆ elem() [7/8]

OCTARRAY_OVERRIDABLE_FUNC_API octave_value & Array< octave_value , 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 562 of file Array.h.

◆ elem() [8/8]

OCTARRAY_OVERRIDABLE_FUNC_API crefT Array< octave_value , 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 595 of file Array.h.

◆ fill()

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

Definition at line 404 of file Array-base.cc.

◆ find() [1/3]

Array< octave_idx_type > Array< octave_value , 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 835 of file Array-base.cc.

◆ find() [2/3]

OCTINTERP_API Array< octave_idx_type > Array< octave::cdef_object >::find ( octave_idx_type  ,
bool   
) const
inherited

Definition at line 52 of file Array-tc.cc.

◆ find() [3/3]

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

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

◆ fortran_vec()

octave_value * Array< octave_value , 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 672 of file Array-base.cc.

◆ hermitian()

Array< octave_value , Alloc > Array< octave_value , Alloc >::hermitian ( octave_value (*)(const octave_value &)  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 661 of file Array-base.cc.

◆ index() [1/10]

Array< octave_value , Alloc > Array< octave_value , 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 686 of file Array-base.cc.

◆ index() [2/10]

OCTARRAY_OVERRIDABLE_FUNC_API Array<octave_value , Alloc> Array< octave_value , 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 736 of file Array.h.

◆ index() [3/10]

Array< octave_value , Alloc > Array< octave_value , Alloc >::index ( const Array< octave::idx_vector > &  ia,
bool  resize_ok,
const octave_value 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 733 of file Array-base.cc.

◆ index() [4/10]

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

Indexing without resizing.

Definition at line 682 of file Array-base.cc.

◆ index() [5/10]

OCTARRAY_OVERRIDABLE_FUNC_API Array<octave_value , Alloc> Array< octave_value , 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 717 of file Array.h.

◆ index() [6/10]

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

Indexing with possible resizing and fill.

Definition at line 715 of file Array-base.cc.

◆ index() [7/10]

Array< octave_value , Alloc > Array< octave_value , 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 684 of file Array-base.cc.

◆ index() [8/10]

OCTARRAY_OVERRIDABLE_FUNC_API Array<octave_value , Alloc> Array< octave_value , 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 726 of file Array.h.

◆ index() [9/10]

Array< octave_value , Alloc > Array< octave_value , Alloc >::index ( const octave::idx_vector i,
const octave::idx_vector j,
bool  resize_ok,
const octave_value 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 723 of file Array-base.cc.

◆ index() [10/10]

◆ insert() [1/4]

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

◆ insert() [2/4]

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

◆ insert() [3/4]

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

Definition at line 337 of file Cell.cc.

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

◆ insert() [4/4]

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

Definition at line 330 of file Cell.cc.

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

Referenced by concat(), octave_map::concat(), and Fdbstop().

◆ instantiation_guard() [1/21]

OCTINTERP_CLASS_TEMPLATE_INSTANTIATION_API void Array< octave::cdef_object >::instantiation_guard ( )
privateinherited

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

◆ instantiation_guard() [2/21]

OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void Array< Complex >::instantiation_guard ( )
privateinherited

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

◆ instantiation_guard() [3/21]

OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void Array< float >::instantiation_guard ( )
privateinherited

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

◆ instantiation_guard() [4/21]

OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void Array< FloatComplex >::instantiation_guard ( )
privateinherited

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

◆ instantiation_guard() [5/21]

OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void Array< signed char >::instantiation_guard ( )
privateinherited

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

◆ instantiation_guard() [6/21]

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

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

◆ instantiation_guard() [7/21]

OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void Array< unsigned char >::instantiation_guard ( )
privateinherited

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

◆ instantiation_guard() [8/21]

OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void Array< unsigned short >::instantiation_guard ( )
privateinherited

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

◆ instantiation_guard() [9/21]

OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void Array< unsigned int >::instantiation_guard ( )
privateinherited

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

◆ instantiation_guard() [10/21]

OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void Array< unsigned long >::instantiation_guard ( )
privateinherited

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

◆ instantiation_guard() [11/21]

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

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

◆ instantiation_guard() [12/21]

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

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

◆ instantiation_guard() [13/21]

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

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

◆ instantiation_guard() [14/21]

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

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

◆ instantiation_guard() [15/21]

OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void Array< octave_uint8 >::instantiation_guard ( )
privateinherited

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

◆ instantiation_guard() [16/21]

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

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

◆ instantiation_guard() [17/21]

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

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

◆ instantiation_guard() [18/21]

OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API void Array< octave_uint64 >::instantiation_guard ( )
privateinherited

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

◆ instantiation_guard() [19/21]

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

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

◆ instantiation_guard() [20/21]

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

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

◆ instantiation_guard() [21/21]

void Array< octave_value , 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 955 of file Array-base.cc.

◆ ipermute()

OCTARRAY_OVERRIDABLE_FUNC_API Array<octave_value , Alloc> Array< octave_value , 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 645 of file Array.h.

◆ is_nd_vector()

OCTARRAY_OVERRIDABLE_FUNC_API bool Array< octave_value , 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 657 of file Array.h.

◆ is_shared()

OCTARRAY_OVERRIDABLE_FUNC_API bool Array< octave_value , Alloc >::is_shared ( 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 674 of file Array.h.

◆ is_sorted_rows() [1/3]

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

Ordering is auto-detected or can be specified.

Definition at line 819 of file Array-base.cc.

◆ is_sorted_rows() [2/3]

OCTINTERP_API sortmode Array< octave::cdef_object >::is_sorted_rows ( sortmode  ) const
inherited

Definition at line 52 of file Array-tc.cc.

◆ is_sorted_rows() [3/3]

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

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

◆ is_true()

bool Cell::is_true ( void  ) const
inline

Definition at line 139 of file Cell.h.

◆ iscellstr()

bool Cell::iscellstr ( void  ) const

◆ isempty()

OCTARRAY_OVERRIDABLE_FUNC_API bool Array< octave_value , 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 651 of file Array.h.

◆ issorted() [1/4]

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

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

◆ issorted() [2/4]

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

Ordering is auto-detected or can be specified.

Definition at line 813 of file Array-base.cc.

◆ issorted() [3/4]

OCTINTERP_API sortmode Array< octave::cdef_object >::issorted ( sortmode  ) const
inherited

Definition at line 52 of file Array-tc.cc.

◆ issorted() [4/4]

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

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

◆ issquare()

OCTARRAY_OVERRIDABLE_FUNC_API bool Array< octave_value , 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 648 of file Array.h.

◆ isvector()

OCTARRAY_OVERRIDABLE_FUNC_API bool Array< octave_value , 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 654 of file Array.h.

◆ linear_slice()

Array< octave_value , Alloc > Array< octave_value , 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 632 of file Array-base.cc.

◆ lookup() [1/6]

OCTINTERP_API Array< octave_idx_type > Array< octave::cdef_object >::lookup ( const Array< octave::cdef_object > &  ,
sortmode   
) const
inherited

Definition at line 52 of file Array-tc.cc.

◆ lookup() [2/6]

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

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

◆ lookup() [3/6]

Array< octave_idx_type > Array< octave_value , Alloc >::lookup ( const Array< octave_value , 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 827 of file Array-base.cc.

◆ lookup() [4/6]

octave_idx_type Array< octave_value , Alloc >::lookup ( const octave_value 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 823 of file Array-base.cc.

◆ lookup() [5/6]

OCTINTERP_API octave_idx_type Array< octave::cdef_object >::lookup ( octave::cdef_object const &  ,
sortmode   
) const
inherited

Definition at line 52 of file Array-tc.cc.

◆ lookup() [6/6]

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

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

◆ make_unique()

OCTARRAY_OVERRIDABLE_FUNC_API void Array< octave_value , Alloc >::make_unique ( void  )
inlineinherited

Definition at line 216 of file Array.h.

◆ map() [1/4]

◆ map() [2/4]

Array<U, A> Array< octave_value , Alloc >::map ( 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 865 of file Array.h.

◆ map() [3/4]

Array<U, A> Array< octave_value , Alloc >::map ( U(&)(const octave_value &)  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 910 of file Array.h.

◆ map() [4/4]

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

Overloads for function references.

Definition at line 901 of file Array.h.

◆ maybe_economize()

OCTARRAY_OVERRIDABLE_FUNC_API void Array< octave_value , 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 795 of file Array.h.

◆ ndims()

OCTARRAY_OVERRIDABLE_FUNC_API int Array< octave_value , 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 677 of file Array.h.

◆ nil_rep()

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

Definition at line 270 of file Array-base.cc.

◆ nnz()

octave_idx_type Cell::nnz ( void  ) const

Definition at line 291 of file Cell.cc.

References err_wrong_type_arg().

◆ nth_element() [1/3]

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

Definition at line 52 of file Array-tc.cc.

◆ nth_element() [2/3]

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

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

◆ nth_element() [3/3]

Array< octave_value , Alloc > Array< octave_value , 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 841 of file Array-base.cc.

◆ numel()

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

Number of elements in the array.

Definition at line 414 of file Array.h.

◆ operator()() [1/8]

OCTARRAY_OVERRIDABLE_FUNC_API octave_value & Array< octave_value , 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 583 of file Array.h.

◆ operator()() [2/8]

OCTARRAY_OVERRIDABLE_FUNC_API crefT Array< octave_value , 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 619 of file Array.h.

◆ operator()() [3/8]

OCTARRAY_OVERRIDABLE_FUNC_API octave_value & Array< octave_value , 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 579 of file Array.h.

◆ operator()() [4/8]

OCTARRAY_OVERRIDABLE_FUNC_API crefT Array< octave_value , 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 613 of file Array.h.

◆ operator()() [5/8]

OCTARRAY_OVERRIDABLE_FUNC_API octave_value & Array< octave_value , 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 581 of file Array.h.

◆ operator()() [6/8]

OCTARRAY_OVERRIDABLE_FUNC_API crefT Array< octave_value , 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 616 of file Array.h.

◆ operator()() [7/8]

OCTARRAY_OVERRIDABLE_FUNC_API octave_value & Array< octave_value , 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 577 of file Array.h.

◆ operator()() [8/8]

OCTARRAY_OVERRIDABLE_FUNC_API crefT Array< octave_value , 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 611 of file Array.h.

◆ operator=()

Cell& Cell::operator= ( const Cell c)
default

◆ optimize_dimensions()

bool Array< octave_value , 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 952 of file Array-base.cc.

◆ page()

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

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

Definition at line 627 of file Array-base.cc.

◆ pages()

OCTARRAY_OVERRIDABLE_FUNC_API octave_idx_type Array< octave_value , 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 481 of file Array.h.

◆ permute()

Array< octave_value , Alloc > Array< octave_value , 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 643 of file Array-base.cc.

◆ print_info()

void Array< octave_value , 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 806 of file Array-base.cc.

◆ reshape() [1/2]

Cell Cell::reshape ( const dim_vector new_dims) const
inline

◆ reshape() [2/2]

OCTARRAY_OVERRIDABLE_FUNC_API Array<octave_value , Alloc> Array< octave_value , 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 635 of file Array.h.

◆ resize() [1/2]

OCTARRAY_OVERRIDABLE_FUNC_API void Array< octave_value , 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 704 of file Array.h.

◆ resize() [2/2]

void Array< octave_value , Alloc >::resize ( const dim_vector dv,
const octave_value 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 703 of file Array-base.cc.

◆ resize1() [1/2]

OCTARRAY_OVERRIDABLE_FUNC_API void Array< octave_value , 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 700 of file Array.h.

◆ resize1() [2/2]

void Array< octave_value , Alloc >::resize1 ( octave_idx_type  n,
const octave_value 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 699 of file Array-base.cc.

◆ resize2() [1/2]

OCTARRAY_OVERRIDABLE_FUNC_API void Array< octave_value , 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 694 of file Array.h.

◆ resize2() [2/2]

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

Resizing (with fill).

Definition at line 693 of file Array-base.cc.

◆ resize_fill_value()

octave_value Cell::resize_fill_value ( void  ) const
virtual

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)'

Reimplemented from Array< octave_value >.

Definition at line 358 of file Cell.cc.

References octave_value().

◆ rows()

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

Definition at line 459 of file Array.h.

◆ size()

OCTARRAY_OVERRIDABLE_FUNC_API size_type Array< octave_value , 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 492 of file Array.h.

◆ sort() [1/6]

Array< octave_value , Alloc > Array< octave_value , 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 809 of file Array-base.cc.

◆ sort() [2/6]

OCTINTERP_API Array< octave::cdef_object > Array< octave::cdef_object >::sort ( Array< octave_idx_type > &  sidx,
int  ,
sortmode   
) const
inherited

Definition at line 52 of file Array-tc.cc.

◆ sort() [3/6]

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

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

◆ sort() [4/6]

Array< octave_value , Alloc > Array< octave_value , 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 808 of file Array-base.cc.

◆ sort() [5/6]

OCTINTERP_API Array< octave::cdef_object > Array< octave::cdef_object >::sort ( int  ,
sortmode   
) const
inherited

Definition at line 52 of file Array-tc.cc.

◆ sort() [6/6]

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

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

◆ sort_rows_idx() [1/3]

Array< octave_idx_type > Array< octave_value , Alloc >::sort_rows_idx ( sortmode  mode = ASCENDING) const
inherited

Sort by rows returns only indices.

Definition at line 816 of file Array-base.cc.

◆ sort_rows_idx() [2/3]

OCTINTERP_API Array< octave_idx_type > Array< octave::cdef_object >::sort_rows_idx ( sortmode  ) const
inherited

Definition at line 52 of file Array-tc.cc.

◆ sort_rows_idx() [3/3]

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

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

◆ squeeze()

Array< octave_value , Alloc > Array< octave_value , Alloc >::squeeze ( void  ) const
inherited

Chop off leading singleton dimensions.

Definition at line 507 of file Array-base.cc.

◆ string_vector_value()

string_vector Cell::string_vector_value ( void  ) const

◆ test()

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

Generic any/all test functionality with arbitrary predicate.

Definition at line 916 of file Array.h.

◆ test_all() [1/3]

bool Array< octave_value , Alloc >::test_all ( bool(&)(const octave_value &)  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 943 of file Array.h.

◆ test_all() [2/3]

bool Array< octave_value , Alloc >::test_all ( bool(&)(octave_value 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 940 of file Array.h.

◆ test_all() [3/3]

bool Array< octave_value , Alloc >::test_all ( fcn) const
inlineinherited

Size of the specified dimension.

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

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

Definition at line 928 of file Array.h.

◆ test_any() [1/3]

bool Array< octave_value , Alloc >::test_any ( bool(&)(const octave_value &)  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 937 of file Array.h.

◆ test_any() [2/3]

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

Overloads for function references.

Definition at line 934 of file Array.h.

◆ test_any() [3/3]

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

Simpler calls.

Definition at line 924 of file Array.h.

◆ transpose()

Array< octave_value , Alloc > Array< octave_value , 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 660 of file Array-base.cc.

◆ xelem() [1/8]

OCTARRAY_OVERRIDABLE_FUNC_API octave_value & Array< octave_value , 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 544 of file Array.h.

◆ xelem() [2/8]

OCTARRAY_OVERRIDABLE_FUNC_API crefT Array< octave_value , 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 548 of file Array.h.

◆ xelem() [3/8]

OCTARRAY_OVERRIDABLE_FUNC_API octave_value & Array< octave_value , 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 530 of file Array.h.

◆ xelem() [4/8]

OCTARRAY_OVERRIDABLE_FUNC_API crefT Array< octave_value , 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 533 of file Array.h.

◆ xelem() [5/8]

OCTARRAY_OVERRIDABLE_FUNC_API octave_value & Array< octave_value , 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 537 of file Array.h.

◆ xelem() [6/8]

OCTARRAY_OVERRIDABLE_FUNC_API crefT Array< octave_value , 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 540 of file Array.h.

◆ xelem() [7/8]

OCTARRAY_OVERRIDABLE_FUNC_API octave_value & Array< octave_value , 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 524 of file Array.h.

◆ xelem() [8/8]

OCTARRAY_OVERRIDABLE_FUNC_API crefT Array< octave_value , 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 526 of file Array.h.

◆ xisalnum()

Cell Cell::xisalnum ( void  ) const
inline

Definition at line 147 of file Cell.h.

References octave_value::xisalnum().

◆ xisalpha()

Cell Cell::xisalpha ( void  ) const
inline

Definition at line 148 of file Cell.h.

References octave_value::xisalpha().

◆ xisascii()

Cell Cell::xisascii ( void  ) const
inline

Definition at line 149 of file Cell.h.

References octave_value::xisascii().

◆ xiscntrl()

Cell Cell::xiscntrl ( void  ) const
inline

Definition at line 150 of file Cell.h.

References octave_value::xiscntrl().

◆ xisdigit()

Cell Cell::xisdigit ( void  ) const
inline

Definition at line 151 of file Cell.h.

References octave_value::xisdigit().

◆ xisgraph()

Cell Cell::xisgraph ( void  ) const
inline

Definition at line 152 of file Cell.h.

References octave_value::xisgraph().

◆ xislower()

Cell Cell::xislower ( void  ) const
inline

Definition at line 153 of file Cell.h.

References octave_value::xislower().

◆ xisprint()

Cell Cell::xisprint ( void  ) const
inline

Definition at line 154 of file Cell.h.

References octave_value::xisprint().

◆ xispunct()

Cell Cell::xispunct ( void  ) const
inline

Definition at line 155 of file Cell.h.

References octave_value::xispunct().

◆ xisspace()

Cell Cell::xisspace ( void  ) const
inline

Definition at line 156 of file Cell.h.

References octave_value::xisspace().

◆ xisupper()

Cell Cell::xisupper ( void  ) const
inline

Definition at line 157 of file Cell.h.

References octave_value::xisupper().

◆ xisxdigit()

Cell Cell::xisxdigit ( void  ) const
inline

Definition at line 158 of file Cell.h.

References octave_value::xisxdigit().

◆ xtolower()

Cell Cell::xtolower ( void  ) const
inline

Definition at line 159 of file Cell.h.

References octave_value::xtolower().

◆ xtoupper()

Cell Cell::xtoupper ( void  ) const
inline

Definition at line 160 of file Cell.h.

References octave_value::xtoupper().

Member Data Documentation

◆ m_dimensions

dim_vector Array< octave_value , Alloc >::m_dimensions
protectedinherited

Definition at line 245 of file Array.h.

◆ m_rep

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

Definition at line 247 of file Array.h.

◆ m_slice_data

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

Definition at line 256 of file Array.h.

◆ m_slice_len

octave_idx_type Array< octave_value , Alloc >::m_slice_len
protectedinherited

Definition at line 257 of file Array.h.


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