GNU Octave 10.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
 
Loading...
Searching...
No Matches
Array< T, Alloc > Class Template Reference

N Dimensional Array with copy-on-write semantics. More...

#include "Array.h"

Inheritance diagram for Array< T, Alloc >:
DiagArray2< Complex > DiagArray2< double > DiagArray2< FloatComplex > DiagArray2< float > MArray< double > MArray< Complex > MArray< float > MArray< FloatComplex > MArray< octave_uint64 > MArray< octave_uint8 > MArray< octave_idx_type >

Classes

class  ArrayRep
 The real representation of all arrays. More...
 

Public Types

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

Public Member Functions

 Array ()
 Empty ctor (0 by 0).
 
 Array (Array< T, Alloc > &&a)
 
 Array (const Array< T, Alloc > &a)
 No type conversion case.
 
 Array (const Array< T, Alloc > &a, const dim_vector &dv)
 Reshape constructor.
 
template<typename U , typename A = Alloc>
 Array (const Array< U, A > &a)
 Type conversion case.
 
template<template< typename... > class Container>
 Array (const Container< T > &a, const dim_vector &dv)
 Constructor from standard library sequence containers.
 
 Array (const dim_vector &dv)
 nD uninitialized ctor.
 
 Array (const dim_vector &dv, const T &val)
 nD initialized ctor.
 
 Array (T *ptr, const dim_vector &dv, const Alloc &xallocator=Alloc())
 
virtual ~Array ()
 
Array< T, Allocas_column () const
 Return the array as a column vector.
 
Array< T, Allocas_matrix () const
 Return the array as a matrix.
 
Array< T, Allocas_row () const
 Return the array as a row vector.
 
void clear ()
 
void clear (const dim_vector &dv)
 
void clear (octave_idx_type r, octave_idx_type c)
 
void fill (const T &val)
 
Array< octave_idx_typefind (octave_idx_type, bool) const
 
Array< octave_idx_typefind (octave_idx_type, bool) const
 
sortmode is_sorted_rows (sortmode) const
 
sortmode is_sorted_rows (sortmode) const
 
sortmode issorted (sortmode) const
 
sortmode issorted (sortmode) const
 
Array< octave_idx_typelookup (const Array< octave::cdef_object > &, sortmode) const
 
Array< octave_idx_typelookup (const Array< octave::idx_vector > &, sortmode) const
 
octave_idx_type lookup (octave::cdef_object const &, sortmode) const
 
octave_idx_type lookup (octave::idx_vector const &, sortmode) const
 
void make_unique ()
 
octave_idx_type nnz () const
 
octave_idx_type nnz () const
 
Array< octave::cdef_object > nth_element (const octave::idx_vector &, int) const
 
Array< octave::idx_vector > nth_element (const octave::idx_vector &, int) const
 
octave_idx_type numel () const
 Number of elements in the array.
 
Array< T, Alloc > & operator= (Array< T, Alloc > &&a)
 
Array< T, Alloc > & operator= (const Array< T, Alloc > &a)
 
Array< octave::cdef_object > sort (Array< octave_idx_type > &sidx, int, sortmode) const
 
Array< octave::idx_vector > sort (Array< octave_idx_type > &sidx, int, sortmode) const
 
Array< octave::cdef_object > sort (int, sortmode) const
 
Array< octave::idx_vector > sort (int, sortmode) const
 
Array< octave_idx_typesort_rows_idx (sortmode) const
 
Array< octave_idx_typesort_rows_idx (sortmode) const
 
First dimension

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

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

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

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

Protected Member Functions

 Array (const Array< T, Alloc > &a, const dim_vector &dv, octave_idx_type l, octave_idx_type u)
 slice constructor
 

Protected Attributes

dim_vector m_dimensions
 
Array< T, Alloc >::ArrayRep * m_rep
 
T * m_slice_data
 
octave_idx_type m_slice_len
 

Third dimension

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

template<typename U , typename A >
class Array
 Size of the specified dimension.
 
octave_idx_type dim3 () const
 Size of the specified dimension.
 
octave_idx_type pages () const
 Size of the specified dimension.
 
size_type size (const size_type d) const
 Size of the specified dimension.
 
std::size_t byte_size () const
 Size of the specified dimension.
 
const dim_vectordims () const
 Return a const-reference so that dims ()(i) works efficiently.
 
Array< T, Allocsqueeze () const
 Chop off leading singleton dimensions.
 
octave_idx_type compute_index (octave_idx_type i, octave_idx_type j) const
 Size of the specified dimension.
 
