ivector Class Reference

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

#include <ivector.h>

Public Member Functions
	ivector ()
	Default constructor. More...
	ivector (const lvector &)
	ivector (const dvector &)
	Construct ivector with same dimensions as u. More...
	ivector (int ncl, int ncu)
	Allocate vector of integers with dimension [ncl to nch]. More...
	ivector (const ad_integer &ncl, const index_type &ncu)
	Description not yet available. More...
	ivector (unsigned int sz, long int *x)
	Constructor. More...
	ivector (const preivector &pd)
	Description not yet available. More...
	ivector (const ivector &t)
	Copy constructor. More...
	~ivector ()
	Default destructor. More...
void	allocate (const ad_integer &ncl, const index_type &ncu)
	Allocate vector of integers with dimension [_ncl to _nch]. More...
void	allocate (int ncl, int ncu)
	Allocate vector of integers with dimension [ncl to nch]. More...
void	allocate (const ivector &iv)
	Description not yet available. More...
void	allocate (const dvector &dv)
	Description not yet available. More...
void	allocate (const char *)
void	allocate ()
	Does not allocate, but initializes class members. More...
int	allocated () const
void	deallocate ()
	Deallocate i3_array memory. More...
int &	elem (int i)
const int &	elem (int i) const
void	fill (const char *s)
	Description not yet available. More...
void	fill_multinomial (const int &seed, const dvector &p)
	Description not yet available. More...
void	fill_multinomial (const random_number_generator &rng, const dvector &p)
	Description not yet available. More...
void	fill_seqadd (int, int)
	Fills ivector elements with values starting from base and incremented by offset. More...
unsigned int	get_ncopies () const
int *	get_v () const
int	indexmax () const
int	indexmin () const
void	initialize (void)
	Description not yet available. More...
int	operator! () const
int &	operator() (int i)
const int &	operator() (int i) const
ivector	operator() (int lb, int ub)
ivector	operator() (const ivector &u)
	Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California. More...
ivector &	operator++ ()
ivector &	operator+= (const ivector &t)
	Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California. More...
ivector &	operator+= (int t)
	Add value to each element of ivec. More...
ivector &	operator-- ()
ivector &	operator= (const ivector &t)
	Description not yet available. More...
ivector &	operator= (int t)
	Assigns value to all elements of ivector. More...
ivector &	operator= (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. More...
void	read_from (const uistream &s)
	Read values from input into ivector. More...
void	reallocate (double size)
	Reallocate size of array. More...
void	safe_allocate (int ncl, int ncu)
	Description not yet available. More...
void	safe_deallocate ()
	Safely deallocates memory by reporting if shallow copies are still in scope. More...
void	save_ivector_position () const
	Description not yet available. More...
void	save_ivector_value () const
	Saves the size, address, and value information for a ivector. More...
void	shallow_copy (const ivector &t)
	Shallow copy other data structure pointers. More...
ivector &	shift (int min)
	Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California. More...
unsigned int	size () const
ivector	sub (int lb, int ub)
void	write_on (const ostream &s) const
	Writes all the elements to the ostream _s. More...
void	write_on (const uostream &s) const
	Write ivector values to output. More...

Protected Attributes
int	index_max
int	index_min
vector_shapex *	shape
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 50 of file ivector.h.

Constructor & Destructor Documentation

ivector::ivector

(

)

Default constructor.

Definition at line 37 of file ivector.cpp.

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

ivector::ivector

(

const lvector &

)

ivector::~ivector

(

)

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

)

Construct ivector with same dimensions as u.

Definition at line 231 of file ivector.cpp.

ivector::ivector	(	int	ncl,
		int	nch
	)

Allocate vector of integers with dimension [ncl to nch].

Parameters

ncl	lower vector index
nch	upper vector index

Definition at line 252 of file ivector.cpp.

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

Description not yet available.

Parameters

Definition at line 477 of file indextyp.cpp.

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

Constructor.

Definition at line 206 of file ivector.cpp.

ivector::ivector

(

const preivector &

pdv

)

Description not yet available.

Parameters

Definition at line 327 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
	)

Allocate vector of integers with dimension [_ncl to _nch].

Parameters

_ncl	lower vector index
_nch	upper vector index

Definition at line 488 of file indextyp.cpp.

Referenced by imatrix::allocate(), hs_symbolic::hs_symbolic(), imatrix::imatrix(), laplace_approximation_calculator::laplace_approximation_calculator(), function_minimizer::sd_routine(), set_partition_sizes(), and square().

