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
dvar5_array Class Reference

Description not yet available. More...

#include <fvar.hpp>

Public Member Functions

 dvar5_array ()
 Description not yet available. More...
 
 dvar5_array (const d5_array &darray)
 Description not yet available. More...
 
 dvar5_array (const dvar5_array &other)
 Copy constructor. More...
 
 dvar5_array (int hhsl, int hhsu)
 Construct vector of empty dvar4_array with dimension [hsl to hsu]. More...
 
 dvar5_array (int hhsl, int hhsu, int hsl, int hsu, int sl, int sh, int nrl, int nrh, int ncl, int nch)
 Description not yet available. More...
 
 dvar5_array (const ad_integer &hhsl, const ad_integer &hhsu, const index_type &hsl, const index_type &hsu, const index_type &sl, const index_type &sh, const index_type &nrl, const index_type &nrh, const index_type &ncl, const index_type &nch)
 Description not yet available. More...
 
 ~dvar5_array ()
 Destructor. More...
 
void allocate (int hhsl, int hhsu, int hsl, int hsu, int sl, int sh, int nrl, int nrh, int ncl, int nch)
 Allocate dvar5_array with dimensions [hsl to hsu] x [sl to sh] x [nrl to nrh] x [ncl to nch] x [l5 to u5]. More...
 
void allocate (int imin, int imax)
 Allocate vector of empty dvar4_array with dimension [hsl to hsu]. More...
 
void allocate (const ad_integer &hhsl, const ad_integer &hhsu, const index_type &hsl, const index_type &hsu, const index_type &sl, const index_type &sh, const index_type &nrl, const index_type &nrh, const index_type &ncl, const index_type &nch)
 Allocate variable array with dimensions [hsl to hsu] x [sl to sh] x [nrl to nrh] x [ncl to nch] x [l5 to u5]. More...
 
void allocate (void)
 Description not yet available. More...
 
void allocate (const d5_array &)
 Allocate dvar5_array with same dimensions as m1. More...
 
void allocate (const dvar5_array &)
 Allocate dvar5_array with same dimensions as m1. More...
 
void deallocate (void)
 Deallocate dvar5_array memory. More...
 
dvar4_arrayelem (int i)
 
dvar3_arrayelem (int i, int j)
 
dvar_matrixelem (int i, int j, int k)
 
dvar_vectorelem (int i, int j, int k, int l)
 
prevariable elem (int i, int j, int k, int l, int _m)
 
const dvar4_arrayelem (int i) const
 
const dvar3_arrayelem (int i, int j) const
 
const dvar_matrixelem (int i, int j, int k) const
 
const dvar_vectorelem (int i, int j, int k, int l) const
 
const prevariable elem (int i, int j, int k, int l, int _m) const
 
unsigned int get_ncopies () const
 
int indexmax () const
 
int indexmin () const
 
void initialize ()
 Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California. More...
 
int operator! (void) const
 
dvar4_arrayoperator() (int i)
 
dvar3_arrayoperator() (int i, int j)
 
dvar_matrixoperator() (int i, int j, int k)
 
dvar_vectoroperator() (int i, int j, int k, int l)
 
prevariable operator() (int i, int j, int k, int l, int _m)
 
const dvar4_arrayoperator() (int i) const
 
const dvar3_arrayoperator() (int i, int j) const
 
const dvar_matrixoperator() (int i, int j, int k) const
 
const dvar_vectoroperator() (int i, int j, int k, int l) const
 
const prevariable operator() (int i, int j, int k, int l, int _m) const
 
void operator/= (const prevariable &d)
 Description not yet available. More...
 
void operator/= (const double &d)
 Description not yet available. More...
 
dvar5_arrayoperator= (const d5_array &)
 Description not yet available. More...
 
dvar5_arrayoperator= (const dvar5_array &m)
 Description not yet available. More...
 
dvar4_arrayoperator[] (int i)
 
const dvar4_arrayoperator[] (int i) const
 
void shallow_copy (const dvar5_array &)
 Shallow copy other data structure pointers. More...
 
unsigned int size () const
 
dvar5_array sub (int hhsl, int hhsu)
 Description not yet available. More...
 

Private Attributes

vector_shapeshape
 
dvar4_arrayt
 

Detailed Description

Description not yet available.

Parameters

Definition at line 6498 of file fvar.hpp.

Constructor & Destructor Documentation

