#include "dNDArray.h"

Inheritance diagram for NDArray:

[legend]

Collaboration diagram for NDArray:

[legend]

Public Types
typedef bool(*	compare_fcn_type) (typename ref_param< double >::type, typename ref_param< double >::type)

typedef ref_param< double >::type	crefT

typedef double	element_type

typedef octave_idx_type	size_type
	Used for operator(), and returned by numel() and size() (beware: signed integer) More...

typedef double	value_type

Public Member Functions
	NDArray (const Array< octave_idx_type > &a, bool zero_based=false, bool negative_to_nan=false)

template<typename U >
	NDArray (const Array< U > &a)

	NDArray (const charNDArray &)

	NDArray (const dim_vector &dv)

	NDArray (const dim_vector &dv, double val)

template<typename U >
	NDArray (const intNDArray< U > &a)

template<typename U >
	NDArray (const MArray< U > &a)

	NDArray (const NDArray &a)

	NDArray (void)

OCTAVE_API NDArray	abs (void) const

OCTAVE_API boolNDArray	all (int dim=-1) const

OCTAVE_API bool	all_elements_are_int_or_inf_or_nan (void) const

OCTAVE_API bool	all_elements_are_zero (void) const

OCTAVE_API bool	all_integers (double &max_val, double &min_val) const

OCTAVE_API bool	all_integers (void) const

OCTAVE_API boolNDArray	any (int dim=-1) const

OCTAVE_API bool	any_element_is_inf_or_nan (void) const

OCTAVE_API bool	any_element_is_nan (void) const

OCTAVE_API bool	any_element_is_negative (bool=false) const

OCTAVE_API bool	any_element_is_positive (bool=false) const

OCTAVE_API bool	any_element_not_one_or_zero (void) const

OCTARRAY_OVERRIDABLE_FUNC_API Array< double, Alloc >	as_column (void) const
	Return the array as a column vector. More...

OCTARRAY_OVERRIDABLE_FUNC_API Array< double, Alloc >	as_matrix (void) const
	Return the array as a matrix. More...

OCTARRAY_OVERRIDABLE_FUNC_API Array< double, Alloc >	as_row (void) const
	Return the array as a row vector. More...

NDArray &	changesign (void)

OCTARRAY_API void	clear (const dim_vector &dv)

void	clear (octave_idx_type r, octave_idx_type c)

OCTARRAY_API void	clear (void)

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

OCTAVE_API ComplexNDArray	concat (const ComplexNDArray &rb, const Array< octave_idx_type > &ra_idx)

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

OCTAVE_API NDArray	cummax (Array< octave_idx_type > &index, int dim=-1) const

OCTAVE_API NDArray	cummax (int dim=-1) const

OCTAVE_API NDArray	cummin (Array< octave_idx_type > &index, int dim=-1) const

OCTAVE_API NDArray	cummin (int dim=-1) const

OCTAVE_API NDArray	cumprod (int dim=-1) const

OCTAVE_API NDArray	cumsum (int dim=-1) const

OCTAVE_API NDArray	diag (octave_idx_type k=0) const

OCTAVE_API NDArray	diag (octave_idx_type m, octave_idx_type n) const

OCTAVE_API NDArray	diff (octave_idx_type order=1, int dim=-1) const

OCTARRAY_API void	fill (const double &val)

OCTINTERP_API Array< octave_idx_type >	find (octave_idx_type, bool) const

OCTAVE_API Array< octave_idx_type >	find (octave_idx_type, bool) const

OCTAVE_API ComplexNDArray	fourier (int dim=1) const

OCTAVE_API ComplexNDArray	fourier2d (void) const

OCTAVE_API ComplexNDArray	fourierNd (void) const

MArray< double >	hermitian (double(*fcn)(const double &)=nullptr) const

OCTARRAY_API void	idx_add (const octave::idx_vector &idx, const MArray< double > &vals)

OCTARRAY_API void	idx_add (const octave::idx_vector &idx, double val)
	Performs indexed accumulative addition. More...

OCTARRAY_API void	idx_add_nd (const octave::idx_vector &idx, const MArray< double > &vals, int dim=-1)

OCTARRAY_API void	idx_max (const octave::idx_vector &idx, const MArray< double > &vals)

OCTARRAY_API void	idx_min (const octave::idx_vector &idx, const MArray< double > &vals)

OCTAVE_API ComplexNDArray	ifourier (int dim=1) const

OCTAVE_API ComplexNDArray	ifourier2d (void) const

OCTAVE_API ComplexNDArray	ifourierNd (void) const

OCTAVE_API NDArray &	insert (const NDArray &a, const Array< octave_idx_type > &ra_idx)

OCTAVE_API NDArray &	insert (const NDArray &a, octave_idx_type r, octave_idx_type c)

MArray< double >	ipermute (const Array< octave_idx_type > &vec) const

OCTINTERP_API sortmode	is_sorted_rows (sortmode) const

OCTAVE_API sortmode	is_sorted_rows (sortmode) const

OCTAVE_API boolNDArray	isfinite (void) const

OCTAVE_API boolNDArray	isinf (void) const

OCTAVE_API boolNDArray	isnan (void) const

OCTAVE_API sortmode	issorted (sortmode mode) const

OCTINTERP_API sortmode	issorted (sortmode) const

OCTAVE_API sortmode	issorted (sortmode) const

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

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

OCTINTERP_API octave_idx_type	lookup (octave::cdef_object const &, sortmode) const

OCTAVE_API octave_idx_type	lookup (octave::idx_vector const &, sortmode) const

OCTARRAY_OVERRIDABLE_FUNC_API void	make_unique (void)

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

OCTAVE_API NDArray	max (int dim=-1) const

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

OCTAVE_API NDArray	min (int dim=-1) const

OCTINTERP_API octave_idx_type	nnz (void) const

OCTAVE_API octave_idx_type	nnz (void) const

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

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

OCTARRAY_OVERRIDABLE_FUNC_API octave_idx_type	numel (void) const
	Number of elements in the array. More...

OCTAVE_API boolNDArray	operator! (void) const

NDArray &	operator= (const NDArray &a)

MArray< double >	permute (const Array< octave_idx_type > &vec, bool inv=false) const

OCTAVE_API NDArray	prod (int dim=-1) const

MArray< double >	reshape (const dim_vector &new_dims) const

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

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

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

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

OCTINTERP_API Array< octave_idx_type >	sort_rows_idx (sortmode) const

OCTAVE_API Array< octave_idx_type >	sort_rows_idx (sortmode) const

NDArray	squeeze (void) const

OCTAVE_API NDArray	sum (int dim=-1) const

OCTAVE_API NDArray	sumsq (int dim=-1) const

OCTAVE_API bool	too_large_for_float (void) const

MArray< double >	transpose (void) const

OCTAVE_API NDArray	xsum (int dim=-1) const

First dimension
Get the first dimension of the array (number of rows)
OCTARRAY_OVERRIDABLE_FUNC_API octave_idx_type	dim1 (void) const

OCTARRAY_OVERRIDABLE_FUNC_API octave_idx_type	rows (void) const

Second dimension
Get the second dimension of the array (number of columns)
OCTARRAY_OVERRIDABLE_FUNC_API octave_idx_type	dim2 (void) const

OCTARRAY_OVERRIDABLE_FUNC_API octave_idx_type	cols (void) const

OCTARRAY_OVERRIDABLE_FUNC_API octave_idx_type	columns (void) const

Static Public Member Functions
static OCTAVE_API octave_idx_type	compute_index (Array< octave_idx_type > &ra_idx, const dim_vector &dimensions)

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

Protected Attributes
dim_vector	m_dimensions

Array< double, Alloc >::ArrayRep *	m_rep

double *	m_slice_data

octave_idx_type	m_slice_len

Private Member Functions
OCTARRAY_CLASS_TEMPLATE_INSTANTIATION_API void	instantiation_guard ()

