GNU Octave  4.0.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | Private Types | Private Member Functions | List of all members
Cell Class Reference

#include "Cell.h"

Inheritance diagram for Cell:
Inheritance graph
[legend]
Collaboration diagram for Cell:
Collaboration graph
[legend]

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
 

Public Member Functions

 Cell (void)
 
 Cell (const octave_value &val)
 
 Cell (const octave_value_list &ovl)
 
 Cell (octave_idx_type n, octave_idx_type m, const octave_value &val=Matrix())
 
 Cell (const dim_vector &dv, const octave_value &val=Matrix())
 
 Cell (const Array< octave_value > &c)
 
 Cell (const Array< octave_value > &c, octave_idx_type nr, octave_idx_type nc)
 
 Cell (const string_vector &sv, bool trim=false)
 
 Cell (const std::list< std::string > &lst)
 
 Cell (const Array< std::string > &sa)
 
 Cell (const dim_vector &dv, const string_vector &sv, bool trim=false)
 
 Cell (const Cell &c)
 
boolMatrix all (int=0) const
 
boolMatrix any (int=0) const
 
bool any_element_is_nan (void) const
 
Array< octave_value > as_column (void) const
 Return the array as a column vector. More...
 
Array< octave_value > as_matrix (void) const
 Return the array as a matrix. More...
 
Array< octave_value > as_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())
 
size_t byte_size (void) const
 
Array< std::string > cellstr_value (void) const
 
octave_value & checkelem (octave_idx_type n)
 
octave_value & checkelem (octave_idx_type i, octave_idx_type j)
 
octave_value & checkelem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 
octave_value & 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)
 
Cell column (octave_idx_type i) const
 
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
 
Cell concat (const Cell &rb, const Array< octave_idx_type > &ra_idx)
 
const octave_value * data (void) const
 
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
 
const dim_vector & dims (void) const
 Return a const-reference so that dims ()(i) works efficiently. More...
 
octave_value & elem (octave_idx_type n)
 
octave_value & elem (octave_idx_type i, octave_idx_type j)
 
octave_value & elem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 
octave_value & 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 octave_value &val)
 
Array< octave_idx_type > find (octave_idx_type n=-1, bool backward=false) const
 Find indices of (at most n) nonzero elements. More...
 
const octave_value * fortran_vec (void) const
 
octave_value * fortran_vec (void)
 
Array< octave_value > hermitian (octave_value(*fcn)(const octave_value &)=0) const
 
Cell index (const octave_value_list &idx, bool resize_ok=false) const
 
Cell & insert (const Cell &a, octave_idx_type r, octave_idx_type c)
 
Cell & insert (const Cell &a, const Array< octave_idx_type > &ra_idx)
 
Array< octave_value > & insert (const Array< octave_value > &a, const Array< octave_idx_type > &idx)
 Insert an array into another at a specified position. More...
 
Array< octave_value > & insert (const Array< octave_value > &a, octave_idx_type r, octave_idx_type c)
 This is just a special case for idx = [r c 0 ...]. More...
 
Array< octave_value > ipermute (const Array< octave_idx_type > &vec) const
 
bool is_cellstr (void) const
 
bool is_empty (void) const
 
bool is_shared (void)
 
sortmode is_sorted (sortmode mode=UNSORTED) const
 Ordering is auto-detected or can be specified. More...
 
sortmode is_sorted_rows (sortmode mode=UNSORTED) const
 Ordering is auto-detected or can be specified. More...
 
bool is_square (void) const
 
bool is_true (void) const
 
bool is_vector (void) const
 
Array< octave_value > 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 (const octave_value &value, sortmode mode=UNSORTED) const
 Do a binary lookup in a sorted array. More...
 
