Vector representing the dimensions (size) of an Array. More...
#include "dim-vector.h"
Public Member Functions | |
dim_vector () | |
dim_vector (const dim_vector &dv) | |
template<typename... Ints> | |
dim_vector (const octave_idx_type r, const octave_idx_type c, Ints... lengths) | |
Construct dim_vector for a N dimensional array. More... | |
dim_vector (dim_vector &&dv) | |
~dim_vector () | |
bool | all_ones () const |
bool | all_zero () const |
bool | any_neg () const |
bool | any_zero () const |
Array< octave_idx_type > | as_array () const |
dim_vector | as_column () const |
dim_vector | as_row () const |
void | chop_all_singletons () |
void | chop_trailing_singletons () |
octave_idx_type | compute_index (const octave_idx_type *idx) const |
Linear index from an index tuple. More... | |
octave_idx_type | compute_index (const octave_idx_type *idx, int nidx) const |
Linear index from an incomplete index tuple (nidx < length ()). More... | |
bool | concat (const dim_vector &dvb, int dim) |
This corresponds to cat(). More... | |
octave_idx_type | cum_compute_index (const octave_idx_type *idx) const |
Compute a linear index from an index tuple. More... | |
dim_vector | cumulative () const |
Return cumulative dimensions. More... | |
octave_idx_type & | elem (int i) |
octave_idx_type | elem (int i) const |
bool | empty_2d () const |
int | first_non_singleton (int def=0) const |
bool | hvcat (const dim_vector &dvb, int dim) |
This corresponds to [,] (horzcat, dim = 0) and [;] (vertcat, dim = 1). More... | |
int | increment_index (octave_idx_type *idx, int start=0) const |
Increment a multi-dimensional index tuple, optionally starting from an offset position and return the index of the last index position that was changed, or length () if just cycled over. More... | |
bool | is_nd_vector () const |
bool | isvector () const |
int | length () const |
Number of dimensions. More... | |
dim_vector | make_nd_vector (octave_idx_type n) const |
octave_idx_type | ndims () const |
Number of dimensions. More... | |
int | num_ones () const |
octave_idx_type | numel (int n=0) const |
Number of elements that a matrix with this dimensions would have. More... | |
octave_idx_type & | operator() (int i) |
octave_idx_type | operator() (int i) const |
dim_vector & | operator= (const dim_vector &dv) |
dim_vector & | operator= (dim_vector &&dv) |
dim_vector | redim (int n) const |
Force certain dimensionality, preserving numel (). More... | |
void | resize (int n, int fill_value=0) |
octave_idx_type | safe_numel () const |
The following function will throw a std::bad_alloc () exception if the requested size is larger than can be indexed by octave_idx_type. More... | |
dim_vector | squeeze () const |
std::string | str (char sep='x') const |
octave_idx_type & | xelem (int i) |
octave_idx_type | xelem (int i) const |
bool | zero_by_zero () const |
Static Public Member Functions | |
static dim_vector | alloc (int n) |
static octave_idx_type | dim_max () |
Friends | |
bool | operator== (const dim_vector &a, const dim_vector &b) |
Vector representing the dimensions (size) of an Array.
A dim_vector is used to represent dimensions of an Array. It is used on its constructor to specify its size, or when reshaping it.
The main thing to understand about this class, is that methods such as ndims() and numel(), return the value for an Array of these dimensions, not the actual number of elements in the dim_vector.
This implementation is more tricky than Array, but the big plus is that dim_vector requires only one allocation instead of two. It is (slightly) patterned after GCC's basic_string implementation. rep is a pointer to an array of memory, comprising count, length, and the data:
//! <count> //! <ndims> //! rep --> <dims[0]> //! <dims[1]> //! ... //!
The inlines count(), ndims() recover this data from the rep. Note that rep points to the beginning of dims to grant faster access (reinterpret_cast is assumed to be an inexpensive operation).
Definition at line 91 of file dim-vector.h.
|
inline |
Construct dim_vector for a N dimensional array.
Each argument to constructor defines the length of an additional dimension. A dim_vector always represents a minimum of 2 dimensions (just like an Array has at least 2 dimensions) and there is no upper limit on the number of dimensions.
The constructed dim_vector dv
will have two elements, , one for each dimension. It can then be used to construct a Matrix with such dimensions, i.e., 7 rows and 5 columns.
This will construct a 3 dimensional NDArray of lengths 7, 5, and 10, on the first, second, and third dimension (rows, columns, and pages) respectively.
Note that that there is no constructor that accepts only one dimension length to avoid confusion. The source for such confusion is that constructor could mean:
Using r, c, and lengths... as arguments, allow us to check at compile time that there's at least 2 dimensions specified, while maintaining type safety.
Definition at line 139 of file dim-vector.h.
References r.
|
inlineexplicit |
Definition at line 184 of file dim-vector.h.
Referenced by hvcat().
|
inline |
Definition at line 190 of file dim-vector.h.
|
inline |
Definition at line 196 of file dim-vector.h.
|
inline |
Definition at line 242 of file dim-vector.h.
|
inline |
Definition at line 324 of file dim-vector.h.
References num_ones().
Referenced by octave_value_list::all_scalars(), octave_base_diag< DMT, MT >::print_as_scalar(), octave_base_matrix< MT >::print_as_scalar(), octave_base_sparse< T >::print_as_scalar(), and octave_perm_matrix::print_as_scalar().
|
inline |
Definition at line 300 of file dim-vector.h.
Referenced by octave_map::concat(), and Ffind().
|
inlinestatic |
Definition at line 202 of file dim-vector.h.
References n.
Referenced by Array< T, Alloc >::assign(), F__base64_decode_bytes__(), Fbase64_decode(), Freshape(), Fvec(), Array< T, Alloc >::index(), Array< T, Alloc >::permute(), redim(), and zero_dims_inquire().
|
inline |
Definition at line 357 of file dim-vector.h.
Referenced by Array< T, Alloc >::resize().
|
inline |
Definition at line 316 of file dim-vector.h.
Referenced by octave_base_diag< DMT, MT >::print_as_scalar(), octave_base_matrix< MT >::print_as_scalar(), octave_base_sparse< T >::print_as_scalar(), and octave_perm_matrix::print_as_scalar().
Array< octave_idx_type > dim_vector::as_array | ( | ) | const |
Definition at line 266 of file dim-vector.cc.
References elem(), and ndims().
Referenced by octave_base_value::dump().
|
inline |
|
inline |
void dim_vector::chop_all_singletons | ( | ) |
Definition at line 50 of file dim-vector.cc.
References ndims(), and xelem().
Referenced by Array< T, Alloc >::assign(), squeeze(), and zero_dims_inquire().
|
inline |
Definition at line 164 of file dim-vector.h.
Referenced by Array< T, Alloc >::Array(), Array< T, Alloc >::assign(), Array< T, Alloc >::clear(), concat(), Fcell(), and octave_map::reshape().
|
inline |
Linear index from an index tuple.
Definition at line 456 of file dim-vector.h.
References compute_index().
Referenced by Array< T, Alloc >::compute_index_unchecked(), do_bsxfun_op(), and do_inplace_bsxfun_op().
|
inline |
Linear index from an incomplete index tuple (nidx < length ()).
Definition at line 460 of file dim-vector.h.
bool dim_vector::concat | ( | const dim_vector & | dvb, |
int | dim | ||
) |
This corresponds to cat().
Definition at line 140 of file dim-vector.cc.
References chop_trailing_singletons(), ndims(), resize(), and xelem().
Referenced by Array< T, Alloc >::cat(), Sparse< T, Alloc >::cat(), and hvcat().
|
inline |
Compute a linear index from an index tuple.
Dimensions are required to be cumulative.
Definition at line 503 of file dim-vector.h.
Referenced by do_bsxfun_op(), and do_inplace_bsxfun_op().
|
inline |
Return cumulative dimensions.
Definition at line 488 of file dim-vector.h.
References xelem().
Referenced by do_bsxfun_op(), and do_inplace_bsxfun_op().
|
static |
|
inline |
Definition at line 157 of file dim-vector.h.
Referenced by as_array(), and squeeze().
|
inline |
Definition at line 162 of file dim-vector.h.
|
inline |
Definition at line 306 of file dim-vector.h.
|
inline |
Definition at line 444 of file dim-vector.h.
Referenced by Fdot(), Ffilter(), filter(), Fnth_element(), Fsort(), MArray< T >::idx_add_nd(), SparseComplexMatrix::max(), SparseMatrix::max(), SparseComplexMatrix::min(), and SparseMatrix::min().
bool dim_vector::hvcat | ( | const dim_vector & | dvb, |
int | dim | ||
) |
This corresponds to [,] (horzcat, dim = 0) and [;] (vertcat, dim = 1).
Definition at line 201 of file dim-vector.cc.
References dim_vector(), concat(), ndims(), and xelem().
Referenced by Array< T, Alloc >::cat(), and Sparse< T, Alloc >::cat().
|
inline |
Increment a multi-dimensional index tuple, optionally starting from an offset position and return the index of the last index position that was changed, or length () if just cycled over.
Definition at line 473 of file dim-vector.h.
Referenced by do_bsxfun_op(), and do_inplace_bsxfun_op().
|
inline |
Definition at line 400 of file dim-vector.h.
Referenced by Array< T, Alloc >::is_nd_vector().
|
inline |
Definition at line 395 of file dim-vector.h.
Referenced by Fdot(), Ffind(), octave::get_dimensions(), Array< T, Alloc >::isvector(), and idx_vector::isvector().
|
inline |
Number of dimensions.
Synonymous with ndims().
While this method is not officially deprecated, consider using ndims() instead to avoid confusion. Array does not have length because of its odd definition as length of the longest dimension.
Definition at line 266 of file dim-vector.h.
|
inline |
Definition at line 421 of file dim-vector.h.
Referenced by Array< octave_value * >::assign().
|
inline |
Number of dimensions.
Returns the number of dimensions of the dim_vector. This is number of elements in the dim_vector including trailing singletons. It is also the number of dimensions an Array with this dim_vector would have.
Definition at line 257 of file dim-vector.h.
Referenced by Sparse< T, Alloc >::Sparse(), all_colon_equiv(), as_array(), Array< T, Alloc >::as_column(), Array< T, Alloc >::as_matrix(), Array< T, Alloc >::as_row(), Array< T, Alloc >::assign(), Array< T, Alloc >::cat(), octave::check_dimensions(), chop_all_singletons(), octave_uint64_matrix::complex_matrix_value(), concat(), Array< T, Alloc >::diag(), Array< T, Alloc >::dim3(), Fellipj(), Ffilter(), filter(), Flinspace(), octave_uint64_matrix::float_complex_matrix_value(), octave_uint64_matrix::float_matrix_value(), ComplexNDArray::fourier(), NDArray::fourier(), FloatComplexNDArray::fourier(), FloatNDArray::fourier(), NDArray::fourier2d(), FloatComplexNDArray::fourier2d(), FloatNDArray::fourier2d(), ComplexNDArray::fourierNd(), NDArray::fourierNd(), FloatComplexNDArray::fourierNd(), FloatNDArray::fourierNd(), freeze(), Fsize(), Fstruct2cell(), get_ra_idx(), hvcat(), ComplexNDArray::ifourier(), NDArray::ifourier(), FloatComplexNDArray::ifourier(), FloatNDArray::ifourier(), ComplexNDArray::ifourier2d(), NDArray::ifourier2d(), FloatComplexNDArray::ifourier2d(), ComplexNDArray::ifourierNd(), NDArray::ifourierNd(), FloatComplexNDArray::ifourierNd(), FloatNDArray::ifourierNd(), increment_index(), ind2sub(), index_in_bounds(), ComplexNDArray::insert(), FloatComplexNDArray::insert(), is_scalar(), is_valid_bsxfun(), is_valid_inplace_bsxfun(), isvector(), make_nd_vector(), octave_uint64_matrix::matrix_value(), SparseComplexMatrix::max(), SparseMatrix::max(), SparseComplexMatrix::min(), SparseMatrix::min(), octave_base_value::ndims(), Array< T, Alloc >::ndims(), Sparse< T, Alloc >::ndims(), num_ones(), operator<<(), Array< T, Alloc >::permute(), Array< octave_value * >::permute(), redim(), Sparse< T, Alloc >::reshape(), Sparse< T, Alloc >::resize(), octave_base_diag< DMT, MT >::resize(), Array< T, Alloc >::resize(), octave_base_int_matrix< T >::save_ascii(), octave_bool_matrix::save_ascii(), octave_cell::save_ascii(), octave_complex_matrix::save_ascii(), octave_float_complex_matrix::save_ascii(), octave_float_matrix::save_ascii(), octave_matrix::save_ascii(), octave_char_matrix_str::save_ascii(), octave_struct::save_ascii(), octave_scalar_struct::save_ascii(), octave_bool_matrix::save_binary(), octave_sparse_bool_matrix::save_binary(), octave_cell::save_binary(), octave_complex_matrix::save_binary(), octave_sparse_complex_matrix::save_binary(), octave_float_complex_matrix::save_binary(), octave_float_matrix::save_binary(), octave_matrix::save_binary(), octave_sparse_matrix::save_binary(), octave_char_matrix_str::save_binary(), octave_struct::save_binary(), octave_base_int_matrix< T >::save_binary(), octave_bool_matrix::save_hdf5(), octave_cell::save_hdf5(), octave_complex_matrix::save_hdf5(), octave_float_complex_matrix::save_hdf5(), octave_float_matrix::save_hdf5(), octave_matrix::save_hdf5(), octave_char_matrix_str::save_hdf5(), octave_base_int_matrix< T >::save_hdf5_internal(), octave_base_value::size(), octave_class::size(), Array< T, Alloc >::sort(), octave_lazy_index::sort(), squeeze(), str(), vector_equivalent(), and zero_dims_inquire().
int dim_vector::num_ones | ( | ) | const |
Definition at line 86 of file dim-vector.cc.
|
inline |
Number of elements that a matrix with this dimensions would have.
Return the number of elements that a matrix with this dimension vector would have, NOT the number of dimensions (elements in the dimension vector).
Definition at line 335 of file dim-vector.h.
References n.
Referenced by airy(), biry(), compute_index(), octave_float_matrix::convert_to_str_internal(), octave_matrix::convert_to_str_internal(), octave_sparse_matrix::convert_to_str_internal(), octave::dims_to_numel(), do_bessel(), do_bsxfun_op(), do_inplace_bsxfun_op(), fftw::fftNd(), filter(), Fregexprep(), Freshape(), octave::get_dimensions(), get_ra_idx(), fftw::ifftNd(), ind2sub(), octave_base_matrix< MT >::is_true(), octave_perm_matrix::is_true(), octave_cell::load_ascii(), octave_char_matrix_str::load_ascii(), octave_bool_matrix::load_binary(), octave_cell::load_binary(), octave_complex_matrix::load_binary(), octave_float_complex_matrix::load_binary(), octave_float_matrix::load_binary(), octave_matrix::load_binary(), octave_char_matrix_str::load_binary(), octave_base_int_matrix< T >::load_binary(), octave_bool_matrix::load_hdf5(), octave_cell::load_hdf5(), octave_base_value::numel(), octave_class::numel(), Sparse< T, Alloc >::reshape(), octave_bool::resize(), octave_complex::resize(), octave_float_scalar::resize(), octave_float_complex::resize(), octave_uint64_scalar::resize(), octave_scalar::resize(), octave_cell::save_ascii(), octave_char_matrix_str::save_ascii(), octave_cell::save_binary(), octave_complex_matrix::save_binary(), octave_float_complex_matrix::save_binary(), octave_float_matrix::save_binary(), octave_matrix::save_binary(), octave_char_matrix_str::save_binary(), octave_cell::save_hdf5(), octave_char_matrix_str::save_hdf5(), Array< T, Alloc >::sort(), and octave_cell::subsasgn().
|
inline |
Definition at line 268 of file dim-vector.h.
|
inline |
Definition at line 270 of file dim-vector.h.
|
inline |
Definition at line 207 of file dim-vector.h.
|
inline |
Definition at line 222 of file dim-vector.h.
dim_vector dim_vector::redim | ( | int | n | ) | const |
Force certain dimensionality, preserving numel ().
Missing dimensions are set to 1, redundant are folded into the trailing one. If n = 1, the result is 2d and the second dim is 1 (dim_vectors are always at least 2D).
Definition at line 226 of file dim-vector.cc.
References alloc(), n, ndims(), and xelem().
Referenced by Array< T, Alloc >::as_matrix(), Array< T, Alloc >::assign(), octave_base_matrix< MT >::assign(), compute_index(), octave::dims_to_numel(), do_bsxfun_op(), do_inplace_bsxfun_op(), Fdot(), Fsize(), MArray< T >::idx_add_nd(), Sparse< T, Alloc >::index(), Array< T, Alloc >::index(), Array< T, Alloc >::insert(), Array< T, Alloc >::resize(), sub2ind(), octave_cell::subsasgn(), and tree_evaluator::visit_simple_for_command().
|
inline |
Definition at line 272 of file dim-vector.h.
References n.
Referenced by concat(), Array< T, Alloc >::delete_elements(), do_bsxfun_op(), Fcell(), freeze(), Fresize(), Fstruct2cell(), octave::get_dimensions(), octave_base_int_matrix< T >::load_ascii(), octave_bool_matrix::load_ascii(), octave_cell::load_ascii(), octave_complex_matrix::load_ascii(), octave_float_complex_matrix::load_ascii(), octave_float_matrix::load_ascii(), octave_matrix::load_ascii(), octave_char_matrix_str::load_ascii(), octave_struct::load_ascii(), octave_bool_matrix::load_binary(), octave_cell::load_binary(), octave_complex_matrix::load_binary(), octave_float_complex_matrix::load_binary(), octave_float_matrix::load_binary(), octave_matrix::load_binary(), octave_char_matrix_str::load_binary(), octave_struct::load_binary(), octave_base_int_matrix< T >::load_binary(), octave_bool_matrix::load_hdf5(), octave_cell::load_hdf5(), octave_complex_matrix::load_hdf5(), octave_float_complex_matrix::load_hdf5(), octave_float_matrix::load_hdf5(), octave_matrix::load_hdf5(), octave_char_matrix_str::load_hdf5(), octave_base_int_matrix< T >::load_hdf5_internal(), Array< T, Alloc >::permute(), Sparse< T, Alloc >::reshape(), Array< T, Alloc >::sort(), and Array< T, Alloc >::squeeze().
octave_idx_type dim_vector::safe_numel | ( | ) | const |
The following function will throw a std::bad_alloc () exception if the requested size is larger than can be indexed by octave_idx_type.
This may be smaller than the actual amount of memory that can be safely allocated on a system. However, if we don't fail here, we can end up with a mysterious crash inside a function that is iterating over an array using octave_idx_type indices.
Definition at line 98 of file dim-vector.cc.
Referenced by Array< T, Alloc >::Array(), Sparse< T, Alloc >::Sparse(), Array< T, Alloc >::clear(), octave_base_sparse< T >::numel(), and Sparse< T, Alloc >::numel().
dim_vector dim_vector::squeeze | ( | ) | const |
Definition at line 117 of file dim-vector.cc.
References as_row(), chop_all_singletons(), elem(), ndims(), and xelem().
Referenced by octave_map::squeeze().
std::string dim_vector::str | ( | char | sep = 'x' | ) | const |
Definition at line 68 of file dim-vector.cc.
References ndims(), and xelem().
Referenced by Array< T, Alloc >::Array(), do_bsxfun_op(), octave_char_matrix_str::edit_display(), octave_struct::edit_display(), octave_scalar_struct::edit_display(), operator<<(), octave_cell::print_raw(), octave_classdef::print_raw(), Sparse< T, Alloc >::reshape(), and warn_array_as_logical().
|
inline |
Definition at line 151 of file dim-vector.h.
Referenced by chop_all_singletons(), concat(), cumulative(), hvcat(), num_ones(), redim(), squeeze(), and str().
|
inline |
Definition at line 153 of file dim-vector.h.
|
inline |
Definition at line 311 of file dim-vector.h.
Referenced by Array< T, Alloc >::assign(), Array< T, Alloc >::cat(), tm_row_const::cellify(), and octave_base_value::is_zero_by_zero().
|
friend |
Definition at line 520 of file dim-vector.h.