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

#include "fNDArray.h"

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

Public Types

typedef bool(* compare_fcn_type )(typename ref_param< float >::type, typename ref_param< float >::type)
 
typedef ref_param< float >::type crefT
 
typedef float element_type
 

Public Member Functions

 FloatNDArray (void)
 
 FloatNDArray (const dim_vector &dv)
 
 FloatNDArray (const dim_vector &dv, float val)
 
 FloatNDArray (const FloatNDArray &a)
 
template<class U >
 FloatNDArray (const MArray< U > &a)
 
template<class U >
 FloatNDArray (const Array< U > &a)
 
template<class U >
 FloatNDArray (const intNDArray< U > &a)
 
 FloatNDArray (const charNDArray &)
 
FloatNDArray abs (void) const
 
boolNDArray all (int dim=-1) const
 
bool all_elements_are_int_or_inf_or_nan (void) const
 
bool all_elements_are_zero (void) const
 
bool all_integers (float &max_val, float &min_val) const
 
bool all_integers (void) const
 
boolNDArray any (int dim=-1) const
 
bool any_element_is_inf_or_nan (void) const
 
bool any_element_is_nan (void) const
 
bool any_element_is_negative (bool=false) const
 
bool any_element_is_positive (bool=false) const
 
bool any_element_not_one_or_zero (void) const
 
Array< floatas_column (void) const
 Return the array as a column vector. More...
 
Array< floatas_matrix (void) const
 Return the array as a matrix. More...
 
Array< floatas_row (void) const
 Return the array as a row vector. More...
 
size_t byte_size (void) const
 
FloatNDArraychangesign (void)
 
floatcheckelem (octave_idx_type n)
 
floatcheckelem (octave_idx_type i, octave_idx_type j)
 
floatcheckelem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 
floatcheckelem (const Array< octave_idx_type > &ra_idx)
 
crefT checkelem (octave_idx_type n) const
 
crefT checkelem (octave_idx_type i, octave_idx_type j) const
 
crefT checkelem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 
crefT checkelem (const Array< octave_idx_type > &ra_idx) const
 
void clear (void)
 
void clear (const dim_vector &dv)
 
void clear (octave_idx_type r, octave_idx_type c)
 
Array< floatcolumn (octave_idx_type k) const
 Extract column: A(:,k+1). More...
 
octave_idx_type compute_index (octave_idx_type i, octave_idx_type j) const
 