dvar5_array::dvar5_array ( )

Description not yet available.

Parameters

Definition at line 17 of file f5arr3.cpp.

dvar5_array::dvar5_array ( const d5_array _m2)

Description not yet available.

Parameters

Definition at line 79 of file f5arr.cpp.

dvar5_array::dvar5_array ( const dvar5_array other)

Copy constructor.

Definition at line 50 of file f5arr.cpp.

dvar5_array::dvar5_array ( int  hsl,
int  hsu 
)

Construct vector of empty dvar4_array with dimension [hsl to hsu].

Parameters
hsllower vector index
hsuupper vector index

Definition at line 470 of file f5arr.cpp.

dvar5_array::dvar5_array ( int  hsl,
int  hsu,
int  sl,
int  sh,
int  nrl,
int  nrh,
int  ncl,
int  nch,
int  l5,
int  u5 
)

Description not yet available.

Parameters

Definition at line 413 of file f5arr.cpp.

dvar5_array::~dvar5_array ( )

Destructor.

Definition at line 110 of file f5arr.cpp.

dvar5_array::dvar5_array ( const ad_integer hsl,
const ad_integer hsu,
const index_type sl,
const index_type sh,
const index_type nrl,
const index_type nrh,
const index_type ncl,
const index_type nch,
const index_type l5,
const index_type u5 
)

Description not yet available.

Parameters

Definition at line 423 of file f5arr.cpp.

Member Function Documentation

void dvar5_array::allocate ( int  hhsl,
int  hhsu,
int  hsl,
int  hsu,
int  sl,
int  sh,
int  nrl,
int  nrh,
int  ncl,
int  nch 
)

Allocate dvar5_array with dimensions [hsl to hsu] x [sl to sh] x [nrl to nrh] x [ncl to nch] x [l5 to u5].

Definition at line 435 of file f5arr.cpp.

Referenced by dvar6_array::allocate(), exp(), log(), mfexp(), operator/(), and sqrt().

void dvar5_array::allocate ( int  hsl,
int  hsu 
)

Allocate vector of empty dvar4_array with dimension [hsl to hsu].

Parameters
hsllower vector index
hsuupper vector index

Definition at line 481 of file f5arr.cpp.

void dvar5_array::allocate ( const ad_integer hsl,
const ad_integer hsu,
const index_type sl,
const index_type sh,
const index_type nrl,
const index_type nrh,
const index_type ncl,
const index_type nch,
const index_type l5,
const index_type u5 
)

Allocate variable array with dimensions [hsl to hsu] x [sl to sh] x [nrl to nrh] x [ncl to nch] x [l5 to u5].

Parameters
hsllower dvar5_array index
hsuupper dvar5_array index
sllower dvar4_array index
suupper dvar4_array index
nrllower dvar3_array row index
nrhupper dvar3_array row index
ncllower matrix row index
nchupper matrix row index
l5lower matrix column index
u5upper matrix column index

Definition at line 518 of file f5arr.cpp.

void dvar5_array::allocate ( void  )

Description not yet available.

Parameters

Definition at line 26 of file f5arr3.cpp.

Referenced by named_dvar5_array::allocate(), deallocate(), dvar5_array(), and shallow_copy().

void dvar5_array::allocate ( const d5_array m1)

Allocate dvar5_array with same dimensions as m1.

Definition at line 204 of file f5arr.cpp.

void dvar5_array::allocate ( const dvar5_array m1)

Allocate dvar5_array with same dimensions as m1.

Definition at line 172 of file f5arr.cpp.

void dvar5_array::deallocate ( void  )

Deallocate dvar5_array memory.

Definition at line 86 of file f5arr.cpp.

Referenced by ~dvar5_array().

dvar4_array& dvar5_array::elem ( int  i)
inline

Definition at line 6541 of file fvar.hpp.

dvar3_array& dvar5_array::elem ( int  i,
int  j 
)
inline

Definition at line 6545 of file fvar.hpp.

dvar_matrix& dvar5_array::elem ( int  i,
int  j,
int  k 
)
inline

Definition at line 6549 of file fvar.hpp.

dvar_vector& dvar5_array::elem ( int  i,
int  j,
int  k,
int  l 
)
inline

Definition at line 6553 of file fvar.hpp.

prevariable dvar5_array::elem ( int  i,
int  j,
int  k,
int  l,
int  _m 
)
inline