OCTARRAY_CLASS_TEMPLATE_INSTANTIATION_API void	instantiation_guard ()

OCTARRAY_CLASS_TEMPLATE_INSTANTIATION_API void	instantiation_guard ()

OCTARRAY_CLASS_TEMPLATE_INSTANTIATION_API void	instantiation_guard ()

OCTARRAY_CLASS_TEMPLATE_INSTANTIATION_API void	instantiation_guard ()

OCTARRAY_CLASS_TEMPLATE_INSTANTIATION_API void	instantiation_guard ()

OCTARRAY_CLASS_TEMPLATE_INSTANTIATION_API void	instantiation_guard ()

OCTARRAY_CLASS_TEMPLATE_INSTANTIATION_API void	instantiation_guard ()

OCTARRAY_CLASS_TEMPLATE_INSTANTIATION_API void	instantiation_guard ()

OCTARRAY_CLASS_TEMPLATE_INSTANTIATION_API void	instantiation_guard ()

Static Private Member Functions
static OCTARRAY_API void	instantiation_guard ()

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

Friends
class	ComplexNDArray

OCTAVE_API NDArray	imag (const ComplexNDArray &a)

OCTAVE_API std::ostream &	operator<< (std::ostream &os, const NDArray &a)

OCTAVE_API std::istream &	operator>> (std::istream &is, NDArray &a)

OCTAVE_API NDArray	real (const ComplexNDArray &a)

Third dimension
Get the third dimension of the array (number of pages)
OCTARRAY_OVERRIDABLE_FUNC_API Array< double, Alloc >	reshape (octave_idx_type nr, octave_idx_type nc) const
	Size of the specified dimension. More...

OCTARRAY_API Array< double, Alloc >	hermitian (double(*fcn)(const double &)=nullptr) const
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API octave_idx_type	dim3 (void) const
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API octave_idx_type	pages (void) const
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API size_type	size (const size_type d) const
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API std::size_t	byte_size (void) const
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API const dim_vector &	dims (void) const
	Return a const-reference so that dims ()(i) works efficiently. More...

OCTARRAY_API octave_idx_type	compute_index (octave_idx_type i, octave_idx_type j) const
	Size of the specified dimension. More...

