idx_vector Class Reference

#include "idx-vector.h"

Collaboration diagram for idx_vector:

Classes
class	idx_base_rep
class	idx_colon_rep
class	idx_mask_rep
class	idx_range_rep
class	idx_scalar_rep
class	idx_vector_rep

Public Types
enum	idx_class_type {   class_invalid = -1, class_colon = 0, class_range, class_scalar,   class_vector, class_mask }

Public Member Functions
	idx_vector (void)
	idx_vector (octave_idx_type i)
	idx_vector (octave_idx_type start, octave_idx_type limit, octave_idx_type step=1)
	idx_vector (const Array< octave_idx_type > &inda)
	idx_vector (const Array< octave_idx_type > &inda, octave_idx_type ext)
	idx_vector (char c)
template<class T >
	idx_vector (octave_int< T > x)
	idx_vector (double x)
	idx_vector (float x)
	idx_vector (bool x)
template<class T >
	idx_vector (const Array< octave_int< T > > &nda)
	idx_vector (const Array< double > &nda)
	idx_vector (const Array< float > &nda)
	idx_vector (const Array< bool > &nda)
	idx_vector (const Range &r)
	idx_vector (const Sparse< bool > &nda)
	idx_vector (const idx_vector &a)
	~idx_vector (void)
Array< octave_idx_type >	as_array (void) const
template<class T >
octave_idx_type	assign (const T *src, octave_idx_type n, T *dest) const
template<class Functor >
octave_idx_type	bloop (octave_idx_type n, Functor body) const
octave_idx_type	checkelem (octave_idx_type n) const
idx_vector	complement (octave_idx_type n) const
void	copy_data (octave_idx_type *data) const
octave_idx_type	elem (octave_idx_type n) const
octave_idx_type	extent (octave_idx_type n) const
template<class T >
octave_idx_type	fill (const T &val, octave_idx_type n, T *dest) const
octave_idx_type	freeze (octave_idx_type z_len, const char *tag, bool resize_ok=false)
idx_class_type	idx_class (void) const
octave_idx_type	increment (void) const
template<class T >
octave_idx_type	index (const T *src, octave_idx_type n, T *dest) const
idx_vector	inverse_permutation (octave_idx_type n) const
bool	is_colon (void) const
bool	is_colon_equiv (octave_idx_type n) const
bool	is_colon_equiv (octave_idx_type n, int) const
bool	is_cont_range (octave_idx_type n, octave_idx_type &l, octave_idx_type &u) const
bool	is_permutation (octave_idx_type n) const
bool	is_range (void) const
bool	is_scalar (void) const
bool	is_vector (void) const
octave_idx_type	length (octave_idx_type n=0) const
template<class Functor >
void	loop (octave_idx_type n, Functor body) const
octave_idx_type	max (void) const
bool	maybe_reduce (octave_idx_type n, const idx_vector &j, octave_idx_type nj)
octave_idx_type	ones_count (void) const
	operator bool (void) const
octave_idx_type	operator() (octave_idx_type n) const
idx_vector &	operator= (const idx_vector &a)
octave_idx_type	orig_columns (void) const
dim_vector	orig_dimensions (void) const
int	orig_empty (void) const
octave_idx_type	orig_rows (void) const
std::ostream &	print (std::ostream &os) const
const octave_idx_type *	raw (void)
void	sort (bool uniq=false)
idx_vector	sorted (bool uniq=false) const
idx_vector	sorted (Array< octave_idx_type > &sidx) const
void	unconvert (idx_class_type &iclass, double &scalar, Range &range, Array< double > &array, Array< bool > &mask) const
idx_vector	unmask (void) const
octave_idx_type	xelem (octave_idx_type n) const

Static Public Member Functions
static idx_vector	make_range (octave_idx_type start, octave_idx_type step, octave_idx_type len)

Static Public Attributes
static const idx_vector	colon

Private Types
enum	direct { DIRECT }

Private Member Functions
	idx_vector (idx_base_rep *r)
void	chkerr (void)

Static Private Member Functions
static idx_vector_rep *	err_rep (void)
static idx_vector_rep *	nil_rep (void)

Private Attributes
idx_base_rep *	rep

