GNU Octave  3.8.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
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | Friends | List of all members
idx_vector Class Reference

#include "idx-vector.h"

Collaboration diagram for idx_vector:
Collaboration graph
[legend]

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_typeas_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_vectoroperator= (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_typeraw (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_reperr_rep (void)
static idx_vector_repnil_rep (void)

Private Attributes

idx_base_reprep

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.

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
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)
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
template<class T >
octave_idx_type idx_vector::assign ( const T *  src,
octave_idx_type  n,
T *  dest 
) const
inline
template<class Functor >
octave_idx_type idx_vector::bloop ( octave_idx_type  n,
Functor  body 
) const
inline
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
void idx_vector::copy_data ( octave_idx_type data) const
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
template<class T >
octave_idx_type idx_vector::fill ( const T &  val,
octave_idx_type  n,
T *  dest 
) const
inline
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
octave_idx_type idx_vector::increment ( void  ) const
template<class T >
octave_idx_type idx_vector::index ( const T *  src,
octave_idx_type  n,
T *  dest 
) const
inline
idx_vector idx_vector::inverse_permutation ( octave_idx_type  n) const
bool idx_vector::is_colon ( void  ) const
inline
bool idx_vector::is_colon_equiv ( octave_idx_type  n) const
inline
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
bool idx_vector::is_permutation ( octave_idx_type  n) const
bool idx_vector::is_range ( void  ) const
inline
bool idx_vector::is_scalar ( void  ) const
inline
bool idx_vector::is_vector ( void  ) const
octave_idx_type idx_vector::length ( octave_idx_type  n = 0) const
inline
template<class Functor >
void idx_vector::loop ( octave_idx_type  n,
Functor  body 
) const
inline
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 
)
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
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  )
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
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
idx_vector idx_vector::unmask ( void  ) const
octave_idx_type idx_vector::xelem ( octave_idx_type  n) const
inline

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
idx_base_rep* idx_vector::rep
private

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