OCTARRAY_API octave_idx_type	compute_index (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
	Size of the specified dimension. More...

OCTARRAY_API octave_idx_type	compute_index (const Array< octave_idx_type > &ra_idx) const
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API octave_idx_type	compute_index_unchecked (const Array< octave_idx_type > &ra_idx) const
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API double &	xelem (octave_idx_type n)
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API crefT	xelem (octave_idx_type n) const
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API double &	xelem (octave_idx_type i, octave_idx_type j)
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API crefT	xelem (octave_idx_type i, octave_idx_type j) const
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API double &	xelem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API crefT	xelem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API double &	xelem (const Array< octave_idx_type > &ra_idx)
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API crefT	xelem (const Array< octave_idx_type > &ra_idx) const
	Size of the specified dimension. More...

OCTARRAY_API double &	checkelem (octave_idx_type n)
	Size of the specified dimension. More...

OCTARRAY_API double &	checkelem (octave_idx_type i, octave_idx_type j)
	Size of the specified dimension. More...

OCTARRAY_API double &	checkelem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
	Size of the specified dimension. More...

OCTARRAY_API double &	checkelem (const Array< octave_idx_type > &ra_idx)
	Size of the specified dimension. More...

OCTARRAY_API crefT	checkelem (octave_idx_type n) const
	Size of the specified dimension. More...

OCTARRAY_API crefT	checkelem (octave_idx_type i, octave_idx_type j) const
	Size of the specified dimension. More...

OCTARRAY_API crefT	checkelem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
	Size of the specified dimension. More...

OCTARRAY_API crefT	checkelem (const Array< octave_idx_type > &ra_idx) const
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API double &	elem (octave_idx_type n)
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API double &	elem (octave_idx_type i, octave_idx_type j)
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API double &	elem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API double &	elem (const Array< octave_idx_type > &ra_idx)
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API crefT	elem (octave_idx_type n) const
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API crefT	elem (octave_idx_type i, octave_idx_type j) const
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API crefT	elem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API crefT	elem (const Array< octave_idx_type > &ra_idx) const
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API double &	operator() (octave_idx_type n)
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API double &	operator() (octave_idx_type i, octave_idx_type j)
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API double &	operator() (octave_idx_type i, octave_idx_type j, octave_idx_type k)
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API double &	operator() (const Array< octave_idx_type > &ra_idx)
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API crefT	operator() (octave_idx_type n) const
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API crefT	operator() (octave_idx_type i, octave_idx_type j) const
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API crefT	operator() (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API crefT	operator() (const Array< octave_idx_type > &ra_idx) const
	Size of the specified dimension. More...

OCTARRAY_API Array< double, Alloc >	column (octave_idx_type k) const
	Extract column: A(:,k+1). More...

OCTARRAY_API Array< double, Alloc >	page (octave_idx_type k) const
	Extract page: A(:,:,k+1). More...

OCTARRAY_API Array< double, 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). More...

OCTARRAY_OVERRIDABLE_FUNC_API bool	issquare (void) const
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API bool	isempty (void) const
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API bool	isvector (void) const
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API bool	is_nd_vector (void) const
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API const double *	data (void) const
	Size of the specified dimension. More...

OCTARRAY_API double *	fortran_vec (void)
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API bool	is_shared (void) const
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API int	ndims (void) const
	Size of the specified dimension. More...

OCTARRAY_API Array< double, Alloc >	index (const octave::idx_vector &i) const
	Indexing without resizing. More...

OCTARRAY_API Array< double, Alloc >	index (const octave::idx_vector &i, const octave::idx_vector &j) const
	Size of the specified dimension. More...

OCTARRAY_API Array< double, Alloc >	index (const Array< octave::idx_vector > &ia) const
	Size of the specified dimension. More...

OCTARRAY_API Array< double, Alloc >	index (const octave::idx_vector &i, bool resize_ok, const double &rfv) const
	Indexing with possible resizing and fill. More...

OCTARRAY_OVERRIDABLE_FUNC_API Array< double, Alloc >	index (const octave::idx_vector &i, bool resize_ok) const
	Size of the specified dimension. More...

OCTARRAY_API Array< double, Alloc >	index (const octave::idx_vector &i, const octave::idx_vector &j, bool resize_ok, const double &rfv) const
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API Array< double, Alloc >	index (const octave::idx_vector &i, const octave::idx_vector &j, bool resize_ok) const
	Size of the specified dimension. More...

OCTARRAY_API Array< double, Alloc >	index (const Array< octave::idx_vector > &ia, bool resize_ok, const double &rfv) const
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API Array< double, Alloc >	index (const Array< octave::idx_vector > &ia, bool resize_ok) const
	Size of the specified dimension. More...

virtual OCTARRAY_API double	resize_fill_value (void) const
	Size of the specified dimension. More...

OCTARRAY_API void	resize2 (octave_idx_type nr, octave_idx_type nc, const double &rfv)
	Resizing (with fill). More...

OCTARRAY_OVERRIDABLE_FUNC_API void	resize2 (octave_idx_type nr, octave_idx_type nc)
	Size of the specified dimension. More...

OCTARRAY_API void	resize1 (octave_idx_type n, const double &rfv)
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API void	resize1 (octave_idx_type n)
	Size of the specified dimension. More...

OCTARRAY_API void	resize (const dim_vector &dv, const double &rfv)
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API void	resize (const dim_vector &dv)
	Size of the specified dimension. More...

OCTARRAY_API void	assign (const octave::idx_vector &i, const Array< double, Alloc > &rhs, const double &rfv)
	Indexed assignment (always with resize & fill). More...

OCTARRAY_OVERRIDABLE_FUNC_API void	assign (const octave::idx_vector &i, const Array< double, Alloc > &rhs)
	Size of the specified dimension. More...

OCTARRAY_API void	assign (const octave::idx_vector &i, const octave::idx_vector &j, const Array< double, Alloc > &rhs, const double &rfv)
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API void	assign (const octave::idx_vector &i, const octave::idx_vector &j, const Array< double, Alloc > &rhs)
	Size of the specified dimension. More...

OCTARRAY_API void	assign (const Array< octave::idx_vector > &ia, const Array< double, Alloc > &rhs, const double &rfv)
	Size of the specified dimension. More...

OCTARRAY_OVERRIDABLE_FUNC_API void	assign (const Array< octave::idx_vector > &ia, const Array< double, Alloc > &rhs)
	Size of the specified dimension. More...

OCTARRAY_API void	delete_elements (const octave::idx_vector &i)
	Deleting elements. More...

OCTARRAY_API void	delete_elements (int dim, const octave::idx_vector &i)
	A(:,...,I,...,:) = [] (>= 2 subscripts, one of them is non-colon) More...

OCTARRAY_API void	delete_elements (const Array< octave::idx_vector > &ia)
	Dispatcher to the above two. More...

OCTARRAY_API Array< double, Alloc > &	insert (const Array< double, Alloc > &a, const Array< octave_idx_type > &idx)
	Insert an array into another at a specified position. More...

OCTARRAY_API Array< double, Alloc > &	insert (const Array< double, Alloc > &a, octave_idx_type r, octave_idx_type c)
	This is just a special case for idx = [r c 0 ...]. More...

OCTARRAY_OVERRIDABLE_FUNC_API void	maybe_economize (void)
	Size of the specified dimension. More...

OCTARRAY_API void	print_info (std::ostream &os, const std::string &prefix) const
	Size of the specified dimension. More...

OCTARRAY_API Array< double, Alloc >	sort (int dim=0, sortmode mode=ASCENDING) const
	Size of the specified dimension. More...

OCTARRAY_API Array< double, Alloc >	sort (Array< octave_idx_type > &sidx, int dim=0, sortmode mode=ASCENDING) const
	Size of the specified dimension. More...

OCTARRAY_API sortmode	issorted (sortmode mode=UNSORTED) const
	Ordering is auto-detected or can be specified. More...

OCTARRAY_API Array< octave_idx_type >	sort_rows_idx (sortmode mode=ASCENDING) const
	Sort by rows returns only indices. More...

OCTARRAY_API sortmode	is_sorted_rows (sortmode mode=UNSORTED) const
	Ordering is auto-detected or can be specified. More...

OCTARRAY_API octave_idx_type	lookup (const double &value, sortmode mode=UNSORTED) const
	Do a binary lookup in a sorted array. More...

OCTARRAY_API Array< octave_idx_type >	lookup (const Array< double, Alloc > &values, sortmode mode=UNSORTED) const
	Ditto, but for an array of values, specializing on the case when values are sorted. More...

OCTARRAY_API octave_idx_type	nnz (void) const
	Count nonzero elements. More...

OCTARRAY_API Array< octave_idx_type >	find (octave_idx_type n=-1, bool backward=false) const
	Find indices of (at most n) nonzero elements. More...

OCTARRAY_API Array< double, 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. More...

Array< U, A >	map (F fcn) const
	Apply function fcn to each element of the Array<T, Alloc>. More...

Array< U, A >	map (U(&fcn)(double)) const
	Overloads for function references. More...

Array< U, A >	map (U(&fcn)(const double &)) const
	Size of the specified dimension. More...

bool	test (F fcn) const
	Generic any/all test functionality with arbitrary predicate. More...

bool	test_any (F fcn) const
	Simpler calls. More...

bool	test_any (bool(&fcn)(double)) const
	Overloads for function references. More...

bool	test_any (bool(&fcn)(const double &)) const
	Size of the specified dimension. More...

bool	test_all (F fcn) const
	Size of the specified dimension. More...

bool	test_all (bool(&fcn)(double)) const
	Size of the specified dimension. More...

bool	test_all (bool(&fcn)(const double &)) const
	Size of the specified dimension. More...

OCTARRAY_API bool	optimize_dimensions (const dim_vector &dv)
	Returns true if this->dims () == dv, and if so, replaces this->m_dimensions by a shallow copy of dv. More...

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

Detailed Description

Definition at line 37 of file dNDArray.h.

Member Typedef Documentation

◆ compare_fcn_type

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

inherited

Definition at line 240 of file Array.h.

◆ crefT

typedef ref_param<double >::type Array< double , Alloc >::crefT

inherited

Definition at line 238 of file Array.h.

◆ element_type

typedef double Array< double , Alloc >::element_type

inherited

Definition at line 230 of file Array.h.

◆ size_type

typedef octave_idx_type Array< double , Alloc >::size_type

inherited

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

Definition at line 236 of file Array.h.

◆ value_type

typedef double Array< double , Alloc >::value_type

inherited

Definition at line 232 of file Array.h.

Constructor & Destructor Documentation

◆ NDArray() [1/9]

NDArray::NDArray ( void )

inline

Definition at line 43 of file dNDArray.h.

◆ NDArray() [2/9]

NDArray::NDArray ( const dim_vector & dv )

inline

Definition at line 45 of file dNDArray.h.

◆ NDArray() [3/9]

NDArray::NDArray	(	const dim_vector &	dv,
		double	val
	)

inline

Definition at line 47 of file dNDArray.h.

◆ NDArray() [4/9]

NDArray::NDArray ( const NDArray & a )

inline

Definition at line 50 of file dNDArray.h.

◆ NDArray() [5/9]

NDArray::NDArray	(	const Array< octave_idx_type > &	a,
		bool	zero_based = `false`,
		bool	negative_to_nan = `false`
	)

Definition at line 47 of file dNDArray.cc.

References Array< T, Alloc >::data(), Array< T, Alloc >::dims(), Array< double >::fortran_vec(), lo_ieee_nan_value(), Array< T, Alloc >::numel(), and Array< double >::resize().

◆ NDArray() [6/9]

template<typename U >

NDArray::NDArray ( const MArray< U > & a )

inline

Definition at line 56 of file dNDArray.h.

◆ NDArray() [7/9]

template<typename U >

NDArray::NDArray ( const Array< U > & a )

inline

Definition at line 59 of file dNDArray.h.

◆ NDArray() [8/9]

template<typename U >

NDArray::NDArray ( const intNDArray< U > & a )

inlineexplicit

Definition at line 62 of file dNDArray.h.

◆ NDArray() [9/9]

NDArray::NDArray ( const charNDArray & a )

Definition at line 89 of file dNDArray.cc.

References n, Array< T, Alloc >::numel(), and Array< double >::xelem().

Member Function Documentation

◆ abs()

NDArray NDArray::abs ( void ) const

Definition at line 570 of file dNDArray.cc.

Referenced by Matrix::abs().

◆ all()

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

Definition at line 395 of file dNDArray.cc.

References mx_inline_all().

Referenced by Matrix::all().

◆ all_elements_are_int_or_inf_or_nan()

bool NDArray::all_elements_are_int_or_inf_or_nan ( void ) const

Definition at line 342 of file dNDArray.cc.

References is_int_or_inf_or_nan(), and Array< double >::test_all().

◆ all_elements_are_zero()

bool NDArray::all_elements_are_zero ( void ) const

Definition at line 336 of file dNDArray.cc.

References is_zero(), and Array< double >::test_all().

◆ all_integers() [1/2]

bool NDArray::all_integers	(	double &	max_val,
		double &	min_val
	)		const

Definition at line 351 of file dNDArray.cc.

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

Referenced by elem_xpow().

◆ all_integers() [2/2]

bool NDArray::all_integers ( void ) const

Definition at line 381 of file dNDArray.cc.

References isinteger(), and Array< double >::test_all().

◆ any()

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

Definition at line 401 of file dNDArray.cc.

References mx_inline_any().

Referenced by Matrix::any().

◆ any_element_is_inf_or_nan()

bool NDArray::any_element_is_inf_or_nan ( void ) const

Definition at line 324 of file dNDArray.cc.

References mx_inline_all_finite().

Referenced by Fgsvd(), Fsvd(), and EIG::init().

◆ any_element_is_nan()

bool NDArray::any_element_is_nan ( void ) const

Definition at line 318 of file dNDArray.cc.

References mx_inline_any_nan().

Referenced by octave_matrix::bool_array_value(), and operator!().

◆ any_element_is_negative()

bool NDArray::any_element_is_negative ( bool neg_zero = false ) const

Definition at line 304 of file dNDArray.cc.

References mx_inline_any_negative(), negative_sign(), and Array< double >::test_all().

Referenced by elem_xpow().

◆ any_element_is_positive()

bool NDArray::any_element_is_positive ( bool neg_zero = false ) const

Definition at line 311 of file dNDArray.cc.

References mx_inline_any_positive(), positive_sign(), and Array< double >::test_all().

◆ any_element_not_one_or_zero()

bool NDArray::any_element_not_one_or_zero ( void ) const

Definition at line 330 of file dNDArray.cc.

References is_one_or_zero(), and Array< double >::test_all().

Referenced by octave_matrix::bool_array_value().

◆ as_column()

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

inlineinherited

Return the array as a column vector.

Definition at line 420 of file Array.h.

◆ as_matrix()

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

inlineinherited

Return the array as a matrix.

Definition at line 442 of file Array.h.

◆ as_row()

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

inlineinherited

Return the array as a row vector.

Definition at line 431 of file Array.h.

◆ assign() [1/6]

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

inlineinherited

Size of the specified dimension.

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

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

Definition at line 765 of file Array.h.

◆ assign() [2/6]

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

inherited

Size of the specified dimension.

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

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

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

◆ assign() [3/6]

OCTARRAY_OVERRIDABLE_FUNC_API void Array< double , Alloc >::assign	(	const octave::idx_vector &	i,
		const Array< T, Alloc > &	rhs
	)

inlineinherited

Size of the specified dimension.

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

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

Definition at line 747 of file Array.h.

◆ assign() [4/6]

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

inherited

Indexed assignment (always with resize & fill).

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

◆ assign() [5/6]

OCTARRAY_OVERRIDABLE_FUNC_API void Array< double , Alloc >::assign	(	const octave::idx_vector &	i,
		const octave::idx_vector &	j,
		const Array< T, Alloc > &	rhs
	)

inlineinherited

Size of the specified dimension.

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

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

Definition at line 756 of file Array.h.

◆ assign() [6/6]

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

inherited

Size of the specified dimension.

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

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

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

◆ byte_size()

OCTARRAY_OVERRIDABLE_FUNC_API std::size_t Array< double , Alloc >::byte_size ( void ) const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 499 of file Array.h.

◆ cat()

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

staticinherited

Concatenation along a specified (0-based) dimension, equivalent to cat().

dim = -1 corresponds to dim = 0 and dim = -2 corresponds to dim = 1, but apply the looser matching rules of vertcat/horzcat.

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

◆ changesign()

NDArray& NDArray::changesign ( void )

inline

Definition at line 162 of file dNDArray.h.

References MArray< T >::changesign().

◆ checkelem() [1/8]

double & Array< double , Alloc >::checkelem ( const Array< octave_idx_type > & ra_idx )

inherited

Size of the specified dimension.

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

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

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

◆ checkelem() [2/8]

Array< double , Alloc >::crefT Array< double , Alloc >::checkelem ( const Array< octave_idx_type > & ra_idx ) const

inherited

Size of the specified dimension.

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

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

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

◆ checkelem() [3/8]

double & Array< double , Alloc >::checkelem	(	octave_idx_type	i,
		octave_idx_type	j
	)

inherited

Size of the specified dimension.

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

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

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

◆ checkelem() [4/8]

Array< double , Alloc >::crefT Array< double , Alloc >::checkelem	(	octave_idx_type	i,
		octave_idx_type	j
	)		const

inherited

Size of the specified dimension.

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

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

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

◆ checkelem() [5/8]

double & Array< double , Alloc >::checkelem	(	octave_idx_type	i,
		octave_idx_type	j,
		octave_idx_type	k
	)

inherited

Size of the specified dimension.

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

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

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

◆ checkelem() [6/8]

Array< double , Alloc >::crefT Array< double , Alloc >::checkelem	(	octave_idx_type	i,
		octave_idx_type	j,
		octave_idx_type	k
	)		const

inherited

Size of the specified dimension.

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

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

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

◆ checkelem() [7/8]

double & Array< double , Alloc >::checkelem ( octave_idx_type n )

inherited

Size of the specified dimension.

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

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

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

◆ checkelem() [8/8]

Array< double , Alloc >::crefT Array< double , Alloc >::checkelem ( octave_idx_type n ) const

inherited

Size of the specified dimension.

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

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

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

◆ clear() [1/3]

void Array< double , Alloc >::clear ( const dim_vector & dv )

inherited

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

◆ clear() [2/3]

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

inlineinherited

Definition at line 409 of file Array.h.

◆ clear() [3/3]

void Array< double , Alloc >::clear ( void )

inherited

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

◆ cols()

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

inlineinherited

Definition at line 469 of file Array.h.

◆ column()

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

inherited

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

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

◆ columns()

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

inlineinherited

Definition at line 471 of file Array.h.

◆ compute_index() [1/4]

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

static

Definition at line 602 of file dNDArray.cc.

References compute_index(), and ra_idx.

◆ compute_index() [2/4]

octave_idx_type Array< double , Alloc >::compute_index ( const Array< octave_idx_type > & ra_idx ) const

inherited

Size of the specified dimension.

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

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

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

◆ compute_index() [3/4]

octave_idx_type Array< double , Alloc >::compute_index	(	octave_idx_type	i,
		octave_idx_type	j
	)		const

inherited

Size of the specified dimension.

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

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

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

◆ compute_index() [4/4]

octave_idx_type Array< double , Alloc >::compute_index	(	octave_idx_type	i,
		octave_idx_type	j,
		octave_idx_type	k
	)		const

inherited

Size of the specified dimension.

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

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

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

◆ compute_index_unchecked()

OCTARRAY_OVERRIDABLE_FUNC_API octave_idx_type Array< double , Alloc >::compute_index_unchecked ( const Array< octave_idx_type > & ra_idx ) const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 517 of file Array.h.

◆ concat() [1/3]

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

Definition at line 514 of file dNDArray.cc.

References d, Array< double >::dims(), Array< T, Alloc >::elem(), Array< double >::elem(), charNDArray::insert(), Array< T, Alloc >::isempty(), isnan(), max(), nint_big(), Array< double >::numel(), and ra_idx.

◆ concat() [2/3]

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

Definition at line 505 of file dNDArray.cc.

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

◆ concat() [3/3]

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

Definition at line 497 of file dNDArray.cc.

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

◆ cummax() [1/2]

NDArray NDArray::cummax	(	Array< octave_idx_type > &	index,
		int	dim = `-1`
	)		const

Definition at line 473 of file dNDArray.cc.

References mx_inline_cummax().

◆ cummax() [2/2]

NDArray NDArray::cummax ( int dim = -1 ) const

Definition at line 467 of file dNDArray.cc.

References mx_inline_cummax().

◆ cummin() [1/2]

NDArray NDArray::cummin	(	Array< octave_idx_type > &	index,
		int	dim = `-1`
	)		const

Definition at line 485 of file dNDArray.cc.

References mx_inline_cummin().

◆ cummin() [2/2]

NDArray NDArray::cummin ( int dim = -1 ) const

Definition at line 479 of file dNDArray.cc.

References mx_inline_cummin().

◆ cumprod()

NDArray NDArray::cumprod ( int dim = -1 ) const

Definition at line 407 of file dNDArray.cc.

References mx_inline_cumprod().

Referenced by Matrix::cumprod().

◆ cumsum()

NDArray NDArray::cumsum ( int dim = -1 ) const

Definition at line 413 of file dNDArray.cc.

References mx_inline_cumsum().

Referenced by Matrix::cumsum(), and Fcumsum().

◆ data()

OCTARRAY_OVERRIDABLE_FUNC_API const double * Array< double , Alloc >::data ( void ) const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 663 of file Array.h.

◆ delete_elements() [1/3]

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

inherited

Dispatcher to the above two.

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

◆ delete_elements() [2/3]

void Array< double , Alloc >::delete_elements ( const octave::idx_vector & i )

inherited

Deleting elements.

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

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

◆ delete_elements() [3/3]

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

inherited

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

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

◆ diag() [1/2]

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

Definition at line 609 of file dNDArray.cc.

References Array< T >::diag().

Referenced by Matrix::diag().

◆ diag() [2/2]

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

Definition at line 615 of file dNDArray.cc.

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

◆ diff()

NDArray NDArray::diff	(	octave_idx_type	order = `1`,
		int	dim = `-1`
	)		const

Definition at line 491 of file dNDArray.cc.

References mx_inline_diff().

Referenced by do_diff().

◆ dim1()

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

inlineinherited

Definition at line 456 of file Array.h.

◆ dim2()

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

inlineinherited

Definition at line 467 of file Array.h.

◆ dim3()

OCTARRAY_OVERRIDABLE_FUNC_API octave_idx_type Array< double , Alloc >::dim3 ( void ) const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 479 of file Array.h.

◆ dims()

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

inlineinherited

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

Definition at line 503 of file Array.h.

◆ elem() [1/8]

OCTARRAY_OVERRIDABLE_FUNC_API double & Array< double , Alloc >::elem ( const Array< octave_idx_type > & ra_idx )

inlineinherited

Size of the specified dimension.

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

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

Definition at line 574 of file Array.h.

◆ elem() [2/8]

OCTARRAY_OVERRIDABLE_FUNC_API crefT Array< double , Alloc >::elem ( const Array< octave_idx_type > & ra_idx ) const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 607 of file Array.h.

◆ elem() [3/8]

OCTARRAY_OVERRIDABLE_FUNC_API double & Array< double , Alloc >::elem	(	octave_idx_type	i,
		octave_idx_type	j
	)

inlineinherited

Size of the specified dimension.

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

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

Definition at line 568 of file Array.h.

◆ elem() [4/8]

OCTARRAY_OVERRIDABLE_FUNC_API crefT Array< double , Alloc >::elem	(	octave_idx_type	i,
		octave_idx_type	j
	)		const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 599 of file Array.h.

◆ elem() [5/8]

OCTARRAY_OVERRIDABLE_FUNC_API double & Array< double , Alloc >::elem	(	octave_idx_type	i,
		octave_idx_type	j,
		octave_idx_type	k
	)

inlineinherited

Size of the specified dimension.

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

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

Definition at line 571 of file Array.h.

◆ elem() [6/8]

OCTARRAY_OVERRIDABLE_FUNC_API crefT Array< double , Alloc >::elem	(	octave_idx_type	i,
		octave_idx_type	j,
		octave_idx_type	k
	)		const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 603 of file Array.h.

◆ elem() [7/8]

OCTARRAY_OVERRIDABLE_FUNC_API double & Array< double , Alloc >::elem ( octave_idx_type n )

inlineinherited

Size of the specified dimension.

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

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

Definition at line 562 of file Array.h.

◆ elem() [8/8]

OCTARRAY_OVERRIDABLE_FUNC_API crefT Array< double , Alloc >::elem ( octave_idx_type n ) const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 595 of file Array.h.

◆ fill()

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

inherited

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

◆ find() [1/3]

Array< octave_idx_type > Array< double , Alloc >::find	(	octave_idx_type	n = `-1`,
		bool	backward = `false`
	)		const

inherited

Find indices of (at most n) nonzero elements.

If n is specified, backward specifies search from backward.

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

◆ find() [2/3]

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

inherited

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

◆ find() [3/3]

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

inherited

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

◆ fortran_vec()

double * Array< double , Alloc >::fortran_vec ( void )

inherited

Size of the specified dimension.

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

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

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

◆ fourier()

ComplexNDArray NDArray::fourier ( int dim = 1 ) const

Definition at line 100 of file dNDArray.cc.

References ComplexNDArray, Array< double >::data(), Array< double >::dims(), Array< T, Alloc >::fortran_vec(), n, dim_vector::ndims(), and Array< double >::numel().

Referenced by do_fft().

◆ fourier2d()

ComplexNDArray NDArray::fourier2d ( void ) const

Definition at line 161 of file dNDArray.cc.

References ComplexNDArray, Array< double >::data(), Array< double >::dims(), Array< T, Alloc >::fortran_vec(), dim_vector::ndims(), and Array< double >::numel().

Referenced by do_fft2().

◆ fourierNd()

ComplexNDArray NDArray::fourierNd ( void ) const

Definition at line 200 of file dNDArray.cc.

References Array< double >::data(), Array< double >::dims(), Array< T, Alloc >::fortran_vec(), and dim_vector::ndims().

Referenced by do_fftn().

◆ hermitian() [1/2]

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

inherited

Size of the specified dimension.

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

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

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

◆ hermitian() [2/2]

MArray<double > MArray< double >::hermitian ( T(*)(const T &) fcn = nullptr ) const

inlineinherited

Definition at line 102 of file MArray.h.

◆ idx_add() [1/2]

void MArray< double >::idx_add	(	const octave::idx_vector &	idx,
		const MArray< T > &	vals
	)

inherited

Definition at line 109 of file MArray.cc.

◆ idx_add() [2/2]

void MArray< double >::idx_add	(	const octave::idx_vector &	idx,
		T	val
	)

inherited

Performs indexed accumulative addition.

Definition at line 107 of file MArray.cc.

◆ idx_add_nd()

void MArray< double >::idx_add_nd	(	const octave::idx_vector &	idx,
		const MArray< T > &	vals,
		int	dim = `-1`
	)

inherited

Definition at line 119 of file MArray.cc.

◆ idx_max()

void MArray< double >::idx_max	(	const octave::idx_vector &	idx,
		const MArray< T > &	vals
	)

inherited

Definition at line 116 of file MArray.cc.

◆ idx_min()

void MArray< double >::idx_min	(	const octave::idx_vector &	idx,
		const MArray< T > &	vals
	)

inherited

Definition at line 113 of file MArray.cc.

◆ ifourier()

ComplexNDArray NDArray::ifourier ( int dim = 1 ) const

Definition at line 131 of file dNDArray.cc.

References ComplexNDArray, Array< double >::dims(), and dim_vector::ndims().

Referenced by do_fft().

◆ ifourier2d()

ComplexNDArray NDArray::ifourier2d ( void ) const

Definition at line 181 of file dNDArray.cc.

References ComplexNDArray, Array< double >::dims(), Array< T, Alloc >::fortran_vec(), dim_vector::ndims(), and Array< double >::numel().

Referenced by do_fft2().

◆ ifourierNd()

ComplexNDArray NDArray::ifourierNd ( void ) const

Definition at line 215 of file dNDArray.cc.

References Array< double >::dims(), Array< T, Alloc >::fortran_vec(), and dim_vector::ndims().

Referenced by do_fftn().

◆ increment_index()

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

static

Definition at line 594 of file dNDArray.cc.

References ra_idx.

◆ index() [1/9]

Array< double , Alloc > Array< double , Alloc >::index ( const Array< octave::idx_vector > & ia ) const

inherited

Size of the specified dimension.

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

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

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

◆ index() [2/9]

OCTARRAY_OVERRIDABLE_FUNC_API Array<double , Alloc> Array< double , Alloc >::index	(	const Array< octave::idx_vector > &	ia,
		bool	resize_ok
	)		const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 736 of file Array.h.

◆ index() [3/9]

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

inherited

Size of the specified dimension.

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

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

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

◆ index() [4/9]

Array< double , Alloc > Array< double , Alloc >::index ( const octave::idx_vector & i ) const

inherited

Indexing without resizing.

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

◆ index() [5/9]

OCTARRAY_OVERRIDABLE_FUNC_API Array<double , Alloc> Array< double , Alloc >::index	(	const octave::idx_vector &	i,
		bool	resize_ok
	)		const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 717 of file Array.h.

◆ index() [6/9]

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

inherited

Indexing with possible resizing and fill.

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

◆ index() [7/9]

Array< double , Alloc > Array< double , Alloc >::index	(	const octave::idx_vector &	i,
		const octave::idx_vector &	j
	)		const

inherited

Size of the specified dimension.

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

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

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

◆ index() [8/9]

OCTARRAY_OVERRIDABLE_FUNC_API Array<double , Alloc> Array< double , Alloc >::index	(	const octave::idx_vector &	i,
		const octave::idx_vector &	j,
		bool	resize_ok
	)		const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 726 of file Array.h.

◆ index() [9/9]

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

inherited

Size of the specified dimension.

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

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

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

◆ insert() [1/4]

Array< double , Alloc > & Array< double , Alloc >::insert	(	const Array< T, Alloc > &	a,
		const Array< octave_idx_type > &	idx
	)

inherited

Insert an array into another at a specified position.

If size (a) is [d1 d2 ... dN] and idx is [i1 i2 ... iN], this method is equivalent to x(i1:i1+d1-1, i2:i2+d2-1, ... , iN:iN+dN-1) = a.

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

◆ insert() [2/4]

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

inherited

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

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

◆ insert() [3/4]

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

Definition at line 563 of file dNDArray.cc.

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

◆ insert() [4/4]

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

Definition at line 556 of file dNDArray.cc.

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

Referenced by concat().

◆ instantiation_guard() [1/11]

OCTARRAY_CLASS_TEMPLATE_INSTANTIATION_API void MArray< int >::instantiation_guard ( )

privateinherited

Definition at line 37 of file MArray-i.cc.

◆ instantiation_guard() [2/11]

OCTARRAY_CLASS_TEMPLATE_INSTANTIATION_API void MArray< octave_int8 >::instantiation_guard ( )

privateinherited

Definition at line 47 of file MArray-i.cc.

◆ instantiation_guard() [3/11]

OCTARRAY_CLASS_TEMPLATE_INSTANTIATION_API void MArray< octave_int16 >::instantiation_guard ( )

privateinherited

Definition at line 48 of file MArray-i.cc.

◆ instantiation_guard() [4/11]

OCTARRAY_CLASS_TEMPLATE_INSTANTIATION_API void MArray< octave_int32 >::instantiation_guard ( )

privateinherited

Definition at line 49 of file MArray-i.cc.

◆ instantiation_guard() [5/11]

OCTARRAY_CLASS_TEMPLATE_INSTANTIATION_API void MArray< octave_int64 >::instantiation_guard ( )

privateinherited

Definition at line 50 of file MArray-i.cc.

◆ instantiation_guard() [6/11]

OCTARRAY_CLASS_TEMPLATE_INSTANTIATION_API void MArray< octave_uint8 >::instantiation_guard ( )

privateinherited

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

◆ instantiation_guard() [7/11]

OCTARRAY_CLASS_TEMPLATE_INSTANTIATION_API void MArray< octave_uint16 >::instantiation_guard ( )

privateinherited

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

◆ instantiation_guard() [8/11]

OCTARRAY_CLASS_TEMPLATE_INSTANTIATION_API void MArray< octave_uint32 >::instantiation_guard ( )

privateinherited

Definition at line 59 of file MArray-i.cc.

◆ instantiation_guard() [9/11]

OCTARRAY_CLASS_TEMPLATE_INSTANTIATION_API void MArray< octave_uint64 >::instantiation_guard ( )

privateinherited

Definition at line 60 of file MArray-i.cc.

◆ instantiation_guard() [10/11]

OCTARRAY_CLASS_TEMPLATE_INSTANTIATION_API void MArray< short >::instantiation_guard ( )

privateinherited

Definition at line 35 of file MArray-s.cc.

◆ instantiation_guard() [11/11]

void MArray< double >::instantiation_guard

staticprivateinherited

Definition at line 125 of file MArray.cc.

◆ ipermute()

MArray<double > MArray< double >::ipermute ( const Array< octave_idx_type > & vec ) const

inlineinherited

Definition at line 94 of file MArray.h.

◆ is_nd_vector()

OCTARRAY_OVERRIDABLE_FUNC_API bool Array< double , Alloc >::is_nd_vector ( void ) const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 657 of file Array.h.

◆ is_shared()

OCTARRAY_OVERRIDABLE_FUNC_API bool Array< double , Alloc >::is_shared ( void ) const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 674 of file Array.h.

◆ is_sorted_rows() [1/3]

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

inherited

Ordering is auto-detected or can be specified.

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

◆ is_sorted_rows() [2/3]

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

inherited

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

◆ is_sorted_rows() [3/3]

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

inherited

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

◆ isempty()

OCTARRAY_OVERRIDABLE_FUNC_API bool Array< double , Alloc >::isempty ( void ) const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 651 of file Array.h.

◆ isfinite()

boolNDArray NDArray::isfinite ( void ) const

Definition at line 588 of file dNDArray.cc.

◆ isinf()

boolNDArray NDArray::isinf ( void ) const

Definition at line 582 of file dNDArray.cc.

◆ isnan()

boolNDArray NDArray::isnan ( void ) const

Definition at line 576 of file dNDArray.cc.

◆ issorted() [1/4]

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

inherited

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

◆ issorted() [2/4]

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

inherited

Ordering is auto-detected or can be specified.

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

◆ issorted() [3/4]

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

inherited

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

◆ issorted() [4/4]

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

inherited

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

◆ issquare()

OCTARRAY_OVERRIDABLE_FUNC_API bool Array< double , Alloc >::issquare ( void ) const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 648 of file Array.h.

◆ isvector()

OCTARRAY_OVERRIDABLE_FUNC_API bool Array< double , Alloc >::isvector ( void ) const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 654 of file Array.h.

◆ linear_slice()

Array< double , Alloc > Array< double , Alloc >::linear_slice	(	octave_idx_type	lo,
		octave_idx_type	up
	)		const

inherited

Extract a slice from this array as a column vector: A(:)(lo+1:up).

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

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

◆ lookup() [1/6]

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

inherited

Ditto, but for an array of values, specializing on the case when values are sorted.

NaNs get the value N.

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

◆ lookup() [2/6]

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

inherited

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

◆ lookup() [3/6]

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

inherited

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

◆ lookup() [4/6]

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

inherited

Do a binary lookup in a sorted array.

Must not contain NaNs. Mode can be specified or is auto-detected by comparing 1st and last element.

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

◆ lookup() [5/6]

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

inherited

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

◆ lookup() [6/6]

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

inherited

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

◆ make_unique()

OCTARRAY_OVERRIDABLE_FUNC_API void Array< double , Alloc >::make_unique ( void )

inlineinherited

Definition at line 216 of file Array.h.

◆ map() [1/3]

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

inlineinherited

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

This function is optimized with a manually unrolled loop.

Definition at line 865 of file Array.h.

◆ map() [2/3]

Array<U, A> Array< double , Alloc >::map ( U(&)(const T &) fcn ) const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 910 of file Array.h.

◆ map() [3/3]

Array<U, A> Array< double , Alloc >::map ( U(&)(T) fcn ) const

inlineinherited

Overloads for function references.

Definition at line 901 of file Array.h.

◆ max() [1/2]

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

Definition at line 449 of file dNDArray.cc.

References mx_inline_max().

◆ max() [2/2]

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

Definition at line 443 of file dNDArray.cc.

References mx_inline_max().

◆ maybe_economize()

OCTARRAY_OVERRIDABLE_FUNC_API void Array< double , Alloc >::maybe_economize ( void )

inlineinherited

Size of the specified dimension.

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

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

Definition at line 795 of file Array.h.

◆ min() [1/2]

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

Definition at line 461 of file dNDArray.cc.

References mx_inline_min().

◆ min() [2/2]

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

Definition at line 455 of file dNDArray.cc.

References mx_inline_min().

◆ ndims()

OCTARRAY_OVERRIDABLE_FUNC_API int Array< double , Alloc >::ndims ( void ) const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 677 of file Array.h.

◆ nil_rep()

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

staticprivateinherited

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

◆ nnz() [1/3]

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

inherited

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

◆ nnz() [2/3]

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

inherited

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

◆ nnz() [3/3]

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

inherited

Count nonzero elements.

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

◆ nth_element() [1/3]

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

inherited

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

◆ nth_element() [2/3]

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

inherited

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

◆ nth_element() [3/3]

Array< double , Alloc > Array< double , Alloc >::nth_element	(	const octave::idx_vector &	n,
		int	dim = `0`
	)		const

inherited

Returns the n-th element in increasing order, using the same ordering as used for sort.

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

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

◆ numel()

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

inlineinherited

Number of elements in the array.

Definition at line 414 of file Array.h.

◆ operator!()

boolNDArray NDArray::operator! ( void ) const

Definition at line 295 of file dNDArray.cc.

References any_element_is_nan(), err_nan_to_logical_conversion(), and mx_inline_not().

◆ operator()() [1/8]

OCTARRAY_OVERRIDABLE_FUNC_API double & Array< double , Alloc >::operator() ( const Array< octave_idx_type > & ra_idx )

inlineinherited

Size of the specified dimension.

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

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

Definition at line 583 of file Array.h.

◆ operator()() [2/8]

OCTARRAY_OVERRIDABLE_FUNC_API crefT Array< double , Alloc >::operator() ( const Array< octave_idx_type > & ra_idx ) const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 619 of file Array.h.

◆ operator()() [3/8]

OCTARRAY_OVERRIDABLE_FUNC_API double & Array< double , Alloc >::operator()	(	octave_idx_type	i,
		octave_idx_type	j
	)

inlineinherited

Size of the specified dimension.

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

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

Definition at line 579 of file Array.h.

◆ operator()() [4/8]

OCTARRAY_OVERRIDABLE_FUNC_API crefT Array< double , Alloc >::operator()	(	octave_idx_type	i,
		octave_idx_type	j
	)		const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 613 of file Array.h.

◆ operator()() [5/8]

OCTARRAY_OVERRIDABLE_FUNC_API double & Array< double , Alloc >::operator()	(	octave_idx_type	i,
		octave_idx_type	j,
		octave_idx_type	k
	)

inlineinherited

Size of the specified dimension.

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

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

Definition at line 581 of file Array.h.

◆ operator()() [6/8]

OCTARRAY_OVERRIDABLE_FUNC_API crefT Array< double , Alloc >::operator()	(	octave_idx_type	i,
		octave_idx_type	j,
		octave_idx_type	k
	)		const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 616 of file Array.h.

◆ operator()() [7/8]

OCTARRAY_OVERRIDABLE_FUNC_API double & Array< double , Alloc >::operator() ( octave_idx_type n )

inlineinherited

Size of the specified dimension.

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

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

Definition at line 577 of file Array.h.

◆ operator()() [8/8]

OCTARRAY_OVERRIDABLE_FUNC_API crefT Array< double , Alloc >::operator() ( octave_idx_type n ) const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 611 of file Array.h.

◆ operator=()

NDArray& NDArray::operator= ( const NDArray & a )

inline

Definition at line 66 of file dNDArray.h.

References MArray< T >::operator=().

◆ optimize_dimensions()

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

inherited

Returns true if this->dims () == dv, and if so, replaces this->m_dimensions by a shallow copy of dv.

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

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

◆ page()

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

inherited

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

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

◆ pages()

OCTARRAY_OVERRIDABLE_FUNC_API octave_idx_type Array< double , Alloc >::pages ( void ) const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 481 of file Array.h.

◆ permute()

MArray<double > MArray< double >::permute	(	const Array< octave_idx_type > &	vec,
		bool	inv = `false`
	)		const

inlineinherited

Definition at line 90 of file MArray.h.

◆ print_info()

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

inherited

Size of the specified dimension.

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

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

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

◆ prod()

NDArray NDArray::prod ( int dim = -1 ) const

Definition at line 419 of file dNDArray.cc.

References mx_inline_prod().

Referenced by Fprod(), and Matrix::prod().

◆ reshape() [1/2]

MArray<double > MArray< double >::reshape ( const dim_vector & new_dims ) const

inlineinherited

Definition at line 87 of file MArray.h.

◆ reshape() [2/2]

OCTARRAY_OVERRIDABLE_FUNC_API Array<double , Alloc> Array< double , Alloc >::reshape	(	octave_idx_type	nr,
		octave_idx_type	nc
	)		const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 635 of file Array.h.

◆ resize() [1/2]

OCTARRAY_OVERRIDABLE_FUNC_API void Array< double , Alloc >::resize ( const dim_vector & dv )

inlineinherited

Size of the specified dimension.

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

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

Definition at line 704 of file Array.h.

◆ resize() [2/2]

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

inherited

Size of the specified dimension.

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

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

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

◆ resize1() [1/2]

OCTARRAY_OVERRIDABLE_FUNC_API void Array< double , Alloc >::resize1 ( octave_idx_type n )

inlineinherited

Size of the specified dimension.

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

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

Definition at line 700 of file Array.h.

◆ resize1() [2/2]

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

inherited

Size of the specified dimension.

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

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

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

◆ resize2() [1/2]

OCTARRAY_OVERRIDABLE_FUNC_API void Array< double , Alloc >::resize2	(	octave_idx_type	nr,
		octave_idx_type	nc
	)

inlineinherited

Size of the specified dimension.

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

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

Definition at line 694 of file Array.h.

◆ resize2() [2/2]

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

inherited

Resizing (with fill).

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

◆ resize_fill_value()

double Array< double , Alloc >::resize_fill_value ( void ) const

virtualinherited

Size of the specified dimension.

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

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

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

◆ rows()

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

inlineinherited

Definition at line 459 of file Array.h.

◆ size()

OCTARRAY_OVERRIDABLE_FUNC_API size_type Array< double , Alloc >::size ( const size_type d ) const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 492 of file Array.h.

◆ sort() [1/6]

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

inherited

Size of the specified dimension.

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

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

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

◆ sort() [2/6]

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

inherited

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

◆ sort() [3/6]

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

inherited

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

◆ sort() [4/6]

Array< double , Alloc > Array< double , Alloc >::sort	(	int	dim = `0`,
		sortmode	mode = `ASCENDING`
	)		const

inherited

Size of the specified dimension.

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

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

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

◆ sort() [5/6]

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

inherited

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

◆ sort() [6/6]

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

inherited

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

◆ sort_rows_idx() [1/3]

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

inherited

Sort by rows returns only indices.

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

◆ sort_rows_idx() [2/3]

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

inherited

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

◆ sort_rows_idx() [3/3]

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

inherited

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

◆ squeeze()

NDArray NDArray::squeeze ( void ) const

inline

Definition at line 143 of file dNDArray.h.

References MArray< T >::squeeze().

Referenced by octave_matrix::squeeze().

◆ sum()

NDArray NDArray::sum ( int dim = -1 ) const

Definition at line 425 of file dNDArray.cc.

References mx_inline_sum().

Referenced by Fsum(), and Matrix::sum().

◆ sumsq()

NDArray NDArray::sumsq ( int dim = -1 ) const

Definition at line 437 of file dNDArray.cc.

References mx_inline_sumsq().

Referenced by Matrix::sumsq().

◆ test()

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

inlineinherited

Generic any/all test functionality with arbitrary predicate.

Definition at line 916 of file Array.h.

◆ test_all() [1/3]

bool Array< double , Alloc >::test_all ( bool(&)(const T &) fcn ) const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 943 of file Array.h.

◆ test_all() [2/3]

bool Array< double , Alloc >::test_all ( bool(&)(T) fcn ) const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 940 of file Array.h.

◆ test_all() [3/3]

bool Array< double , Alloc >::test_all ( F fcn ) const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 928 of file Array.h.

◆ test_any() [1/3]

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

inlineinherited

Size of the specified dimension.

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

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

Definition at line 937 of file Array.h.

◆ test_any() [2/3]

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

inlineinherited

Overloads for function references.

Definition at line 934 of file Array.h.

◆ test_any() [3/3]

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

inlineinherited

Simpler calls.

Definition at line 924 of file Array.h.

◆ too_large_for_float()

bool NDArray::too_large_for_float ( void ) const

Definition at line 387 of file dNDArray.cc.

References Array< double >::test_any(), and too_large_for_float().

◆ transpose()

MArray<double > MArray< double >::transpose ( void ) const

inlineinherited

Definition at line 99 of file MArray.h.

◆ xelem() [1/8]

OCTARRAY_OVERRIDABLE_FUNC_API double & Array< double , Alloc >::xelem ( const Array< octave_idx_type > & ra_idx )

inlineinherited

Size of the specified dimension.

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

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

Definition at line 544 of file Array.h.

◆ xelem() [2/8]

OCTARRAY_OVERRIDABLE_FUNC_API crefT Array< double , Alloc >::xelem ( const Array< octave_idx_type > & ra_idx ) const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 548 of file Array.h.

◆ xelem() [3/8]

OCTARRAY_OVERRIDABLE_FUNC_API double & Array< double , Alloc >::xelem	(	octave_idx_type	i,
		octave_idx_type	j
	)

inlineinherited

Size of the specified dimension.

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

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

Definition at line 530 of file Array.h.

◆ xelem() [4/8]

OCTARRAY_OVERRIDABLE_FUNC_API crefT Array< double , Alloc >::xelem	(	octave_idx_type	i,
		octave_idx_type	j
	)		const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 533 of file Array.h.

◆ xelem() [5/8]

OCTARRAY_OVERRIDABLE_FUNC_API double & Array< double , Alloc >::xelem	(	octave_idx_type	i,
		octave_idx_type	j,
		octave_idx_type	k
	)

inlineinherited

Size of the specified dimension.

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

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

Definition at line 537 of file Array.h.

◆ xelem() [6/8]

OCTARRAY_OVERRIDABLE_FUNC_API crefT Array< double , Alloc >::xelem	(	octave_idx_type	i,
		octave_idx_type	j,
		octave_idx_type	k
	)		const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 540 of file Array.h.

◆ xelem() [7/8]

OCTARRAY_OVERRIDABLE_FUNC_API double & Array< double , Alloc >::xelem ( octave_idx_type n )

inlineinherited

Size of the specified dimension.

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

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

Definition at line 524 of file Array.h.

◆ xelem() [8/8]

OCTARRAY_OVERRIDABLE_FUNC_API crefT Array< double , Alloc >::xelem ( octave_idx_type n ) const

inlineinherited

Size of the specified dimension.

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

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

Definition at line 526 of file Array.h.

◆ xsum()

NDArray NDArray::xsum ( int dim = -1 ) const

Definition at line 431 of file dNDArray.cc.

References mx_inline_xsum().

Referenced by Fsum().

Friends And Related Function Documentation

◆ ComplexNDArray

friend class ComplexNDArray

friend

Definition at line 141 of file dNDArray.h.

Referenced by fourier(), fourier2d(), ifourier(), and ifourier2d().

◆ imag

OCTAVE_API NDArray imag ( const ComplexNDArray & a )

friend

Definition at line 550 of file dNDArray.cc.

◆ operator<<

OCTAVE_API std::ostream& operator<<	(	std::ostream &	os,
		const NDArray &	a
	)

friend

Definition at line 621 of file dNDArray.cc.

◆ operator>>

OCTAVE_API std::istream& operator>>	(	std::istream &	is,
		NDArray &	a
	)

friend

Definition at line 636 of file dNDArray.cc.

◆ real

OCTAVE_API NDArray real ( const ComplexNDArray & a )

friend

Definition at line 544 of file dNDArray.cc.

Member Data Documentation

◆ m_dimensions

dim_vector Array< double , Alloc >::m_dimensions

protectedinherited

Definition at line 245 of file Array.h.

◆ m_rep

Array<double , Alloc>::ArrayRep* Array< double , Alloc >::m_rep

protectedinherited

Definition at line 247 of file Array.h.

◆ m_slice_data

double * Array< double , Alloc >::m_slice_data

protectedinherited

Definition at line 256 of file Array.h.

◆ m_slice_len

octave_idx_type Array< double , Alloc >::m_slice_len

protectedinherited

Definition at line 257 of file Array.h.

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

liboctave/array/dNDArray.h
liboctave/array/dNDArray.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Friends

Third dimension

Detailed Description

Member Typedef Documentation

◆ compare_fcn_type

◆ crefT

◆ element_type

◆ size_type

◆ value_type

Constructor & Destructor Documentation

◆ NDArray() [1/9]

◆ NDArray() [2/9]

◆ NDArray() [3/9]

◆ NDArray() [4/9]

◆ NDArray() [5/9]

◆ NDArray() [6/9]

◆ NDArray() [7/9]

◆ NDArray() [8/9]

◆ NDArray() [9/9]

Member Function Documentation

◆ abs()

◆ all()

◆ all_elements_are_int_or_inf_or_nan()

◆ all_elements_are_zero()

◆ all_integers() [1/2]

◆ all_integers() [2/2]

◆ any()

◆ any_element_is_inf_or_nan()

◆ any_element_is_nan()

◆ any_element_is_negative()

◆ any_element_is_positive()

◆ any_element_not_one_or_zero()

◆ as_column()

◆ as_matrix()

◆ as_row()

◆ assign() [1/6]

◆ assign() [2/6]

◆ assign() [3/6]

◆ assign() [4/6]

◆ assign() [5/6]

◆ assign() [6/6]

◆ byte_size()

◆ cat()

◆ changesign()

◆ checkelem() [1/8]

◆ checkelem() [2/8]

◆ checkelem() [3/8]

◆ checkelem() [4/8]

◆ checkelem() [5/8]

◆ checkelem() [6/8]

◆ checkelem() [7/8]

◆ checkelem() [8/8]

◆ clear() [1/3]

◆ clear() [2/3]

◆ clear() [3/3]

◆ cols()

◆ column()

◆ columns()

◆ compute_index() [1/4]

◆ compute_index() [2/4]

◆ compute_index() [3/4]

◆ compute_index() [4/4]

◆ compute_index_unchecked()

◆ concat() [1/3]

◆ concat() [2/3]

◆ concat() [3/3]

◆ cummax() [1/2]

◆ cummax() [2/2]

◆ cummin() [1/2]

◆ cummin() [2/2]

◆ cumprod()

◆ cumsum()

◆ data()

◆ delete_elements() [1/3]