Array< octave_idx_type > lookup (const Array< octave_value > &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...
 
void maybe_economize (void)
 
void * mex_get_data (void) const
 Give a pointer to the data in mex format. More...
 
int ndims (void) const
 
octave_idx_type nnz (void) const
 
Array< octave_value > 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...
 
octave_value & operator() (octave_idx_type n)
 
octave_value & operator() (octave_idx_type i, octave_idx_type j)
 
octave_value & operator() (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 
octave_value & 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
 
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< octave_value > page (octave_idx_type k) const
 Extract page: A(:,:,k+1). More...
 
Array< octave_value > permute (const Array< octave_idx_type > &vec, bool inv=false) const
 
void print_info (std::ostream &os, const std::string &prefix) const
 
Cell reshape (const dim_vector &new_dims) const
 
Array< octave_value > reshape (octave_idx_type nr, octave_idx_type nc) const
 
octave_value resize_fill_value (void) const
 
Array< octave_value > sort (int dim=0, sortmode mode=ASCENDING) const
 
Array< octave_value > sort (Array< octave_idx_type > &sidx, int dim=0, sortmode mode=ASCENDING) const
 
Array< octave_idx_type > sort_rows_idx (sortmode mode=ASCENDING) const
 Sort by rows returns only indices. More...
 
Array< octave_value > squeeze (void) const
 Chop off leading singleton dimensions. More...
 
bool test (F fcn) const
 Generic any/all test functionality with arbitrary predicate. More...
 
Array< octave_value > transpose (void) const
 
octave_value & xelem (octave_idx_type n)
 
crefT xelem (octave_idx_type n) const
 
octave_value & xelem (octave_idx_type i, octave_idx_type j)
 
crefT xelem (octave_idx_type i, octave_idx_type j) const
 
octave_value & 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
 
octave_value & xelem (const Array< octave_idx_type > &ra_idx)
 
crefT xelem (const Array< octave_idx_type > &ra_idx) 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 xtoascii (void) const
 
Cell xtolower (void) const
 
Cell xtoupper (void) 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< octave_value > index (const idx_vector &i) const
 Indexing without resizing. More...
 
Array< octave_value > index (const idx_vector &i, const idx_vector &j) const
 
Array< octave_value > index (const Array< idx_vector > &ia) const
 
Array< octave_value > index (const idx_vector &i, bool resize_ok, const octave_value &rfv) const
 Indexing with possible resizing and fill. More...
 
Array< octave_value > index (const idx_vector &i, bool resize_ok) const
 
Array< octave_value > index (const idx_vector &i, const idx_vector &j, bool resize_ok, const octave_value &rfv) const
 
Array< octave_value > index (const idx_vector &i, const idx_vector &j, bool resize_ok) const
 
Array< octave_value > index (const Array< idx_vector > &ia, bool resize_ok, const octave_value &rfv) const
 
Array< octave_value > index (const Array< idx_vector > &ia, bool resize_ok) const
 
void resize2 (octave_idx_type nr, octave_idx_type nc, const octave_value &rfv)
 Resizing (with fill). More...
 
void resize2 (octave_idx_type nr, octave_idx_type nc)
 
void resize1 (octave_idx_type n, const octave_value &rfv)
 
void resize1 (octave_idx_type n)
 
void resize (const dim_vector &dv, const octave_value &rfv)
 
void resize (const dim_vector &dv)
 
void assign (const idx_vector &i, const Array< octave_value > &rhs, const octave_value &rfv)
 Indexed assignment (always with resize & fill). More...
 
void assign (const idx_vector &i, const Array< octave_value > &rhs)
 
void assign (const idx_vector &i, const idx_vector &j, const Array< octave_value > &rhs, const octave_value &rfv)
 
void assign (const idx_vector &i, const idx_vector &j, const Array< octave_value > &rhs)
 
void assign (const Array< idx_vector > &ia, const Array< octave_value > &rhs, const octave_value &rfv)
 
void assign (const Array< idx_vector > &ia, const Array< octave_value > &rhs)
 
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)(octave_value)) const
 Overloads for function references. More...
 
Array< U > map (U(&fcn)(const octave_value &)) const
 
bool test_any (F fcn) const
 Simpler calls. More...
 
bool test_all (F fcn) const
 
bool test_any (bool(&fcn)(octave_value)) const
 Overloads for function references. More...
 
bool test_any (bool(&fcn)(const octave_value &)) const
 
bool test_all (bool(&fcn)(octave_value)) const
 
bool test_all (bool(&fcn)(const octave_value &)) const
 
int * jit_ref_count (void)
 WARNING: Only call these functions from jit. More...
 
octave_value * jit_slice_data (void) const
 