Friends
std::ostream &	operator<< (std::ostream &os, const idx_vector &a)
class	std::auto_ptr

Detailed Description

Definition at line 51 of file idx-vector.h.

Member Enumeration Documentation

enum idx_vector::direct

private

Enumerator:

DIRECT

Definition at line 157 of file idx-vector.h.

enum idx_vector::idx_class_type

Enumerator:

class_invalid
class_colon
class_range
class_scalar
class_vector
class_mask

Definition at line 57 of file idx-vector.h.

Constructor & Destructor Documentation

idx_vector::idx_vector ( idx_base_rep *  r )

inlineprivate

Definition at line 436 of file idx-vector.h.

idx_vector::idx_vector ( void  )

inline

Definition at line 470 of file idx-vector.h.

Referenced by SparseBoolMatrix::any(), complement(), maybe_reduce(), and SparseBoolMatrix::sum().

idx_vector::idx_vector ( octave_idx_type  i )

inline

Definition at line 473 of file idx-vector.h.

idx_vector::idx_vector ( octave_idx_type  start, octave_idx_type  limit, octave_idx_type  step = 1  )

inline

Definition at line 476 of file idx-vector.h.

idx_vector::idx_vector ( const Array< octave_idx_type > &  inda )

inline

Definition at line 488 of file idx-vector.h.

idx_vector::idx_vector ( const Array< octave_idx_type > &  inda, octave_idx_type  ext  )

inline

Definition at line 493 of file idx-vector.h.

idx_vector::idx_vector ( char  c )

inline

Definition at line 501 of file idx-vector.h.

template<class T >

idx_vector::idx_vector ( octave_int< T >  x )

inline

Definition at line 506 of file idx-vector.h.

idx_vector::idx_vector ( double  x )

inline

Definition at line 508 of file idx-vector.h.

idx_vector::idx_vector ( float  x )

inline

Definition at line 510 of file idx-vector.h.

idx_vector::idx_vector ( bool  x )

inline

Definition at line 513 of file idx-vector.h.

template<class T >

idx_vector::idx_vector ( const Array< octave_int< T > > &  nda )

inline

Definition at line 516 of file idx-vector.h.

idx_vector::idx_vector ( const Array< double > &  nda )

inline

Definition at line 519 of file idx-vector.h.

idx_vector::idx_vector ( const Array< float > &  nda )

inline

Definition at line 522 of file idx-vector.h.

idx_vector::idx_vector

(

const Array< bool > &

nda

)

Definition at line 780 of file idx-vector.cc.

References Array< FloatComplex >::nnz(), Array< T >::nnz(), Array< T >::numel(), and rep.

idx_vector::idx_vector ( const Range &  r )

inline

Definition at line 527 of file idx-vector.h.

idx_vector::idx_vector ( const Sparse< bool > &  nda )

inline

Definition at line 531 of file idx-vector.h.

idx_vector::idx_vector ( const idx_vector &  a )

inline

Definition at line 534 of file idx-vector.h.

idx_vector::~idx_vector ( void  )

inline

Definition at line 536 of file idx-vector.h.

Member Function Documentation

Array< octave_idx_type > idx_vector::as_array

(

void

)

const

Definition at line 1271 of file idx-vector.cc.

References idx_vector::idx_base_rep::as_array(), and rep.

Referenced by Sparse< T >::index(), octave_lazy_index::is_sorted(), octave_matrix::is_sorted(), octave_lazy_index::is_sorted_rows(), octave_matrix::is_sorted_rows(), octave_lazy_index::permute(), raw(), octave_lazy_index::reshape(), octave_matrix::reshape(), octave_lazy_index::sort(), octave_lazy_index::sort_rows_idx(), octave_lazy_index::squeeze(), and octave_matrix::squeeze().

template<class T >

octave_idx_type idx_vector::assign ( const T *  src, octave_idx_type  n, T *  dest  ) const

inline

Definition at line 700 of file idx-vector.h.

References copy_or_memcpy(), idx_vector::idx_mask_rep::extent(), idx_vector::idx_scalar_rep::get_data(), idx_vector::idx_vector_rep::get_data(), idx_vector::idx_mask_rep::get_data(), idx_vector::idx_range_rep::get_start(), and idx_vector::idx_range_rep::get_step().

