ADMB Documentation  11.5.3197
 All Classes Files Functions Variables Typedefs Friends Defines
Public Member Functions | Protected Attributes | Friends
ivector Class Reference

Array of integers(int) with indexes from index_min to indexmax. More...

#include <ivector.h>

Public Member Functions

 ivector ()
 Default constructor.
 ivector (const lvector &)
 ivector (const dvector &)
 Constructor.
 ivector (int ncl, int ncu)
 Description not yet available.
 ivector (const ad_integer &ncl, const index_type &ncu)
 Description not yet available.
 ivector (unsigned int sz, long int *x)
 Constructor.
 ivector (const preivector &pd)
 Description not yet available.
 ivector (const ivector &t)
 Copy constructor.
 ~ivector ()
 Default destructor.
void allocate (const ad_integer &ncl, const index_type &ncu)
 Description not yet available.
void allocate (int ncl, int ncu)
 Description not yet available.
void allocate (const ivector &iv)
 Description not yet available.
void allocate (const dvector &dv)
 Description not yet available.
void allocate (const char *)
void allocate ()
 Does not allocate, but initializes class members.
int allocated () const
void deallocate ()
 Called by destructor to deallocate memory for a ivector object.
int & elem (int i)
const int & elem (int i) const
void fill (const char *s)
 Description not yet available.
void fill_multinomial (const int &seed, const dvector &p)
 Description not yet available.
void fill_multinomial (const random_number_generator &rng, const dvector &p)
 Description not yet available.
void fill_seqadd (int, int)
 Description not yet available.
unsigned int get_ncopies () const
int * get_v () const
int indexmax () const
int indexmin () const
void initialize (void)
 Description not yet available.
int operator! () const
int & operator() (int i)
const int & operator() (int i) const
ivector operator() (int lb, int ub)
ivector operator() (const ivector &u)
 Description not yet available.
ivectoroperator++ ()
ivectoroperator+= (const ivector &t)
 Description not yet available.
ivectoroperator+= (int t)
 Description not yet available.
ivectoroperator-- ()
ivectoroperator= (const ivector &t)
 Description not yet available.
ivectoroperator= (int t)
 Description not yet available.
ivectoroperator= (const lvector &t)
int & operator[] (int i)
const int & operator[] (int i) const
void read_from (const istream &s)
 Reads all the elements from istream _s.
void read_from (const uistream &s)
 Description not yet available.
void reallocate (double size)
 Reallocate size of array.
void safe_allocate (int ncl, int ncu)
 Description not yet available.
void safe_deallocate ()
 Safely deallocates memory by reporting if shallow copies are still in scope.
void save_ivector_position () const
 Description not yet available.
void save_ivector_value () const
 Saves the size, address, and value information for a ivector.
void shallow_copy (const ivector &t)
 Description not yet available.
ivectorshift (int min)
 Description not yet available.
int size () const
ivector sub (int lb, int ub)
void write_on (const ostream &s) const
 Writes all the elements to the ostream _s.
void write_on (const uostream &s) const
 Description not yet available.

Protected Attributes

int index_max
int index_min
vector_shapexshape
int * v

Friends

class i3_array
class imatrix
class vector_index

Detailed Description

Array of integers(int) with indexes from index_min to indexmax.

Definition at line 49 of file ivector.h.


Constructor & Destructor Documentation

Default constructor.

Definition at line 37 of file ivector.cpp.

Referenced by data_ivector::allocate(), and fill().

ivector::ivector ( const lvector )

Default destructor.

Invoked by the compiler. Only frees allocated memory if all shallow copies in scope have been removed. Produces an error if the double* member v is NULL.

Definition at line 70 of file ivector.cpp.

ivector::ivector ( const dvector u)

Constructor.

Definition at line 245 of file ivector.cpp.

ivector::ivector ( int  ncl,
int  nch 
)

Description not yet available.

Parameters:

Definition at line 264 of file ivector.cpp.

ivector::ivector ( const ad_integer ncl,
const index_type nch 
)

Description not yet available.

Parameters:

Definition at line 463 of file indextyp.cpp.