octave_idx_type * jit_dimensions (void) const
 
void * jit_array_rep (void) const
 

Static Public Member Functions

static Array< octave_value > cat (int dim, octave_idx_type n, const Array< octave_value > *array_list)
 Concatenation along a specified (0-based) dimension, equivalent to cat(). More...
 

Protected Attributes

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

Private Types

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

Private Member Functions

Cell map (ctype_mapper) const
 

Detailed Description

Definition at line 35 of file Cell.h.

Member Typedef Documentation

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

Definition at line 122 of file Array.h.

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

Definition at line 120 of file Array.h.

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

Definition at line 140 of file Cell.h.

typedef octave_value Array< octave_value >::element_type
inherited

Definition at line 118 of file Array.h.

Constructor & Destructor Documentation

Cell::Cell ( void  )
inline

Definition at line 41 of file Cell.h.

Cell::Cell ( const octave_value &  val)
inline

Definition at line 44 of file Cell.h.

Cell::Cell ( const octave_value_list &  ovl)

Definition at line 35 of file Cell.cc.

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

Definition at line 49 of file Cell.h.

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

Definition at line 53 of file Cell.h.

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

Definition at line 56 of file Cell.h.

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

Definition at line 59 of file Cell.h.

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

Definition at line 40 of file Cell.cc.

References Array< octave_value >::elem(), Array< T >::length(), and Array< octave_value >::resize().

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

Definition at line 65 of file Cell.cc.

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

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

Definition at line 84 of file Cell.cc.

References Array< T >::data(), Array< octave_value >::fortran_vec(), and Array< T >::numel().

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

Definition at line 99 of file Cell.cc.

References Array< octave_value >::elem(), Array< T >::length(), and Array< octave_value >::numel().

Cell::Cell ( const Cell &  c)
inline

Definition at line 70 of file Cell.h.

Member Function Documentation

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

Definition at line 98 of file Cell.h.

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

Definition at line 101 of file Cell.h.

bool Cell::any_element_is_nan ( void  ) const
inline

Definition at line 109 of file Cell.h.

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

Return the array as a column vector.

Definition at line 279 of file Array.h.

References Array< T >::dimensions, and dim_vector::length().

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

Return the array as a matrix.

Definition at line 299 of file Array.h.

References Array< T >::dimensions, dim_vector::length(), and dim_vector::redim().

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

Return the array as a row vector.

Definition at line 289 of file Array.h.

References Array< T >::dimensions, and dim_vector::length().

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

Definition at line 222 of file Cell.cc.

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

Referenced by octave_map::assign().

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

Indexed assignment (always with resize & fill).

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

Definition at line 548 of file Array.h.

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

Definition at line 555 of file Array.h.

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

Definition at line 561 of file Array.h.

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

Definition at line 333 of file Array.h.

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

Number of elements in the array.

Synonymous with length(), nelem(), and numel().

Definition at line 256 of file Array.h.