Referenced by Array< T >::assign(), and rec_index_helper::do_assign().

template<class Functor >

octave_idx_type idx_vector::bloop ( octave_idx_type  n, Functor  body  ) const

inline

Definition at line 907 of file idx-vector.h.

References idx_vector::idx_mask_rep::extent(), idx_vector::idx_scalar_rep::get_data(), idx_vector::idx_vector_rep::get_data(), idx_vector::idx_mask_rep::get_data(), idx_vector::idx_range_rep::get_start(), and idx_vector::idx_range_rep::get_step().

octave_idx_type idx_vector::checkelem ( octave_idx_type  n ) const

inline

Definition at line 566 of file idx-vector.h.

void idx_vector::chkerr ( void  )

inlineprivate

Definition at line 456 of file idx-vector.h.

Referenced by freeze().

idx_vector idx_vector::complement

(

octave_idx_type

n

)

const

Definition at line 1109 of file idx-vector.cc.

References class_mask, Array< FloatComplex >::data(), idx_vector::idx_mask_rep::extent(), extent(), fill(), Array< T >::fortran_vec(), idx_vector::idx_mask_rep::get_data(), idx_class(), idx_vector(), idx_vector::idx_mask_rep::length(), length(), and rep.

Referenced by Sparse< T >::delete_elements(), and Array< T >::delete_elements().

void idx_vector::copy_data

(

octave_idx_type *

data

)

const

Definition at line 1052 of file idx-vector.cc.

References class_colon, class_mask, class_range, class_scalar, class_vector, copy_or_memcpy(), current_liboctave_error_handler, idx_vector::idx_mask_rep::extent(), idx_vector::idx_scalar_rep::get_data(), idx_vector::idx_vector_rep::get_data(), idx_vector::idx_mask_rep::get_data(), idx_vector::idx_range_rep::get_start(), idx_vector::idx_range_rep::get_step(), idx_vector::idx_base_rep::idx_class(), idx_vector::idx_base_rep::length(), and rep.

Referenced by Sparse< T >::assign().

octave_idx_type idx_vector::elem ( octave_idx_type  n ) const

inline

Definition at line 1029 of file idx-vector.h.

Referenced by increment().

static idx_vector_rep* idx_vector::err_rep ( void  )

inlinestaticprivate

Definition at line 447 of file idx-vector.h.

References idx_vector::idx_base_rep::err.

octave_idx_type idx_vector::extent ( octave_idx_type  n ) const

inline

Definition at line 560 of file idx-vector.h.

Referenced by Array< T >::assign(), Sparse< T >::assign(), complement(), Sparse< T >::delete_elements(), Array< T >::delete_elements(), do_accumarray_minmax(), do_accumarray_sum(), do_accumdim_sum(), Fisindex(), freeze(), MArray< T >::idx_add(), MArray< T >::idx_add_nd(), MArray< T >::idx_max(), MArray< T >::idx_min(), ind2sub(), Range::index(), Array< T >::index(), Sparse< T >::index(), is_permutation(), octave_lazy_index::permute(), raw(), octave_lazy_index::reshape(), octave_matrix::reshape(), octave_lazy_index::sort(), Sparse< T >::Sparse(), octave_lazy_index::squeeze(), octave_matrix::squeeze(), sub2ind(), and zero_dims_inquire().

template<class T >

octave_idx_type idx_vector::fill ( const T &  val, octave_idx_type  n, T *  dest  ) const

inline

Definition at line 771 of file idx-vector.h.

References idx_vector::idx_mask_rep::extent(), idx_vector::idx_scalar_rep::get_data(), idx_vector::idx_vector_rep::get_data(), idx_vector::idx_mask_rep::get_data(), idx_vector::idx_range_rep::get_start(), and idx_vector::idx_range_rep::get_step().

Referenced by Array< T >::assign(), complement(), and rec_index_helper::do_fill().

octave_idx_type idx_vector::freeze	(	octave_idx_type	z_len,
		const char *	tag,
		bool	resize_ok = false
	)

Definition at line 1283 of file idx-vector.cc.

References chkerr(), idx_vector::idx_base_rep::err, extent(), length(), and rep.