Definition at line 6557 of file fvar.hpp.

const dvar4_array& dvar5_array::elem ( int  i) const
inline

Definition at line 6561 of file fvar.hpp.

const dvar3_array& dvar5_array::elem ( int  i,
int  j 
) const
inline

Definition at line 6565 of file fvar.hpp.

const dvar_matrix& dvar5_array::elem ( int  i,
int  j,
int  k 
) const
inline

Definition at line 6569 of file fvar.hpp.

const dvar_vector& dvar5_array::elem ( int  i,
int  j,
int  k,
int  l 
) const
inline

Definition at line 6573 of file fvar.hpp.

const prevariable dvar5_array::elem ( int  i,
int  j,
int  k,
int  l,
int  _m 
) const
inline

Definition at line 6577 of file fvar.hpp.

unsigned int dvar5_array::get_ncopies ( void  ) const
inline

Definition at line 6662 of file fvar.hpp.

int dvar5_array::indexmax ( void  ) const
inline
int dvar5_array::indexmin ( void  ) const
inline
void dvar5_array::initialize ( void  )

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

Description not yet available.

Parameters

Definition at line 12 of file f5arr.cpp.

Referenced by dvar6_array::initialize().

int dvar5_array::operator! ( void  ) const
inline

Definition at line 6534 of file fvar.hpp.

dvar4_array& dvar5_array::operator() ( int  i)
inline

Definition at line 6582 of file fvar.hpp.

dvar3_array& dvar5_array::operator() ( int  i,
int  j 
)
inline

Definition at line 6590 of file fvar.hpp.

dvar_matrix& dvar5_array::operator() ( int  i,
int  j,
int  k 
)
inline

Definition at line 6594 of file fvar.hpp.

dvar_vector& dvar5_array::operator() ( int  i,
int  j,
int  k,
int  l 
)
inline

Definition at line 6598 of file fvar.hpp.

prevariable dvar5_array::operator() ( int  i,
int  j,
int  k,
int  l,
int  _m 
)
inline

Definition at line 6602 of file fvar.hpp.

const dvar4_array& dvar5_array::operator() ( int  i) const
inline

Definition at line 6606 of file fvar.hpp.

const dvar3_array& dvar5_array::operator() ( int  i,
int  j 
) const
inline

Definition at line 6614 of file fvar.hpp.

const dvar_matrix& dvar5_array::operator() ( int  i,
int  j,
int  k 
) const
inline

Definition at line 6618 of file fvar.hpp.

const dvar_vector& dvar5_array::operator() ( int  i,
int  j,
int  k,
int  l 
) const
inline

Definition at line 6622 of file fvar.hpp.

const prevariable dvar5_array::operator() ( int  i,
int  j,
int  k,
int  l,
int  _m 
) const
inline

Definition at line 6626 of file fvar.hpp.

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

Description not yet available.

Parameters

Definition at line 72 of file f5arr2.cpp.

void dvar5_array::operator/= ( const double &  d)

Description not yet available.

Parameters

Definition at line 87 of file f5arr2.cpp.

dvar5_array & dvar5_array::operator= ( const d5_array m)

Description not yet available.

Parameters

Definition at line 146 of file f5arr.cpp.

Referenced by named_dvar5_array::operator=().

dvar5_array & dvar5_array::operator= ( const dvar5_array m)

Description not yet available.

Parameters

Definition at line 119 of file f5arr.cpp.

dvar4_array& dvar5_array::operator[] ( int  i)
inline

Definition at line 6586 of file fvar.hpp.

const dvar4_array& dvar5_array::operator[] ( int  i) const
inline

Definition at line 6610 of file fvar.hpp.

void dvar5_array::shallow_copy ( const dvar5_array other)

Shallow copy other data structure pointers.

Parameters
otherdvar5_array

Definition at line 59 of file f5arr.cpp.

Referenced by dvar5_array().

unsigned int dvar5_array::size ( void  ) const
inline

Definition at line 6654 of file fvar.hpp.

Referenced by allocate().

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

Description not yet available.

Parameters

Definition at line 29 of file f5arr.cpp.

Member Data Documentation

vector_shape* dvar5_array::shape
private

Definition at line 6500 of file fvar.hpp.

Referenced by allocate(), deallocate(), get_ncopies(), indexmax(), indexmin(), operator!(), and shallow_copy().

dvar4_array* dvar5_array::t
private

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