ADMB Documentation  -a65f1c97
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Attributes | List of all members
dvar3_array Class Reference

Description not yet available. More...

#include <fvar.hpp>

Public Member Functions

 dvar3_array (int, int)
 Description not yet available. More...
 
 dvar3_array (int sl, int sh, int nrl, int nrh, int ncl, int nch)
 Description not yet available. More...
 
 dvar3_array (int sl, int sh, int nrl, int nrh, const ivector &ncl, int nch)
 Description not yet available. More...
 
 dvar3_array (int sl, int sh, const ivector &nrl, const ivector &nrh, ivector &ncl, const ivector &nch)
 Description not yet available. More...
 
 dvar3_array (int sl, int sh, int nrl, const ivector &nrh, int ncl, const ivector &nch)
 Description not yet available. More...
 
 dvar3_array (int sl, int sh, int nrl, const ivector &nrh, int ncl, int nch)
 Description not yet available. More...
 
 dvar3_array (ad_integer sl, ad_integer sh, const index_type &nrl, const index_type &nrh, const index_type &ncl, const index_type &nch)
 Description not yet available. More...
 
 dvar3_array (const d3_array &m2)
 Description not yet available. More...
 
 dvar3_array (const param_init_matrix_vector &m2)
 
 dvar3_array (const param_init_bounded_matrix_vector &m2)
 
 dvar3_array (const dvar3_array &m2)
 Copy constructor. More...
 
 dvar3_array (void)
 Default constructor. More...
 
 ~dvar3_array ()
 Destructor. More...
 
void allocate (int sl, int sh, int nrl, int nrh, int ncl, int nch)
 Allocate variable vector of matrices with dimensions [sl to sh] x ([nrl to nrh] x [ncl to nch]) where nch is a vector of indexes. More...
 
void allocate (int sl, int sh, int nrl, int nrh)
 Allocate vector of matrices having empty columns wht the dimensions [sl to sh] x [nrl to nrh]. More...
 
void allocate (int sl, int sh, const index_type &nrl, const index_type &nrh)
 Description not yet available. 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)
 Allocate variable vector of matrices with dimensions [sl to sh] x ([nrl to nrh] x [ncl to nch]) where nch is a vector of indexes. More...
 
void allocate (const d3_array &m1)
 Allocate dvar3_array with same dimensions as m1. More...
 
void allocate (void)
 Does not allocte, but initialize class members. More...
 
void allocate (const dvar3_array &m1)
 Allocate dvar3_array with same dimensions as m1. More...
 
void allocate (int sl, int sh, int nrl, int nrh, const ivector &ncl, const ivector &nch)
 Allocate variable vector of matrices with dimensions [sl to sh] x ([nrl to nrh] x [ncl to nch]) where nch is a vector of indexes. More...
 
void allocate (int sl, int sh, const ivector &nrl, const ivector &nrh, const ivector &ncl, const ivector &nch)
 Allocate variable vector of matrices with dimensions [sl to sh] x ([nrl to nrh] x [ncl to nch]) where nrh and nch are vectors of indexes. More...
 
void allocate (int sl, int sh, const ivector &nrl, const ivector &nrh, int ncl, int nch)
 Allocate variable vector of matrices with dimensions [sl to sh] x ([nrl to nrh] x [ncl to nch]) where nrl and nrh are vectors of indexes. More...
 
void allocate (int sl, int sh, const ivector &nrl, int nrh, int ncl, int nch)
 Allocate variable vector of matrices with dimensions [sl to sh] x ([nrl to nrh] x [ncl to nch]) where nrl is a vector of indexes. More...
 
void allocate (int sl, int sh, int nrl, const ivector &nrh, int ncl, int nch)
 Allocate variable vector of matrices with dimensions [sl to sh] x ([nrl to nrh] x [ncl to nch]) where nrh is a vector of indexes. More...
 
void allocate (int sl, int sh, int nrl, const ivector &nrh, int ncl, const ivector &nch)
 Allocate variable vector of matrices with dimensions [sl to sh] x ([nrl to nrh] x [ncl to nch]) where nrh and nch are vectors of indexes. More...
 
void allocate (int sl, int sh, int nrl, int nrh, int ncl, const ivector &nch)
 Allocate variable vector of matrices with dimensions [sl to sh] x ([nrl to nrh] x [ncl to nch]) where nch is a vector of indexes. More...
 