idx_class_type idx_vector::idx_class ( void  ) const

inline

Definition at line 555 of file idx-vector.h.

Referenced by complement(), inverse_permutation(), is_vector(), maybe_reduce(), Array< T >::nth_element(), octave_value::octave_value(), unconvert(), and unmask().

octave_idx_type idx_vector::increment

(

void

)

const

Definition at line 1009 of file idx-vector.cc.

References class_colon, class_mask, class_range, class_vector, elem(), idx_vector::idx_base_rep::idx_class(), length(), and rep.

Referenced by Sparse< T >::assign(), Sparse< T >::index(), inverse_permutation(), octave_lazy_index::is_sorted(), and Array< T >::nth_element().

template<class T >

octave_idx_type idx_vector::index ( const T *  src, octave_idx_type  n, T *  dest  ) const

inline

Definition at line 627 of file idx-vector.h.

References copy_or_memcpy(), idx_vector::idx_mask_rep::extent(), idx_vector::idx_scalar_rep::get_data(), idx_vector::idx_vector_rep::get_data(), idx_vector::idx_mask_rep::get_data(), idx_vector::idx_range_rep::get_start(), and idx_vector::idx_range_rep::get_step().

Referenced by rec_index_helper::do_index(), Array< T >::index(), and ft_render::render().

idx_vector idx_vector::inverse_permutation

(

octave_idx_type

n

)

const

Definition at line 1169 of file idx-vector.cc.

References class_range, class_vector, DIRECT, idx_vector::idx_vector_rep::extent(), idx_vector::idx_vector_rep::get_data(), idx_class(), increment(), length(), orig_dimensions(), rep, sorted(), and Array< T >::xelem().

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

bool idx_vector::is_colon ( void  ) const

inline

Definition at line 581 of file idx-vector.h.

Referenced by Sparse< T >::assign(), Sparse< T >::delete_elements(), Array< T >::delete_elements(), octave_diag_matrix::do_index_op(), octave_perm_matrix::do_index_op(), Range::index(), Array< T >::index(), Sparse< T >::index(), ones_count(), and zero_dims_inquire().

bool idx_vector::is_colon_equiv ( octave_idx_type  n ) const

inline

Definition at line 590 of file idx-vector.h.

Referenced by Array< T >::assign(), Sparse< T >::assign(), Sparse< T >::delete_elements(), octave_base_diag< DMT, MT >::do_index_op(), Sparse< T >::index(), is_permutation(), and maybe_reduce().

bool idx_vector::is_colon_equiv ( octave_idx_type  n, int    ) const

inline

Definition at line 1032 of file idx-vector.h.

References is_colon_equiv().

Referenced by is_colon_equiv().

bool idx_vector::is_cont_range	(	octave_idx_type	n,
		octave_idx_type &	l,
		octave_idx_type &	u
	)		const

Definition at line 956 of file idx-vector.cc.

References class_colon, class_mask, class_range, class_scalar, idx_vector::idx_mask_rep::extent(), idx_vector::idx_scalar_rep::get_data(), idx_vector::idx_range_rep::get_start(), idx_vector::idx_range_rep::get_step(), idx_vector::idx_base_rep::idx_class(), idx_vector::idx_range_rep::length(), idx_vector::idx_mask_rep::length(), and rep.

Referenced by Sparse< T >::assign(), Sparse< T >::delete_elements(), Array< T >::delete_elements(), Array< T >::index(), Sparse< T >::index(), and rec_index_helper::is_cont_range().

bool idx_vector::is_permutation

(

octave_idx_type

n

)

const

Definition at line 1140 of file idx-vector.cc.

References extent(), is_colon_equiv(), left, length(), OCTAVE_LOCAL_BUFFER_INIT, and xelem().

Referenced by Sparse< T >::assign(), octave_diag_matrix::do_index_op(), octave_perm_matrix::do_index_op(), Sparse< T >::index(), and PermMatrix::PermMatrix().

bool idx_vector::is_range ( void  ) const

inline

Definition at line 587 of file idx-vector.h.

Referenced by Sparse< T >::assign(), Sparse< T >::index(), octave_lazy_index::is_sorted(), and sub2ind().

bool idx_vector::is_scalar ( void  ) const

inline