void ivector::allocate	(	int	ncl,
		int	nch
	)

Allocate vector of integers with dimension [ncl to nch].

Parameters

ncl	lower vector index
nch	upper vector index

Definition at line 263 of file ivector.cpp.

void ivector::allocate

(

const ivector &

dv

)

Description not yet available.

Parameters

Definition at line 311 of file ivector.cpp.

void ivector::allocate

(

const dvector &

dv

)

Description not yet available.

Parameters

Definition at line 302 of file ivector.cpp.

void ivector::allocate

(

const char *

)

void ivector::allocate

(

void

)

Does not allocate, but initializes class members.

Definition at line 316 of file ivector.cpp.

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

int ivector::allocated ( void  ) const

inline

Definition at line 63 of file ivector.h.

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

void ivector::deallocate

(

void

)

Deallocate i3_array memory.

Definition at line 91 of file ivector.cpp.

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

int& ivector::elem ( int  i )

inline

Definition at line 90 of file ivector.h.

Referenced by det(), dvector::dvector(), fill_seqadd(), inv(), ivector(), ln_det(), ludcmp_index(), lvector::lvector(), max(), min(), operator=(), and pow().

const int& ivector::elem ( int  i ) const

inline

Definition at line 94 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
	)

Fills ivector elements with values starting from base and incremented by offset.

Parameters

base	initial value
offset	incremental value

Definition at line 73 of file cranfill.cpp.

Referenced by banded_lower_triangular_dmatrix::banded_lower_triangular_dmatrix(), banded_lower_triangular_dvar_matrix::banded_lower_triangular_dvar_matrix(), banded_symmetric_dmatrix::banded_symmetric_dmatrix(), banded_symmetric_dvar_matrix::banded_symmetric_dvar_matrix(), det(), dmatrix::dmatrix(), imatrix::fill_seqadd(), shareinfo::get_inv_matrix_shared(), shareinfo::get_inv_vector_shared(), getreindex(), inv(), ln_det(), ludcmp(), ludcmp_index(), banded_symmetric_dmatrix::operator=(), reorder(), solve(), and admb_deprecated::sort().

unsigned int ivector::get_ncopies ( void  ) const

inline

Definition at line 88 of file ivector.h.

int* ivector::get_v ( void  ) const

inline

Definition at line 114 of file ivector.h.

Referenced by imatrix::allocate(), dvar_matrix::allocate(), dmatrix::allocate(), d3_array::allocate(), dvar3_array::allocate(), d4_array::allocate(), colsum(), column(), df_xldet(), dfinvpret(), dmatrix::dmatrix(), dmatrix_position::dmatrix_position(), dmdv_solve(), laplace_approximation_calculator::do_separable_stuff_laplace_approximation_banded(), laplace_approximation_calculator::do_separable_stuff_laplace_approximation_banded_adjoint(), laplace_approximation_calculator::do_separable_stuff_laplace_approximation_block_diagonal(), laplace_approximation_calculator::do_separable_stuff_newton_raphson_banded(), laplace_approximation_calculator::do_separable_stuff_newton_raphson_block_diagonal(), laplace_approximation_calculator::do_separable_stuff_x_u_block_diagonal(), dvar_matrix_position::dvar_matrix_position(), laplace_approximation_calculator::get_block_diagonal_hessian(), laplace_approximation_calculator::get_uhat_quasi_newton_block_diagonal(), inv(), ivector_position::ivector_position(), mfexp(), nograd_assign(), nograd_assign_trans(), dvar_matrix_position::operator()(), dmatrix_position::operator()(), operator*(), operator+(), operator+=(), operator-(), DF_FILE::restore_dmatrix_position(), DF_FILE::restore_dvar_matrix_position(), DF_FILE::restore_ivector_value(), rowsum(), DF_FILE::save_dmatrix_position(), DF_FILE::save_dvar_matrix_position(), DF_FILE::save_ivector_value(), funnel_init_df1b2variable::set_index(), funnel_init_df1b2vector::set_index(), solve(), sum(), use_shape(), and value().

int ivector::indexmax ( void  ) const

inline

Definition at line 104 of file ivector.h.

Referenced by factor::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(), vector_index::indexmax(), initialize(), ivector(), ivector_check(), ivector_position::ivector_position(), laplace_approximation_calculator::laplace_approximation_calculator(), lmatrix::lmatrix(), lvector::lvector(), max(), min(), norm2(), operator()(), dvector::operator()(), lvector::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(), DF_FILE::save_ivector_value(), admb_deprecated::sort(), sort(), square(), sum(), tmpxchol1(), nested_calls_shape::trim(), value(), write_on(), and xxxv().

