GNU Octave  9.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
idx_vector Class Reference

#include "idx-vector.h"

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 ()
 
 idx_vector (bool x)
 
 idx_vector (char c)
 
 idx_vector (const Array< bool > &nda)
 
 idx_vector (const Array< double > &nda)
 
 idx_vector (const Array< float > &nda)
 
 idx_vector (const Array< octave_idx_type > &inda)
 
 idx_vector (const Array< octave_idx_type > &inda, octave_idx_type ext)
 
template<typename T >
 idx_vector (const Array< octave_int< T >> &nda)
 
 idx_vector (const idx_vector &a)
 
 idx_vector (const range< double > &r)
 
 idx_vector (const Sparse< bool > &nda)
 
 idx_vector (double x)
 
 idx_vector (float x)
 
 idx_vector (octave_idx_type i)
 
 idx_vector (octave_idx_type start, octave_idx_type limit, octave_idx_type step=1)
 
template<typename T >
 idx_vector (octave_int< T > x)
 
 ~idx_vector ()
 
Array< octave_idx_type > as_array () const
 
template<typename T >
octave_idx_type assign (const T *src, octave_idx_type n, T *dest) const
 
template<typename 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<typename 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 () const
 
octave_idx_type increment () const
 
template<typename 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 () 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 () const
 
bool is_scalar () const
 
bool isvector () const
 
octave_idx_type length (octave_idx_type n=0) const
 
template<typename Functor >
void loop (octave_idx_type n, Functor body) const
 
octave_idx_type max () const
 
bool maybe_reduce (octave_idx_type n, const idx_vector &j, octave_idx_type nj)
 
octave_idx_type ones_count () const
 
 operator bool () const
 
octave_idx_type operator() (octave_idx_type n) const
 
idx_vector & operator= (const idx_vector &a)
 
octave_idx_type orig_columns () const
 
dim_vector orig_dimensions () const
 
int orig_empty () const
 
octave_idx_type orig_rows () const
 
std::ostream & print (std::ostream &os) const
 
const octave_idx_type * raw ()
 
void sort (bool uniq=false)
 
idx_vector sorted (Array< octave_idx_type > &sidx) const
 
idx_vector sorted (bool uniq=false) const
 
void unconvert (idx_class_type &iclass, double &scalar, range< double > &range, Array< double > &array, Array< bool > &mask) const
 
idx_vector unmask () 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
 

Friends

std::ostream & operator<< (std::ostream &os, const idx_vector &a)
 
template<typename T , typename D >
class std::unique_ptr
 

Detailed Description

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

Member Enumeration Documentation

◆ idx_class_type

enum idx_vector::idx_class_type
Enumerator
class_invalid 
class_colon 
class_range 
class_scalar 
class_vector 
class_mask 

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

Constructor & Destructor Documentation

◆ idx_vector() [1/17]

idx_vector::idx_vector ( )
inline

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

Referenced by complement(), maybe_reduce(), and raw().

◆ idx_vector() [2/17]

idx_vector::idx_vector ( octave_idx_type  i)
inline

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

◆ idx_vector() [3/17]

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

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

◆ idx_vector() [4/17]

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

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

◆ idx_vector() [5/17]

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

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

◆ idx_vector() [6/17]

idx_vector::idx_vector ( char  c)
inline

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

◆ idx_vector() [7/17]

template<typename T >
idx_vector::idx_vector ( octave_int< T >  x)
inline

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

◆ idx_vector() [8/17]

idx_vector::idx_vector ( double  x)
inline

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

◆ idx_vector() [9/17]

idx_vector::idx_vector ( float  x)
inline

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

◆ idx_vector() [10/17]

idx_vector::idx_vector ( bool  x)
inline

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

◆ idx_vector() [11/17]

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

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

◆ idx_vector() [12/17]

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

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

◆ idx_vector() [13/17]

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

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

◆ idx_vector() [14/17]

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

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

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

◆ idx_vector() [15/17]

idx_vector::idx_vector ( const range< double > &  r)
inline

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

◆ idx_vector() [16/17]

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

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

◆ idx_vector() [17/17]

idx_vector::idx_vector ( const idx_vector &  a)
inline

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

◆ ~idx_vector()

idx_vector::~idx_vector ( )
inline

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

Member Function Documentation

◆ as_array()

Array< octave_idx_type > idx_vector::as_array ( ) const

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

Referenced by raw().

◆ assign()

template<typename T >
octave_idx_type idx_vector::assign ( const T *  src,
octave_idx_type  n,
T *  dest 
) const
inline

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

References len, n, and r.

◆ bloop()

template<typename Functor >
octave_idx_type idx_vector::bloop ( octave_idx_type  n,
Functor  body 
) const
inline

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

References len, n, and r.

◆ checkelem()

octave_idx_type idx_vector::checkelem ( octave_idx_type  n) const
inline

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

References n.

◆ complement()

idx_vector idx_vector::complement ( octave_idx_type  n) const

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

References idx_vector(), class_mask, extent(), fill(), Array< T, Alloc >::fortran_vec(), idx_class(), length(), n, and r.

