i3_array Class Reference

Description not yet available. More...

#include <fvar.hpp>

Public Member Functions
	i3_array (int sl, int sh, int nrl, int nrh, const ivector &nc)
	i3_array (void)
	Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California. More...
	i3_array (int sl, int sh, const index_type &nrl, const index_type &nrh, const index_type &ncl, const index_type &nch)
	Description not yet available. More...
	i3_array (int _sl, int _sh, const imatrix &m1)
	Allocate vector [sl to sh] of integer matrices with same dimension as m1. More...
	i3_array (int sl, int sh)
	Construct vector of empty matrices with dimension [sl to sh]. More...
	i3_array (int sl, int sh, int nrl, int nrh, int ncl, int nch)
	Allocate vector of integer matrices with dimensions [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
	i3_array (int sl, int sh, int nrl, int nrh, const ivector &ncl, int nch)
	i3_array (int sl, int sh, const ivector &nrl, const ivector &nrh, const imatrix &ncl, const imatrix &nch)
	i3_array (int sl, int sh, const ivector &nrl, const ivector &nrh, int ncl, const imatrix &nch)
	i3_array (int sl, int sh, const ivector &nrl, const ivector &nrh, const ivector &ncl, const ivector &nch)
	i3_array (int sl, int sh, int nrl, int nrh, const ivector &ncl, const ivector &nch)
	Construct vector of integer matrices with dimensions [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
	i3_array (int sl, int sh, int nrl, const ivector &nrh, int ncl, const ivector &nch)
	i3_array (int sl, int sh, int nrl, const ivector &nrh, int ncl, int nch)
	Construct vector of integer matrices with dimensions [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
	i3_array (int sl, int sh, int nrl, const ivector &nrh, int ncl, const imatrix &nch)
	Construct vector of integer matrices with dimensions [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
	i3_array (const i3_array &m2)
	Copy constructor (shallow) More...
	~i3_array ()
	Destructor. More...
void	allocate (int sl, int sh, int nrl, int nrh, const ivector &nc)
void	allocate (int sl, int sh, int nrl, const ivector &nrh, int ncl, int nch)
	Allocate vector of integer matrices with dimensions [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
void	allocate (const dvar3_array &)
void	allocate (const i3_array &i3v)
	Allocate i3_array with same dimension as other. More...
void	allocate (int sl, int sh, int nrl, int nrh, int ncl, int nch)
	Allocate vector of integer matrices with dimensions [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
void	allocate (int sl, int sh)
	Allocate vector of empty matrices with dimension [sl to sh]. More...
void	allocate (int sl, int sh, int nrl, int nrh, const ivector &ncl, int nch)
void	allocate (int sl, int sh, const index_type &nrl, const index_type &nrh, const index_type &ncl, const index_type &nch)
	Allocate array of matrices with dimensions [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
void	allocate (int sl, int sh, const ivector &nrl, const ivector &nrh, const imatrix &ncl, const imatrix &nch)
void	allocate (int sl, int sh, int nrl, const ivector &nrh, int ncl, const imatrix &nch)
	Allocate vector of integer matrices with dimensions [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
void	allocate (int sl, int sh, const ivector &nrl, const ivector &nrh, int ncl, const imatrix &nch)
void	allocate (int sl, int sh, const ivector &nrl, const ivector &nrh, int ncl, int nch)
void	allocate (int sl, int sh, const ivector &nrl, int nrh, int ncl, int nch)
void	allocate (int sl, int sh, const ivector &nrl, const ivector &nrh, const ivector &ncl, const ivector &nch)
void	allocate (int sl, int sh, int nrl, const ivector &nrh, int ncl, const ivector &nch)
void	allocate (int sl, int sh, int nrl, int nrh, const ivector &ncl, const ivector &nch)
	Allocate vector of integer matrices with dimensions [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
void	allocate (int sl, int sh, int nrl, int nrh, int ncl, const ivector &nch)
void	allocate (void)
	Does NOT allocate, but set empty i3_array. More...
int	colmax (void) const
int	colmin (void) const
int	colsize () const
void	deallocate (void)
	Deallocate i3_array memory. More...
imatrix &	elem (int i)
const imatrix &	elem (int i) const
void	fill_randn (long int &n)
void	fill_randn_ni (long int &n)
void	fill_randu (long int &n)
void	fill_randu_ni (long int &n)
unsigned int	get_ncopies () const
int	indexmax () const
int	indexmin () const
void	initialize (int sl, int sh, int nrl, const ivector &nrh, int ncl, const ivector &nch)
void	initialize ()
	Initialize all elements of i3_array to zero. More...
int	operator! (void) const
int &	operator() (int i, int j, int k)
ivector &	operator() (int i, int j)
imatrix &	operator() (int i)
const int &	operator() (int i, int j, int k) const
const ivector &	operator() (int i, int j) const
const imatrix &	operator() (int i) const
i3_array &	operator= (const i3_array &other)
	Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California. More...
i3_array &	operator= (int value)
	Assigns value to all elements of i3_array. More...
imatrix &	operator[] (int i)
const imatrix &	operator[] (int i) const
int	rowmax (void) const
int	rowmin (void) const
int	rowsize () const
void	shallow_copy (const i3_array &)
	Shallow copy other data structure pointers. More...
int	slicemax () const
int	slicemin () const
unsigned int	slicesize () const

Private Attributes
three_array_shape *	shape
imatrix *	t

Detailed Description

Description not yet available.

Parameters

Definition at line 3944 of file fvar.hpp.

Constructor & Destructor Documentation

i3_array::i3_array	(	int	sl,
		int	sh,
		int	nrl,
		int	nrh,
		const ivector &	nc
	)

i3_array::i3_array

(

void

)

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

Default constructor

Definition at line 8 of file i3arr.cpp.

Referenced by data_3iarray::allocate().

i3_array::i3_array	(	int	sl,
		int	sh,
		const index_type &	nrl,
		const index_type &	nrh,
		const index_type &	ncl,
		const index_type &	nch
	)

Description not yet available.

Parameters

Definition at line 263 of file indextyp.cpp.

i3_array::i3_array	(	int	sl,
		int	sh,
		const imatrix &	m1
	)

Allocate vector [sl to sh] of integer matrices with same dimension as m1.

Parameters

sl	lower vector index
sh	upper vector index
m1	matrix to copy dimensions

Definition at line 215 of file i3arr.cpp.

i3_array::i3_array	(	int	sl,
		int	sh
	)

Construct vector of empty matrices with dimension [sl to sh].

Parameters

sl	lower vector index
sh	upper vector index

Definition at line 91 of file i3arr.cpp.

i3_array::i3_array	(	int	sl,
		int	sh,
		int	nrl,
		int	nrh,
		int	ncl,
		int	nch
	)

Allocate vector of integer matrices with dimensions [sl to sh] x [nrl to nrh] x [ncl to nch].

Parameters

sl	lower vector index
sh	upper vector index
nrl	lower matrix row index
nrh	upper matrix row index
ncl	lower matrix column index
nch	upper matrix column index

Definition at line 164 of file i3arr.cpp.

i3_array::i3_array	(	int	sl,
		int	sh,
		int	nrl,
		int	nrh,
		const ivector &	ncl,
		int	nch
	)

i3_array::i3_array	(	int	sl,
		int	sh,
		const ivector &	nrl,
		const ivector &	nrh,
		const imatrix &	ncl,
		const imatrix &	nch
	)

i3_array::i3_array	(	int	sl,
		int	sh,
		const ivector &	nrl,
		const ivector &	nrh,
		int	ncl,
		const imatrix &	nch
	)

i3_array::i3_array	(	int	sl,
		int	sh,
		const ivector &	nrl,
		const ivector &	nrh,
		const ivector &	ncl,
		const ivector &	nch
	)

i3_array::i3_array	(	int	sl,
		int	sh,
		int	nrl,
		int	nrh,
		const ivector &	ncl,
		const ivector &	nch
	)

Construct vector of integer matrices with dimensions [sl to sh] x [nrl to nrh] x [ncl to nch].

Parameters

sl	lower vector index
sh	upper vector index
nrl	lower matrix row index
nrh	upper matrix row index
ncl	vector of lower matrix column indexes
nch	vector of upper matrix column indexes

Definition at line 78 of file i3arr.cpp.

i3_array::i3_array	(	int	sl,
		int	sh,
		int	nrl,
		const ivector &	nrh,
		int	ncl,
		const ivector &	nch
	)

i3_array::i3_array	(	int	sl,
		int	sh,
		int	nrl,
		const ivector &	nrh,
		int	ncl,
		int	nch
	)

Construct vector of integer matrices with dimensions [sl to sh] x [nrl to nrh] x [ncl to nch].

Parameters

sl	lower vector index
sh	upper vector index
nrl	lower matrix row index
nrh	vector of upper matrix row indexes
ncl	lower matrix column index
nch	upper matrix column index

Definition at line 105 of file i3arr.cpp.

i3_array::i3_array	(	int	sl,
		int	sh,
		int	nrl,
		const ivector &	nrh,
		int	ncl,
		const imatrix &	nch
	)

Construct vector of integer matrices with dimensions [sl to sh] x [nrl to nrh] x [ncl to nch].

Parameters

sl	lower vector index
sh	upper vector index
nrl	lower matrix row index
nrh	vector of upper matrix row indexes [sl to sh]
ncl	lower matrix column index
nch	matrix of upper matrix column indexes [sl to sh] x [ncl to nrh]

Definition at line 181 of file i3arr.cpp.

i3_array::i3_array

(

const i3_array &

m2

)

Copy constructor (shallow)

Definition at line 251 of file i3arr.cpp.

i3_array::~i3_array

(

)

Destructor.

Definition at line 13 of file i3arr.cpp.

Member Function Documentation

void i3_array::allocate	(	int	sl,
		int	sh,
		int	nrl,
		int	nrh,
		const ivector &	nc
	)

Referenced by i4_array::allocate().

void i3_array::allocate	(	int	sl,
		int	sh,
		int	nrl,
		const ivector &	nrh,
		int	ncl,
		int	nch
	)

Allocate vector of integer matrices with dimensions [sl to sh] x [nrl to nrh] x [ncl to nch].

Parameters

sl	lower vector index
sh	upper vector index
nrl	lower matrix row index
nrh	vector of upper matrix row indexes
ncl	lower matrix column index
nch	upper matrix column index

Definition at line 143 of file i3arr.cpp.

void i3_array::allocate

(

const dvar3_array &

)

void i3_array::allocate

(

const i3_array &

other

)

Allocate i3_array with same dimension as other.

Parameters

other

i3_array

Definition at line 228 of file i3arr.cpp.

void i3_array::allocate	(	int	sl,
		int	sh,
		int	nrl,
		int	nrh,
		int	ncl,
		int	nch
	)

Allocate vector of integer matrices with dimensions [sl to sh] x [nrl to nrh] x [ncl to nch].

Parameters

sl	lower vector index
sh	upper vector index
nrl	lower matrix row index
nrh	upper matrix row index
ncl	lower matrix column index
nch	upper matrix column index

Definition at line 27 of file i3arr.cpp.

void i3_array::allocate	(	int	sl,
		int	sh
	)

Allocate vector of empty matrices with dimension [sl to sh].

Parameters

sl	lower vector index
sh	upper vector index

Definition at line 44 of file i3arr.cpp.

void i3_array::allocate	(	int	sl,
		int	sh,
		int	nrl,
		int	nrh,
		const ivector &	ncl,
		int	nch
	)

void i3_array::allocate	(	int	sl,
		int	sh,
		const index_type &	nrl,
		const index_type &	nrh,
		const index_type &	ncl,
		const index_type &	nch
	)

Allocate array of matrices with dimensions [sl to sh] x [nrl to nrh] x [ncl to nch].

Parameters

sl	lower vector index
sh	upper vector index
nrl	lower matrix row index
nrl	upper matrix row index
ncl	lower matrix column index
ncl	upper matrix column index

Definition at line 279 of file indextyp.cpp.

void i3_array::allocate	(	int	sl,
		int	sh,
		const ivector &	nrl,
		const ivector &	nrh,
		const imatrix &	ncl,
		const imatrix &	nch
	)

void i3_array::allocate	(	int	sl,
		int	sh,
		int	nrl,
		const ivector &	nrh,
		int	ncl,
		const imatrix &	nch
	)

Allocate vector of integer matrices with dimensions [sl to sh] x [nrl to nrh] x [ncl to nch].

Parameters

sl	lower vector index
sh	upper vector index
nrl	lower matrix row index
nrh	vector of upper matrix row indexes [sl to sh]
ncl	lower matrix column index
nch	matrix of upper matrix column indexes [sl to sh] x [ncl to nrh]

Definition at line 198 of file i3arr.cpp.

void i3_array::allocate	(	int	sl,
		int	sh,
		const ivector &	nrl,
		const ivector &	nrh,
		int	ncl,
		const imatrix &	nch
	)

void i3_array::allocate	(	int	sl,
		int	sh,
		const ivector &	nrl,
		const ivector &	nrh,
		int	ncl,
		int	nch
	)

void i3_array::allocate	(	int	sl,
		int	sh,
		const ivector &	nrl,
		int	nrh,
		int	ncl,
		int	nch
	)

void i3_array::allocate	(	int	sl,
		int	sh,
		const ivector &	nrl,
		const ivector &	nrh,
		const ivector &	ncl,
		const ivector &	nch
	)

void i3_array::allocate	(	int	sl,
		int	sh,
		int	nrl,
		const ivector &	nrh,
		int	ncl,
		const ivector &	nch
	)

void i3_array::allocate	(	int	sl,
		int	sh,
		int	nrl,
		int	nrh,
		const ivector &	ncl,
		const ivector &	nch
	)

Allocate vector of integer matrices with dimensions [sl to sh] x [nrl to nrh] x [ncl to nch].

Parameters

sl	lower vector index
sh	upper vector index
nrl	lower matrix row index
nrh	upper matrix row index
ncl	vector of lower matrix column indexes
nch	vector of upper matrix column indexes

Definition at line 122 of file i3arr.cpp.

void i3_array::allocate	(	int	sl,
		int	sh,
		int	nrl,
		int	nrh,
		int	ncl,
		const ivector &	nch
	)

void i3_array::allocate

(

void

)

Does NOT allocate, but set empty i3_array.

Definition at line 237 of file i3arr.cpp.

Referenced by named_i3_array::allocate(), data_3iarray::allocate(), allocate(), deallocate(), i3_array(), and shallow_copy().

int i3_array::colmax ( void  ) const

inline

Definition at line 4041 of file fvar.hpp.

Referenced by colsize().

int i3_array::colmin ( void  ) const

inline

Definition at line 4037 of file fvar.hpp.

Referenced by colsize().

int i3_array::colsize ( ) const

inline

Definition at line 4064 of file fvar.hpp.

void i3_array::deallocate

(

void

)

Deallocate i3_array memory.

Definition at line 277 of file i3arr.cpp.

Referenced by ~i3_array().

imatrix & i3_array::elem ( int  i )

inline

Definition at line 4091 of file fvar.hpp.

Referenced by allocate(), initialize(), operator()(), operator=(), and operator[]().

const imatrix & i3_array::elem ( int  i ) const

inline

Definition at line 4107 of file fvar.hpp.

void i3_array::fill_randn

(

long int &

n

)

void i3_array::fill_randn_ni

(

long int &

n

)

void i3_array::fill_randu

(

long int &

n

)

void i3_array::fill_randu_ni

(

long int &

n

)

unsigned int i3_array::get_ncopies ( void  ) const

inline

Definition at line 4089 of file fvar.hpp.

int i3_array::indexmax ( void  ) const

inline

Definition at line 4025 of file fvar.hpp.

Referenced by laplace_approximation_calculator::check_hessian_type(), shareinfo::get_inv_matrix_shared(), operator>>(), param_init_d3array::shared_set_value(), param_init_d3array::shared_size_count(), and sub_unallocated().

int i3_array::indexmin ( void  ) const

inline

Definition at line 4021 of file fvar.hpp.

Referenced by laplace_approximation_calculator::check_hessian_type(), deallocate(), shareinfo::get_inv_matrix_shared(), operator>>(), param_init_d3array::shared_set_value(), param_init_d3array::shared_size_count(), and sub_unallocated().

void i3_array::initialize	(	int	sl,
		int	sh,
		int	nrl,
		const ivector &	nrh,
		int	ncl,
		const ivector &	nch
	)

Referenced by laplace_approximation_calculator::check_hessian_type(), shareinfo::get_inv_matrix_shared(), nested_calls_shape::initialize(), and i4_array::initialize().

void i3_array::initialize

(

void

)

Initialize all elements of i3_array to zero.

Definition at line 243 of file i3arr.cpp.

int i3_array::operator! ( void  ) const

inline

Definition at line 3953 of file fvar.hpp.

int & i3_array::operator() ( int  i, int  j, int  k  )

inline

Definition at line 4147 of file fvar.hpp.

ivector & i3_array::operator() ( int  i, int  j  )

inline

Definition at line 4139 of file fvar.hpp.

imatrix & i3_array::operator() ( int  i )

inline

Definition at line 4131 of file fvar.hpp.

const int & i3_array::operator() ( int  i, int  j, int  k  ) const

inline

Definition at line 4179 of file fvar.hpp.

const ivector & i3_array::operator() ( int  i, int  j  ) const

inline

Definition at line 4171 of file fvar.hpp.

const imatrix & i3_array::operator() ( int  i ) const

inline

Definition at line 4163 of file fvar.hpp.

i3_array & i3_array::operator=

(

const i3_array &

other

)

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

Assign values from other to i3_array. Note: Both matrices should have the same bounds.

Parameters

other

i3_array

Definition at line 13 of file i3arr8.cpp.

Referenced by named_i3_array::operator=().

i3_array & i3_array::operator=

(

int

value

)

Assigns value to all elements of i3_array.

Parameters

value

integer

Definition at line 36 of file i3arr8.cpp.

imatrix & i3_array::operator[] ( int  i )

inline

Definition at line 4123 of file fvar.hpp.

const imatrix & i3_array::operator[] ( int  i ) const

inline

Definition at line 4155 of file fvar.hpp.

int i3_array::rowmax ( void  ) const

inline

Definition at line 4049 of file fvar.hpp.

Referenced by rowsize().

int i3_array::rowmin ( void  ) const

inline

Definition at line 4045 of file fvar.hpp.

Referenced by rowsize().

int i3_array::rowsize ( void  ) const

inline

Definition at line 4059 of file fvar.hpp.

void i3_array::shallow_copy

(

const i3_array &

other

)

Shallow copy other data structure pointers.

Parameters

other

i3_array

Definition at line 260 of file i3arr.cpp.

Referenced by i3_array().

int i3_array::slicemax ( ) const

inline

Definition at line 4033 of file fvar.hpp.

Referenced by allocate(), elem(), i3_array(), indexmax(), i3_index::indexmax(), initialize(), operator<<(), operator=(), operator>>(), and slicesize().

int i3_array::slicemin ( ) const

inline

Definition at line 4029 of file fvar.hpp.

Referenced by allocate(), colmax(), colmin(), elem(), i3_array(), indexmin(), i3_index::indexmin(), initialize(), operator<<(), operator=(), operator>>(), rowmax(), rowmin(), and slicesize().

unsigned int i3_array::slicesize ( ) const

inline

Definition at line 4054 of file fvar.hpp.

Referenced by allocate().

Member Data Documentation

three_array_shape* i3_array::shape

private

Definition at line 3947 of file fvar.hpp.

Referenced by allocate(), deallocate(), get_ncopies(), operator!(), shallow_copy(), slicemax(), and slicemin().

imatrix* i3_array::t

private

Definition at line 3946 of file fvar.hpp.

Referenced by allocate(), deallocate(), elem(), i3_array(), operator()(), operator=(), operator[](), and shallow_copy().

---

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

• fvar.hpp (Last Changed on August 07, 2022 for git-revision 0a920593f1602d0b526036677a330e80065904b7.)
• i3arr.cpp (Last Changed on April 02, 2021 for git-revision 11813c5e0448296e55956e4e38440332e15d371a.)
• i3arr8.cpp (Last Changed on August 08, 2017 for git-revision 7cf19f305116d2b73e89f98c40db15bfca16b845.)
• indextyp.cpp (Last Changed on September 25, 2018 for git-revision e59c44f9a74017f07ab78470257c0a1fb893bd50.)