octave_idx_type compute_index (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 Size of the specified dimension.
 
octave_idx_type compute_index (const Array< octave_idx_type > &ra_idx) const
 Size of the specified dimension.
 
octave_idx_type compute_index_unchecked (const Array< octave_idx_type > &ra_idx) const
 Size of the specified dimension.
 
T & xelem (octave_idx_type n)
 Size of the specified dimension.
 
crefT xelem (octave_idx_type n) const
 Size of the specified dimension.
 
T & xelem (octave_idx_type i, octave_idx_type j)
 Size of the specified dimension.
 
crefT xelem (octave_idx_type i, octave_idx_type j) const
 Size of the specified dimension.
 
T & xelem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 Size of the specified dimension.
 
crefT xelem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 Size of the specified dimension.
 
T & xelem (const Array< octave_idx_type > &ra_idx)
 Size of the specified dimension.
 
crefT xelem (const Array< octave_idx_type > &ra_idx) const
 Size of the specified dimension.
 
T & checkelem (octave_idx_type n)
 Size of the specified dimension.
 
T & checkelem (octave_idx_type i, octave_idx_type j)
 Size of the specified dimension.
 
T & checkelem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 Size of the specified dimension.
 
T & checkelem (const Array< octave_idx_type > &ra_idx)
 Size of the specified dimension.
 
T & elem (octave_idx_type n)
 Size of the specified dimension.
 
T & elem (octave_idx_type i, octave_idx_type j)
 Size of the specified dimension.
 
T & elem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 Size of the specified dimension.
 
T & elem (const Array< octave_idx_type > &ra_idx)
 Size of the specified dimension.
 
T & operator() (octave_idx_type n)
 Size of the specified dimension.
 
T & operator() (octave_idx_type i, octave_idx_type j)
 Size of the specified dimension.
 
T & operator() (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 Size of the specified dimension.
 
T & operator() (const Array< octave_idx_type > &ra_idx)
 Size of the specified dimension.
 
crefT checkelem (octave_idx_type n) const
 Size of the specified dimension.
 
crefT checkelem (octave_idx_type i, octave_idx_type j) const
 Size of the specified dimension.
 
crefT checkelem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 Size of the specified dimension.
 
crefT checkelem (const Array< octave_idx_type > &ra_idx) const
 Size of the specified dimension.
 
crefT elem (octave_idx_type n) const
 Size of the specified dimension.
 
crefT elem (octave_idx_type i, octave_idx_type j) const
 Size of the specified dimension.
 
crefT elem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 Size of the specified dimension.
 
crefT elem (const Array< octave_idx_type > &ra_idx) const
 Size of the specified dimension.
 
crefT operator() (octave_idx_type n) const
 Size of the specified dimension.
 
crefT operator() (octave_idx_type i, octave_idx_type j) const
 Size of the specified dimension.
 
crefT operator() (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 Size of the specified dimension.
 
crefT operator() (const Array< octave_idx_type > &ra_idx) const
 Size of the specified dimension.
 
Array< T, Alloccolumn (octave_idx_type k) const
 Extract column: A(:,k+1).
 
Array< T, Allocpage (octave_idx_type k) const
 Extract page: A(:,:,k+1).
 
Array< T, 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).
 
Array< T, Allocreshape (octave_idx_type nr, octave_idx_type nc) const
 Size of the specified dimension.
 
Array< T, Allocreshape (const dim_vector &new_dims) const
 Size of the specified dimension.
 
Array< T, Allocpermute (const Array< octave_idx_type > &vec, bool inv=false) const
 Size of the specified dimension.
 
Array< T, Allocipermute (const Array< octave_idx_type > &vec) const
 Size of the specified dimension.
 
bool issquare () const
 Size of the specified dimension.
 
bool isempty () const
 Size of the specified dimension.
 
bool isvector () const
 Size of the specified dimension.
 
bool is_nd_vector () const
 Size of the specified dimension.
 
Array< T, Alloctranspose () const
 Size of the specified dimension.
 
Array< T, Allochermitian (T(*fcn)(const T &)=nullptr) const
 Size of the specified dimension.
 
const T * data () const
 Size of the specified dimension.
 
T * rwdata ()
 Size of the specified dimension.
 
T * fortran_vec ()
 Size of the specified dimension.
 
bool is_shared () const
 Size of the specified dimension.
 
int ndims () const
 Size of the specified dimension.
 
Array< T, Allocindex (const octave::idx_vector &i) const
 Indexing without resizing.
 
Array< T, Allocindex (const octave::idx_vector &i, const octave::idx_vector &j) const
 Size of the specified dimension.
 
Array< T, Allocindex (const Array< octave::idx_vector > &ia) const
 Size of the specified dimension.
 
virtual T resize_fill_value () const
 Size of the specified dimension.
 
void resize2 (octave_idx_type nr, octave_idx_type nc, const T &rfv)
 Resizing (with fill).
 
void resize2 (octave_idx_type nr, octave_idx_type nc)
 Size of the specified dimension.
 
void resize1 (octave_idx_type n, const T &rfv)
 Size of the specified dimension.
 
void resize1 (octave_idx_type n)
 Size of the specified dimension.
 
void resize (const dim_vector &dv, const T &rfv)
 Size of the specified dimension.
 
void resize (const dim_vector &dv)
 Size of the specified dimension.
 
Array< T, Allocindex (const octave::idx_vector &i, bool resize_ok, const T &rfv) const
 Indexing with possible resizing and fill.
 
Array< T, Allocindex (const octave::idx_vector &i, bool resize_ok) const
 Size of the specified dimension.
 
Array< T, Allocindex (const octave::idx_vector &i, const octave::idx_vector &j, bool resize_ok, const T &rfv) const
 Size of the specified dimension.
 
Array< T, Allocindex (const octave::idx_vector &i, const octave::idx_vector &j, bool resize_ok) const
 Size of the specified dimension.
 
Array< T, Allocindex (const Array< octave::idx_vector > &ia, bool resize_ok, const T &rfv) const
 Size of the specified dimension.
 
Array< T, Allocindex (const Array< octave::idx_vector > &ia, bool resize_ok) const
 Size of the specified dimension.
 
void assign (const octave::idx_vector &i, const Array< T, Alloc > &rhs, const T &rfv)
 Indexed assignment (always with resize & fill).
 
void assign (const octave::idx_vector &i, const Array< T, Alloc > &rhs)
 Size of the specified dimension.
 
void assign (const octave::idx_vector &i, const octave::idx_vector &j, const Array< T, Alloc > &rhs, const T &rfv)
 Size of the specified dimension.
 
void assign (const octave::idx_vector &i, const octave::idx_vector &j, const Array< T, Alloc > &rhs)
 Size of the specified dimension.
 
void assign (const Array< octave::idx_vector > &ia, const Array< T, Alloc > &rhs, const T &rfv)
 Size of the specified dimension.
 
void assign (const Array< octave::idx_vector > &ia, const Array< T, Alloc > &rhs)
 Size of the specified dimension.
 
void delete_elements (const octave::idx_vector &i)
 Deleting elements.
 
void delete_elements (int dim, const octave::idx_vector &i)
 A(:,...,I,...,:) = [] (>= 2 subscripts, one of them is non-colon)
 
void delete_elements (const Array< octave::idx_vector > &ia)
 Dispatcher to the above two.
 
Array< T, Alloc > & insert (const Array< T, Alloc > &a, const Array< octave_idx_type > &idx)
 Insert an array into another at a specified position.
 
Array< T, Alloc > & insert (const Array< T, Alloc > &a, octave_idx_type r, octave_idx_type c)
 This is just a special case for idx = [r c 0 ...].
 
void maybe_economize ()
 Size of the specified dimension.
 
void print_info (std::ostream &os, const std::string &prefix) const
 Size of the specified dimension.
 
Array< T, Allocsort (int dim=0, sortmode mode=ASCENDING) const
 Size of the specified dimension.
 
Array< T, Allocsort (Array< octave_idx_type > &sidx, int dim=0, sortmode mode=ASCENDING) const
 Size of the specified dimension.
 
sortmode issorted (sortmode mode=UNSORTED) const
 Ordering is auto-detected or can be specified.
 
Array< octave_idx_typesort_rows_idx (sortmode mode=ASCENDING) const
 Sort by rows returns only indices.
 
sortmode is_sorted_rows (sortmode mode=UNSORTED) const
 Ordering is auto-detected or can be specified.
 
octave_idx_type lookup (const T &value, sortmode mode=UNSORTED) const
 Do a binary lookup in a sorted array.
 
Array< octave_idx_typelookup (const Array< T, Alloc > &values, sortmode mode=UNSORTED) const
 Ditto, but for an array of values, specializing on the case when values are sorted.
 
octave_idx_type nnz () const
 Count nonzero elements.
 
Array< octave_idx_typefind (octave_idx_type n=-1, bool backward=false) const
 Find indices of (at most n) nonzero elements.
 
Array< T, 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.
 
Array< T, Allocdiag (octave_idx_type k=0) const
 Get the kth super or subdiagonal.
 
Array< T, Allocdiag (octave_idx_type m, octave_idx_type n) const
 Size of the specified dimension.
 
template<typename U , typename F , typename A = std::allocator<U>>
Array< U, Amap (F fcn) const
 Apply function fcn to each element of the Array<T, Alloc>.
 
template<typename U , typename A = std::allocator<U>>
Array< U, Amap (U(&fcn)(T)) const
 Overloads for function references.
 
template<typename U , typename A = std::allocator<U>>
Array< U, Amap (U(&fcn)(const T &)) const
 Size of the specified dimension.
 
template<typename F , bool zero>
bool test (F fcn) const
 Generic any/all test functionality with arbitrary predicate.
 
template<typename F >
bool test_any (F fcn) const
 Simpler calls.
 
template<typename F >
bool test_all (F fcn) const
 Size of the specified dimension.
 
bool test_any (bool(&fcn)(T)) const
 Overloads for function references.
 
bool test_any (bool(&fcn)(const T &)) const
 Size of the specified dimension.
 
bool test_all (bool(&fcn)(T)) const
 Size of the specified dimension.
 
bool test_all (bool(&fcn)(const T &)) const
 Size of the specified dimension.
 
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.
 
static Array< T, Alloccat (int dim, octave_idx_type n, const Array< T, Alloc > *array_list)
 Concatenation along a specified (0-based) dimension, equivalent to cat().
 

Detailed Description

template<typename T, typename Alloc>
class Array< T, Alloc >

N Dimensional Array with copy-on-write semantics.

The Array class is at the root of Octave. It provides a container with an arbitrary number of dimensions. The operator () provides access to individual elements via subscript and linear indexing. Indexing starts at 0. Arrays are column-major order as in Fortran.

// 3 D Array with 10 rows, 20 columns, and 5 pages, filled with 7.0
Array<double> A (dim_vector (10, 20, 5), 7.0);
// set value for row 0, column 10, and page 3
A(0, 10, 3) = 2.5;
// get value for row 1, column 2, and page 0
double v = A(1, 2, 0);
// get value for 25th element (row 4, column 3, page 1)
double v = A(24);
N Dimensional Array with copy-on-write semantics.
Definition Array.h:130
Vector representing the dimensions (size) of an Array.
Definition dim-vector.h:90
F77_RET_T const F77_INT F77_CMPLX * A

Notes on STL compatibility

size() and length()

To access the total number of elements in an Array, use numel() which is short for number of elements and is equivalent to the Octave function with same name.

Array<int> A (dim_vector (10, 20, 4), 1);
octave_idx_type n = A.numel (); // returns 800 (10x20x4)
octave_idx_type nr = A.size (0); // returns 10 (number of rows/dimension 0)
octave_idx_type nc = A.size (1); // returns 20 (number of columns)
octave_idx_type nc = A.size (2); // returns 4 (size of dimension 3)
octave_idx_type l6 = A.size (6); // returns 1 (implicit singleton dimension)
// Alternatively, get a dim_vector which represents the dimensions.
dim_vector dims = A.dims ();
const dim_vector & dims() const
Return a const-reference so that dims ()(i) works efficiently.
Definition Array.h:507

The methods size() and length() as they exist in the STL cause confusion in the context of a N dimensional array.

The size() of an array is the length of all dimensions. In Octave, the size() function returns a row vector with the length of each dimension, or the size of a specific dimension. Only the latter is present in liboctave.

Since there is more than 1 dimension, length() would not make sense without expliciting which dimension. If the function existed, which length should it return? Octave length() function returns the length of the longest dimension which is an odd definition, only useful for vectors and square matrices. The alternatives numel(), rows(), columns(), and size(d) are more explicit and recommended.

size_type

Array::size_type is 'octave_idx_type' which is a typedef for 'int' or 'long int', depending whether Octave was configured for 64-bit indexing.

This is a signed integer which may cause problems when mixed with STL containers. The reason is that Octave interacts with Fortran routines, providing an interface many Fortran numeric libraries.

Subclasses

The following subclasses specializations, will be of most use:

Definition at line 129 of file Array.h.

Member Typedef Documentation

◆ compare_fcn_type

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

Definition at line 244 of file Array.h.

◆ crefT

template<typename T , typename Alloc >
typedef ref_param<T>::type Array< T, Alloc >::crefT

Definition at line 242 of file Array.h.

◆ element_type

template<typename T , typename Alloc >
typedef T Array< T, Alloc >::element_type

Definition at line 234 of file Array.h.

◆ size_type

template<typename T , typename Alloc >
typedef octave_idx_type Array< T, Alloc >::size_type

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

Definition at line 240 of file Array.h.

◆ value_type

template<typename T , typename Alloc >
typedef T Array< T, Alloc >::value_type

Definition at line 236 of file Array.h.

Constructor & Destructor Documentation

◆ Array() [1/10]

template<typename T , typename Alloc >
Array< T, Alloc >::Array ( const Array< T, Alloc > &  a,
const dim_vector dv,
octave_idx_type  l,
octave_idx_type  u 
)
inlineprotected

slice constructor

Definition at line 264 of file Array.h.

References dim_vector::chop_trailing_singletons(), and Array< T, Alloc >::ArrayRep::m_count.

◆ Array() [2/10]

template<typename T , typename Alloc >
Array< T, Alloc >::Array ( )
inline

Empty ctor (0 by 0).

Definition at line 279 of file Array.h.

References Array< T, Alloc >::ArrayRep::m_count.

◆ Array() [3/10]

template<typename T , typename Alloc >
Array< T, Alloc >::Array ( const dim_vector dv)
inlineexplicit

nD uninitialized ctor.

Definition at line 287 of file Array.h.

References dim_vector::chop_trailing_singletons().

◆ Array() [4/10]

template<typename T , typename Alloc >
Array< T, Alloc >::Array ( const dim_vector dv,
const T &  val 
)
inlineexplicit

nD initialized ctor.

Definition at line 296 of file Array.h.

References dim_vector::chop_trailing_singletons().

◆ Array() [5/10]

template<typename T , typename Alloc >
Array< T, Alloc >::Array ( T *  ptr,
const dim_vector dv,
const Alloc xallocator = Alloc () 
)
inlineexplicit

Definition at line 312 of file Array.h.

References dim_vector::chop_trailing_singletons().

◆ Array() [6/10]

◆ Array() [7/10]

template<typename T , typename Alloc >
template<template< typename... > class Container>
Array< T, Alloc >::Array ( const Container< T > &  a,
const dim_vector dv 
)

Constructor from standard library sequence containers.

Definition at line 959 of file Array.h.

References dim_vector::chop_trailing_singletons(), Array< T, Alloc >::m_dimensions, Array< T, Alloc >::m_slice_data, dim_vector::safe_numel(), dim_vector::str(), and x.

◆ Array() [8/10]

template<typename T , typename Alloc >
template<typename U , typename A = Alloc>
Array< T, Alloc >::Array ( const Array< U, A > &  a)
inline

Type conversion case.

Definition at line 330 of file Array.h.

◆ Array() [9/10]

template<typename T , typename Alloc >
Array< T, Alloc >::Array ( const Array< T, Alloc > &  a)
inline

No type conversion case.

Definition at line 337 of file Array.h.

References Array< T, Alloc >::ArrayRep::m_count.

◆ Array() [10/10]

template<typename T , typename Alloc >
Array< T, Alloc >::Array ( Array< T, Alloc > &&  a)
inline

Definition at line 344 of file Array.h.

◆ ~Array()

template<typename T , typename Alloc >
virtual Array< T, Alloc >::~Array ( )
inlinevirtual

Definition at line 355 of file Array.h.

References Array< T, Alloc >::ArrayRep::m_count.

Member Function Documentation

◆ as_column()

template<typename T , typename Alloc >
Array< T, Alloc > Array< T, Alloc >::as_column ( ) const
inline

Return the array as a column vector.

Definition at line 424 of file Array.h.

References Array< T, Alloc >::m_dimensions, dim_vector::ndims(), and numel().

◆ as_matrix()

template<typename T , typename Alloc >
Array< T, Alloc > Array< T, Alloc >::as_matrix ( ) const
inline

Return the array as a matrix.

Definition at line 446 of file Array.h.

References Array< T, Alloc >::m_dimensions, dim_vector::ndims(), and dim_vector::redim().

Referenced by Sparse< T, Alloc >::index().

◆ as_row()

template<typename T , typename Alloc >
Array< T, Alloc > Array< T, Alloc >::as_row ( ) const
inline

Return the array as a row vector.

Definition at line 435 of file Array.h.

References Array< T, Alloc >::m_dimensions, dim_vector::ndims(), and numel().

◆ assign() [1/6]

template<typename T , typename Alloc >
void Array< T, Alloc >::assign ( const Array< octave::idx_vector > &  ia,
const Array< T, Alloc > &  rhs 
)

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 1414 of file Array-base.cc.

◆ assign() [2/6]

template<typename T , typename Alloc >
void Array< T, Alloc >::assign ( const Array< octave::idx_vector > &  ia,
const Array< T, Alloc > &  rhs,
const T &  rfv 
)

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 1294 of file Array-base.cc.

References dim_vector::alloc(), dim_vector::chop_all_singletons(), dim_vector::chop_trailing_singletons(), Array< T, Alloc >::data(), Array< T, Alloc >::dims(), dim_vector::ndims(), Array< T, Alloc >::numel(), dim_vector::redim(), Array< T, Alloc >::reshape(), dim_vector::zero_by_zero(), and zero_dims_inquire().

◆ assign() [3/6]

template<typename T , typename Alloc >
void Array< T, Alloc >::assign ( const octave::idx_vector &  i,
const Array< T, Alloc > &  rhs 
)
inline

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

◆ assign() [4/6]

template<typename T , typename Alloc >
void Array< T, Alloc >::assign ( const octave::idx_vector &  i,
const Array< T, Alloc > &  rhs,
const T &  rfv 
)

◆ assign() [5/6]

template<typename T , typename Alloc >
void Array< T, Alloc >::assign ( const octave::idx_vector &  i,
const octave::idx_vector &  j,
const Array< T, Alloc > &  rhs 
)
inline

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

◆ assign() [6/6]

template<typename T , typename Alloc >
void Array< T, Alloc >::assign ( const octave::idx_vector &  i,
const octave::idx_vector &  j,
const Array< T, Alloc > &  rhs,
const T &  rfv 
)

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 1190 of file Array-base.cc.

References dim_vector::chop_all_singletons(), Array< T, Alloc >::data(), Array< T, Alloc >::dim1(), Array< T, Alloc >::dim2(), Array< T, Alloc >::dims(), dim_vector::ndims(), Array< T, Alloc >::numel(), numel(), dim_vector::redim(), Array< T, Alloc >::reshape(), dim_vector::zero_by_zero(), and zero_dims_inquire().

◆ byte_size()

template<typename T , typename Alloc >
std::size_t Array< T, Alloc >::byte_size ( ) const
inline

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

References numel().

Referenced by octave_cell::byte_size(), DiagArray2< T >::byte_size(), PermMatrix::byte_size(), octave_perm_matrix::load_binary(), and octave_perm_matrix::save_binary().

◆ cat()

template<typename T , typename Alloc >
Array< T, Alloc > Array< T, Alloc >::cat ( int  dim,
octave_idx_type  n,
const Array< T, Alloc > *  array_list 
)
static

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 2670 of file Array-base.cc.

References dim_vector::concat(), Array< T, Alloc >::dims(), dim_vector::hvcat(), dim_vector::ndims(), and dim_vector::zero_by_zero().

◆ checkelem() [1/8]

template<typename T , typename Alloc >
T & Array< T, Alloc >::checkelem ( const Array< octave_idx_type > &  ra_idx)

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 249 of file Array-base.cc.

References compute_index(), and ra_idx.

◆ checkelem() [2/8]

template<typename T , typename Alloc >
Array< T, Alloc >::crefT Array< T, Alloc >::checkelem ( const Array< octave_idx_type > &  ra_idx) const

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 284 of file Array-base.cc.

References compute_index(), and ra_idx.

◆ checkelem() [3/8]

template<typename T , typename Alloc >
T & Array< T, Alloc >::checkelem ( octave_idx_type  i,
octave_idx_type  j 
)

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 235 of file Array-base.cc.

References compute_index().

◆ checkelem() [4/8]

template<typename T , typename Alloc >
Array< T, Alloc >::crefT Array< T, Alloc >::checkelem ( octave_idx_type  i,
octave_idx_type  j 
) const

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 269 of file Array-base.cc.

References compute_index().

◆ checkelem() [5/8]

template<typename T , typename Alloc >
T & Array< T, Alloc >::checkelem ( octave_idx_type  i,
octave_idx_type  j,
octave_idx_type  k 
)

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 242 of file Array-base.cc.

References compute_index().

◆ checkelem() [6/8]

template<typename T , typename Alloc >
Array< T, Alloc >::crefT Array< T, Alloc >::checkelem ( octave_idx_type  i,
octave_idx_type  j,
octave_idx_type  k 
) const

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 276 of file Array-base.cc.

References compute_index().

◆ checkelem() [7/8]

◆ checkelem() [8/8]

template<typename T , typename Alloc >
Array< T, Alloc >::crefT Array< T, Alloc >::checkelem ( octave_idx_type  n) const

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 256 of file Array-base.cc.

◆ clear() [1/3]

◆ clear() [2/3]

template<typename T , typename Alloc >
void Array< T, Alloc >::clear ( const dim_vector dv)

◆ clear() [3/3]

template<typename T , typename Alloc >
void Array< T, Alloc >::clear ( octave_idx_type  r,
octave_idx_type  c 
)
inline

Definition at line 413 of file Array.h.

◆ cols()

template<typename T , typename Alloc >
octave_idx_type Array< T, Alloc >::cols ( ) const
inline

Definition at line 473 of file Array.h.

Referenced by aepbalance< MT >::aepbalance(), aepbalance< MT >::aepbalance(), aepbalance< MT >::aepbalance(), aepbalance< MT >::aepbalance(), ComplexMatrix::ComplexMatrix(), ComplexMatrix::ComplexMatrix(), FloatComplexMatrix::FloatComplexMatrix(), FloatComplexMatrix::FloatComplexMatrix(), FloatMatrix::FloatMatrix(), Matrix::Matrix(), airy(), airy(), ComplexMatrix::append(), Matrix::append(), ComplexMatrix::append(), ComplexMatrix::append(), ComplexMatrix::append(), ComplexMatrix::append(), ComplexMatrix::append(), Matrix::append(), FloatComplexMatrix::append(), FloatMatrix::append(), FloatComplexMatrix::append(), FloatComplexMatrix::append(), FloatComplexMatrix::append(), FloatComplexMatrix::append(), FloatComplexMatrix::append(), FloatMatrix::append(), FloatComplexMatrix::append(), FloatMatrix::append(), FloatComplexMatrix::append(), FloatMatrix::append(), ComplexMatrix::append(), Matrix::append(), ComplexMatrix::append(), Matrix::append(), biry(), biry(), ComplexMatrix::column_max(), Matrix::column_max(), FloatComplexMatrix::column_max(), FloatMatrix::column_max(), ComplexMatrix::column_min(), Matrix::column_min(), FloatComplexMatrix::column_min(), FloatMatrix::column_min(), ComplexMatrix::determinant(), Matrix::determinant(), FloatComplexMatrix::determinant(), FloatMatrix::determinant(), ComplexMatrix::diag(), Matrix::diag(), FloatComplexMatrix::diag(), FloatMatrix::diag(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), ComplexMatrix::fill(), ComplexMatrix::fill(), FloatComplexMatrix::fill(), FloatComplexMatrix::fill(), ComplexMatrix::fill(), Matrix::fill(), ComplexMatrix::fill(), Matrix::fill(), FloatComplexMatrix::fill(), FloatMatrix::fill(), FloatComplexMatrix::fill(), FloatMatrix::fill(), ComplexMatrix::fourier(), Matrix::fourier(), FloatComplexMatrix::fourier(), FloatMatrix::fourier(), ComplexMatrix::fourier2d(), Matrix::fourier2d(), FloatComplexMatrix::fourier2d(), FloatMatrix::fourier2d(), Fperms(), ComplexMatrix::ifourier(), Matrix::ifourier(), FloatComplexMatrix::ifourier(), FloatMatrix::ifourier(), ComplexMatrix::ifourier2d(), Matrix::ifourier2d(), FloatComplexMatrix::ifourier2d(), FloatMatrix::ifourier2d(), Sparse< T, Alloc >::index(), qr< T >::init(), qrp< T >::init(), qr< T >::init(), qrp< T >::init(), qr< T >::init(), qrp< T >::init(), qr< T >::init(), qrp< T >::init(), ComplexMatrix::insert(), Matrix::insert(), ComplexMatrix::insert(), ComplexMatrix::insert(), ComplexMatrix::insert(), ComplexMatrix::insert(), Matrix::insert(), FloatComplexMatrix::insert(), FloatMatrix::insert(), FloatComplexMatrix::insert(), FloatComplexMatrix::insert(), FloatComplexMatrix::insert(), FloatComplexMatrix::insert(), FloatMatrix::insert(), FloatComplexMatrix::insert(), FloatComplexMatrix::insert(), FloatMatrix::insert(), ComplexMatrix::insert(), ComplexMatrix::insert(), Matrix::insert(), qr< T >::insert_col(), qr< T >::insert_col(), qr< T >::insert_col(), qr< T >::insert_col(), ComplexMatrix::ishermitian(), FloatComplexMatrix::ishermitian(), Matrix::issymmetric(), FloatMatrix::issymmetric(), Matrix::lssolve(), ComplexMatrix::lssolve(), ComplexMatrix::lssolve(), FloatMatrix::lssolve(), FloatComplexMatrix::lssolve(), FloatComplexMatrix::lssolve(), FloatMatrix::lssolve(), Matrix::lssolve(), matrix_real_probe(), octave_print_internal(), octave_print_internal(), ComplexMatrix::operator+=(), ComplexMatrix::operator+=(), Matrix::operator+=(), FloatComplexMatrix::operator+=(), FloatComplexMatrix::operator+=(), FloatMatrix::operator+=(), FloatComplexMatrix::operator+=(), ComplexMatrix::operator+=(), ComplexMatrix::operator-=(), ComplexMatrix::operator-=(), Matrix::operator-=(), FloatComplexMatrix::operator-=(), FloatComplexMatrix::operator-=(), FloatMatrix::operator-=(), FloatComplexMatrix::operator-=(), ComplexMatrix::operator-=(), boolMatrix::operator==(), charMatrix::operator==(), ComplexMatrix::operator==(), FloatComplexMatrix::operator==(), FloatMatrix::operator==(), Matrix::operator==(), ComplexMatrix::pseudo_inverse(), Matrix::pseudo_inverse(), FloatComplexMatrix::pseudo_inverse(), FloatMatrix::pseudo_inverse(), ComplexMatrix::rcond(), Matrix::rcond(), FloatComplexMatrix::rcond(), FloatMatrix::rcond(), ComplexMatrix::row_max(), Matrix::row_max(), FloatComplexMatrix::row_max(), FloatMatrix::row_max(), ComplexMatrix::row_min(), Matrix::row_min(), FloatComplexMatrix::row_min(), FloatMatrix::row_min(), rsf2csf< ComplexMatrix, Matrix >(), rsf2csf< FloatComplexMatrix, FloatMatrix >(), octave_cell::save_ascii(), octave_char_matrix_str::save_ascii(), save_mat_ascii_data(), save_mat_binary_data(), ComplexMatrix::stack(), Matrix::stack(), ComplexMatrix::stack(), ComplexMatrix::stack(), ComplexMatrix::stack(), ComplexMatrix::stack(), ComplexMatrix::stack(), Matrix::stack(), FloatComplexMatrix::stack(), FloatMatrix::stack(), FloatComplexMatrix::stack(), FloatComplexMatrix::stack(), FloatComplexMatrix::stack(), FloatComplexMatrix::stack(), FloatComplexMatrix::stack(), FloatMatrix::stack(), FloatComplexMatrix::stack(), FloatMatrix::stack(), FloatComplexMatrix::stack(), FloatMatrix::stack(), ComplexMatrix::stack(), Matrix::stack(), ComplexMatrix::stack(), Matrix::stack(), octave_bool_matrix::try_narrowing_conversion(), qr< T >::update(), qr< T >::update(), qr< T >::update(), qr< T >::update(), xgemm(), xgemm(), xgemm(), xgemm(), xpow(), xpow(), xpow(), xpow(), xpow(), xpow(), xpow(), xpow(), xpow(), xpow(), xpow(), xpow(), xpow(), xpow(), xpow(), and xpow().

◆ column()

template<typename T , typename Alloc >
Array< T, Alloc > Array< T, Alloc >::column ( octave_idx_type  k) const

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

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

◆ columns()

template<typename T , typename Alloc >
octave_idx_type Array< T, Alloc >::columns ( ) const
inline

Definition at line 475 of file Array.h.

Referenced by lu< T >::lu(), lu< T >::lu(), lu< T >::lu(), lu< T >::lu(), type_info::assign_ops_map(), type_info::assignany_ops_map(), type_info::binary_ops_map(), column_norms(), type_info::compound_binary_ops_map(), octave_complex_matrix::diag(), octave_float_complex_matrix::diag(), octave_float_matrix::diag(), octave_matrix::diag(), octave_complex_matrix::diag(), octave_float_complex_matrix::diag(), octave_float_matrix::diag(), octave_matrix::diag(), opengl_renderer::draw_patch(), opengl_renderer::draw_surface(), elem_xdiv(), elem_xdiv(), elem_xdiv(), elem_xdiv(), elem_xdiv(), elem_xdiv(), elem_xdiv(), elem_xdiv(), F__delaunayn__(), F__dsearchn__(), F__event_manager_file_dialog__(), F__pchip_deriv__(), F__voronoi__(), Faudiowrite(), Fconvhulln(), Fstrrep(), Array< T, Alloc >::index(), Array< T, Alloc >::insert(), ComplexMatrix::inverse(), Matrix::inverse(), FloatComplexMatrix::inverse(), FloatMatrix::inverse(), max(), max(), max(), max(), max(), max(), max(), max(), max(), max(), min(), min(), min(), min(), min(), min(), min(), min(), min(), min(), type_info::non_const_unary_ops_map(), operator*(), operator*(), operator*(), operator*(), ComplexMatrix::row_is_real_only(), FloatComplexMatrix::row_is_real_only(), row_norms(), tree_evaluator::switch_case_label_matches(), type_info::unary_ops_map(), lu< T >::update(), lu< T >::update(), lu< T >::update(), lu< T >::update(), lu< T >::update(), lu< T >::update(), lu< T >::update(), lu< T >::update(), lu< T >::update_piv(), lu< T >::update_piv(), lu< T >::update_piv(), lu< T >::update_piv(), lu< T >::update_piv(), lu< T >::update_piv(), lu< T >::update_piv(), and lu< T >::update_piv().

◆ compute_index() [1/3]

template<typename T , typename Alloc >
octave_idx_type Array< T, Alloc >::compute_index ( const Array< octave_idx_type > &  ra_idx) const

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 208 of file Array-base.cc.

References ra_idx.

◆ compute_index() [2/3]

template<typename T , typename Alloc >
octave_idx_type Array< T, Alloc >::compute_index ( octave_idx_type  i,
octave_idx_type  j 
) const

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 193 of file Array-base.cc.

◆ compute_index() [3/3]

template<typename T , typename Alloc >
octave_idx_type Array< T, Alloc >::compute_index ( octave_idx_type  i,
octave_idx_type  j,
octave_idx_type  k 
) const

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 200 of file Array-base.cc.

◆ compute_index_unchecked()

template<typename T , typename Alloc >
octave_idx_type Array< T, Alloc >::compute_index_unchecked ( const Array< octave_idx_type > &  ra_idx) const

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 215 of file Array-base.cc.

References octave_base_value::numel(), and ra_idx.

◆ data()

template<typename T , typename Alloc >
const T * Array< T, Alloc >::data ( ) const
inline

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

Referenced by Cell::Cell(), NDArray::NDArray(), octave_bool_matrix::as_mxArray(), octave_cell::as_mxArray(), octave_char_matrix::as_mxArray(), octave_complex_matrix::as_mxArray(), octave_float_complex_matrix::as_mxArray(), octave_float_matrix::as_mxArray(), ov_range< T >::as_mxArray(), octave_matrix::as_mxArray(), octave_struct::as_mxArray(), octave_scalar_struct::as_mxArray(), Array< T, Alloc >::assign(), Array< T, Alloc >::assign(), Array< T, Alloc >::assign(), binmap(), binmap(), binmap(), blkmm_internal(), blkmm_internal(), blkmm_internal(), blkmm_internal(), cam2xform(), DiagArray2< T >::data(), do_bitpack(), do_bsxfun_op(), do_mm_binary_op(), do_mx_check(), do_mx_cum_op(), do_mx_cumminmax_op(), do_mx_cumminmax_op(), do_mx_diff_op(), do_mx_minmax_op(), do_mx_minmax_op(), do_mx_red_op(), do_sm_binary_op(), opengl_renderer::draw_patch(), opengl_renderer::draw_surface(), F__dsearchn__(), F__glpk__(), F__native2unicode__(), F__pchip_deriv__(), F__unicode2native__(), F__unicode_length__(), Fbase64_encode(), Fdot(), Fellipj(), filter(), Fordschur(), ComplexMatrix::fourier(), Matrix::fourier(), FloatComplexMatrix::fourier(), FloatMatrix::fourier(), ComplexNDArray::fourier(), NDArray::fourier(), FloatComplexNDArray::fourier(), FloatNDArray::fourier(), ComplexMatrix::fourier2d(), ComplexNDArray::fourier2d(), Matrix::fourier2d(), NDArray::fourier2d(), FloatComplexMatrix::fourier2d(), FloatMatrix::fourier2d(), FloatNDArray::fourier2d(), ComplexNDArray::fourierNd(), NDArray::fourierNd(), FloatComplexNDArray::fourierNd(), FloatNDArray::fourierNd(), Fperms(), Funicode_idx(), MArray< T >::idx_add(), MArray< T >::idx_add_nd(), MArray< T >::idx_max(), ComplexMatrix::ifourier(), Matrix::ifourier(), FloatComplexMatrix::ifourier(), ComplexNDArray::ifourier(), FloatComplexNDArray::ifourier(), ComplexMatrix::ifourier2d(), ComplexNDArray::ifourier2d(), FloatComplexMatrix::ifourier2d(), FloatComplexNDArray::ifourier2d(), ComplexNDArray::ifourierNd(), FloatComplexNDArray::ifourierNd(), octave_char_matrix::index_vector(), qr< T >::insert_col(), qr< T >::insert_col(), qr< T >::insert_col(), qr< T >::insert_col(), qr< T >::insert_col(), qr< T >::insert_col(), qr< T >::insert_col(), Array< T, Alloc >::lookup(), octave_cell::mex_get_data(), num2hex(), octinternal_do_mul_pm_sm(), octinternal_do_mul_sm_pm(), operator*(), operator*(), operator*(), operator*(), operator*(), operator*(), operator*(), operator*(), ComplexColumnVector::operator+=(), FloatComplexColumnVector::operator+=(), FloatComplexMatrix::operator+=(), FloatComplexRowVector::operator+=(), ComplexMatrix::operator+=(), ComplexRowVector::operator+=(), ComplexColumnVector::operator-=(), FloatComplexColumnVector::operator-=(), FloatComplexMatrix::operator-=(), FloatComplexRowVector::operator-=(), ComplexMatrix::operator-=(), ComplexRowVector::operator-=(), boolMatrix::operator==(), charMatrix::operator==(), ColumnVector::operator==(), ComplexColumnVector::operator==(), ComplexMatrix::operator==(), ComplexRowVector::operator==(), FloatColumnVector::operator==(), FloatComplexColumnVector::operator==(), FloatComplexMatrix::operator==(), FloatComplexRowVector::operator==(), FloatMatrix::operator==(), FloatRowVector::operator==(), Matrix::operator==(), RowVector::operator==(), ComplexMatrix::rcond(), Matrix::rcond(), FloatComplexMatrix::rcond(), FloatMatrix::rcond(), read_mat5_binary_element(), octave_char_matrix_str::save_ascii(), octave_bool_matrix::save_binary(), octave_complex_diag_matrix::save_binary(), octave_complex_matrix::save_binary(), octave_float_complex_diag_matrix::save_binary(), octave_float_complex_matrix::save_binary(), octave_float_diag_matrix::save_binary(), octave_float_matrix::save_binary(), octave_perm_matrix::save_binary(), octave_diag_matrix::save_binary(), octave_matrix::save_binary(), octave_char_matrix_str::save_binary(), octave_bool_matrix::save_hdf5(), octave_complex_matrix::save_hdf5(), octave_float_complex_matrix::save_hdf5(), octave_float_matrix::save_hdf5(), octave_matrix::save_hdf5(), save_mat5_binary_element(), save_mat5_element_length(), save_mat_binary_data(), opengl_renderer::set_clipbox(), opengl_renderer::set_color(), opengl_renderer::setup_opengl_transformation(), lu< T >::update_piv(), lu< T >::update_piv(), lu< T >::update_piv(), lu< T >::update_piv(), lu< T >::update_piv(), lu< T >::update_piv(), lu< T >::update_piv(), lu< T >::update_piv(), stream::write(), xgemm(), xgemm(), xgemm(), and xgemm().

◆ delete_elements() [1/3]

template<typename T , typename Alloc >
void Array< T, Alloc >::delete_elements ( const Array< octave::idx_vector > &  ia)

Dispatcher to the above two.

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

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

◆ delete_elements() [2/3]

template<typename T , typename Alloc >
void Array< T, Alloc >::delete_elements ( const octave::idx_vector &  i)

Deleting elements.

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

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

References numel(), and Array< T, Alloc >::rwdata().

Referenced by octave_map::delete_elements(), octave_map::delete_elements(), Cell::delete_elements(), and octave_map::delete_elements().

◆ delete_elements() [3/3]

template<typename T , typename Alloc >
void Array< T, Alloc >::delete_elements ( int  dim,
const octave::idx_vector &  i 
)

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

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

References dim_vector::resize(), and Array< T, Alloc >::rwdata().

◆ diag() [1/2]

template<typename T , typename Alloc >
Array< T, Alloc > Array< T, Alloc >::diag ( octave_idx_type  k = 0) const

◆ diag() [2/2]

template<typename T , typename Alloc >
Array< T, Alloc > Array< T, Alloc >::diag ( octave_idx_type  m,
octave_idx_type  n 
) const

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 2654 of file Array-base.cc.

References numel().

◆ dim1()

template<typename T , typename Alloc >
octave_idx_type Array< T, Alloc >::dim1 ( ) const
inline

◆ dim2()

template<typename T , typename Alloc >
octave_idx_type Array< T, Alloc >::dim2 ( ) const
inline

◆ dim3()

template<typename T , typename Alloc >
octave_idx_type Array< T, Alloc >::dim3 ( ) const
inline

Size of the specified dimension.

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

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

Definition at line 483 of file Array.h.

References dim_vector::ndims().

Referenced by base_text_renderer::rotate_pixels().

◆ dims()

template<typename T , typename Alloc >
const dim_vector & Array< T, Alloc >::dims ( ) const
inline

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

Definition at line 507 of file Array.h.

Referenced by NDArray::NDArray(), airy(), airy(), Array< T, Alloc >::assign(), Array< T, Alloc >::assign(), Array< T, Alloc >::assign(), octave_map::assign(), binmap(), binmap(), binmap(), biry(), biry(), bitopxx(), Array< T, Alloc >::cat(), NDArray::concat(), FloatNDArray::concat(), charNDArray::concat(), conv_to_int_array(), octave_map::delete_elements(), octave_map::delete_elements(), octave_map::delete_elements(), do_bitpack(), do_bsxfun_op(), do_inplace_bsxfun_op(), do_mm_binary_op(), do_mm_inplace_op(), do_mx_cum_op(), do_mx_cumminmax_op(), do_mx_cumminmax_op(), do_mx_diff_op(), do_mx_minmax_op(), do_mx_minmax_op(), do_mx_red_op(), do_simple_cellfun(), do_sm_binary_op(), opengl_renderer::draw_surface(), octave_char_matrix_str::edit_display(), elem_xdiv(), elem_xdiv(), elem_xdiv(), elem_xdiv(), elem_xdiv(), elem_xdiv(), elem_xdiv(), elem_xdiv(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), F__isprimelarge__(), F__make_valid_name__(), Fcell2struct(), Fcomplex(), Fellipj(), filter(), Fis_same_file(), Fisa(), Fisargout(), Fisfield(), Flookup(), ComplexNDArray::fourier(), NDArray::fourier(), FloatComplexNDArray::fourier(), FloatNDArray::fourier(), ComplexNDArray::fourier2d(), NDArray::fourier2d(), FloatNDArray::fourier2d(), ComplexNDArray::fourierNd(), NDArray::fourierNd(), FloatComplexNDArray::fourierNd(), FloatNDArray::fourierNd(), Fregexprep(), Frepelems(), Fstr2double(), Fstrfind(), Fstrrep(), Fstruct(), Funicode_idx(), hex2num(), MArray< T >::idx_add_nd(), ComplexNDArray::ifourier(), NDArray::ifourier(), FloatComplexNDArray::ifourier(), FloatNDArray::ifourier(), ComplexNDArray::ifourier2d(), NDArray::ifourier2d(), FloatComplexNDArray::ifourier2d(), FloatNDArray::ifourier2d(), ComplexNDArray::ifourierNd(), NDArray::ifourierNd(), FloatComplexNDArray::ifourierNd(), FloatNDArray::ifourierNd(), octave_map::index(), octave_map::index(), octave_map::index(), Array< T, Alloc >::insert(), ComplexNDArray::insert(), FloatComplexNDArray::insert(), Array< T, Alloc >::lookup(), octave_float_matrix::map(), octave_matrix::map(), map_2_xldexp(), cdef_object::map_value(), num2hex(), octave_print_internal(), operator<<(), octave_map::permute(), octave_cell::print_raw(), octave_map::setfield(), sizes_cmp(), Array< T, Alloc >::sort(), and cdef_object_array::subsasgn().

◆ elem() [1/8]

template<typename T , typename Alloc >
T & Array< T, Alloc >::elem ( const Array< octave_idx_type > &  ra_idx)
inline

Size of the specified dimension.

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

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

Definition at line 575 of file Array.h.

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

◆ elem() [2/8]

template<typename T , typename Alloc >
crefT Array< T, Alloc >::elem ( const Array< octave_idx_type > &  ra_idx) const
inline

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

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

◆ elem() [3/8]

template<typename T , typename Alloc >
T & Array< T, Alloc >::elem ( octave_idx_type  i,
octave_idx_type  j 
)
inline

Size of the specified dimension.

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

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

Definition at line 569 of file Array.h.

◆ elem() [4/8]

template<typename T , typename Alloc >
crefT Array< T, Alloc >::elem ( octave_idx_type  i,
octave_idx_type  j 
) const
inline

Size of the specified dimension.

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

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

Definition at line 600 of file Array.h.

◆ elem() [5/8]

template<typename T , typename Alloc >
T & Array< T, Alloc >::elem ( octave_idx_type  i,
octave_idx_type  j,
octave_idx_type  k 
)
inline

Size of the specified dimension.

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

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

Definition at line 572 of file Array.h.

◆ elem() [6/8]

template<typename T , typename Alloc >
crefT Array< T, Alloc >::elem ( octave_idx_type  i,
octave_idx_type  j,
octave_idx_type  k 
) const
inline

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

◆ elem() [7/8]

template<typename T , typename Alloc >
T & Array< T, Alloc >::elem ( octave_idx_type  n)
inline

Size of the specified dimension.

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

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

Definition at line 563 of file Array.h.

Referenced by ComplexMatrix::ComplexMatrix(), ComplexMatrix::ComplexMatrix(), ComplexMatrix::ComplexMatrix(), ComplexMatrix::ComplexMatrix(), ComplexMatrix::ComplexMatrix(), ComplexMatrix::ComplexMatrix(), ComplexMatrix::ComplexMatrix(), FloatComplexMatrix::FloatComplexMatrix(), FloatComplexMatrix::FloatComplexMatrix(), FloatComplexMatrix::FloatComplexMatrix(), FloatComplexMatrix::FloatComplexMatrix(), FloatComplexMatrix::FloatComplexMatrix(), FloatComplexMatrix::FloatComplexMatrix(), FloatComplexMatrix::FloatComplexMatrix(), FloatMatrix::FloatMatrix(), FloatMatrix::FloatMatrix(), FloatMatrix::FloatMatrix(), FloatMatrix::FloatMatrix(), FloatMatrix::FloatMatrix(), Matrix::Matrix(), Matrix::Matrix(), Matrix::Matrix(), Matrix::Matrix(), Matrix::Matrix(), Sparse< T, Alloc >::Sparse(), ComplexNDArray::all_integers(), NDArray::all_integers(), FloatComplexNDArray::all_integers(), FloatNDArray::all_integers(), aepbalance< MT >::balancing_matrix(), octave_complex_matrix::char_array_value(), octave_float_complex_matrix::char_array_value(), octave_float_matrix::char_array_value(), ov_range< T >::char_array_value(), octave_matrix::char_array_value(), ComplexMatrix::column_is_real_only(), FloatComplexMatrix::column_is_real_only(), ComplexMatrix::column_max(), Matrix::column_max(), FloatComplexMatrix::column_max(), FloatMatrix::column_max(), ComplexMatrix::column_min(), Matrix::column_min(), FloatComplexMatrix::column_min(), FloatMatrix::column_min(), NDArray::concat(), FloatNDArray::concat(), charNDArray::concat(), conv_to_int_array(), ddasrt_j(), delete_graphics_objects(), ComplexMatrix::determinant(), Matrix::determinant(), FloatComplexMatrix::determinant(), FloatMatrix::determinant(), DiagArray2< T >::dgelem(), DiagArray2< T >::dgelem(), LSODE::do_integrate(), LSODE::do_integrate(), Array< T, Alloc >::elem(), DiagArray2< T >::elem(), DiagArray2< T >::elem(), elem_xdiv(), elem_xdiv(), elem_xdiv(), elem_xdiv(), ComplexRowVector::extract(), RowVector::extract(), FloatComplexRowVector::extract(), FloatRowVector::extract(), ComplexDiagMatrix::extract(), charMatrix::extract(), DiagMatrix::extract(), FloatComplexDiagMatrix::extract(), FloatDiagMatrix::extract(), ComplexColumnVector::extract(), ColumnVector::extract(), FloatComplexColumnVector::extract(), FloatColumnVector::extract(), ComplexRowVector::extract_n(), RowVector::extract_n(), FloatComplexRowVector::extract_n(), FloatRowVector::extract_n(), ComplexColumnVector::extract_n(), ColumnVector::extract_n(), FloatComplexColumnVector::extract_n(), FloatColumnVector::extract_n(), ComplexDiagMatrix::fill(), DiagMatrix::fill(), ComplexDiagMatrix::fill(), ComplexDiagMatrix::fill(), ComplexDiagMatrix::fill(), ComplexDiagMatrix::fill(), FloatDiagMatrix::fill(), FloatComplexDiagMatrix::fill(), FloatDiagMatrix::fill(), FloatComplexDiagMatrix::fill(), FloatComplexDiagMatrix::fill(), FloatComplexDiagMatrix::fill(), FloatComplexDiagMatrix::fill(), FloatComplexDiagMatrix::fill(), FloatDiagMatrix::fill(), FloatComplexDiagMatrix::fill(), FloatDiagMatrix::fill(), ComplexDiagMatrix::fill(), DiagMatrix::fill(), ComplexDiagMatrix::fill(), DiagMatrix::fill(), qr< T >::form(), qr< T >::form(), qr< T >::form(), qr< T >::form(), Fsymrcm(), Givens(), Givens(), Givens(), Givens(), ComplexColumnVector::insert(), ColumnVector::insert(), ComplexMatrix::insert(), Matrix::insert(), ComplexColumnVector::insert(), ComplexMatrix::insert(), ComplexRowVector::insert(), ComplexMatrix::insert(), FloatComplexColumnVector::insert(), FloatColumnVector::insert(), FloatComplexMatrix::insert(), FloatMatrix::insert(), FloatComplexColumnVector::insert(), FloatComplexMatrix::insert(), FloatComplexRowVector::insert(), FloatComplexMatrix::insert(), FloatComplexMatrix::insert(), FloatComplexRowVector::insert(), FloatRowVector::insert(), FloatComplexMatrix::insert(), FloatMatrix::insert(), ComplexMatrix::insert(), ComplexNDArray::insert(), FloatComplexNDArray::insert(), ComplexRowVector::insert(), RowVector::insert(), ComplexMatrix::insert(), Matrix::insert(), DASPK::integrate(), DASSL::integrate(), DASPK::integrate(), DASSL::integrate(), ComplexMatrix::inverse(), Matrix::inverse(), FloatComplexMatrix::inverse(), FloatMatrix::inverse(), ComplexMatrix::ishermitian(), Matrix::issymmetric(), FloatMatrix::issymmetric(), octave_bool_matrix::load_ascii(), octave_cell::load_ascii(), octave_cell::load_binary(), octave_bool_matrix::load_hdf5(), octave_cell::load_hdf5(), Matrix::lssolve(), ComplexMatrix::lssolve(), ComplexMatrix::lssolve(), FloatMatrix::lssolve(), FloatComplexMatrix::lssolve(), FloatComplexMatrix::lssolve(), FloatMatrix::lssolve(), Matrix::lssolve(), matrix_real_probe(), SparseBoolMatrix::matrix_value(), ComplexColumnVector::max(), ComplexRowVector::max(), ColumnVector::max(), RowVector::max(), FloatComplexColumnVector::max(), FloatColumnVector::max(), FloatComplexRowVector::max(), FloatRowVector::max(), SparseComplexMatrix::max(), SparseMatrix::max(), ComplexColumnVector::min(), ComplexRowVector::min(), ColumnVector::min(), RowVector::min(), FloatComplexColumnVector::min(), FloatColumnVector::min(), FloatComplexRowVector::min(), FloatRowVector::min(), SparseComplexMatrix::min(), SparseMatrix::min(), boolMatrix::operator!(), intNDArray< T >::operator!(), operator*(), ComplexMatrix::operator+=(), ComplexMatrix::operator+=(), Matrix::operator+=(), FloatComplexMatrix::operator+=(), FloatComplexMatrix::operator+=(), FloatMatrix::operator+=(), ComplexMatrix::operator-=(), ComplexMatrix::operator-=(), Matrix::operator-=(), FloatComplexMatrix::operator-=(), FloatComplexMatrix::operator-=(), FloatMatrix::operator-=(), operator<<(), operator<<(), operator>>(), bp_table::parse_dbfunction_params(), Array< T, Alloc >::permute(), plus_or_minus(), plus_or_minus(), ComplexMatrix::pseudo_inverse(), Matrix::pseudo_inverse(), FloatComplexMatrix::pseudo_inverse(), FloatMatrix::pseudo_inverse(), read_mat_ascii_data(), ComplexMatrix::row_is_real_only(), FloatComplexMatrix::row_is_real_only(), ComplexMatrix::row_max(), Matrix::row_max(), FloatComplexMatrix::row_max(), FloatMatrix::row_max(), ComplexMatrix::row_min(), Matrix::row_min(), FloatComplexMatrix::row_min(), FloatMatrix::row_min(), octave_cell::save_ascii(), octave_cell::save_binary(), and octave_cell::save_hdf5().

◆ elem() [8/8]

template<typename T , typename Alloc >
crefT Array< T, Alloc >::elem ( octave_idx_type  n) const
inline

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

◆ fill()

template<typename T , typename Alloc >
void Array< T, Alloc >::fill ( const T &  val)

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

References numel().

◆ find() [1/3]

template<typename T , typename Alloc >
Array< octave_idx_type > Array< T, Alloc >::find ( octave_idx_type  n = -1,
bool  backward = false 
) const

Find indices of (at most n) nonzero elements.

If n is specified, backward specifies search from backward.

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

References Array< T, Alloc >::clear(), Array< T, Alloc >::isempty(), Array< T, Alloc >::m_dimensions, Array< T, Alloc >::numel(), numel(), Array< T, Alloc >::resize2(), and Array< T, Alloc >::rwdata().

Referenced by find_nonzero_elem_idx(), and cdef_class::make_meta_class().

◆ find() [2/3]

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

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

◆ find() [3/3]

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

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

◆ fortran_vec()

template<typename T , typename Alloc >
T * Array< T, Alloc >::fortran_vec ( )
inline

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

◆ hermitian()

template<typename T , typename Alloc >
Array< T, Alloc > Array< T, Alloc >::hermitian ( T(*)(const T &)  fcn = nullptr) const

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 1689 of file Array-base.cc.

References liboctave_panic_unless, and Array< T, Alloc >::xelem().

Referenced by MArray< T >::hermitian().

◆ index() [1/9]

template<typename T , typename Alloc >
Array< T, Alloc > Array< T, Alloc >::index ( const Array< octave::idx_vector > &  ia) const

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 843 of file Array-base.cc.

◆ index() [2/9]

template<typename T , typename Alloc >
Array< T, Alloc > Array< T, Alloc >::index ( const Array< octave::idx_vector > &  ia,
bool  resize_ok 
) const

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 1136 of file Array-base.cc.

◆ index() [3/9]

template<typename T , typename Alloc >
Array< T, Alloc > Array< T, Alloc >::index ( const Array< octave::idx_vector > &  ia,
bool  resize_ok,
const T &  rfv 
) const

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 1105 of file Array-base.cc.

References dim_vector::alloc(), Array< T, Alloc >::index(), Array< T, Alloc >::m_dimensions, Array< T, Alloc >::numel(), dim_vector::redim(), and Array< T, Alloc >::resize().

◆ index() [4/9]

◆ index() [5/9]

template<typename T , typename Alloc >
Array< T, Alloc > Array< T, Alloc >::index ( const octave::idx_vector &  i,
bool  resize_ok 
) const
inline

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

◆ index() [6/9]

template<typename T , typename Alloc >
Array< T, Alloc > Array< T, Alloc >::index ( const octave::idx_vector &  i,
bool  resize_ok,
const T &  rfv 
) const

Indexing with possible resizing and fill.

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

References Array< T, Alloc >::index(), Array< T, Alloc >::numel(), numel(), and Array< T, Alloc >::resize1().

◆ index() [7/9]

template<typename T , typename Alloc >
Array< T, Alloc > Array< T, Alloc >::index ( const octave::idx_vector &  i,
const octave::idx_vector &  j 
) const

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 785 of file Array-base.cc.

References dim_vector::redim().

◆ index() [8/9]

template<typename T , typename Alloc >
Array< T, Alloc > Array< T, Alloc >::index ( const octave::idx_vector &  i,
const octave::idx_vector &  j,
bool  resize_ok 
) const
inline

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

◆ index() [9/9]

template<typename T , typename Alloc >
Array< T, Alloc > Array< T, Alloc >::index ( const octave::idx_vector &  i,
const octave::idx_vector &  j,
bool  resize_ok,
const T &  rfv 
) const

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 1077 of file Array-base.cc.

References Array< T, Alloc >::columns(), Array< T, Alloc >::index(), dim_vector::redim(), Array< T, Alloc >::resize2(), and Array< T, Alloc >::rows().

◆ insert() [1/2]

◆ insert() [2/2]

template<typename T , typename Alloc >
Array< T, Alloc > & Array< T, Alloc >::insert ( const Array< T, Alloc > &  a,
octave_idx_type  r,
octave_idx_type  c 
)

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

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

References Array< T, Alloc >::columns(), Array< T, Alloc >::m_dimensions, Array< T, Alloc >::ndims(), and Array< T, Alloc >::rows().

◆ ipermute()

template<typename T , typename Alloc >
Array< T, Alloc > Array< T, Alloc >::ipermute ( const Array< octave_idx_type > &  vec) const
inline

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

Referenced by MArray< T >::ipermute().

◆ is_nd_vector()

template<typename T , typename Alloc >
bool Array< T, Alloc >::is_nd_vector ( ) const
inline

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

References dim_vector::is_nd_vector().

◆ is_shared()

template<typename T , typename Alloc >
bool Array< T, Alloc >::is_shared ( ) const
inline

Size of the specified dimension.

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

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

Definition at line 676 of file Array.h.

References Array< T, Alloc >::ArrayRep::m_count.

Referenced by mx_el_or_assign(), operator*=(), operator+=(), operator+=(), operator-=(), operator-=(), operator/=(), operator/=(), operator/=(), product_eq(), and quotient_eq().

◆ is_sorted_rows() [1/3]

template<typename T , typename Alloc >
sortmode Array< T, Alloc >::is_sorted_rows ( sortmode  mode = UNSORTED) const

Ordering is auto-detected or can be specified.

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

References ASCENDING, DESCENDING, octave_sort< T >::is_sorted_rows(), safe_comparator(), octave_sort< T >::set_compare(), and UNSORTED.

Referenced by octave_cell::is_sorted_rows().

◆ is_sorted_rows() [2/3]

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

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

◆ is_sorted_rows() [3/3]

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

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

◆ isempty()

◆ issorted() [1/3]

template<typename T , typename Alloc >
sortmode Array< T, Alloc >::issorted ( sortmode  mode = UNSORTED) const

Ordering is auto-detected or can be specified.

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

References ASCENDING, DESCENDING, octave_sort< T >::issorted(), numel(), safe_comparator(), octave_sort< T >::set_compare(), and UNSORTED.

Referenced by F__ode15__(), octave_cell::issorted(), and Array< T, Alloc >::lookup().

◆ issorted() [2/3]

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

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

◆ issorted() [3/3]

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

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

◆ issquare()

template<typename T , typename Alloc >
bool Array< T, Alloc >::issquare ( ) const
inline

Size of the specified dimension.

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

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

Definition at line 649 of file Array.h.

Referenced by ComplexMatrix::ishermitian(), FloatComplexMatrix::ishermitian(), Matrix::issymmetric(), and FloatMatrix::issymmetric().

◆ isvector()

template<typename T , typename Alloc >
bool Array< T, Alloc >::isvector ( ) const
inline

Size of the specified dimension.

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

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

Definition at line 655 of file Array.h.

References dim_vector::isvector().

Referenced by Ffilter(), read_mat5_binary_element(), and sizes_cmp().

◆ linear_slice()

template<typename T , typename Alloc >
Array< T, Alloc > Array< T, Alloc >::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).

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

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

◆ lookup() [1/6]

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

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

◆ lookup() [2/6]

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

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

◆ lookup() [3/6]

template<typename T , typename Alloc >
Array< octave_idx_type > Array< T, Alloc >::lookup ( const Array< T, Alloc > &  values,
sortmode  mode = UNSORTED 
) const

◆ lookup() [4/6]

template<typename T , typename Alloc >
octave_idx_type Array< T, Alloc >::lookup ( const T &  value,
sortmode  mode = UNSORTED 
) const

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 2185 of file Array-base.cc.

References ASCENDING, DESCENDING, octave_sort< T >::descending_compare(), octave_sort< T >::lookup(), numel(), octave_sort< T >::set_compare(), and UNSORTED.

Referenced by Flookup().

◆ lookup() [5/6]

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

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

◆ lookup() [6/6]

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

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

◆ make_unique()

template<typename T , typename Alloc >
void Array< T, Alloc >::make_unique ( )
inline

Definition at line 220 of file Array.h.

References Array< T, Alloc >::ArrayRep::m_data.

Referenced by ComplexColumnVector::fill(), ComplexMatrix::fill(), ComplexRowVector::fill(), ComplexRowVector::fill(), ComplexMatrix::fill(), ComplexColumnVector::fill(), FloatComplexColumnVector::fill(), FloatComplexMatrix::fill(), FloatComplexRowVector::fill(), FloatComplexRowVector::fill(), FloatComplexMatrix::fill(), FloatComplexColumnVector::fill(), ComplexColumnVector::fill(), ComplexMatrix::fill(), ComplexRowVector::fill(), Matrix::fill(), RowVector::fill(), ComplexRowVector::fill(), RowVector::fill(), ComplexMatrix::fill(), Matrix::fill(), ComplexColumnVector::fill(), ColumnVector::fill(), FloatComplexColumnVector::fill(), FloatComplexMatrix::fill(), FloatComplexRowVector::fill(), FloatMatrix::fill(), FloatRowVector::fill(), FloatComplexRowVector::fill(), FloatRowVector::fill(), FloatComplexMatrix::fill(), FloatMatrix::fill(), FloatComplexColumnVector::fill(), FloatColumnVector::fill(), imag(), imag(), ComplexColumnVector::insert(), ColumnVector::insert(), ComplexMatrix::insert(), Matrix::insert(), ComplexColumnVector::insert(), ComplexMatrix::insert(), ComplexMatrix::insert(), ComplexRowVector::insert(), ComplexMatrix::insert(), Matrix::insert(), FloatComplexColumnVector::insert(), FloatColumnVector::insert(), FloatComplexMatrix::insert(), FloatMatrix::insert(), FloatComplexColumnVector::insert(), FloatComplexMatrix::insert(), FloatComplexMatrix::insert(), FloatComplexRowVector::insert(), FloatComplexMatrix::insert(), FloatMatrix::insert(), FloatComplexMatrix::insert(), FloatComplexRowVector::insert(), FloatRowVector::insert(), FloatComplexMatrix::insert(), FloatMatrix::insert(), ComplexMatrix::insert(), ComplexRowVector::insert(), RowVector::insert(), ComplexMatrix::insert(), Matrix::insert(), octave_cell::subsasgn(), and octave_struct::subsasgn().

◆ map() [1/3]

template<typename T , typename Alloc >
template<typename U , typename F , typename A = std::allocator<U>>
Array< U, A > Array< T, Alloc >::map ( fcn) const
inline

◆ map() [2/3]

template<typename T , typename Alloc >
template<typename U , typename A = std::allocator<U>>
Array< U, A > Array< T, Alloc >::map ( U(&)(const T &)  fcn) const
inline

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

◆ map() [3/3]

template<typename T , typename Alloc >
template<typename U , typename A = std::allocator<U>>
Array< U, A > Array< T, Alloc >::map ( U(&)(T)  fcn) const
inline

Overloads for function references.

Definition at line 897 of file Array.h.

◆ maybe_economize()

template<typename T , typename Alloc >
void Array< T, Alloc >::maybe_economize ( )
inline

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

References Array< T, Alloc >::ArrayRep::m_count, Array< T, Alloc >::ArrayRep::m_data, and Array< T, Alloc >::ArrayRep::m_len.

◆ ndims()

◆ nnz() [1/3]

octave_idx_type Array< octave::cdef_object >::nnz ( ) const

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

◆ nnz() [2/3]

octave_idx_type Array< octave::idx_vector >::nnz ( ) const

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

◆ nnz() [3/3]

template<typename T , typename Alloc >
octave_idx_type Array< T, Alloc >::nnz ( ) const

Count nonzero elements.

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

References numel().

Referenced by idx_vector::idx_vector(), and F__magick_finfo__().

◆ nth_element() [1/3]

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

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

◆ nth_element() [2/3]

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

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

◆ nth_element() [3/3]

template<typename T , typename Alloc >
Array< T, Alloc > Array< T, Alloc >::nth_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.

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

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

References ASCENDING, DESCENDING, Array< T, Alloc >::isempty(), octave_sort< T >::nth_element(), numel(), OCTAVE_LOCAL_BUFFER, Array< T, Alloc >::rwdata(), octave_sort< T >::set_compare(), and UNSORTED.

Referenced by Fnth_element().

◆ numel()

template<typename T , typename Alloc >
octave_idx_type Array< T, Alloc >::numel ( ) const
inline

Number of elements in the array.

Definition at line 418 of file Array.h.

Referenced by Array< octave_value >::Array(), Array< T, Alloc >::Array(), Cell::Cell(), ComplexMatrix::ComplexMatrix(), ComplexNDArray::ComplexNDArray(), DiagArray2< T >::DiagArray2(), FloatComplexMatrix::FloatComplexMatrix(), FloatComplexNDArray::FloatComplexNDArray(), FloatNDArray::FloatNDArray(), idx_vector::idx_vector(), NDArray::NDArray(), NDArray::NDArray(), octave_value_list::octave_value_list(), octave_value_list::octave_value_list(), Sparse< T, Alloc >::Sparse(), sparse_lu< lu_type >::sparse_lu(), sparse_lu< lu_type >::sparse_lu(), ComplexNDArray::all_integers(), NDArray::all_integers(), FloatComplexNDArray::all_integers(), FloatNDArray::all_integers(), all_ones(), any_ones(), ComplexMatrix::append(), Matrix::append(), ComplexMatrix::append(), ComplexMatrix::append(), ComplexRowVector::append(), FloatComplexMatrix::append(), FloatMatrix::append(), FloatComplexMatrix::append(), FloatComplexMatrix::append(), FloatComplexRowVector::append(), FloatComplexMatrix::append(), FloatComplexRowVector::append(), FloatMatrix::append(), FloatRowVector::append(), ComplexMatrix::append(), ComplexRowVector::append(), Matrix::append(), RowVector::append(), octave_value_list::array_value(), Array< T, Alloc >::assign(), Array< T, Alloc >::assign(), Array< T, Alloc >::assign(), binmap(), binmap(), binmap(), bitopxx(), octave_cell::break_closure_cycles(), octave_class::break_closure_cycles(), octave_struct::break_closure_cycles(), calc_dimensions(), PermMatrix::checkelem(), gh_manager::close_all_figures(), boolNDArray::concat(), charNDArray::concat(), NDArray::concat(), FloatNDArray::concat(), ComplexNDArray::concat(), NDArray::concat(), FloatComplexNDArray::concat(), FloatNDArray::concat(), FloatComplexNDArray::concat(), FloatNDArray::concat(), charNDArray::concat(), ComplexNDArray::concat(), NDArray::concat(), concat(), concat(), conv_to_int_array(), tree_evaluator::convert_return_list_to_const_vector(), bp_table::dbstop_process_map_args(), error_system::default_warning_state(), DEFMETHOD(), DEFMETHOD(), DEFMETHOD(), DEFMETHOD(), DEFMETHODX(), qr< T >::delete_col(), Array< T, Alloc >::delete_elements(), delete_graphics_objects(), Array< octave_value >::diag(), DiagArray2< T >::diag_length(), PermMatrix::dim1(), PermMatrix::dim2(), error_system::display_warning_options(), do_bitpack(), do_bsxfun_op(), do_inplace_bsxfun_op(), LSODE::do_integrate(), LSODE::do_integrate(), DASPK::do_integrate(), DASSL::do_integrate(), LSODE::do_integrate(), DefQuad::do_integrate(), FloatDefQuad::do_integrate(), do_mat2cell(), do_mat2cell_nd(), do_minmax_bin_op< charNDArray >(), do_mm_binary_op(), do_mm_inplace_op(), do_ms_binary_op(), do_ms_inplace_op(), do_mx_check(), do_mx_inplace_op(), do_mx_unary_op(), do_simple_cellfun(), do_sm_binary_op(), chol< T >::downdate(), chol< T >::downdate(), chol< T >::downdate(), chol< T >::downdate(), opengl_renderer::draw(), opengl_renderer::draw_line(), opengl_renderer::draw_marker(), opengl_renderer::draw_patch(), opengl_renderer::draw_scatter(), opengl_renderer::draw_text(), EigsComplexNonSymmetricFunc(), EigsComplexNonSymmetricMatrix(), EigsComplexNonSymmetricMatrixShift(), EigsRealNonSymmetricFunc(), EigsRealNonSymmetricMatrix(), EigsRealNonSymmetricMatrixShift(), EigsRealSymmetricFunc(), EigsRealSymmetricMatrix(), EigsRealSymmetricMatrixShift(), elem_xdiv(), elem_xdiv(), elem_xdiv(), elem_xdiv(), elem_xdiv(), elem_xdiv(), elem_xdiv(), elem_xdiv(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), octave_fields::equal_up_to_order(), gh_manager::execute_callback(), F__base64_decode_bytes__(), F__contourc__(), F__delaunayn__(), F__event_manager_input_dialog__(), F__event_manager_list_dialog__(), F__get__(), F__glpk__(), F__go_delete__(), F__go_execute_callback__(), F__go_post_callback__(), F__isprimelarge__(), F__magick_read__(), F__make_valid_name__(), F__native2unicode__(), F__ode15__(), F__pchip_deriv__(), F__unicode2native__(), F__unicode_length__(), F__voronoi__(), Fbase64_decode(), Fbase64_encode(), Fccolamd(), Fcell2struct(), Fcellfun(), Fcellslices(), Fcolamd(), Fcomplex(), Fconvhulln(), Fcsymamd(), Fdbstop(), Fdrawnow(), Fellipj(), Ffilter(), Fget(), ComplexDiagMatrix::fill(), DiagMatrix::fill(), ComplexDiagMatrix::fill(), DiagMatrix::fill(), ComplexColumnVector::fill(), ComplexRowVector::fill(), ComplexRowVector::fill(), ComplexColumnVector::fill(), ComplexDiagMatrix::fill(), ComplexDiagMatrix::fill(), ComplexDiagMatrix::fill(), ComplexDiagMatrix::fill(), FloatComplexDiagMatrix::fill(), FloatDiagMatrix::fill(), FloatComplexDiagMatrix::fill(), FloatDiagMatrix::fill(), FloatComplexColumnVector::fill(), FloatComplexRowVector::fill(), FloatComplexRowVector::fill(), FloatComplexColumnVector::fill(), FloatComplexDiagMatrix::fill(), FloatComplexDiagMatrix::fill(), FloatComplexDiagMatrix::fill(), FloatComplexDiagMatrix::fill(), FloatComplexDiagMatrix::fill(), FloatDiagMatrix::fill(), FloatComplexDiagMatrix::fill(), FloatDiagMatrix::fill(), ComplexDiagMatrix::fill(), DiagMatrix::fill(), ComplexDiagMatrix::fill(), DiagMatrix::fill(), ComplexColumnVector::fill(), ComplexRowVector::fill(), RowVector::fill(), ComplexRowVector::fill(), RowVector::fill(), ComplexColumnVector::fill(), ColumnVector::fill(), FloatComplexColumnVector::fill(), FloatColumnVector::fill(), FloatComplexRowVector::fill(), FloatRowVector::fill(), FloatComplexRowVector::fill(), FloatRowVector::fill(), FloatComplexColumnVector::fill(), FloatColumnVector::fill(), filter(), filter(), Array< T, Alloc >::find(), Fis_same_file(), Fisa(), Fisargout(), Fiscolumn(), Fisfield(), Fismatrix(), Fisrow(), Fisscalar(), Fissquare(), Fisvector(), Flookup(), Flu(), Fmatrix_type(), Fndims(), Fordschur(), ComplexNDArray::fourier(), NDArray::fourier(), FloatComplexNDArray::fourier(), FloatNDArray::fourier(), ComplexNDArray::fourier2d(), NDArray::fourier2d(), FloatNDArray::fourier2d(), Fpow2(), Fquadcc(), Fregexprep(), Frepelems(), Freset(), Freshape(), Fresize(), Frmfield(), Fset(), Fsize(), Fspparms(), Fstr2double(), Fstrfind(), Fstrrep(), Fsymamd(), Fterminal_size(), Ftsearch(), Funicode_idx(), Furlread(), Furlwrite(), Fwarning(), cdef_object_scalar::get(), get_children_limits(), get_dimensions(), get_scalar_idx(), get_sort_mode(), hex2num(), MArray< T >::idx_add(), MArray< T >::idx_max(), ComplexNDArray::ifourier(), FloatComplexNDArray::ifourier(), FloatNDArray::ifourier(), ComplexNDArray::ifourier2d(), NDArray::ifourier2d(), FloatComplexNDArray::ifourier2d(), FloatNDArray::ifourier2d(), imag(), Array< T, Alloc >::index(), Array< T, Alloc >::index(), opengl_renderer::init_gl_context(), ODES::initialize(), ODES::initialize(), base_diff_alg_eqn::initialize(), ComplexColumnVector::insert(), ColumnVector::insert(), ComplexMatrix::insert(), Matrix::insert(), ComplexColumnVector::insert(), ComplexMatrix::insert(), ComplexRowVector::insert(), ComplexMatrix::insert(), FloatComplexColumnVector::insert(), FloatColumnVector::insert(), FloatComplexMatrix::insert(), FloatMatrix::insert(), FloatComplexColumnVector::insert(), FloatComplexMatrix::insert(), FloatComplexRowVector::insert(), FloatComplexMatrix::insert(), FloatComplexRowVector::insert(), FloatRowVector::insert(), FloatComplexMatrix::insert(), FloatMatrix::insert(), ComplexNDArray::insert(), FloatComplexNDArray::insert(), ComplexRowVector::insert(), RowVector::insert(), ComplexMatrix::insert(), Matrix::insert(), qr< T >::insert_col(), qr< T >::insert_col(), qr< T >::insert_col(), qr< T >::insert_col(), qr< T >::insert_col(), qr< T >::insert_col(), qr< T >::insert_col(), qr< T >::insert_col(), qr< T >::insert_row(), qr< T >::insert_row(), qr< T >::insert_row(), qr< T >::insert_row(), chol< T >::insert_sym(), chol< T >::insert_sym(), chol< T >::insert_sym(), chol< T >::insert_sym(), DASRT::integrate(), DASRT::integrate(), DASPK::integrate(), DASSL::integrate(), DASPK::integrate(), DASSL::integrate(), sparse_chol< chol_type >::inverse(), is_superclass(), DiagArray2< T >::isempty(), Java_org_octave_Octave_doInvoke(), DiagArray2< T >::length(), linspace(), linspace(), linspace(), linspace(), octave_bool_matrix::load_ascii(), octave_perm_matrix::load_binary(), Array< T, Alloc >::lookup(), lookup_classes(), Matrix::lssolve(), ComplexMatrix::lssolve(), FloatMatrix::lssolve(), FloatComplexMatrix::lssolve(), error_system::make_stack_frame_list(), map_2_xldexp(), cdef_object::map_value(), ComplexColumnVector::max(), ComplexRowVector::max(), ColumnVector::max(), RowVector::max(), FloatComplexColumnVector::max(), FloatColumnVector::max(), FloatComplexRowVector::max(), FloatRowVector::max(), ComplexColumnVector::min(), ComplexRowVector::min(), ColumnVector::min(), RowVector::min(), FloatComplexColumnVector::min(), FloatColumnVector::min(), FloatComplexRowVector::min(), FloatRowVector::min(), num2hex(), numel(), octave_class::numeric_conv(), OCTAVE_BEGIN_NAMESPACE(), OCTAVE_BEGIN_NAMESPACE(), OCTAVE_BEGIN_NAMESPACE(), octave_print_internal(), operator*(), operator*(), operator*(), operator*(), operator*(), operator*(), operator*(), operator*(), operator*(), ComplexColumnVector::operator+=(), FloatComplexColumnVector::operator+=(), FloatComplexMatrix::operator+=(), FloatComplexRowVector::operator+=(), ComplexMatrix::operator+=(), ComplexRowVector::operator+=(), ComplexColumnVector::operator-=(), FloatComplexColumnVector::operator-=(), FloatComplexMatrix::operator-=(), FloatComplexRowVector::operator-=(), ComplexMatrix::operator-=(), ComplexRowVector::operator-=(), operator<<(), ColumnVector::operator==(), ComplexColumnVector::operator==(), ComplexMatrix::operator==(), ComplexRowVector::operator==(), FloatColumnVector::operator==(), FloatComplexColumnVector::operator==(), FloatComplexMatrix::operator==(), FloatComplexRowVector::operator==(), FloatMatrix::operator==(), FloatRowVector::operator==(), Matrix::operator==(), RowVector::operator==(), operator>>(), bp_table::parse_dbfunction_params(), PermMatrix::perm_length(), octave_base_diag< DMT, MT >::permute(), Array< T, Alloc >::permute(), Sparse< T, Alloc >::permute(), ComplexMatrix::pseudo_inverse(), Matrix::pseudo_inverse(), FloatComplexMatrix::pseudo_inverse(), FloatMatrix::pseudo_inverse(), read_images(), read_mat5_binary_element(), read_mat5_binary_file_header(), type_info::register_type(), opengl_renderer::render_grid(), opengl_renderer::render_tickmarks(), opengl_renderer::render_ticktexts(), safe_comparator(), safe_comparator(), safe_comparator(), safe_comparator(), octave_perm_matrix::save_ascii(), octave_bool_matrix::save_binary(), octave_complex_diag_matrix::save_binary(), octave_float_complex_diag_matrix::save_binary(), octave_float_diag_matrix::save_binary(), octave_diag_matrix::save_binary(), save_mat5_binary_element(), save_mat5_element_length(), error_system::set_warning_option(), octave_cell::simple_subsref(), base_diff_eqn::size(), sizes_cmp(), ComplexColumnVector::stack(), ComplexMatrix::stack(), ColumnVector::stack(), Matrix::stack(), ComplexColumnVector::stack(), ComplexMatrix::stack(), ComplexMatrix::stack(), FloatComplexColumnVector::stack(), FloatComplexMatrix::stack(), FloatColumnVector::stack(), FloatMatrix::stack(), FloatComplexColumnVector::stack(), FloatComplexMatrix::stack(), FloatComplexMatrix::stack(), FloatComplexMatrix::stack(), FloatMatrix::stack(), ComplexMatrix::stack(), Matrix::stack(), sub2ind(), cdef_object_array::subsasgn(), octave_cell::subsasgn(), octave_struct::subsasgn(), octave_struct::subsref(), octave_cell::subsref(), octave_struct::subsref(), octave_cell::subsref(), octave_class::subsref(), cdef_object_array::subsref(), PermMatrix::transpose(), octave_complex_matrix::try_narrowing_conversion(), octave_float_complex_matrix::try_narrowing_conversion(), octave_float_matrix::try_narrowing_conversion(), octave_matrix::try_narrowing_conversion(), chol< T >::update(), lu< T >::update(), qr< T >::update(), chol< T >::update(), lu< T >::update(), qr< T >::update(), chol< T >::update(), lu< T >::update(), qr< T >::update(), chol< T >::update(), lu< T >::update(), qr< T >::update(), lu< T >::update_piv(), lu< T >::update_piv(), lu< T >::update_piv(), lu< T >::update_piv(), vector_norm(), tree_evaluator::visit_complex_for_command(), error_system::warning_query(), stream::write(), xzip(), and zero_dims_inquire().

◆ operator()() [1/8]

template<typename T , typename Alloc >
T & Array< T, Alloc >::operator() ( const Array< octave_idx_type > &  ra_idx)
inline

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

References ra_idx.

◆ operator()() [2/8]

template<typename T , typename Alloc >
crefT Array< T, Alloc >::operator() ( const Array< octave_idx_type > &  ra_idx) const
inline

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

References ra_idx.

◆ operator()() [3/8]

template<typename T , typename Alloc >
T & Array< T, Alloc >::operator() ( octave_idx_type  i,
octave_idx_type  j 
)
inline

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

◆ operator()() [4/8]

template<typename T , typename Alloc >
crefT Array< T, Alloc >::operator() ( octave_idx_type  i,
octave_idx_type  j 
) const
inline

Size of the specified dimension.

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

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

Definition at line 614 of file Array.h.

◆ operator()() [5/8]

template<typename T , typename Alloc >
T & Array< T, Alloc >::operator() ( octave_idx_type  i,
octave_idx_type  j,
octave_idx_type  k 
)
inline

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

◆ operator()() [6/8]

template<typename T , typename Alloc >
crefT Array< T, Alloc >::operator() ( octave_idx_type  i,
octave_idx_type  j,
octave_idx_type  k 
) const
inline

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

◆ operator()() [7/8]

template<typename T , typename Alloc >
T & Array< T, Alloc >::operator() ( octave_idx_type  n)
inline

Size of the specified dimension.

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

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

Definition at line 578 of file Array.h.

◆ operator()() [8/8]

template<typename T , typename Alloc >
crefT Array< T, Alloc >::operator() ( octave_idx_type  n) const
inline

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

◆ operator=() [1/2]

template<typename T , typename Alloc >
Array< T, Alloc > & Array< T, Alloc >::operator= ( Array< T, Alloc > &&  a)
inline

Definition at line 383 of file Array.h.

References Array< T, Alloc >::ArrayRep::m_count.

◆ operator=() [2/2]

◆ optimize_dimensions()

template<typename T , typename Alloc >
bool Array< T, Alloc >::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.

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

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

◆ page()

template<typename T , typename Alloc >
Array< T, Alloc > Array< T, Alloc >::page ( octave_idx_type  k) const

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

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

◆ pages()

template<typename T , typename Alloc >
octave_idx_type Array< T, Alloc >::pages ( ) const
inline

Size of the specified dimension.

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

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

Definition at line 485 of file Array.h.

◆ permute()

template<typename T , typename Alloc >
Array< T, Alloc > Array< T, Alloc >::permute ( const Array< octave_idx_type > &  vec,
bool  inv = false 
) const

Size of the specified dimension.

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

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

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

References dim_vector::alloc(), Array< T, Alloc >::elem(), dim_vector::ndims(), Array< T, Alloc >::numel(), OCTAVE_LOCAL_BUFFER_INIT, and dim_vector::resize().

Referenced by F__unicode_length__(), Funicode_idx(), octave_base_scalar< ST >::permute(), octave_map::permute(), ov_range< T >::permute(), octave_char_matrix_sq_str::permute(), and MArray< T >::permute().

◆ print_info()

template<typename T , typename Alloc >
void Array< T, Alloc >::print_info ( std::ostream &  os,
const std::string &  prefix 
) const

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 2774 of file Array-base.cc.

Referenced by DiagArray2< T >::print_info(), and PermMatrix::print_info().

◆ reshape() [1/2]

template<typename T , typename Alloc >
Array< T, Alloc > Array< T, Alloc >::reshape ( const dim_vector new_dims) const
inline

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

◆ reshape() [2/2]

template<typename T , typename Alloc >
Array< T, Alloc > Array< T, Alloc >::reshape ( octave_idx_type  nr,
octave_idx_type  nc 
) const
inline

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

Referenced by Array< T, Alloc >::assign(), Array< T, Alloc >::assign(), Array< T, Alloc >::assign(), Fbase64_decode(), range< T, typename std::enable_if< std::is_floating_point< T >::value >::type >::index(), octave_map::reshape(), Cell::reshape(), octave_base_scalar< ST >::reshape(), ov_range< T >::reshape(), octave_char_matrix_sq_str::reshape(), and MArray< T >::reshape().

◆ resize() [1/2]

template<typename T , typename Alloc >
void Array< T, Alloc >::resize ( const dim_vector dv)
inline

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

◆ resize() [2/2]

template<typename T , typename Alloc >
void Array< T, Alloc >::resize ( const dim_vector dv,
const T &  rfv 
)

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 1031 of file Array-base.cc.

References dim_vector::any_neg(), dim_vector::ndims(), dim_vector::redim(), and Array< T, Alloc >::rwdata().

Referenced by Cell::Cell(), DiagArray2< T >::DiagArray2(), NDArray::NDArray(), sparse_lu< lu_type >::sparse_lu(), sparse_lu< lu_type >::sparse_lu(), octave_value_list::array_value(), base64_decode(), base64_decode_bytes(), bitopxx(), Cell::column(), ComplexMatrix::column_max(), Matrix::column_max(), FloatComplexMatrix::column_max(), FloatMatrix::column_max(), ComplexMatrix::column_min(), Matrix::column_min(), FloatComplexMatrix::column_min(), FloatMatrix::column_min(), DASPK::do_integrate(), DASSL::do_integrate(), LSODE::do_integrate(), tree_cell::evaluate(), DiagArray2< Complex >::extract_diag(), F__glpk__(), F__magick_read__(), Fbsxfun(), Ffilter(), Fget(), filter(), find_nonzero_elem_idx(), find_nonzero_elem_idx(), Frandperm(), Fsize(), Fwarning(), get_ra_idx(), ichol_t(), MArray< T >::idx_add_nd(), ilu_crout(), ilu_tp(), Array< T, Alloc >::index(), octave_bool_matrix::load_hdf5(), octave_cell::load_hdf5(), octave_complex_matrix::load_hdf5(), octave_float_complex_matrix::load_hdf5(), octave_float_matrix::load_hdf5(), octave_matrix::load_hdf5(), octave_char_matrix_str::load_hdf5(), Matrix::lssolve(), ComplexMatrix::lssolve(), ComplexMatrix::lssolve(), FloatMatrix::lssolve(), FloatComplexMatrix::lssolve(), FloatComplexMatrix::lssolve(), FloatMatrix::lssolve(), Matrix::lssolve(), SparseComplexMatrix::max(), SparseMatrix::max(), SparseComplexMatrix::min(), SparseMatrix::min(), type_info::register_type(), octave_map::resize(), ov_range< T >::resize(), octave_char_matrix_str::resize(), octave_char_matrix_sq_str::resize(), ComplexColumnVector::resize(), ComplexRowVector::resize(), ColumnVector::resize(), RowVector::resize(), FloatColumnVector::resize(), FloatRowVector::resize(), FloatComplexColumnVector::resize(), FloatComplexRowVector::resize(), DiagArray2< T >::resize(), boolMatrix::resize(), charMatrix::resize(), ComplexMatrix::row_max(), Matrix::row_max(), FloatComplexMatrix::row_max(), FloatMatrix::row_max(), ComplexMatrix::row_min(), Matrix::row_min(), FloatComplexMatrix::row_min(), FloatMatrix::row_min(), error_system::set_warning_option(), and octave_base_scalar< ST >::sort().

◆ resize1() [1/2]

template<typename T , typename Alloc >
void Array< T, Alloc >::resize1 ( octave_idx_type  n)
inline

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

◆ resize1() [2/2]

template<typename T , typename Alloc >
void Array< T, Alloc >::resize1 ( octave_idx_type  n,
const T &  rfv 
)

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 918 of file Array-base.cc.

References numel().

Referenced by Array< T, Alloc >::index().

◆ resize2() [1/2]

template<typename T , typename Alloc >
void Array< T, Alloc >::resize2 ( octave_idx_type  nr,
octave_idx_type  nc 
)
inline

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

◆ resize2() [2/2]

template<typename T , typename Alloc >
void Array< T, Alloc >::resize2 ( octave_idx_type  nr,
octave_idx_type  nc,
const T &  rfv 
)

Resizing (with fill).

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

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

Referenced by Array< T, Alloc >::find(), and Array< T, Alloc >::index().

◆ resize_fill_value()

template<typename T , typename Alloc >
T Array< T, Alloc >::resize_fill_value ( ) 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 in Cell.

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

◆ rows()

template<typename T , typename Alloc >
octave_idx_type Array< T, Alloc >::rows ( ) const
inline

Definition at line 463 of file Array.h.

Referenced by aepbalance< MT >::aepbalance(), aepbalance< MT >::aepbalance(), aepbalance< MT >::aepbalance(), aepbalance< MT >::aepbalance(), ComplexMatrix::ComplexMatrix(), ComplexMatrix::ComplexMatrix(), FloatComplexMatrix::FloatComplexMatrix(), FloatComplexMatrix::FloatComplexMatrix(), FloatMatrix::FloatMatrix(), lu< T >::lu(), lu< T >::lu(), lu< T >::lu(), lu< T >::lu(), Matrix::Matrix(), airy(), airy(), ComplexMatrix::append(), Matrix::append(), ComplexMatrix::append(), ComplexMatrix::append(), ComplexMatrix::append(), ComplexMatrix::append(), ComplexMatrix::append(), Matrix::append(), FloatComplexMatrix::append(), FloatMatrix::append(), FloatComplexMatrix::append(), FloatComplexMatrix::append(), FloatComplexMatrix::append(), FloatComplexMatrix::append(), FloatComplexMatrix::append(), FloatMatrix::append(), FloatComplexMatrix::append(), FloatMatrix::append(), FloatComplexMatrix::append(), FloatMatrix::append(), ComplexMatrix::append(), Matrix::append(), ComplexMatrix::append(), Matrix::append(), biry(), biry(), octave_char_matrix_str::cellstr_value(), ComplexMatrix::column_is_real_only(), FloatComplexMatrix::column_is_real_only(), ComplexMatrix::column_max(), Matrix::column_max(), FloatComplexMatrix::column_max(), FloatMatrix::column_max(), ComplexMatrix::column_min(), Matrix::column_min(), FloatComplexMatrix::column_min(), FloatMatrix::column_min(), column_norms(), ComplexMatrix::determinant(), Matrix::determinant(), FloatComplexMatrix::determinant(), FloatMatrix::determinant(), octave_complex_matrix::diag(), octave_float_complex_matrix::diag(), octave_float_matrix::diag(), octave_matrix::diag(), octave_complex_matrix::diag(), octave_float_complex_matrix::diag(), octave_float_matrix::diag(), octave_matrix::diag(), ComplexMatrix::diag(), Matrix::diag(), FloatComplexMatrix::diag(), FloatMatrix::diag(), opengl_renderer::draw_patch(), opengl_renderer::draw_scatter(), opengl_renderer::draw_surface(), sparse_qr< SPARSE_T >::E_MAT(), elem_xdiv(), elem_xdiv(), elem_xdiv(), elem_xdiv(), elem_xdiv(), elem_xdiv(), elem_xdiv(), elem_xdiv(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), F__delaunayn__(), F__dsearchn__(), F__event_manager_file_dialog__(), F__event_manager_input_dialog__(), F__pchip_deriv__(), F__voronoi__(), Faudiowrite(), Fconvhulln(), ComplexMatrix::fill(), ComplexMatrix::fill(), FloatComplexMatrix::fill(), FloatComplexMatrix::fill(), ComplexMatrix::fill(), Matrix::fill(), ComplexMatrix::fill(), Matrix::fill(), FloatComplexMatrix::fill(), FloatMatrix::fill(), FloatComplexMatrix::fill(), FloatMatrix::fill(), find_nonzero_elem_idx(), qr< T >::form(), qr< T >::form(), qr< T >::form(), qr< T >::form(), ComplexMatrix::fourier(), Matrix::fourier(), FloatComplexMatrix::fourier(), FloatMatrix::fourier(), ComplexMatrix::fourier2d(), Matrix::fourier2d(), FloatComplexMatrix::fourier2d(), FloatMatrix::fourier2d(), Frepelems(), Fstrrep(), Ftsearch(), ComplexMatrix::ifourier(), Matrix::ifourier(), FloatComplexMatrix::ifourier(), FloatMatrix::ifourier(), ComplexMatrix::ifourier2d(), Matrix::ifourier2d(), FloatComplexMatrix::ifourier2d(), FloatMatrix::ifourier2d(), Sparse< T, Alloc >::index(), Array< T, Alloc >::index(), qr< T >::init(), qrp< T >::init(), qr< T >::init(), qrp< T >::init(), qr< T >::init(), qrp< T >::init(), qr< T >::init(), qrp< T >::init(), Array< T, Alloc >::insert(), ComplexMatrix::insert(), Matrix::insert(), ComplexMatrix::insert(), ComplexMatrix::insert(), ComplexMatrix::insert(), ComplexMatrix::insert(), Matrix::insert(), FloatComplexMatrix::insert(), FloatMatrix::insert(), FloatComplexMatrix::insert(), FloatComplexMatrix::insert(), FloatComplexMatrix::insert(), FloatComplexMatrix::insert(), FloatMatrix::insert(), FloatComplexMatrix::insert(), FloatComplexMatrix::insert(), FloatMatrix::insert(), ComplexMatrix::insert(), ComplexMatrix::insert(), Matrix::insert(), ComplexMatrix::inverse(), Matrix::inverse(), FloatComplexMatrix::inverse(), FloatMatrix::inverse(), ComplexMatrix::ishermitian(), FloatComplexMatrix::ishermitian(), Matrix::issymmetric(), FloatMatrix::issymmetric(), Matrix::lssolve(), ComplexMatrix::lssolve(), ComplexMatrix::lssolve(), FloatMatrix::lssolve(), FloatComplexMatrix::lssolve(), FloatComplexMatrix::lssolve(), FloatMatrix::lssolve(), Matrix::lssolve(), matrix_real_probe(), max(), max(), max(), max(), max(), max(), max(), max(), max(), max(), min(), min(), min(), min(), min(), min(), min(), min(), min(), min(), octave_print_internal(), octave_print_internal(), octave_print_internal(), operator*(), operator*(), operator*(), operator*(), ComplexMatrix::operator+=(), ComplexMatrix::operator+=(), Matrix::operator+=(), FloatComplexMatrix::operator+=(), FloatComplexMatrix::operator+=(), FloatMatrix::operator+=(), FloatComplexMatrix::operator+=(), ComplexMatrix::operator+=(), ComplexMatrix::operator-=(), ComplexMatrix::operator-=(), Matrix::operator-=(), FloatComplexMatrix::operator-=(), FloatComplexMatrix::operator-=(), FloatMatrix::operator-=(), FloatComplexMatrix::operator-=(), ComplexMatrix::operator-=(), boolMatrix::operator==(), charMatrix::operator==(), ComplexMatrix::operator==(), FloatComplexMatrix::operator==(), FloatMatrix::operator==(), Matrix::operator==(), ComplexMatrix::pseudo_inverse(), Matrix::pseudo_inverse(), FloatComplexMatrix::pseudo_inverse(), FloatMatrix::pseudo_inverse(), ComplexMatrix::rcond(), Matrix::rcond(), FloatComplexMatrix::rcond(), FloatMatrix::rcond(), regexp::replace(), ComplexMatrix::row_max(), Matrix::row_max(), FloatComplexMatrix::row_max(), FloatMatrix::row_max(), ComplexMatrix::row_min(), Matrix::row_min(), FloatComplexMatrix::row_min(), FloatMatrix::row_min(), row_norms(), rsf2csf< ComplexMatrix, Matrix >(), rsf2csf< FloatComplexMatrix, FloatMatrix >(), octave_cell::save_ascii(), octave_char_matrix_str::save_ascii(), save_mat_ascii_data(), save_mat_binary_data(), save_three_d(), sizes_cmp(), ComplexMatrix::stack(), Matrix::stack(), ComplexMatrix::stack(), ComplexMatrix::stack(), ComplexMatrix::stack(), ComplexMatrix::stack(), ComplexMatrix::stack(), Matrix::stack(), FloatComplexMatrix::stack(), FloatMatrix::stack(), FloatComplexMatrix::stack(), FloatComplexMatrix::stack(), FloatComplexMatrix::stack(), FloatComplexMatrix::stack(), FloatComplexMatrix::stack(), FloatMatrix::stack(), FloatComplexMatrix::stack(), FloatMatrix::stack(), FloatComplexMatrix::stack(), FloatMatrix::stack(), ComplexMatrix::stack(), Matrix::stack(), ComplexMatrix::stack(), Matrix::stack(), octave_char_matrix_str::string_value(), octave_char_matrix_str::string_vector_value(), tree_evaluator::switch_case_label_matches(), Sylvester(), Sylvester(), Sylvester(), Sylvester(), octave_bool_matrix::try_narrowing_conversion(), lu< T >::update(), lu< T >::update(), lu< T >::update(), qr< T >::update(), lu< T >::update(), lu< T >::update(), lu< T >::update(), qr< T >::update(), lu< T >::update(), qr< T >::update(), lu< T >::update(), qr< T >::update(), lu< T >::update_piv(), lu< T >::update_piv(), lu< T >::update_piv(), lu< T >::update_piv(), lu< T >::update_piv(), lu< T >::update_piv(), lu< T >::update_piv(), lu< T >::update_piv(), xgemm(), xgemm(), xgemm(), xgemm(), xpow(), xpow(), xpow(), xpow(), xpow(), xpow(), xpow(), xpow(), xpow(), xpow(), xpow(), xpow(), xpow(), xpow(), xpow(), and xpow().

◆ rwdata()

template<typename T , typename Alloc >
T * Array< T, Alloc >::rwdata ( )

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 1787 of file Array-base.cc.

Referenced by lu< T >::lu(), lu< T >::lu(), lu< T >::lu(), lu< T >::lu(), NDArray::NDArray(), sparse_lu< lu_type >::sparse_lu(), sparse_lu< lu_type >::sparse_lu(), SparseBoolMatrix::any(), octave_uint64_matrix::array_value(), Sparse< T, Alloc >::assign(), aepbalance< MT >::balancing_matrix(), base64_decode(), base64_decode_bytes(), binmap(), binmap(), binmap(), blkmm_internal(), blkmm_internal(), blkmm_internal(), blkmm_internal(), octave_uint64_matrix::bool_array_value(), cam2xform(), octave_uint64_matrix::char_array_value(), idx_vector::complement(), octave_uint64_matrix::complex_array_value(), octave_uint64_matrix::complex_matrix_value(), Array< T, Alloc >::delete_elements(), Array< T, Alloc >::delete_elements(), ComplexMatrix::determinant(), Matrix::determinant(), FloatComplexMatrix::determinant(), FloatMatrix::determinant(), SparseComplexMatrix::determinant(), SparseMatrix::determinant(), do_bitunpack(), do_bsxfun_op(), do_inplace_bsxfun_op(), DASPK::do_integrate(), DASSL::do_integrate(), LSODE::do_integrate(), DefQuad::do_integrate(), IndefQuad::do_integrate(), FloatDefQuad::do_integrate(), FloatIndefQuad::do_integrate(), do_mm_binary_op(), do_mm_inplace_op(), do_ms_binary_op(), do_ms_inplace_op(), do_mx_cum_op(), do_mx_cumminmax_op(), do_mx_cumminmax_op(), do_mx_diff_op(), do_mx_inplace_op(), do_mx_minmax_op(), do_mx_minmax_op(), do_mx_red_op(), do_mx_unary_op(), do_sm_binary_op(), EigsComplexNonSymmetricFunc(), EigsComplexNonSymmetricMatrix(), EigsComplexNonSymmetricMatrixShift(), EigsRealNonSymmetricFunc(), EigsRealNonSymmetricMatrix(), EigsRealNonSymmetricMatrixShift(), EigsRealSymmetricFunc(), EigsRealSymmetricMatrix(), EigsRealSymmetricMatrixShift(), octave_fields::equal_up_to_order(), F__delaunayn__(), F__dsearchn__(), F__glpk__(), F__icholt__(), F__iluc__(), F__ilutp__(), F__magick_finfo__(), F__pchip_deriv__(), F__voronoi__(), Famd(), Faudioread(), Fconvhulln(), Fdot(), Fellipj(), filter(), Array< T, Alloc >::find(), octave_uint64_matrix::float_array_value(), octave_uint64_matrix::float_complex_array_value(), octave_uint64_matrix::float_complex_matrix_value(), octave_uint64_matrix::float_matrix_value(), Fordqz(), Fordschur(), DiagArray2< T >::fortran_vec(), ComplexMatrix::fourier(), Matrix::fourier(), FloatComplexMatrix::fourier(), FloatMatrix::fourier(), ComplexNDArray::fourier(), NDArray::fourier(), FloatComplexNDArray::fourier(), FloatNDArray::fourier(), ComplexMatrix::fourier2d(), ComplexNDArray::fourier2d(), Matrix::fourier2d(), NDArray::fourier2d(), FloatComplexMatrix::fourier2d(), FloatMatrix::fourier2d(), FloatNDArray::fourier2d(), ComplexNDArray::fourierNd(), NDArray::fourierNd(), FloatComplexNDArray::fourierNd(), FloatNDArray::fourierNd(), Fquadcc(), Fqz(), Frandperm(), Fsymrcm(), opengl_renderer::get_pixels(), ichol_t(), MArray< T >::idx_add_nd(), ComplexMatrix::ifourier(), Matrix::ifourier(), FloatComplexMatrix::ifourier(), FloatMatrix::ifourier(), ComplexNDArray::ifourier(), FloatComplexNDArray::ifourier(), FloatNDArray::ifourier(), ComplexMatrix::ifourier2d(), ComplexNDArray::ifourier2d(), Matrix::ifourier2d(), NDArray::ifourier2d(), FloatComplexMatrix::ifourier2d(), FloatComplexNDArray::ifourier2d(), FloatMatrix::ifourier2d(), FloatNDArray::ifourier2d(), ComplexNDArray::ifourierNd(), NDArray::ifourierNd(), FloatComplexNDArray::ifourierNd(), FloatNDArray::ifourierNd(), ilu_crout(), ilu_tp(), range< T, typename std::enable_if< std::is_floating_point< T >::value >::type >::index(), CollocWt::init(), qr< T >::init(), qrp< T >::init(), qr< T >::init(), qrp< T >::init(), qr< T >::init(), qrp< T >::init(), qr< T >::init(), qrp< T >::init(), qr< T >::insert_row(), qr< T >::insert_row(), qr< T >::insert_row(), qr< T >::insert_row(), octave_char_matrix_str::load_ascii(), octave_bool_matrix::load_binary(), octave_complex_matrix::load_binary(), octave_float_complex_matrix::load_binary(), octave_float_matrix::load_binary(), octave_perm_matrix::load_binary(), octave_matrix::load_binary(), octave_char_matrix_str::load_binary(), octave_complex_matrix::load_hdf5(), octave_float_complex_matrix::load_hdf5(), octave_float_matrix::load_hdf5(), octave_matrix::load_hdf5(), octave_char_matrix_str::load_hdf5(), Array< T, Alloc >::lookup(), Matrix::lssolve(), ComplexMatrix::lssolve(), ComplexMatrix::lssolve(), FloatMatrix::lssolve(), FloatComplexMatrix::lssolve(), FloatComplexMatrix::lssolve(), FloatMatrix::lssolve(), Matrix::lssolve(), Array< T, Alloc >::map(), octave_uint64_matrix::matrix_value(), Array< T, Alloc >::nth_element(), operator*(), operator*(), operator*(), operator*(), ComplexColumnVector::operator+=(), FloatComplexColumnVector::operator+=(), FloatComplexMatrix::operator+=(), FloatComplexRowVector::operator+=(), ComplexMatrix::operator+=(), ComplexRowVector::operator+=(), ComplexColumnVector::operator-=(), FloatComplexColumnVector::operator-=(), FloatComplexMatrix::operator-=(), FloatComplexRowVector::operator-=(), ComplexMatrix::operator-=(), ComplexRowVector::operator-=(), ComplexMatrix::rcond(), Matrix::rcond(), FloatComplexMatrix::rcond(), FloatMatrix::rcond(), read_mat5_binary_element(), read_mat_binary_data(), Array< T, Alloc >::resize(), Array< T, Alloc >::resize2(), rsf2csf< ComplexMatrix, Matrix >(), rsf2csf< FloatComplexMatrix, FloatMatrix >(), DiagArray2< T >::rwdata(), Array< T, Alloc >::sort(), string_vector::sort(), Array< T, Alloc >::sort(), Array< T, Alloc >::sort_rows_idx(), sub2ind(), SparseBoolMatrix::sum(), Sylvester(), Sylvester(), Sylvester(), Sylvester(), Array< T, Alloc >::transpose(), unit_cube(), lu< T >::update(), qr< T >::update(), lu< T >::update(), qr< T >::update(), lu< T >::update(), qr< T >::update(), lu< T >::update(), qr< T >::update(), lu< T >::update(), qr< T >::update(), lu< T >::update(), qr< T >::update(), lu< T >::update(), qr< T >::update(), lu< T >::update(), qr< T >::update(), lu< T >::update_piv(), lu< T >::update_piv(), lu< T >::update_piv(), lu< T >::update_piv(), lu< T >::update_piv(), lu< T >::update_piv(), lu< T >::update_piv(), lu< T >::update_piv(), xgemm(), xgemm(), xgemm(), and xgemm().

◆ size()

template<typename T , typename Alloc >
size_type Array< T, Alloc >::size ( const size_type  d) const
inline

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

References d.

Referenced by octave_value::size().

◆ sort() [1/6]

template<typename T , typename Alloc >
Array< T, Alloc > Array< T, Alloc >::sort ( Array< octave_idx_type > &  sidx,
int  dim = 0,
sortmode  mode = ASCENDING 
) const

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 1922 of file Array-base.cc.

References DESCENDING, numel(), OCTAVE_LOCAL_BUFFER, Array< T, Alloc >::rwdata(), octave_sort< T >::set_compare(), octave_sort< T >::sort(), and UNSORTED.

◆ sort() [2/6]

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

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

◆ sort() [3/6]

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

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

◆ sort() [4/6]

template<typename T , typename Alloc >
Array< T, Alloc > Array< T, Alloc >::sort ( int  dim = 0,
sortmode  mode = ASCENDING 
) const

◆ sort() [5/6]

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

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

◆ sort() [6/6]

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

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

◆ sort_rows_idx() [1/3]

◆ sort_rows_idx() [2/3]

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

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

◆ sort_rows_idx() [3/3]

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

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

◆ squeeze()

template<typename T , typename Alloc >
Array< T, Alloc > Array< T, Alloc >::squeeze ( ) const

Chop off leading singleton dimensions.

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

References dim_vector::resize().

Referenced by boolNDArray::squeeze(), charNDArray::squeeze(), and MArray< T >::squeeze().

◆ test()

template<typename T , typename Alloc >
template<typename F , bool zero>
bool Array< T, Alloc >::test ( fcn) const
inline

Generic any/all test functionality with arbitrary predicate.

Definition at line 912 of file Array.h.

References numel().

◆ test_all() [1/3]

template<typename T , typename Alloc >
bool Array< T, Alloc >::test_all ( bool(&)(const T &)  fcn) const
inline

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

◆ test_all() [2/3]

template<typename T , typename Alloc >
bool Array< T, Alloc >::test_all ( bool(&)(T)  fcn) const
inline

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

◆ test_all() [3/3]

template<typename T , typename Alloc >
template<typename F >
bool Array< T, Alloc >::test_all ( fcn) const
inline

◆ test_any() [1/3]

template<typename T , typename Alloc >
bool Array< T, Alloc >::test_any ( bool(&)(const T &)  fcn) const
inline

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

◆ test_any() [2/3]

template<typename T , typename Alloc >
bool Array< T, Alloc >::test_any ( bool(&)(T)  fcn) const
inline

Overloads for function references.

Definition at line 930 of file Array.h.

◆ test_any() [3/3]

template<typename T , typename Alloc >
template<typename F >
bool Array< T, Alloc >::test_any ( fcn) const
inline

Simpler calls.

Definition at line 920 of file Array.h.

Referenced by ComplexNDArray::too_large_for_float(), and NDArray::too_large_for_float().

◆ transpose()

template<typename T , typename Alloc >
Array< T, Alloc > Array< T, Alloc >::transpose ( ) const

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 1646 of file Array-base.cc.

References liboctave_panic_unless, Array< T, Alloc >::rwdata(), and Array< T, Alloc >::xelem().

Referenced by Sparse< T, Alloc >::index(), Sparse< T, Alloc >::sort(), boolMatrix::transpose(), charMatrix::transpose(), and MArray< T >::transpose().

◆ xelem() [1/8]

template<typename T , typename Alloc >
T & Array< T, Alloc >::xelem ( const Array< octave_idx_type > &  ra_idx)
inline

Size of the specified dimension.

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

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

Definition at line 545 of file Array.h.

References ra_idx.

◆ xelem() [2/8]

template<typename T , typename Alloc >
crefT Array< T, Alloc >::xelem ( const Array< octave_idx_type > &  ra_idx) const
inline

Size of the specified dimension.

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

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

Definition at line 549 of file Array.h.

References ra_idx.

◆ xelem() [3/8]

template<typename T , typename Alloc >
T & Array< T, Alloc >::xelem ( octave_idx_type  i,
octave_idx_type  j 
)
inline

Size of the specified dimension.

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

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

Definition at line 531 of file Array.h.

◆ xelem() [4/8]

template<typename T , typename Alloc >
crefT Array< T, Alloc >::xelem ( octave_idx_type  i,
octave_idx_type  j 
) const
inline

Size of the specified dimension.

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

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

Definition at line 534 of file Array.h.

◆ xelem() [5/8]

template<typename T , typename Alloc >
T & Array< T, Alloc >::xelem ( octave_idx_type  i,
octave_idx_type  j,
octave_idx_type  k 
)
inline

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

◆ xelem() [6/8]

template<typename T , typename Alloc >
crefT Array< T, Alloc >::xelem ( octave_idx_type  i,
octave_idx_type  j,
octave_idx_type  k 
) const
inline

Size of the specified dimension.

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

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

Definition at line 541 of file Array.h.

◆ xelem() [7/8]

template<typename T , typename Alloc >
T & Array< T, Alloc >::xelem ( octave_idx_type  n)
inline

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

Referenced by ComplexMatrix::ComplexMatrix(), ComplexNDArray::ComplexNDArray(), FloatComplexMatrix::FloatComplexMatrix(), FloatComplexNDArray::FloatComplexNDArray(), FloatNDArray::FloatNDArray(), NDArray::NDArray(), intNDArray< T >::abs(), SparseBoolMatrix::any(), octave_value_list::array_value(), range< T, typename std::enable_if< std::is_floating_point< T >::value >::type >::array_value(), Sparse< T, Alloc >::array_value(), type_info::assign_ops_map(), type_info::assignany_ops_map(), type_info::binary_ops_map(), Cell::cellstr_value(), octave_char_matrix_str::cellstr_value(), Cell::column(), column_norms(), column_norms(), type_info::compound_binary_ops_map(), DiagArray2< T >::dgxelem(), DiagArray2< T >::dgxelem(), do_mat2cell(), do_mat2cell_nd(), Array< T, Alloc >::elem(), elem_xpow(), elem_xpow(), elem_xpow(), elem_xpow(), RowVector::extract(), FloatRowVector::extract(), ColumnVector::extract(), FloatColumnVector::extract(), RowVector::extract_n(), FloatRowVector::extract_n(), ColumnVector::extract_n(), FloatColumnVector::extract_n(), F__event_manager_file_dialog__(), F__event_manager_input_dialog__(), F__event_manager_list_dialog__(), F__native2unicode__(), F__unicode2native__(), Famd(), Faudiowrite(), Fcellindexmat(), Fcellslices(), Fcomplex(), ComplexColumnVector::fill(), ComplexMatrix::fill(), ComplexRowVector::fill(), ComplexRowVector::fill(), ComplexMatrix::fill(), ComplexColumnVector::fill(), FloatComplexColumnVector::fill(), FloatComplexMatrix::fill(), FloatComplexRowVector::fill(), FloatComplexRowVector::fill(), FloatComplexMatrix::fill(), FloatComplexColumnVector::fill(), ComplexColumnVector::fill(), ComplexMatrix::fill(), ComplexRowVector::fill(), Matrix::fill(), RowVector::fill(), ComplexRowVector::fill(), RowVector::fill(), ComplexMatrix::fill(), Matrix::fill(), ComplexColumnVector::fill(), ColumnVector::fill(), FloatComplexColumnVector::fill(), FloatComplexMatrix::fill(), FloatComplexRowVector::fill(), FloatMatrix::fill(), FloatRowVector::fill(), FloatComplexRowVector::fill(), FloatRowVector::fill(), FloatComplexMatrix::fill(), FloatMatrix::fill(), FloatComplexColumnVector::fill(), FloatColumnVector::fill(), find_nonzero_elem_idx(), Flookup(), Fordschur(), qr< T >::form(), qr< T >::form(), qr< T >::form(), qr< T >::form(), Fpow2(), Frepelems(), Fsize(), Fstruct2cell(), lu< T >::getp(), Array< T, Alloc >::hermitian(), hex2num(), imag(), imag(), Sparse< T, Alloc >::index(), ComplexColumnVector::insert(), ColumnVector::insert(), ComplexMatrix::insert(), Matrix::insert(), ComplexColumnVector::insert(), ComplexMatrix::insert(), ComplexMatrix::insert(), ComplexRowVector::insert(), ComplexMatrix::insert(), Matrix::insert(), FloatComplexColumnVector::insert(), FloatColumnVector::insert(), FloatComplexMatrix::insert(), FloatMatrix::insert(), FloatComplexColumnVector::insert(), FloatComplexMatrix::insert(), FloatComplexMatrix::insert(), FloatComplexRowVector::insert(), FloatComplexMatrix::insert(), FloatMatrix::insert(), FloatComplexMatrix::insert(), FloatComplexRowVector::insert(), FloatRowVector::insert(), FloatComplexMatrix::insert(), FloatMatrix::insert(), ComplexMatrix::insert(), ComplexRowVector::insert(), RowVector::insert(), ComplexMatrix::insert(), Matrix::insert(), install_ops(), idx_vector::inverse_permutation(), linspace(), linspace(), linspace(), linspace(), map_2_xldexp(), map_2_xlog2(), type_info::non_const_unary_ops_map(), octave_scalar_map::orderfields(), octave_map::orderfields(), octave_map::orderfields(), octave_scalar_map::orderfields(), lu< T >::P_vec(), sparse_lu< lu_type >::Pc_vec(), octave_base_diag< DMT, MT >::permute(), sparse_lu< lu_type >::Pr_vec(), read_mat_binary_data(), row_norms(), row_norms(), intNDArray< T >::signum(), SparseBoolMatrix::sum(), Array< T, Alloc >::transpose(), PermMatrix::transpose(), type_info::unary_ops_map(), DiagArray2< T >::xelem(), xgemm(), xgemm(), xgemm(), and xgemm().

◆ xelem() [8/8]

template<typename T , typename Alloc >
crefT Array< T, Alloc >::xelem ( octave_idx_type  n) const
inline

Size of the specified dimension.

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

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

Definition at line 527 of file Array.h.

Friends And Related Symbol Documentation

◆ Array

template<typename T , typename Alloc >
template<typename U , typename A >
friend class Array
friend

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.

Member Data Documentation

◆ m_dimensions

◆ m_rep

template<typename T , typename Alloc >
Array<T,Alloc>::ArrayRep* Array< T, Alloc >::m_rep
protected

Definition at line 251 of file Array.h.

Referenced by Array< T, Alloc >::Array(), and Array< T, Alloc >::operator=().

◆ m_slice_data

template<typename T , typename Alloc >
T* Array< T, Alloc >::m_slice_data
protected

Definition at line 260 of file Array.h.

Referenced by Array< T, Alloc >::Array(), and Array< T, Alloc >::operator=().

◆ m_slice_len

template<typename T , typename Alloc >
octave_idx_type Array< T, Alloc >::m_slice_len
protected

Definition at line 261 of file Array.h.

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


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