◆ copy_data()

void idx_vector::copy_data ( octave_idx_type *  data) const

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

References class_colon, class_mask, class_range, class_scalar, class_vector, and r.

◆ elem()

octave_idx_type idx_vector::elem ( octave_idx_type  n) const
inline

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

References n.

Referenced by increment().

◆ extent()

octave_idx_type idx_vector::extent ( octave_idx_type  n) const
inline

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

References n.

Referenced by complement(), octave::Fisindex(), freeze(), range< T, typename std::enable_if< std::is_floating_point< T >::value >::type >::index(), is_permutation(), and raw().

◆ fill()

template<typename T >
octave_idx_type idx_vector::fill ( const T &  val,
octave_idx_type  n,
T *  dest 
) const
inline

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

References len, n, and r.

Referenced by complement().

◆ freeze()

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

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

References extent(), and length().

◆ idx_class()

idx_class_type idx_vector::idx_class ( ) const
inline

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

Referenced by complement(), inverse_permutation(), isvector(), maybe_reduce(), and unmask().

◆ increment()

octave_idx_type idx_vector::increment ( ) const

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

References class_colon, class_mask, class_range, class_vector, elem(), and length().

Referenced by inverse_permutation().

◆ index()

template<typename T >
octave_idx_type idx_vector::index ( const T *  src,
octave_idx_type  n,
T *  dest 
) const
inline

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

References len, n, and r.

◆ inverse_permutation()

idx_vector idx_vector::inverse_permutation ( octave_idx_type  n) const

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

References class_range, class_vector, idx_class(), increment(), length(), n, orig_dimensions(), r, sorted(), and Array< T, Alloc >::xelem().

◆ is_colon()

bool idx_vector::is_colon ( ) const
inline

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

Referenced by range< T, typename std::enable_if< std::is_floating_point< T >::value >::type >::index(), and ones_count().

◆ is_colon_equiv() [1/2]

bool idx_vector::is_colon_equiv ( octave_idx_type  n) const
inline

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

References n.

Referenced by is_permutation(), and maybe_reduce().

◆ is_colon_equiv() [2/2]

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

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

References n.

◆ is_cont_range()

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

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

References class_colon, class_mask, class_range, class_scalar, n, and r.

◆ is_permutation()

bool idx_vector::is_permutation ( octave_idx_type  n) const

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

References extent(), is_colon_equiv(), length(), n, and OCTAVE_LOCAL_BUFFER_INIT.

◆ is_range()

bool idx_vector::is_range ( ) const
inline

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

◆ is_scalar()

bool idx_vector::is_scalar ( ) const
inline

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

◆ isvector()

bool idx_vector::isvector ( ) const

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

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

◆ length()

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

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

References n.

Referenced by complement(), octave::dims_to_numel(), freeze(), increment(), inverse_permutation(), is_permutation(), and ones_count().

◆ loop()

template<typename Functor >
void idx_vector::loop ( octave_idx_type  n,
Functor  body 
) const
inline

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

References len, n, and r.

◆ make_range()

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

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

References len.

Referenced by opengl_renderer::get_pixels().

◆ max()

octave_idx_type idx_vector::max ( ) const
inline

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

◆ maybe_reduce()

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

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

References idx_vector(), class_colon, class_range, class_scalar, idx_class(), is_colon_equiv(), n, and r.

◆ ones_count()

octave_idx_type idx_vector::ones_count ( ) const

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

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

◆ operator bool()

idx_vector::operator bool ( ) const
inline

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

◆ operator()()

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

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

References n.

◆ operator=()

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

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

◆ orig_columns()

octave_idx_type idx_vector::orig_columns ( ) const
inline

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

◆ orig_dimensions()

dim_vector idx_vector::orig_dimensions ( ) const
inline

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

Referenced by inverse_permutation(), and isvector().

◆ orig_empty()

int idx_vector::orig_empty ( ) const
inline

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

◆ orig_rows()

octave_idx_type idx_vector::orig_rows ( ) const
inline

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

◆ print()

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

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

◆ raw()

const octave_idx_type * idx_vector::raw ( )

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

References idx_vector(), as_array(), class_vector, extent(), and r.

◆ sort()

void idx_vector::sort ( bool  uniq = false)
inline

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

◆ sorted() [1/2]

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

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

◆ sorted() [2/2]

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

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

Referenced by inverse_permutation().

◆ unconvert()

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

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

◆ unmask()

idx_vector idx_vector::unmask ( ) const

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

References class_mask, idx_class(), and r.

◆ xelem()

octave_idx_type idx_vector::xelem ( octave_idx_type  n) const
inline

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

References n.

Referenced by ones_count().

Friends And Related Function Documentation

◆ operator<<

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

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

◆ std::unique_ptr

template<typename T , typename D >
friend class std::unique_ptr
friend

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

Member Data Documentation

◆ colon

const idx_vector idx_vector::colon
static

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

Referenced by F__ilutp__(), and opengl_renderer::get_pixels().

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