ivector::ivector ( unsigned int  sz,
long int *  x 
)

Constructor.

Definition at line 219 of file ivector.cpp.

ivector::ivector ( const preivector pdv)

Description not yet available.

Parameters:

Definition at line 341 of file ivector.cpp.

ivector::ivector ( const ivector t)

Copy constructor.

Definition at line 44 of file ivector.cpp.


Member Function Documentation

void ivector::allocate ( const ad_integer _ncl,
const index_type _nch 
)
void ivector::allocate ( int  ncl,
int  nch 
)

Description not yet available.

Parameters:

Definition at line 273 of file ivector.cpp.

void ivector::allocate ( const ivector dv)

Description not yet available.

Parameters:

Definition at line 322 of file ivector.cpp.

void ivector::allocate ( const dvector dv)

Description not yet available.

Parameters:

Definition at line 313 of file ivector.cpp.

void ivector::allocate ( const char *  )
void ivector::allocate ( void  )

Does not allocate, but initializes class members.

Definition at line 329 of file ivector.cpp.

Referenced by allocate(), named_ivector::allocate(), data_ivector::allocate(), ivector(), reallocate(), and safe_allocate().

int ivector::allocated ( void  ) const [inline]

Definition at line 62 of file ivector.h.

Referenced by operator=(), reallocate(), and safe_allocate().

void ivector::deallocate ( void  )

Called by destructor to deallocate memory for a ivector object.

Produces an error if the int* member is NULL.

Definition at line 114 of file ivector.cpp.

Referenced by reallocate(), safe_deallocate(), and ~ivector().

int& ivector::elem ( int  i) [inline]
const int& ivector::elem ( int  i) const [inline]

Definition at line 96 of file ivector.h.

void ivector::fill ( const char *  s)

Description not yet available.

Parameters:

Definition at line 17 of file ivec4.cpp.

void ivector::fill_multinomial ( const int &  seed,
const dvector p 
)

Description not yet available.

Parameters:

Definition at line 50 of file dvect11.cpp.

void ivector::fill_multinomial ( const random_number_generator rng,
const dvector p 
)

Description not yet available.

Parameters:

Definition at line 52 of file dvect25.cpp.

void ivector::fill_seqadd ( int  base,
int  offset 
)
unsigned int ivector::get_ncopies ( void  ) const [inline]

Definition at line 87 of file ivector.h.

int* ivector::get_v ( void  ) const [inline]

Definition at line 115 of file ivector.h.

Referenced by ivector_position::ivector_position().

int ivector::indexmax ( void  ) const [inline]

Reimplemented in vector_index.

Definition at line 106 of file ivector.h.

Referenced by factor::allocate(), imatrix::allocate(), allocate(), dvar_matrix::allocate(), dmatrix::allocate(), d3_array::allocate(), dvar3_array::allocate(), lmatrix::allocate(), laplace_approximation_calculator::block_diagonal_calculations(), laplace_approximation_calculator::build_up_nested_shape(), laplace_approximation_calculator::check_hessian_type(), laplace_approximation_calculator::check_hessian_type2(), check_order(), laplace_approximation_calculator::check_sparse_matrix_structure(), clean(), common(), count_factor(), laplace_approximation_calculator::default_calculations_check_derivatives(), dfcholeski_sparse(), dmatrix::dmatrix(), dvector::dvector(), fill(), fill_multinomial(), fill_seqadd(), laplace_approximation_calculator::get_newton_raphson_info_banded(), multi_index::get_offset(), getreindex(), imatrix::imatrix(), initialize(), ivector(), ivector_check(), ivector_position::ivector_position(), laplace_approximation_calculator::laplace_approximation_calculator(), lmatrix::lmatrix(), lvector::lvector(), max(), min(), norm2(), operator()(), dvector::operator()(), df1b2vector::operator()(), dvar_vector::operator()(), dmatrix::operator()(), operator*(), operator+(), multi_index::operator++(), operator+=(), operator-(), operator=(), df1b2quadratic_prior::operator=(), cifstream::operator>>(), pow(), read_from(), reallocate(), reorder(), save_ivector_value(), sort(), square(), sum(), tmpxchol1(), nested_calls_shape::trim(), value(), write_on(), and xxxv().