int ivector::indexmin ( void  ) const

inline

Definition at line 99 of file ivector.h.

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

void ivector::initialize

(

void

)

Description not yet available.

Parameters

Definition at line 17 of file ivec2.cpp.

Referenced by laplace_approximation_calculator::check_hessian_type(), laplace_approximation_calculator::check_hessian_type2(), laplace_approximation_calculator::check_sparse_matrix_structure(), cs_add(), cs_amd(), cs_counts(), cs_etree(), cs_pinv(), cs_post(), cs_transpose(), dependent_variables_information::dependent_variables_information(), dfcholeski_sparse(), laplace_approximation_calculator::get_block_diagonal_hessian(), shareinfo::get_inv_matrix_shared(), shareinfo::get_inv_vector_shared(), laplace_approximation_calculator::get_newton_raphson_info_banded(), laplace_approximation_calculator::get_uhat_quasi_newton_block_diagonal(), function_minimizer::hess_routine_noparallel_random_effects(), histogram(), hs_symperm(), nested_calls_shape::initialize(), laplace_approximation_calculator::laplace_approximation_calculator(), reallocate(), and tmpxchol1().

int ivector::operator! ( ) const

inline

Definition at line 83 of file ivector.h.

int & ivector::operator() ( int  i )

inline

Definition at line 198 of file ivector.h.

Referenced by operator()().

const int & ivector::operator() ( int  i ) const

inline

Definition at line 206 of file ivector.h.

ivector ivector::operator() ( int  lb, int  ub  )

inline

Definition at line 168 of file ivector.h.

ivector ivector::operator()

(

const ivector &

indexes

)

Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California.

Returns a selected vector of values from ivector using positions in indexes.

Note: Assumes positions are in range [indexmin() to indexmax()].

Parameters

indexes

contains vector of valid index values

Definition at line 15 of file ivec3.cpp.

ivector& ivector::operator++ ( void  )

inline

Definition at line 76 of file ivector.h.

ivector & ivector::operator+=

(

const ivector &

other

)

Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California.

Element wise add elements from other to ivector.

Parameters

other

ivector

Definition at line 13 of file ivec9.cpp.

ivector & ivector::operator+=

(

int

value

)

Add value to each element of ivec.

Parameters

value

integer

Definition at line 41 of file ivec9.cpp.

ivector& ivector::operator-- ( void  )

inline

Definition at line 67 of file ivector.h.

ivector & ivector::operator=

(

const ivector &

t

)

Description not yet available.

Parameters

Definition at line 164 of file ivector.cpp.

ivector & ivector::operator=

(

int

value

)

Assigns value to all elements of ivector.

Parameters

value

int

Definition at line 195 of file ivector.cpp.

ivector& ivector::operator=

(

const lvector &

t

)

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

inline

Definition at line 194 of file ivector.h.

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

inline

Definition at line 202 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.

void ivector::read_from

(

const uistream &

input

)

Read values from input into ivector.

Parameters

input

uistream

Definition at line 40 of file ivec_io1.cpp.

void ivector::reallocate

(

double

s

)

Reallocate size of array.

Parameters

percent

change

Definition at line 14 of file ivect11.cpp.

Referenced by cs_multiply().

void ivector::safe_allocate	(	int	ncl,
		int	nch
	)

Description not yet available.

Parameters

Definition at line 78 of file ivector.cpp.

Referenced by laplace_approximation_calculator::check_hessian_type(), laplace_approximation_calculator::check_hessian_type2(), laplace_approximation_calculator::default_calculations_check_derivatives(), and laplace_approximation_calculator::get_newton_raphson_info_banded().

void ivector::safe_deallocate

(

void

)

Safely deallocates memory by reporting if shallow copies are still in scope.

Definition at line 119 of file ivector.cpp.

Referenced by laplace_approximation_calculator::check_hessian_type(), laplace_approximation_calculator::check_hessian_type2(), laplace_approximation_calculator::default_calculations_check_derivatives(), and laplace_approximation_calculator::get_newton_raphson_info_banded().

void ivector::save_ivector_position

(

)

const

Description not yet available.

Parameters

Definition at line 194 of file cmpdif3.cpp.

void ivector::save_ivector_value

(

)

const

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

Definition at line 148 of file cmpdif4.cpp.

void ivector::shallow_copy

(

const ivector &

other

)