void allocate (ad_integer sl, ad_integer sh, const index_type &nrl, const index_type &nrh, const index_type &ncl, const index_type &nch)
 Allocate array with dimensions [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
 
void allocate (ad_integer sl, ad_integer sh, const index_type &nrl, const index_type &nrh)
 Description not yet available. More...
 
void allocate (ad_integer sl, ad_integer sh)
 Allocate vector with dimension [sl to sh] of empty matrices. More...
 
int colmax (void) const
 
int colmin () const
 
int colsize () const
 
void deallocate ()
 Deallocate dvar3_array memory. More...
 
dvar_matrixelem (int i)
 ? Retrieves an element of a dvar3_array. More...
 
prevariable elem (int i, int j, int k)
 ? Retrieves an element of a dvar3_array. More...
 
const dvar_matrixelem (int i) const
 ? Retrieves an element of a dvar3_array. More...
 
const prevariable elem (int i, int j, int k) const
 ? Retrieves an element of a dvar3_array. More...
 
void fill_randn (long int &n)
 Description not yet available. More...
 
void fill_randn_ni (long int &n)
 Description not yet available. More...
 
void fill_randu (long int &n)
 Description not yet available. More...
 
void fill_randu_ni (long int &n)
 Description not yet available. More...
 
double fill_seqadd (double, double)
 Description not yet available. More...
 
unsigned int get_ncopies () const
 
int indexmax () const
 
int indexmin () const
 
void initialize (void)
 Description not yet available. More...
 
int operator! (void) const
 
const prevariable operator() (int k, int i, int j) const
 
const dvar_vectoroperator() (int k, int i) const
 
const dvar_matrixoperator() (int i) const
 
prevariable operator() (int k, int i, int j)
 
dvar_vectoroperator() (int k, int i)
 
dvar_matrixoperator() (int i)
 
void operator/= (const prevariable &)
 Description not yet available. More...
 
void operator/= (double)
 Description not yet available. More...
 
dvar3_arrayoperator= (const d3_array &m1)
 Assign element values from scalar arr3 to dvar3_array. More...
 
dvar3_arrayoperator= (double x)
 Assigns value to all elements of dvar3_array. More...
 
dvar3_arrayoperator= (const dvar3_array &m1)
 Assign values from other to dvar3_array. More...
 
const dvar_matrixoperator[] (int i) const
 
dvar_matrixoperator[] (int i)
 
int rowmax (void) const
 
int rowmin (void) const
 
int rowsize () const
 
void shallow_copy (const dvar3_array &)
 Shallow copy other data structure pointers. More...
 
int slicemax () const
 
int slicemin () const
 
unsigned int slicesize () const
 
dvar3_array sub (int, int)
 Description not yet available. More...
 
d3_array value (const dvar3_array &)
 

Private Attributes

three_array_shapeshape
 
dvar_matrixt
 

Detailed Description

Description not yet available.

Parameters

Definition at line 4197 of file fvar.hpp.

Constructor & Destructor Documentation

dvar3_array::dvar3_array ( int  nrl,
int  nrh 
)

Description not yet available.

Parameters

Definition at line 58 of file f3arr.cpp.

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

Description not yet available.

Parameters

Definition at line 67 of file f3arr.cpp.

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

Description not yet available.

Parameters

Definition at line 227 of file f3arr.cpp.

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

Description not yet available.

Parameters

Definition at line 464 of file f3arr.cpp.

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

Description not yet available.

Parameters

Definition at line 530 of file f3arr.cpp.

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

Description not yet available.

Parameters

Definition at line 592 of file f3arr.cpp.

dvar3_array::dvar3_array ( ad_integer  sl,
ad_integer  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 17 of file f3arr15.cpp.

dvar3_array::dvar3_array ( const d3_array m1)

Description not yet available.

Parameters

Definition at line 385 of file f3arr.cpp.

dvar3_array::dvar3_array ( const param_init_matrix_vector m2)
dvar3_array::dvar3_array ( const param_init_bounded_matrix_vector m2)
dvar3_array::dvar3_array ( const dvar3_array m2)

Copy constructor.

Definition at line 644 of file f3arr.cpp.

dvar3_array::dvar3_array ( void  )

Default constructor.

Definition at line 11 of file f3arr17.cpp.

Referenced by param_init_d3array::restore_value(), and param_init_d3array::save_value().

dvar3_array::~dvar3_array ( )

Destructor.

Definition at line 670 of file f3arr.cpp.

Member Function Documentation

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

Allocate variable vector of matrices with dimensions [sl to sh] x ([nrl to nrh] x [ncl to nch]) where nch is a vector of indexes.

Parameters
sllower index of vector
shupper index of vector
nrllower row index for matrix
nrhupper row index for matrix
ncllower column index for matrix
nchupper column index for matrix

Definition at line 91 of file f3arr.cpp.

Referenced by dvar4_array::allocate(), cos(), cube(), elem_div(), elem_prod(), exp(), log(), mfexp(), operator*(), operator+(), operator-(), operator/(), pow(), sin(), sqr(), sqrt(), square(), and tan().

void dvar3_array::allocate ( int  sl,
int  sh,
int  nrl,
int  nrh 
)

Allocate vector of matrices having empty columns wht the dimensions [sl to sh] x [nrl to nrh].

Parameters
sllower index of vector
shupper index of vector
nrllower row index of matrix
nrhupper row index of matrix

Definition at line 128 of file f3arr.cpp.

void dvar3_array::allocate ( int  sl,
int  sh,
const index_type nrl,
const index_type nrh 
)

Description not yet available.

Parameters

Definition at line 161 of file f3arr.cpp.

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

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

Parameters
sllower index of vector
shupper index of vector

Definition at line 195 of file f3arr.cpp.

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

Allocate variable vector of matrices with dimensions [sl to sh] x ([nrl to nrh] x [ncl to nch]) where nch is a vector of indexes.

Parameters
sllower index of vector
shupper index of vector
nrllower row index for matrix
nrhupper row index for matrix
nclvector of lower column indexes for matrix
nchupper column index for matrix

Definition at line 252 of file f3arr.cpp.

void dvar3_array::allocate ( const d3_array m1)

Allocate dvar3_array with same dimensions as m1.

Definition at line 404 of file f3arr.cpp.

void dvar3_array::allocate ( void  )
void dvar3_array::allocate ( const dvar3_array m1)

Allocate dvar3_array with same dimensions as m1.

Definition at line 433 of file f3arr.cpp.

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

Allocate variable vector of matrices with dimensions [sl to sh] x ([nrl to nrh] x [ncl to nch]) where nch is a vector of indexes.

Parameters
sllower index of vector
shupper index of vector
nrllower row index for matrix
nrhupper row index for matrix
nclvector of lower column indexes for matrix
nchvector of upper column indexes for matrix

Definition at line 294 of file f3arr.cpp.

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

Allocate variable vector of matrices with dimensions [sl to sh] x ([nrl to nrh] x [ncl to nch]) where nrh and nch are vectors of indexes.

Parameters
sllower index of vector
shupper index of vector
nrllower row index for matrix
nrhvector of upper row indexes for matrix
nclupper column index for matrix
nrhvector of upper column indexes for matrix

Definition at line 489 of file f3arr.cpp.

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

Allocate variable vector of matrices with dimensions [sl to sh] x ([nrl to nrh] x [ncl to nch]) where nrl and nrh are vectors of indexes.

Parameters
sllower index of vector
shupper index of vector
nrlvector of lower row indexes for matrix
nrhvector of upper row indexes for matrix
nclupper column index for matrix
nchupper column index for matrix

Definition at line 710 of file f3arr.cpp.

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

Allocate variable vector of matrices with dimensions [sl to sh] x ([nrl to nrh] x [ncl to nch]) where nrl is a vector of indexes.

Parameters
sllower index of vector
shupper index of vector
nrlvector of lower row indexes for matrix
nrhupper row index for matrix
nclupper column index for matrix
nchupper column index for matrix

Definition at line 752 of file f3arr.cpp.

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

Allocate variable vector of matrices with dimensions [sl to sh] x ([nrl to nrh] x [ncl to nch]) where nrh is a vector of indexes.

Parameters
sllower index of vector
shupper index of vector
nrllower row index for matrix
nrhvector of upper row indexes for matrix
nclupper column index for matrix
nchupper column index for matrix

Definition at line 617 of file f3arr.cpp.

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

Allocate variable vector of matrices with dimensions [sl to sh] x ([nrl to nrh] x [ncl to nch]) where nrh and nch are vectors of indexes.

Parameters
sllower index of vector
shupper index of vector
nrllower row index for matrix
nrhvector of upper row indexes for matrix
nclupper column index for matrix
nrhvector of upper column indexes for matrix

Definition at line 555 of file f3arr.cpp.

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

Allocate variable vector of matrices with dimensions [sl to sh] x ([nrl to nrh] x [ncl to nch]) where nch is a vector of indexes.

Parameters
sllower index of vector
shupper index of vector
nrllower row index for matrix
nrhupper row index for matrix
ncllower column index for matrix
nchvector of upper column indexes for matrix

Definition at line 344 of file f3arr.cpp.

void dvar3_array::allocate ( ad_integer  sl,
ad_integer  sh,
const index_type nrl,
const index_type nrh,
const index_type ncl,
const index_type nch 
)

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

Parameters
sllower i3_array index
shupper i3_array index
nrllower matrix row index
nrhupper matrix row index
ncllower matrix column index
nchupper matrix column index

Definition at line 38 of file f3arr15.cpp.

void dvar3_array::allocate ( ad_integer  sl,
ad_integer  sh,
const index_type nrl,
const index_type nrh 
)

Description not yet available.

Parameters

Definition at line 89 of file f3arr15.cpp.

void dvar3_array::allocate ( ad_integer  sl,
ad_integer  sh 
)

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

Parameters
sllower vector index
shupper vector index

Definition at line 138 of file f3arr15.cpp.

int dvar3_array::colmax ( void  ) const
inline
int dvar3_array::colmin ( void  ) const
inline
int dvar3_array::colsize ( ) const
inline

Definition at line 4305 of file fvar.hpp.

void dvar3_array::deallocate ( void  )

Deallocate dvar3_array memory.

Definition at line 675 of file f3arr.cpp.

Referenced by ~dvar3_array().

void dvar3_array::fill_randn ( long int &  n)

Description not yet available.

Parameters

Definition at line 208 of file ranfill2.cpp.

void dvar3_array::fill_randn_ni ( long int &  n)

Description not yet available.

Parameters

Definition at line 130 of file ranf_ni2.cpp.

void dvar3_array::fill_randu ( long int &  n)

Description not yet available.

Parameters

Definition at line 224 of file ranfill2.cpp.

void dvar3_array::fill_randu_ni ( long int &  n)

Description not yet available.

Parameters

Definition at line 145 of file ranf_ni2.cpp.

double dvar3_array::fill_seqadd ( double  i1,
double  i2 
)

Description not yet available.

Parameters

Definition at line 17 of file f3arr16.cpp.

unsigned int dvar3_array::get_ncopies ( void  ) const
inline

Definition at line 4406 of file fvar.hpp.

int dvar3_array::indexmax ( void  ) const
inline
int dvar3_array::indexmin ( void  ) const
inline
void dvar3_array::initialize ( void  )
int dvar3_array::operator! ( void  ) const
inline

Definition at line 4206 of file fvar.hpp.

const prevariable dvar3_array::operator() ( int  k,
int  i,
int  j 
) const
inline

Definition at line 4343 of file fvar.hpp.

const dvar_vector& dvar3_array::operator() ( int  k,
int  i 
) const
inline

Definition at line 4348 of file fvar.hpp.

const dvar_matrix& dvar3_array::operator() ( int  i) const
inline

Definition at line 4353 of file fvar.hpp.

prevariable dvar3_array::operator() ( int  k,
int  i,
int  j 
)
inline

Definition at line 4363 of file fvar.hpp.

dvar_vector& dvar3_array::operator() ( int  k,
int  i 
)
inline

Definition at line 4368 of file fvar.hpp.

dvar_matrix& dvar3_array::operator() ( int  i)
inline

Definition at line 4373 of file fvar.hpp.

void dvar3_array::operator/= ( const prevariable d)

Description not yet available.

Parameters

Definition at line 72 of file f3arr5.cpp.

void dvar3_array::operator/= ( double  d)

Description not yet available.

Parameters

Definition at line 87 of file f3arr5.cpp.

dvar3_array & dvar3_array::operator= ( const d3_array arr3)

Assign element values from scalar arr3 to dvar3_array.

Parameters
arr3d3_array

Definition at line 19 of file f3arr13.cpp.

Referenced by named_dvar3_array::operator=(), dll_param_init_d3array::operator=(), and dll_param_d3array::operator=().

dvar3_array & dvar3_array::operator= ( double  value)

Assigns value to all elements of dvar3_array.

Parameters
valuedouble

Definition at line 53 of file f3arr13.cpp.

dvar3_array & dvar3_array::operator= ( const dvar3_array other)

Assign values from other to dvar3_array.

Parameters
otherdvar3_array

Definition at line 15 of file f3arr14.cpp.

const dvar_matrix& dvar3_array::operator[] ( int  i) const
inline

Definition at line 4358 of file fvar.hpp.

dvar_matrix& dvar3_array::operator[] ( int  i)
inline

Definition at line 4378 of file fvar.hpp.

int dvar3_array::rowmax ( void  ) const
inline
int dvar3_array::rowmin ( void  ) const
inline
int dvar3_array::rowsize ( void  ) const
inline

Definition at line 4300 of file fvar.hpp.

void dvar3_array::shallow_copy ( const dvar3_array other)

Shallow copy other data structure pointers.

Parameters
otherdvar3_array

Definition at line 653 of file f3arr.cpp.

Referenced by dvar3_array(), and sub().

int dvar3_array::slicemax ( ) const
inline
int dvar3_array::slicemin ( ) const
inline
unsigned int dvar3_array::slicesize ( ) const
inline

Definition at line 4277 of file fvar.hpp.

Referenced by allocate().

dvar3_array dvar3_array::sub ( int  nrl,
int  nrh 
)

Description not yet available.

Parameters

Definition at line 37 of file f3arr.cpp.

d3_array dvar3_array::value ( const dvar3_array )

Member Data Documentation

three_array_shape* dvar3_array::shape
private

Definition at line 4200 of file fvar.hpp.

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

dvar_matrix* dvar3_array::t
private

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