int ivector::indexmin ( void  ) const [inline]
void ivector::initialize ( void  )
int ivector::operator! ( void  ) const [inline]

Definition at line 82 of file ivector.h.

int & ivector::operator() ( int  i) [inline]

Definition at line 199 of file ivector.h.

const int & ivector::operator() ( int  i) const [inline]

Definition at line 207 of file ivector.h.

ivector ivector::operator() ( int  lb,
int  ub 
) [inline]

Definition at line 169 of file ivector.h.

ivector ivector::operator() ( const ivector u)

Description not yet available.

Parameters:

Definition at line 22 of file ivec3.cpp.

ivector& ivector::operator++ ( void  ) [inline]

Definition at line 75 of file ivector.h.

ivector & ivector::operator+= ( const ivector j)

Description not yet available.

Parameters:

Definition at line 17 of file ivec9.cpp.

ivector & ivector::operator+= ( int  j)

Description not yet available.

Parameters:

Definition at line 37 of file ivec9.cpp.

ivector& ivector::operator-- ( void  ) [inline]

Definition at line 66 of file ivector.h.

ivector & ivector::operator= ( const ivector t)

Description not yet available.

Parameters:

Definition at line 176 of file ivector.cpp.

ivector & ivector::operator= ( int  u)

Description not yet available.

Parameters:

Definition at line 207 of file ivector.cpp.

ivector& ivector::operator= ( const lvector t)
int & ivector::operator[] ( int  i) [inline]

Reimplemented in vector_index.

Definition at line 195 of file ivector.h.

const int & ivector::operator[] ( int  i) const [inline]

Definition at line 203 of file ivector.h.

void ivector::read_from ( const istream &  s)

Reads all the elements from istream _s.

Definition at line 93 of file ivect_io.cpp.

Referenced by operator>>().

void ivector::read_from ( const uistream _s)

Description not yet available.

Parameters:

Definition at line 55 of file ivec_io1.cpp.

void ivector::reallocate ( double  s)

Reallocate size of array.

Parameters:
percentchange

Definition at line 14 of file ivect11.cpp.

Referenced by cs_multiply().

void ivector::safe_allocate ( int  ncl,
int  nch 
)
void ivector::safe_deallocate ( void  )
void ivector::save_ivector_position ( void  ) const

Description not yet available.

Parameters:

Definition at line 191 of file cmpdif3.cpp.

Referenced by det(), inv(), ln_det(), dvar_vector::operator()(), and solve().

void ivector::save_ivector_value ( void  ) const

Saves the size, address, and value information for a ivector.

Definition at line 118 of file cmpdif4.cpp.

Referenced by det(), inv(), ln_det(), dvar_vector::operator()(), and solve().

void ivector::shallow_copy ( const ivector t)

Description not yet available.

Parameters:
Descriptionnot yet available.

Definition at line 156 of file ivector.cpp.

Referenced by operator=().

ivector & ivector::shift ( int  min)

Description not yet available.

Parameters:

Definition at line 17 of file ivec.cpp.

int ivector::size ( void  ) const [inline]

Definition at line 111 of file ivector.h.

Referenced by sort().

ivector ivector::sub ( int  lb,
int  ub 
) [inline]

Definition at line 165 of file ivector.h.

void ivector::write_on ( const ostream &  s) const

Writes all the elements to the ostream _s.

Definition at line 42 of file ivect_io.cpp.

Referenced by operator<<().

void ivector::write_on ( const uostream _s) const

Description not yet available.

Parameters:

Definition at line 83 of file ivec_io1.cpp.


Friends And Related Function Documentation

friend class i3_array [friend]

Definition at line 191 of file ivector.h.

friend class imatrix [friend]

Definition at line 190 of file ivector.h.

friend class vector_index [friend]

Definition at line 189 of file ivector.h.


Member Data Documentation

int ivector::index_max [protected]
int ivector::index_min [protected]
int* ivector::v [protected]

List of all members.


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