Shallow copy other data structure pointers.

Parameters

other

i3_array

Definition at line 136 of file ivector.cpp.

Referenced by operator=().

ivector & ivector::shift

(

int

to_indexmin

)

Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California.

Shift current dimensions of ivector using to_indexmin as the new lower index value.

ie [1 to 5] shift to_indexmin 2 will change to [2 to 5]

Note: Size and data are unchanged.

Parameters

to_indexmin

lower index changed to

Definition at line 17 of file ivec.cpp.

Referenced by admb_deprecated::sort().

unsigned int ivector::size ( void  ) const

inline

Definition at line 109 of file ivector.h.

Referenced by admb_deprecated::sort(), and sort().

ivector ivector::sub ( int  lb, int  ub  )

inline

Definition at line 164 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 &

output

)

const

Write ivector values to output.

Parameters

output

uostream

Definition at line 68 of file ivec_io1.cpp.

Friends And Related Function Documentation

friend class i3_array

friend

Definition at line 190 of file ivector.h.

friend class imatrix

friend

Definition at line 189 of file ivector.h.

friend class vector_index

friend

Definition at line 188 of file ivector.h.

Member Data Documentation

int ivector::index_max

protected

Definition at line 54 of file ivector.h.

Referenced by imatrix::allocate(), allocate(), indexmax(), ivector(), operator++(), operator--(), shallow_copy(), shift(), and size().

int ivector::index_min

protected

Definition at line 53 of file ivector.h.

Referenced by imatrix::allocate(), allocate(), indexmin(), ivector(), operator++(), operator--(), shallow_copy(), shift(), and size().

vector_shapex* ivector::shape

protected

Definition at line 56 of file ivector.h.

Referenced by imatrix::allocate(), allocate(), allocated(), deallocate(), get_ncopies(), ivector(), operator!(), safe_deallocate(), shallow_copy(), and shift().

int* ivector::v

protected

Definition at line 55 of file ivector.h.

Referenced by imatrix::allocate(), allocate(), deallocate(), elem(), get_v(), initialize(), ivector(), operator()(), operator++(), operator+=(), operator--(), operator=(), operator[](), read_from(), shallow_copy(), shift(), and write_on().

---

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

• ivector.h (Last Changed on May 24, 2022 for git-revision 737ad378036b5b0581ef78c3ce5a7d53af77d244.)
• cmpdif3.cpp (Last Changed on August 06, 2022 for git-revision 808780089317c67198079de06b64df009a4a6543.)
• cmpdif4.cpp (Last Changed on August 06, 2022 for git-revision 808780089317c67198079de06b64df009a4a6543.)
• cranfill.cpp (Last Changed on June 23, 2017 for git-revision 19c0e8cec9cad500661693d7e734c4b8c359ea5e.)
• dvect11.cpp (Last Changed on September 17, 2014 for git-revision c16ffd4bd6a4a02a627b1f2d3af27456fdf6a69a.)
• dvect25.cpp (Last Changed on February 28, 2014 for git-revision 95b191673ef4c02f99839f6d98a7c2ad2a741766.)
• indextyp.cpp (Last Changed on September 25, 2018 for git-revision e59c44f9a74017f07ab78470257c0a1fb893bd50.)
• ivec.cpp (Last Changed on July 06, 2017 for git-revision a732e96e90a660d7c2c479e79939a5fce7f55a07.)
• ivec2.cpp (Last Changed on July 16, 2022 for git-revision f135841d1e9e036eca334761b451cbe2d797a2ba.)
• ivec3.cpp (Last Changed on June 21, 2017 for git-revision 15994b03c4964d34bdb58e4eaab0e713c78edfdd.)
• ivec4.cpp (Last Changed on July 10, 2012 for git-revision 76dfbb79d865d9f35eaf44e022ac338243e71411.)
• ivec9.cpp (Last Changed on July 16, 2022 for git-revision f135841d1e9e036eca334761b451cbe2d797a2ba.)
• ivec_io1.cpp (Last Changed on June 28, 2017 for git-revision f8a051978d04e89987944892ffc0c51e9beee487.)
• ivect11.cpp (Last Changed on August 08, 2017 for git-revision 1eb6077b975e0506c37aeefc7e5d920e862d5e95.)
• ivect_io.cpp (Last Changed on April 08, 2014 for git-revision 5a50ee539546300a87166cffec406aab49a4decb.)
• ivector.cpp (Last Changed on April 02, 2021 for git-revision 11813c5e0448296e55956e4e38440332e15d371a.)