octave_idx_type compute_index (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 
octave_idx_type compute_index (const Array< octave_idx_type > &ra_idx) const
 
octave_idx_type compute_index_unchecked (const Array< octave_idx_type > &ra_idx) const
 
FloatNDArray concat (const FloatNDArray &rb, const Array< octave_idx_type > &ra_idx)
 
FloatComplexNDArray concat (const FloatComplexNDArray &rb, const Array< octave_idx_type > &ra_idx)
 
charNDArray concat (const charNDArray &rb, const Array< octave_idx_type > &ra_idx)
 
FloatNDArray cummax (int dim=-1) const
 
FloatNDArray cummax (Array< octave_idx_type > &index, int dim=-1) const
 
FloatNDArray cummin (int dim=-1) const
 
FloatNDArray cummin (Array< octave_idx_type > &index, int dim=-1) const
 
FloatNDArray cumprod (int dim=-1) const
 
FloatNDArray cumsum (int dim=-1) const
 
const floatdata (void) const
 
FloatNDArray diag (octave_idx_type k=0) const
 
FloatNDArray diag (octave_idx_type m, octave_idx_type n) const
 
FloatNDArray diff (octave_idx_type order=1, int dim=-1) const
 
const dim_vectordims (void) const
 Return a const-reference so that dims ()(i) works efficiently. More...
 
NDArray dprod (int dim=-1) const
 
NDArray dsum (int dim=-1) const
 
floatelem (octave_idx_type n)
 
floatelem (octave_idx_type i, octave_idx_type j)
 
floatelem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 
floatelem (const Array< octave_idx_type > &ra_idx)
 
crefT elem (octave_idx_type n) const
 
crefT elem (octave_idx_type i, octave_idx_type j) const
 
crefT elem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 
crefT elem (const Array< octave_idx_type > &ra_idx) const
 
void fill (const float &val)
 
Array< octave_idx_typefind (octave_idx_type n=-1, bool backward=false) const
 Find indices of (at most n) nonzero elements. More...
 
const floatfortran_vec (void) const
 
floatfortran_vec (void)
 
FloatComplexNDArray fourier (int dim=1) const
 
FloatComplexNDArray fourier2d (void) const
 
FloatComplexNDArray fourierNd (void) const
 
MArray< floathermitian (float(*fcn)(const float &)=0) const
 
void idx_add (const idx_vector &idx, floatval)
 
void idx_add (const idx_vector &idx, const MArray< float > &vals)
 
void idx_add_nd (const idx_vector &idx, const MArray< float > &vals, int dim=-1)
 
void idx_max (const idx_vector &idx, const MArray< float > &vals)
 
void idx_min (const idx_vector &idx, const MArray< float > &vals)
 
FloatComplexNDArray ifourier (int dim=1) const
 
FloatComplexNDArray ifourier2d (void) const
 
FloatComplexNDArray ifourierNd (void) const
 
FloatNDArrayinsert (const FloatNDArray &a, octave_idx_type r, octave_idx_type c)
 
FloatNDArrayinsert (const FloatNDArray &a, const Array< octave_idx_type > &ra_idx)
 
Array< float > & insert (const Array< float > &a, const Array< octave_idx_type > &idx)
 Insert an array into another at a specified position. More...
 
Array< float > & insert (const Array< float > &a, octave_idx_type r, octave_idx_type c)
 This is just a special case for idx = [r c 0 ...]. More...
 
MArray< floatipermute (const Array< octave_idx_type > &vec) const
 
bool is_empty (void) const
 
bool is_shared (void)
 
sortmode is_sorted (sortmode mode=UNSORTED) const
 Ordering is auto-detected or can be specified. More...
 
sortmode is_sorted_rows (sortmode mode=UNSORTED) const
 Ordering is auto-detected or can be specified. More...
 
bool is_square (void) const
 
bool is_vector (void) const
 
boolNDArray isfinite (void) const
 
boolNDArray isinf (void) const
 
boolNDArray isnan (void) const
 
Array< floatlinear_slice (octave_idx_type lo, octave_idx_type up) const
 Extract a slice from this array as a column vector: A(:)(lo+1:up). More...
 
octave_idx_type lookup (const float &value, sortmode mode=UNSORTED) const
 Do a binary lookup in a sorted array. More...
 
Array< octave_idx_typelookup (const Array< float > &values, sortmode mode=UNSORTED) const
 Ditto, but for an array of values, specializing on the case when values are sorted. More...
 
void make_unique (void)
 
Array< U > map (F fcn) const
 Apply function fcn to each element of the Array<T>. More...
 
FloatNDArray max (int dim=-1) const
 
FloatNDArray max (Array< octave_idx_type > &index, int dim=-1) const
 
void maybe_economize (void)
 
void * mex_get_data (void) const
 Give a pointer to the data in mex format. More...
 
FloatNDArray min (int dim=-1) const
 
FloatNDArray min (Array< octave_idx_type > &index, int dim=-1) const
 
int ndims (void) const
 
octave_idx_type nnz (void) const
 Count nonzero elements. More...
 
Array< floatnth_element (const idx_vector &n, int dim=0) const
 Returns the n-th element in increasing order, using the same ordering as used for sort. More...
 
boolNDArray operator! (void) const
 
floatoperator() (octave_idx_type n)
 
floatoperator() (octave_idx_type i, octave_idx_type j)
 
floatoperator() (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 
floatoperator() (const Array< octave_idx_type > &ra_idx)
 
crefT operator() (octave_idx_type n) const
 
crefT operator() (octave_idx_type i, octave_idx_type j) const
 
crefT operator() (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 
crefT operator() (const Array< octave_idx_type > &ra_idx) const
 
FloatNDArrayoperator= (const FloatNDArray &a)
 
bool optimize_dimensions (const dim_vector &dv)
 Returns true if this->dims () == dv, and if so, replaces this->dimensions by a shallow copy of dv. More...
 
Array< floatpage (octave_idx_type k) const
 Extract page: A(:,:,k+1). More...
 
MArray< floatpermute (const Array< octave_idx_type > &vec, bool inv=false) const
 
void print_info (std::ostream &os, const std::string &prefix) const
 
FloatNDArray prod (int dim=-1) const
 
MArray< floatreshape (const dim_vector &new_dims) const
 
Array< floatreshape (octave_idx_type nr, octave_idx_type nc) const
 
virtual float resize_fill_value (void) const
 
Array< floatsort (int dim=0, sortmode mode=ASCENDING) const
 
Array< floatsort (Array< octave_idx_type > &sidx, int dim=0, sortmode mode=ASCENDING) const
 
Array< octave_idx_typesort_rows_idx (sortmode mode=ASCENDING) const
 Sort by rows returns only indices. More...
 
FloatNDArray squeeze (void) const
 
FloatNDArray sum (int dim=-1) const
 
FloatNDArray sumsq (int dim=-1) const
 
bool test (F fcn) const
 Generic any/all test functionality with arbitrary predicate. More...
 
bool too_large_for_float (void) const
 
MArray< floattranspose (void) const
 
floatxelem (octave_idx_type n)
 
crefT xelem (octave_idx_type n) const
 
floatxelem (octave_idx_type i, octave_idx_type j)
 
crefT xelem (octave_idx_type i, octave_idx_type j) const
 
floatxelem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 
crefT xelem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 
floatxelem (const Array< octave_idx_type > &ra_idx)
 
crefT xelem (const Array< octave_idx_type > &ra_idx) const
 
octave_idx_type capacity (void) const
 Number of elements in the array. More...
 
octave_idx_type length (void) const
 Number of elements in the array. More...
 
octave_idx_type nelem (void) const
 Number of elements in the array. More...
 
octave_idx_type numel (void) const
 Number of elements in the array. More...
 
First dimension

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

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

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

octave_idx_type dim2 (void) const
 
octave_idx_type cols (void) const
 
octave_idx_type columns (void) const
 
Third dimension

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

octave_idx_type dim3 (void) const
 
octave_idx_type pages (void) const
 
Array< floatindex (const idx_vector &i) const
 Indexing without resizing. More...
 
Array< floatindex (const idx_vector &i, const idx_vector &j) const
 
Array< floatindex (const Array< idx_vector > &ia) const
 
Array< floatindex (const idx_vector &i, bool resize_ok, const float &rfv) const
 Indexing with possible resizing and fill. More...
 
Array< floatindex (const idx_vector &i, bool resize_ok) const
 
Array< floatindex (const idx_vector &i, const idx_vector &j, bool resize_ok, const float &rfv) const
 
Array< floatindex (const idx_vector &i, const idx_vector &j, bool resize_ok) const
 
Array< floatindex (const Array< idx_vector > &ia, bool resize_ok, const float &rfv) const
 
Array< floatindex (const Array< idx_vector > &ia, bool resize_ok) const
 
void resize2 (octave_idx_type nr, octave_idx_type nc, const float &rfv)
 Resizing (with fill). More...
 
void resize2 (octave_idx_type nr, octave_idx_type nc)
 
void resize1 (octave_idx_type n, const float &rfv)
 
void resize1 (octave_idx_type n)
 
void resize (const dim_vector &dv, const float &rfv)
 
void resize (const dim_vector &dv)
 
void assign (const idx_vector &i, const Array< float > &rhs, const float &rfv)
 Indexed assignment (always with resize & fill). More...
 
void assign (const idx_vector &i, const Array< float > &rhs)
 
void assign (const idx_vector &i, const idx_vector &j, const Array< float > &rhs, const float &rfv)
 
void assign (const idx_vector &i, const idx_vector &j, const Array< float > &rhs)
 
void assign (const Array< idx_vector > &ia, const Array< float > &rhs, const float &rfv)
 
void assign (const Array< idx_vector > &ia, const Array< float > &rhs)
 
void delete_elements (const idx_vector &i)
 Deleting elements. More...
 
void delete_elements (int dim, const idx_vector &i)
 A(:,...,I,...,:) = [] (>= 2 subscripts, one of them is non-colon) More...
 
void delete_elements (const Array< idx_vector > &ia)
 Dispatcher to the above two. More...
 
Array< U > map (U(&fcn)(float)) const
 Overloads for function references. More...
 
Array< U > map (U(&fcn)(const float &)) const
 
bool test_any (F fcn) const
 Simpler calls. More...
 
bool test_all (F fcn) const
 
bool test_any (bool(&fcn)(float)) const
 Overloads for function references. More...
 
bool test_any (bool(&fcn)(const float &)) const
 
bool test_all (bool(&fcn)(float)) const
 
bool test_all (bool(&fcn)(const float &)) const
 
intjit_ref_count (void)
 WARNING: Only call these functions from jit. More...
 
floatjit_slice_data (void) const
 
octave_idx_typejit_dimensions (void) const
 
void * jit_array_rep (void) const
 

Static Public Member Functions

static Array< floatcat (int dim, octave_idx_type n, const Array< float > *array_list)
 Concatenation along a specified (0-based) dimension, equivalent to cat(). More...
 
static octave_idx_type compute_index (Array< octave_idx_type > &ra_idx, const dim_vector &dimensions)
 
static void increment_index (Array< octave_idx_type > &ra_idx, const dim_vector &dimensions, int start_dimension=0)
 

Protected Attributes

dim_vector dimensions
 
Array< float >::ArrayRep * rep
 
floatslice_data
 
octave_idx_type slice_len
 

Friends

class FloatComplexNDArray
 
OCTAVE_API FloatNDArray imag (const FloatComplexNDArray &a)
 
OCTAVE_API std::ostream & operator<< (std::ostream &os, const FloatNDArray &a)
 
OCTAVE_API std::istream & operator>> (std::istream &is, FloatNDArray &a)
 
OCTAVE_API FloatNDArray real (const FloatComplexNDArray &a)
 

Detailed Description

Definition at line 33 of file fNDArray.h.

Member Typedef Documentation

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

Definition at line 122 of file Array.h.

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

Definition at line 120 of file Array.h.

typedef float Array< float >::element_type
inherited

Definition at line 118 of file Array.h.

Constructor & Destructor Documentation

FloatNDArray::FloatNDArray ( void  )
inline

Definition at line 39 of file fNDArray.h.

FloatNDArray::FloatNDArray ( const dim_vector dv)
inline

Definition at line 41 of file fNDArray.h.

FloatNDArray::FloatNDArray ( const dim_vector dv,
float  val 
)
inline

Definition at line 43 of file fNDArray.h.

FloatNDArray::FloatNDArray ( const FloatNDArray a)
inline

Definition at line 46 of file fNDArray.h.

template<class U >
FloatNDArray::FloatNDArray ( const MArray< U > &  a)
inline

Definition at line 49 of file fNDArray.h.

template<class U >
FloatNDArray::FloatNDArray ( const Array< U > &  a)
inline

Definition at line 52 of file fNDArray.h.

template<class U >
FloatNDArray::FloatNDArray ( const intNDArray< U > &  a)
inlineexplicit

Definition at line 55 of file fNDArray.h.

FloatNDArray::FloatNDArray ( const charNDArray a)

Definition at line 47 of file fNDArray.cc.

References Array< T >::numel(), and Array< float >::xelem().

Member Function Documentation

FloatNDArray FloatNDArray::abs ( void  ) const

Definition at line 792 of file fNDArray.cc.

Referenced by FloatMatrix::abs().

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

Definition at line 601 of file fNDArray.cc.

References mx_inline_all().

bool FloatNDArray::all_elements_are_int_or_inf_or_nan ( void  ) const

Definition at line 548 of file fNDArray.cc.

References Array< float >::test_all(), and xis_int_or_inf_or_nan().

bool FloatNDArray::all_elements_are_zero ( void  ) const

Definition at line 542 of file fNDArray.cc.

References Array< float >::test_all(), and xis_zero().

bool FloatNDArray::all_integers ( float max_val,
float min_val 
) const
bool FloatNDArray::all_integers ( void  ) const

Definition at line 587 of file fNDArray.cc.

References Array< float >::test_all(), and xisinteger().

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

Definition at line 607 of file fNDArray.cc.

References mx_inline_any().

bool FloatNDArray::any_element_is_inf_or_nan ( void  ) const

Definition at line 530 of file fNDArray.cc.

References mx_inline_all_finite().

Referenced by Fsvd(), and FloatEIG::init().

bool FloatNDArray::any_element_is_nan ( void  ) const

Definition at line 524 of file fNDArray.cc.

References mx_inline_any_nan().

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

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

Definition at line 510 of file fNDArray.cc.

References mx_inline_any_negative(), Array< float >::test_all(), and xnegative_sign().

Referenced by elem_xpow().

bool FloatNDArray::any_element_is_positive ( bool  neg_zero = false) const
bool FloatNDArray::any_element_not_one_or_zero ( void  ) const

Definition at line 536 of file fNDArray.cc.

References Array< float >::test_all(), and xis_one_or_zero().

Referenced by octave_float_matrix::bool_array_value().

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

Return the array as a column vector.

Definition at line 279 of file Array.h.

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

Return the array as a matrix.

Definition at line 299 of file Array.h.

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

Return the array as a row vector.

Definition at line 289 of file Array.h.

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

Indexed assignment (always with resize & fill).

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

Definition at line 548 of file Array.h.

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

Definition at line 555 of file Array.h.

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

Definition at line 561 of file Array.h.

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

Definition at line 333 of file Array.h.

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

Number of elements in the array.

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

Definition at line 256 of file Array.h.

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

FloatNDArray& FloatNDArray::changesign ( void  )
inline

Definition at line 154 of file fNDArray.h.

References MArray< T >::changesign().

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

Definition at line 249 of file Array.h.

octave_idx_type Array< float >::cols ( void  ) const
inlineinherited
Array<float > Array< float >::column ( octave_idx_type  k) const
inherited

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

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

Definition at line 322 of file Array.h.

Referenced by FloatMatrix::inverse().

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

Definition at line 824 of file fNDArray.cc.

References compute_index().

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

Definition at line 347 of file Array.h.

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

Definition at line 709 of file fNDArray.cc.

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

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

Definition at line 718 of file fNDArray.cc.

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

charNDArray FloatNDArray::concat ( const charNDArray rb,
const Array< octave_idx_type > &  ra_idx 
)
FloatNDArray FloatNDArray::cummax ( int  dim = -1) const

Definition at line 679 of file fNDArray.cc.

References mx_inline_cummax().

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

Definition at line 685 of file fNDArray.cc.

References mx_inline_cummax().

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

Definition at line 691 of file fNDArray.cc.

References mx_inline_cummin().

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

Definition at line 697 of file fNDArray.cc.

References mx_inline_cummin().

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

Definition at line 613 of file fNDArray.cc.

References mx_inline_cumprod().

Referenced by FloatMatrix::cumprod().

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

Definition at line 619 of file fNDArray.cc.

References mx_inline_cumsum().

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

const float * Array< float >::data ( void  ) const
inlineinherited
void Array< float >::delete_elements ( const idx_vector i)
inherited

Deleting elements.

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

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

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

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

Dispatcher to the above two.

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

Definition at line 831 of file fNDArray.cc.

References Array< T >::diag().

Referenced by FloatMatrix::diag().

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

Definition at line 837 of file fNDArray.cc.

References Array< T >::diag().

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

Definition at line 703 of file fNDArray.cc.

References mx_inline_diff().

Referenced by do_diff().

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

Definition at line 312 of file Array.h.

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

Definition at line 320 of file Array.h.

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

Definition at line 329 of file Array.h.

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

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

Definition at line 337 of file Array.h.

Referenced by concat(), fourier(), fourier2d(), fourierNd(), ifourier(), ifourier2d(), and ifourierNd().

NDArray FloatNDArray::dprod ( int  dim = -1) const

Definition at line 631 of file fNDArray.cc.

References mx_inline_dprod().

Referenced by Fprod().

NDArray FloatNDArray::dsum ( int  dim = -1) const

Definition at line 643 of file fNDArray.cc.

References mx_inline_dsum().

Referenced by Fsum().

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

Definition at line 386 of file Array.h.

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

Definition at line 388 of file Array.h.

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

Definition at line 391 of file Array.h.

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

Definition at line 417 of file Array.h.

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

Definition at line 419 of file Array.h.

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

Definition at line 422 of file Array.h.

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

Definition at line 425 of file Array.h.

void Array< float >::fill ( const float val)
inherited
Array<octave_idx_type> Array< float >::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.

const float * Array< float >::fortran_vec ( void  ) const
inlineinherited
float * Array< float >::fortran_vec ( void  )
inherited
FloatComplexNDArray FloatNDArray::fourier ( int  dim = 1) const
FloatComplexNDArray FloatNDArray::fourier2d ( void  ) const
FloatComplexNDArray FloatNDArray::fourierNd ( void  ) const
MArray<float > MArray< float >::hermitian ( float (*)(const float &)  fcn = 0) const
inlineinherited

Definition at line 86 of file MArray.h.

void MArray< float >::idx_add ( const idx_vector idx,
float  val 
)
inherited
void MArray< float >::idx_add ( const idx_vector idx,
const MArray< float > &  vals 
)
inherited
void MArray< float >::idx_add_nd ( const idx_vector idx,
const MArray< float > &  vals,
int  dim = -1 
)
inherited
void MArray< float >::idx_max ( const idx_vector idx,
const MArray< float > &  vals 
)
inherited
void MArray< float >::idx_min ( const idx_vector idx,
const MArray< float > &  vals 
)
inherited
FloatComplexNDArray FloatNDArray::ifourier ( int  dim = 1) const
FloatComplexNDArray FloatNDArray::ifourier2d ( void  ) const
FloatComplexNDArray FloatNDArray::ifourierNd ( void  ) const
void FloatNDArray::increment_index ( Array< octave_idx_type > &  ra_idx,
const dim_vector dimensions,
int  start_dimension = 0 
)
static

Definition at line 816 of file fNDArray.cc.

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

Indexing with possible resizing and fill.

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

Definition at line 523 of file Array.h.

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

Definition at line 530 of file Array.h.

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

Definition at line 538 of file Array.h.

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

Definition at line 776 of file fNDArray.cc.

References Array< T >::insert().

Referenced by concat(), and FloatMatrix::insert().

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

Definition at line 784 of file fNDArray.cc.

References Array< T >::insert().

Array<float >& Array< float >::insert ( const Array< float > &  a,
const Array< octave_idx_type > &  idx 
)
inherited

Insert an array into another at a specified position.

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

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

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

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

Definition at line 78 of file MArray.h.

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

Definition at line 472 of file Array.h.

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

Definition at line 485 of file Array.h.

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

Ordering is auto-detected or can be specified.

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

References ASCENDING, Array< T >::data(), DESCENDING, Array< T >::numel(), UNSORTED, and xisnan().

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

Ordering is auto-detected or can be specified.

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

Definition at line 470 of file Array.h.

Referenced by FloatMatrix::is_symmetric().

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

Definition at line 474 of file Array.h.

boolNDArray FloatNDArray::isfinite ( void  ) const

Definition at line 810 of file fNDArray.cc.

boolNDArray FloatNDArray::isinf ( void  ) const

Definition at line 804 of file fNDArray.cc.

boolNDArray FloatNDArray::isnan ( void  ) const

Definition at line 798 of file fNDArray.cc.

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

Definition at line 749 of file Array.h.

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

Definition at line 747 of file Array.h.

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

WARNING: Only call these functions from jit.

Definition at line 743 of file Array.h.

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

Definition at line 745 of file Array.h.

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

Number of elements in the array.

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

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

Definition at line 267 of file Array.h.

Referenced by FloatRowVector::append(), FloatRowVector::fill(), FloatColumnVector::fill(), FloatRowVector::insert(), FloatColumnVector::insert(), FloatRowVector::max(), FloatColumnVector::max(), FloatRowVector::min(), FloatColumnVector::min(), FloatRowVector::operator==(), FloatColumnVector::operator==(), FloatMatrix::operator==(), and FloatColumnVector::stack().

Array<float > Array< float >::linear_slice ( octave_idx_type  lo,
octave_idx_type  up 
) const
inherited

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

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

octave_idx_type Array< float >::lookup ( const float value,
sortmode  mode = UNSORTED 
) const
inherited

Do a binary lookup in a sorted array.

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

Array<octave_idx_type> Array< float >::lookup ( const Array< float > &  values,
sortmode  mode = UNSORTED 
) const
inherited

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

NaNs get the value N.

void Array< float >::make_unique ( void  )
inlineinherited
Array<U> Array< float >::map ( F  fcn) const
inlineinherited

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

This function is optimised with a manually unrolled loop.

Definition at line 659 of file Array.h.

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

Overloads for function references.

Definition at line 691 of file Array.h.

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

Definition at line 696 of file Array.h.

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

Definition at line 655 of file fNDArray.cc.

References mx_inline_max().

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

Definition at line 661 of file fNDArray.cc.

References mx_inline_max().

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

Definition at line 589 of file Array.h.

void* Array< float >::mex_get_data ( void  ) const
inlineinherited

Give a pointer to the data in mex format.

Unsafe. This function exists to support the MEX interface. You should not use it anywhere else.

Definition at line 605 of file Array.h.

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

Definition at line 667 of file fNDArray.cc.

References mx_inline_min().

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

Definition at line 673 of file fNDArray.cc.

References mx_inline_min().

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

Definition at line 487 of file Array.h.

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

Number of elements in the array.

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

Definition at line 271 of file Array.h.

Referenced by all_integers().

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

Count nonzero elements.

Array<float > Array< float >::nth_element ( const idx_vector n,
int  dim = 0 
) const
inherited

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

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

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

Number of elements in the array.

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

Definition at line 275 of file Array.h.

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

boolNDArray FloatNDArray::operator! ( void  ) const
float & Array< float >::operator() ( octave_idx_type  n)
inlineinherited

Definition at line 403 of file Array.h.

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

Definition at line 404 of file Array.h.

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

Definition at line 405 of file Array.h.

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

Definition at line 407 of file Array.h.

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

Definition at line 438 of file Array.h.

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

Definition at line 439 of file Array.h.

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

Definition at line 441 of file Array.h.

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

Definition at line 444 of file Array.h.

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

Definition at line 59 of file fNDArray.h.

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

bool Array< float >::optimize_dimensions ( const dim_vector dv)
inherited

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

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

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

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

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

Definition at line 330 of file Array.h.

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

Definition at line 74 of file MArray.h.

void Array< float >::print_info ( std::ostream &  os,
const std::string &  prefix 
) const
inherited
FloatNDArray FloatNDArray::prod ( int  dim = -1) const

Definition at line 625 of file fNDArray.cc.

References mx_inline_prod().

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

MArray<float > MArray< float >::reshape ( const dim_vector new_dims) const
inlineinherited

Definition at line 71 of file MArray.h.

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

Definition at line 460 of file Array.h.

void Array< float >::resize ( const dim_vector dv,
const float rfv 
)
inherited
void Array< float >::resize ( const dim_vector dv)
inlineinherited

Definition at line 512 of file Array.h.

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

Definition at line 509 of file Array.h.

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

Resizing (with fill).

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

Definition at line 503 of file Array.h.

virtual float Array< float >::resize_fill_value ( void  ) const
virtualinherited
octave_idx_type Array< float >::rows ( void  ) const
inlineinherited
Array<float > Array< float >::sort ( int  dim = 0,
sortmode  mode = ASCENDING 
) const
inherited
Array<float > Array< float >::sort ( Array< octave_idx_type > &  sidx,
int  dim = 0,
sortmode  mode = ASCENDING 
) const
inherited
Array<octave_idx_type> Array< float >::sort_rows_idx ( sortmode  mode = ASCENDING) const
inherited

Sort by rows returns only indices.

FloatNDArray FloatNDArray::squeeze ( void  ) const
inline

Definition at line 135 of file fNDArray.h.

References MArray< T >::squeeze().

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

Definition at line 637 of file fNDArray.cc.

References mx_inline_sum().

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

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

Definition at line 649 of file fNDArray.cc.

References mx_inline_sumsq().

Referenced by FloatMatrix::sumsq().

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

Generic any/all test functionality with arbitrary predicate.

Definition at line 702 of file Array.h.

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

Definition at line 726 of file Array.h.

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

Definition at line 729 of file Array.h.

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

Simpler calls.

Definition at line 710 of file Array.h.

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

Overloads for function references.

Definition at line 720 of file Array.h.

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

Definition at line 723 of file Array.h.

bool FloatNDArray::too_large_for_float ( void  ) const

Definition at line 593 of file fNDArray.cc.

MArray<float > MArray< float >::transpose ( void  ) const
inlineinherited

Definition at line 83 of file MArray.h.

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

Definition at line 354 of file Array.h.

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

Definition at line 356 of file Array.h.

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

Definition at line 358 of file Array.h.

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

Definition at line 361 of file Array.h.

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

Definition at line 363 of file Array.h.

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

Definition at line 366 of file Array.h.

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

Definition at line 369 of file Array.h.

Friends And Related Function Documentation

friend class FloatComplexNDArray
friend

Definition at line 133 of file fNDArray.h.

OCTAVE_API FloatNDArray imag ( const FloatComplexNDArray a)
friend

Definition at line 770 of file fNDArray.cc.

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

Definition at line 844 of file fNDArray.cc.

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

Definition at line 858 of file fNDArray.cc.

OCTAVE_API FloatNDArray real ( const FloatComplexNDArray a)
friend

Definition at line 764 of file fNDArray.cc.

Member Data Documentation

dim_vector Array< float >::dimensions
protectedinherited

Definition at line 127 of file Array.h.

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

Definition at line 129 of file Array.h.

float * Array< float >::slice_data
protectedinherited

Definition at line 138 of file Array.h.

octave_idx_type Array< float >::slice_len
protectedinherited

Definition at line 139 of file Array.h.


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