static Array<octave_value > Array< octave_value >::cat ( int  dim,
octave_idx_type  n,
const Array< octave_value > *  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.

Array< std::string > Cell::cellstr_value ( void  ) const

Definition at line 146 of file Cell.cc.

References Array< octave_value >::dims(), Array< octave_value >::elem(), Array< octave_value >::numel(), octave_value::string_value(), and Array< T >::xelem().

Referenced by octave_cell::cellstr_value(), string_array_property::do_set(), F__octave_link_input_dialog__(), and F__octave_link_list_dialog__().

octave_value & Array< octave_value >::checkelem ( octave_idx_type  n)
inherited
octave_value & Array< octave_value >::checkelem ( octave_idx_type  i,
octave_idx_type  j 
)
inherited
octave_value & Array< octave_value >::checkelem ( octave_idx_type  i,
octave_idx_type  j,
octave_idx_type  k 
)
inherited
octave_value & Array< octave_value >::checkelem ( const Array< octave_idx_type > &  ra_idx)
inherited
crefT Array< octave_value >::checkelem ( octave_idx_type  n) const
inherited
crefT Array< octave_value >::checkelem ( octave_idx_type  i,
octave_idx_type  j 
) const
inherited
crefT Array< octave_value >::checkelem ( octave_idx_type  i,
octave_idx_type  j,
octave_idx_type  k 
) const
inherited
crefT Array< octave_value >::checkelem ( const Array< octave_idx_type > &  ra_idx) const
inherited
void Array< octave_value >::clear ( void  )
inherited
void Array< octave_value >::clear ( const dim_vector &  dv)
inherited
void Array< octave_value >::clear ( octave_idx_type  r,
octave_idx_type  c 
)
inlineinherited

Definition at line 249 of file Array.h.

References clear().

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

Definition at line 321 of file Array.h.

Referenced by column().

Cell Cell::column ( octave_idx_type  i) const

Definition at line 264 of file Cell.cc.

References Array< octave_value >::cols(), Array< octave_value >::elem(), error(), Array< octave_value >::ndims(), Array< T >::resize(), Array< octave_value >::rows(), and Array< T >::xelem().

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

Definition at line 322 of file Array.h.

octave_idx_type Array< octave_value >::compute_index ( octave_idx_type  i,
octave_idx_type  j 
) const
inherited
octave_idx_type Array< octave_value >::compute_index ( octave_idx_type  i,
octave_idx_type  j,
octave_idx_type  k 
) const
inherited
octave_idx_type Array< octave_value >::compute_index ( const Array< octave_idx_type > &  ra_idx) const
inherited
octave_idx_type Array< octave_value >::compute_index_unchecked ( const Array< octave_idx_type > &  ra_idx) const
inlineinherited

Definition at line 347 of file Array.h.

References dim_vector::compute_index(), Array< T >::data(), and Array< T >::length().

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

Definition at line 289 of file Cell.cc.

References insert().

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

Definition at line 479 of file Array.h.

Referenced by map().

void Cell::delete_elements ( const octave_value_list &  idx)

Definition at line 237 of file Cell.cc.

References Array< T >::delete_elements(), octave_value_list::length(), ra_idx, and Array< T >::xelem().

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

Deleting elements.

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

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

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

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

Dispatcher to the above two.

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

Definition at line 323 of file Cell.cc.

References Array< T >::diag().

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

Definition at line 329 of file Cell.cc.

References Array< T >::diag().

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

Definition at line 312 of file Array.h.

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

Definition at line 320 of file Array.h.

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

Definition at line 329 of file Array.h.

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

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

Definition at line 337 of file Array.h.

Referenced by cellstr_value(), and map().

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

Definition at line 380 of file Array.h.

Referenced by Cell(), cellstr_value(), column(), and is_cellstr().

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

Definition at line 386 of file Array.h.

References Array< T >::elem().

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

Definition at line 388 of file Array.h.

References elem.

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

Definition at line 391 of file Array.h.

References Array< T >::elem().

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

Definition at line 417 of file Array.h.

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

Definition at line 419 of file Array.h.

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

Definition at line 422 of file Array.h.

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

Definition at line 425 of file Array.h.

References Array< T >::xelem().

void Array< octave_value >::fill ( const octave_value &  val)
inherited
Array< octave_idx_type > Array< octave_value >::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 36 of file Array-tc.cc.

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

Definition at line 481 of file Array.h.

Referenced by Cell().

octave_value * Array< octave_value >::fortran_vec ( void  )
inherited
Array<octave_value > Array< octave_value >::hermitian ( octave_value (*)(const octave_value &)  fcn = 0) const
inherited
Cell Cell::index ( const octave_value_list &  idx,
bool  resize_ok = false 
) const

Definition at line 159 of file Cell.cc.

References error_state, Array< T >::index(), and octave_value_list::length().

Referenced by do_cellslices_nda(), Fcell2struct(), octave_struct::subsasgn(), octave_cell::subsasgn(), octave_class::subsasgn_common(), octave_struct::subsref(), and octave_class::subsref().

Array<octave_value > Array< octave_value >::index ( const idx_vector &  i) const
inherited

Indexing without resizing.

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

Indexing with possible resizing and fill.

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

Definition at line 523 of file Array.h.

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

Definition at line 530 of file Array.h.

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

Definition at line 538 of file Array.h.

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

Definition at line 295 of file Cell.cc.

References Array< T >::insert().

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

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

Definition at line 302 of file Cell.cc.

References Array< T >::insert().

Array<octave_value >& Array< octave_value >::insert ( const Array< octave_value > &  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.

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

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

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

Definition at line 467 of file Array.h.

bool Cell::is_cellstr ( void  ) const

Definition at line 127 of file Cell.cc.

References Array< octave_value >::elem(), and Array< octave_value >::numel().

Referenced by do_strcmp_fun(), octave_cell::is_cellstr(), and string_array_property::string_array_property().

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

Definition at line 472 of file Array.h.

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

Definition at line 485 of file Array.h.

References Array< T >::ArrayRep::count.

sortmode Array< octave_value >::is_sorted ( sortmode  mode = UNSORTED) const
inherited

Ordering is auto-detected or can be specified.

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

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

Ordering is auto-detected or can be specified.

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

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

Definition at line 470 of file Array.h.

bool Cell::is_true ( void  ) const
inline

Definition at line 110 of file Cell.h.

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

Definition at line 474 of file Array.h.

References dim_vector::is_vector().

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

Definition at line 749 of file Array.h.

References Array< T >::rep.

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

Definition at line 747 of file Array.h.

References dim_vector::to_jit().

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

WARNING: Only call these functions from jit.

Definition at line 743 of file Array.h.

References Array< T >::ArrayRep::count, and octave_refcount< T >::get().

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

Definition at line 745 of file Array.h.

References Array< T >::slice_data.

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

Number of elements in the array.

Synonymous with capacity(), nelem(), and numel().

Note
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 267 of file Array.h.

Array<octave_value > Array< octave_value >::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.

octave_idx_type Array< octave_value >::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.

Array<octave_idx_type> Array< octave_value >::lookup ( const Array< octave_value > &  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.

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

Definition at line 104 of file Array.h.

Cell Cell::map ( ctype_mapper  fcn) const
private

Definition at line 309 of file Cell.cc.

References Array< octave_value >::data(), Array< octave_value >::dims(), Array< T >::fortran_vec(), and Array< octave_value >::numel().

Array<U> Array< octave_value >::map ( F  fcn) const
inlineinherited

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

This function is optimised with a manually unrolled loop.

Definition at line 659 of file Array.h.

References Array< T >::fortran_vec(), and jit_convention::length.

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

Overloads for function references.

Definition at line 691 of file Array.h.

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

Definition at line 696 of file Array.h.

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

Definition at line 589 of file Array.h.

References Array< T >::ArrayRep::count, Array< T >::ArrayRep::data, and Array< T >::ArrayRep::len.

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

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

Definition at line 487 of file Array.h.

References dim_vector::length().

Referenced by column().

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

Number of elements in the array.

Synonymous with capacity(), length(), and numel().

Definition at line 271 of file Array.h.

octave_idx_type Cell::nnz ( void  ) const

Definition at line 251 of file Cell.cc.

References gripe_wrong_type_arg().

Array< octave_value > Array< octave_value >::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 36 of file Array-tc.cc.

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

Number of elements in the array.

Synonymous with capacity(), length(), and nelem().

Definition at line 275 of file Array.h.

Referenced by Cell(), cellstr_value(), is_cellstr(), and map().

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

Definition at line 403 of file Array.h.

References elem.

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

Definition at line 404 of file Array.h.

References elem.

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

Definition at line 405 of file Array.h.

References elem.

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

Definition at line 407 of file Array.h.

References elem.

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

Definition at line 438 of file Array.h.

References elem.

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

Definition at line 439 of file Array.h.

References elem.

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

Definition at line 441 of file Array.h.

References elem.

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

Definition at line 444 of file Array.h.

References elem.

bool Array< octave_value >::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).

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

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

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

Definition at line 330 of file Array.h.

Array<octave_value > Array< octave_value >::permute ( const Array< octave_idx_type > &  vec,
bool  inv = false 
) const
inherited
void Array< octave_value >::print_info ( std::ostream &  os,
const std::string &  prefix 
) const
inherited
Cell Cell::reshape ( const dim_vector &  new_dims) const
inline

Definition at line 90 of file Cell.h.

References Array< T >::reshape().

Referenced by Fcell2struct(), octave_struct::subsasgn(), octave_cell::subsasgn(), and octave_class::subsasgn_common().

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

Definition at line 460 of file Array.h.

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

Referenced by Cell().

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

Definition at line 512 of file Array.h.

References Array< T >::resize().

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

Definition at line 509 of file Array.h.

References Array< T >::resize1().

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

Resizing (with fill).

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

Definition at line 503 of file Array.h.

octave_value Cell::resize_fill_value ( void  ) const
inlinevirtual

Reimplemented from Array< octave_value >.

Definition at line 112 of file Cell.h.

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

Definition at line 313 of file Array.h.

Referenced by column().

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

Sort by rows returns only indices.

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

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

Chop off leading singleton dimensions.

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

Generic any/all test functionality with arbitrary predicate.

Definition at line 702 of file Array.h.

References jit_convention::length.

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

Definition at line 714 of file Array.h.

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

Definition at line 726 of file Array.h.

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

Definition at line 729 of file Array.h.

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

Simpler calls.

Definition at line 710 of file Array.h.

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

Overloads for function references.

Definition at line 720 of file Array.h.

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

Definition at line 723 of file Array.h.

Array<octave_value > Array< octave_value >::transpose ( void  ) const
inherited
octave_value & Array< octave_value >::xelem ( octave_idx_type  n)
inlineinherited

Definition at line 353 of file Array.h.

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

Definition at line 354 of file Array.h.

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

Definition at line 356 of file Array.h.

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

Definition at line 358 of file Array.h.

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

Definition at line 361 of file Array.h.

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

Definition at line 363 of file Array.h.

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

Definition at line 366 of file Array.h.

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

Definition at line 369 of file Array.h.

Cell Cell::xisalnum ( void  ) const
inline

Definition at line 122 of file Cell.h.

References octave_value::xisalnum().

Cell Cell::xisalpha ( void  ) const
inline

Definition at line 123 of file Cell.h.

References octave_value::xisalpha().

Cell Cell::xisascii ( void  ) const
inline

Definition at line 124 of file Cell.h.

References octave_value::xisascii().

Cell Cell::xiscntrl ( void  ) const
inline

Definition at line 125 of file Cell.h.

References octave_value::xiscntrl().

Cell Cell::xisdigit ( void  ) const
inline

Definition at line 126 of file Cell.h.

References octave_value::xisdigit().

Cell Cell::xisgraph ( void  ) const
inline

Definition at line 127 of file Cell.h.

References octave_value::xisgraph().

Cell Cell::xislower ( void  ) const
inline

Definition at line 128 of file Cell.h.

References octave_value::xislower().

Cell Cell::xisprint ( void  ) const
inline

Definition at line 129 of file Cell.h.

References octave_value::xisprint().

Cell Cell::xispunct ( void  ) const
inline

Definition at line 130 of file Cell.h.

References octave_value::xispunct().

Cell Cell::xisspace ( void  ) const
inline

Definition at line 131 of file Cell.h.

References octave_value::xisspace().

Cell Cell::xisupper ( void  ) const
inline

Definition at line 132 of file Cell.h.

References octave_value::xisupper().

Cell Cell::xisxdigit ( void  ) const
inline

Definition at line 133 of file Cell.h.

References octave_value::xisxdigit().

Cell Cell::xtoascii ( void  ) const
inline

Definition at line 134 of file Cell.h.

References octave_value::xtoascii().

Cell Cell::xtolower ( void  ) const
inline

Definition at line 135 of file Cell.h.

References octave_value::xtolower().

Cell Cell::xtoupper ( void  ) const
inline

Definition at line 136 of file Cell.h.

References octave_value::xtoupper().

Member Data Documentation

dim_vector Array< octave_value >::dimensions
protectedinherited

Definition at line 127 of file Array.h.

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

Definition at line 129 of file Array.h.

octave_value * Array< octave_value >::slice_data
protectedinherited

Definition at line 138 of file Array.h.

octave_idx_type Array< octave_value >::slice_len
protectedinherited

Definition at line 139 of file Array.h.

The documentation for this class was generated from the following files:
Generated on Thu Jun 4 2015 23:30:49 for GNU Octave by   doxygen 1.8.8