Definition at line 584 of file idx-vector.h.

Referenced by octave_base_matrix< MT >::assign(), Array< T >::delete_elements(), octave_perm_matrix::do_index_op(), octave_base_diag< DMT, MT >::do_index_op(), octave_base_matrix< MT >::do_index_op(), octave_range::do_index_op(), ind2sub(), Array< T >::index(), Sparse< T >::index(), and zero_dims_inquire().

bool idx_vector::is_vector

(

void

)

const

Definition at line 1277 of file idx-vector.cc.

References class_vector, idx_class(), dim_vector::is_vector(), and orig_dimensions().

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

octave_idx_type idx_vector::length ( octave_idx_type  n = 0 ) const

inline

Definition at line 557 of file idx-vector.h.

Referenced by Array< T >::assign(), Sparse< T >::assign(), complement(), Sparse< T >::delete_elements(), Array< T >::delete_elements(), dims_to_numel(), do_accumarray_minmax(), do_accumarray_sum(), do_accumdim_sum(), rec_index_helper::do_assign(), rec_index_helper::do_fill(), rec_index_helper::do_index(), octave_base_diag< DMT, MT >::do_index_op(), freeze(), MArray< T >::idx_add(), MArray< T >::idx_add_nd(), MArray< T >::idx_max(), MArray< T >::idx_min(), increment(), ind2sub(), Range::index(), Array< T >::index(), Sparse< T >::index(), inverse_permutation(), is_permutation(), Array< T >::nth_element(), ones_count(), PermMatrix::PermMatrix(), Sparse< T >::Sparse(), sub2ind(), and octave_lazy_index::try_narrowing_conversion().

template<class Functor >

void idx_vector::loop ( octave_idx_type  n, Functor  body  ) const

inline

Definition at line 840 of file idx-vector.h.

References idx_vector::idx_mask_rep::extent(), idx_vector::idx_scalar_rep::get_data(), idx_vector::idx_vector_rep::get_data(), idx_vector::idx_mask_rep::get_data(), idx_vector::idx_range_rep::get_start(), and idx_vector::idx_range_rep::get_step().

Referenced by MArray< T >::idx_add(), MArray< T >::idx_add_nd(), MArray< T >::idx_max(), MArray< T >::idx_min(), and Range::index().

static idx_vector idx_vector::make_range ( octave_idx_type  start, octave_idx_type  step, octave_idx_type  len  )

inlinestatic

Definition at line 482 of file idx-vector.h.

Referenced by convolve(), and sub2ind().

octave_idx_type idx_vector::max ( void  ) const

inline

Definition at line 1043 of file idx-vector.h.

Referenced by idx_vector::idx_vector_rep::idx_vector_rep().

bool idx_vector::maybe_reduce	(	octave_idx_type	n,
		const idx_vector &	j,
		octave_idx_type	nj
	)

Definition at line 793 of file idx-vector.cc.

References class_colon, class_range, class_scalar, DIRECT, idx_vector::idx_scalar_rep::get_data(), idx_vector::idx_range_rep::get_start(), idx_vector::idx_range_rep::get_step(), idx_vector::idx_base_rep::idx_class(), idx_class(), idx_vector(), idx_vector::idx_base_rep::is_colon_equiv(), is_colon_equiv(), idx_vector::idx_base_rep::length(), idx_vector::idx_range_rep::length(), and rep.

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

static idx_vector_rep* idx_vector::nil_rep ( void  )

inlinestaticprivate

Definition at line 440 of file idx-vector.h.

octave_idx_type idx_vector::ones_count

(

void

)

const

Definition at line 1297 of file idx-vector.cc.

References is_colon(), length(), and xelem().

idx_vector::operator bool ( void  ) const

inline

Definition at line 578 of file idx-vector.h.

octave_idx_type idx_vector::operator() ( octave_idx_type  n ) const

inline

Definition at line 569 of file idx-vector.h.

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

inline

Definition at line 542 of file idx-vector.h.

References idx_vector::idx_base_rep::count, and rep.

octave_idx_type idx_vector::orig_columns ( void  ) const

inline

Definition at line 604 of file idx-vector.h.

dim_vector idx_vector::orig_dimensions ( void  ) const

inline

Definition at line 599 of file idx-vector.h.

Referenced by Sparse< T >::delete_elements(), ind2sub(), Range::index(), Array< T >::index(), Sparse< T >::index(), inverse_permutation(), is_vector(), octave_lazy_index::sort(), and octave_lazy_index::try_narrowing_conversion().

int idx_vector::orig_empty ( void  ) const

inline

Definition at line 607 of file idx-vector.h.

octave_idx_type idx_vector::orig_rows ( void  ) const

inline

Definition at line 601 of file idx-vector.h.

std::ostream& idx_vector::print ( std::ostream &  os ) const

inline

Definition at line 612 of file idx-vector.h.

const octave_idx_type * idx_vector::raw

(

void

)

Definition at line 1039 of file idx-vector.cc.

References as_array(), class_vector, extent(), idx_vector::idx_vector_rep::get_data(), idx_vector::idx_base_rep::idx_class(), and rep.

Referenced by Sparse< T >::delete_elements(), Sparse< T >::index(), Sparse< T >::Sparse(), and zunhj().

void idx_vector::sort ( bool  uniq = false )

inline

Definition at line 1038 of file idx-vector.h.

idx_vector idx_vector::sorted ( bool  uniq = false ) const

inline

Definition at line 593 of file idx-vector.h.

Referenced by Sparse< T >::assign(), Sparse< T >::delete_elements(), inverse_permutation(), octave_lazy_index::sort(), and Sparse< T >::Sparse().

idx_vector idx_vector::sorted ( Array< octave_idx_type > &  sidx ) const

inline

Definition at line 596 of file idx-vector.h.

void idx_vector::unconvert	(	idx_class_type &	iclass,
		double &	scalar,
		Range &	range,
		Array< double > &	array,
		Array< bool > &	mask
	)		const

Definition at line 1226 of file idx-vector.cc.

References class_colon, class_mask, class_range, class_scalar, class_vector, idx_class(), rep, idx_vector::idx_range_rep::unconvert(), idx_vector::idx_scalar_rep::unconvert(), idx_vector::idx_vector_rep::unconvert(), and idx_vector::idx_mask_rep::unconvert().

Referenced by octave_value::octave_value().

idx_vector idx_vector::unmask

(

void

)

const

Definition at line 1204 of file idx-vector.cc.

References class_mask, Array< FloatComplex >::data(), DIRECT, idx_vector::idx_mask_rep::extent(), idx_vector::idx_mask_rep::get_data(), idx_class(), idx_vector::idx_mask_rep::length(), idx_vector::idx_mask_rep::orig_dimensions(), and rep.

Referenced by Ffind().

octave_idx_type idx_vector::xelem ( octave_idx_type  n ) const

inline

Definition at line 563 of file idx-vector.h.

Referenced by Array< T >::assign(), idx_vector::idx_vector_rep::checkelem(), idx_vector::idx_mask_rep::checkelem(), Array< T >::index(), is_permutation(), and ones_count().

Friends And Related Function Documentation

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

friend

Definition at line 614 of file idx-vector.h.

friend class std::auto_ptr

friend

Definition at line 67 of file idx-vector.h.

Member Data Documentation

const idx_vector idx_vector::colon

static

Definition at line 498 of file idx-vector.h.

Referenced by Sparse< T >::assign(), Sparse< T >::cat(), Array< T >::cat(), Matrix::column(), FloatMatrix::column(), ComplexMatrix::column(), FloatComplexMatrix::column(), octave_map::column(), DEFUN(), Sparse< T >::delete_elements(), Array< T >::delete_elements(), do_cellslices_nda(), do_mat2cell_nd(), Sparse< T >::index(), octave_map::page(), prepare_idx(), Matrix::row(), FloatMatrix::row(), ComplexMatrix::row(), and FloatComplexMatrix::row().

idx_base_rep* idx_vector::rep

private

Definition at line 1047 of file idx-vector.h.

Referenced by as_array(), complement(), copy_data(), freeze(), idx_vector(), increment(), inverse_permutation(), is_cont_range(), maybe_reduce(), operator=(), raw(), unconvert(), and unmask().

---

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

• liboctave/array/idx-vector.h
• liboctave/array/idx-vector.cc