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

Description not yet available. More...

#include <fvar.hpp>

Public Member Functions

 d4_array (int, int)
 Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California. More...
 
 d4_array (int hsl, int hsu, int sl, int sh, ivector nrl, ivector nrh, ivector ncl, ivector nch)
 Description not yet available. More...
 
 d4_array (int hsl, int hsu, int sl, const ivector &sh, int nrl, const imatrix &nrh, int ncl, const i3_array &nch)
 Description not yet available. More...
 
 d4_array (int hsl, int 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...
 
 d4_array (const d4_array &m2)
 Copy constructor (shallow) More...
 
 d4_array (int, int, int, int, int, int, int, int)
 Description not yet available. More...
 
 d4_array (int hsl, int hsu, int sl, const ivector &sh, int nrl, const imatrix &nrh, int ncl, int nch)
 Description not yet available. More...
 
 d4_array ()
 Default constructor. More...
 
 ~d4_array ()
 Destructor. More...
 
void allocate (int hsl, int hsu, int sl, int sh, int nrl, int nrh, int ncl, int nch)
 Allocate arrays with dimension [hsl to hsu] x [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
 
void allocate (int hsl, int hsu, int sl, const ivector &sh, int nrl, const imatrix &nrh, int ncl, const imatrix &nch)
 
void allocate (int hsl, int hsu, int sl, const ivector &sh, int nrl, const imatrix &nrh, int ncl, const i3_array &nch)
 Description not yet available. More...
 
void allocate (int hsl, int hsu, int sl, int sh, int nrl, int nrh, const ivector &ncl, const ivector &nch)
 Allocate arrays with dimension [hsl to hsu] x [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
 
void allocate (int hsl, int hsu, int sl, int sh, const ivector &nrl, const ivector &nrh, const ivector &ncl, const ivector &nch)
 Allocate arrays with dimension [hsl to hsu] x [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
 
void allocate (int hsl, int hsu, int sl, const ivector &sh, int nrl, const imatrix &nrh, int ncl, int nch)
 Allocate arrays with dimension [hsl to hsu] x [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
 
void allocate (void)
 Does not allocate, but initializes pointers to NULL. More...
 
void allocate (const d4_array &)
 Allocate d4_array with same dimensions as other. More...
 
void allocate (const dvar4_array &)
 
void allocate (int hsl, int 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 arrays with dimension [hsl to hsu] x [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
 
void allocate (ad_integer hsl, 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)
 Allocate arrays with dimension [hsl to hsu] x [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
 
void allocate (ad_integer hsl, ad_integer hsu, const index_type &sl, const index_type &sh, const index_type &nrl, const index_type &nrh)
 Allocate arrays with empty columns matrices with dimension [hsl to hsu] x [sl to sh] x [nrl to nrh]. More...
 
void allocate (ad_integer hsl, ad_integer hsu, const index_type &sl, const index_type &sh)
 Allocate 2d arrays with empty matrices with dimension [hsl to hsu] x [sl to sh]. More...
 
void allocate (ad_integer hsl, ad_integer hsu)
 Allocate vector of empty i3_array with dimension [hsl to hsu]. More...
 
int colmax (void)
 
int colmax (void) const
 
int colmin (void)
 
int colmin (void) const
 
int colsize ()
 
int colsize () const
 
void deallocate (void)
 Deallocates d4_array memory. More...
 
d3_arrayelem (int i)
 
dmatrixelem (int i, int j)
 
dvectorelem (int i, int j, int k)
 
double & elem (int i, int j, int k, int l)
 
const d3_arrayelem (int i) const
 
const dmatrixelem (int i, int j) const
 
const dvectorelem (int i, int j, int k) const
 
const double & elem (int i, int j, int k, int l) const
 
unsigned int get_ncopies () const
 
int hslicemax () const
 
int hslicemin () const
 
unsigned int hslicesize () const
 
int indexmax () const
 
int indexmin () const
 
void initialize ()
 Description not yet available. More...
 
int operator! (void) const
 
const d3_arrayoperator() (int i) const
 
const dmatrixoperator() (int i, int j) const
 
const dvectoroperator() (int i, int j, int k) const
 
const double & operator() (int i, int j, int k, int l) const
 
d3_arrayoperator() (int)
 
dmatrixoperator() (int, int)
 
dvectoroperator() (int, int, int)
 
double & operator() (int, int, int, int)
 
void operator/= (double d)
 Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California. More...
 
d4_arrayoperator= (const d4_array &)
 Assigns element values from other to d4_array. More...
 
const d3_arrayoperator[] (int i) const
 
d3_arrayoperator[] (int)
 
int rowmax (void)
 
int rowmax (void) const
 
int rowmin (void)
 
int rowmin (void) const
 
int rowsize ()
 
int rowsize () const
 
void shallow_copy (const d4_array &)
 Copies pointer locations from other to d4_array. More...
 
int slicemax (void)
 
int slicemax (void) const
 
int slicemin (void)
 
int slicemin (void) const
 
int slicesize ()
 
int slicesize () const
 
d4_array sub (int, int)
 Description not yet available. More...
 

Private Attributes

four_array_shapeshape
 
d3_arrayt
 

Friends

class four_array_shape
 

Detailed Description

Description not yet available.

Parameters

Definition at line 5161 of file fvar.hpp.

Constructor & Destructor Documentation

d4_array::d4_array ( int  nrl,
int  nrh 
)

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

Construct vector with dimension [nrl to nrh] of empty d3_array.

Parameters
nrllower vector index
nrhupper vector index

Definition at line 15 of file d4arr.cpp.

d4_array::d4_array ( int  hsl,
int  hsu,
int  sl,
int  sh,
ivector  nrl,
ivector  nrh,
ivector  ncl,
ivector  nch 
)

Description not yet available.

Parameters

Definition at line 524 of file d4arr.cpp.

d4_array::d4_array ( int  hsl,
int  hsu,
int  sl,
const ivector sh,
int  nrl,
const imatrix nrh,
int  ncl,
const i3_array nch 
)

Description not yet available.

Parameters

Definition at line 553 of file d4arr.cpp.

d4_array::d4_array ( int  hsl,
int  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.

Parameters

Definition at line 600 of file d4arr.cpp.

d4_array::d4_array ( const d4_array m2)

Copy constructor (shallow)

Definition at line 81 of file d4arr.cpp.

d4_array::d4_array ( int  hsl,
int  hsu,
int  sl,
int  sh,
int  nrl,
int  nrh,
int  ncl,
int  nch 
)

Description not yet available.

Parameters

Definition at line 514 of file d4arr.cpp.

d4_array::d4_array ( int  hsl,
int  hsu,
int  sl,
const ivector sh,
int  nrl,
const imatrix nrh,
int  ncl,
int  nch 
)

Description not yet available.

Parameters

Definition at line 460 of file d4arr.cpp.

d4_array::d4_array ( )

Default constructor.

Definition at line 9 of file d4arr3.cpp.

Referenced by data_4array::allocate().

d4_array::~d4_array ( )

Destructor.

Definition at line 132 of file d4arr.cpp.

Member Function Documentation

void d4_array::allocate ( int  hsl,
int  hsu,
int  sl,
int  sh,
int  nrl,
int  nrh,
int  ncl,
int  nch 
)

Allocate arrays with dimension [hsl to hsu] x [sl to sh] x [nrl to nrh] x [ncl to nch].

Parameters
hsllower d4_array index
hsuupper d4_array index
sllower d3_array index
shupper d3_array index
nrllower row matrix index
nrhupper row matrix index
ncllower column matrix index
nchupper column matrix index

Definition at line 344 of file d4arr.cpp.

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

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

Description not yet available.

Parameters

Definition at line 563 of file d4arr.cpp.

void d4_array::allocate ( int  hsl,
int  hsu,
int  sl,
int  sh,
int  nrl,
int  nrh,
const ivector ncl,
const ivector nch 
)

Allocate arrays with dimension [hsl to hsu] x [sl to sh] x [nrl to nrh] x [ncl to nch].

Parameters
hsllower d4_array index
hsuupper d4_array index
sllower d3_array index
shupper d3_array index
nrllower row matrix index
nrhupper row matrix index
ncllower column matrix index
nchupper column matrix index

Definition at line 383 of file d4arr.cpp.

void d4_array::allocate ( int  hsl,
int  hsu,
int  sl,
int  sh,
const ivector nrl,
const ivector nrh,
const ivector ncl,
const ivector nch 
)

Allocate arrays with dimension [hsl to hsu] x [sl to sh] x [nrl to nrh] x [ncl to nch].

Parameters
hsllower d4_array index
hsuupper d4_array index
sllower d3_array index
shupper d3_array index
nrllower row matrix index
nrhupper row matrix index
ncllower column matrix index
nchupper column matrix index

Definition at line 422 of file d4arr.cpp.

void d4_array::allocate ( int  hsl,
int  hsu,
int  sl,
const ivector sh,
int  nrl,
const imatrix nrh,
int  ncl,
int  nch 
)

Allocate arrays with dimension [hsl to hsu] x [sl to sh] x [nrl to nrh] x [ncl to nch].

Parameters
hsllower d4_array index
hsuupper d4_array index
sllower d3_array index
shupper d3_array index
nrllower row matrix index
nrhupper row matrix index
ncllower column matrix index
nchupper column matrix index

Definition at line 479 of file d4arr.cpp.

void d4_array::allocate ( void  )

Does not allocate, but initializes pointers to NULL.

Definition at line 14 of file d4arr3.cpp.

Referenced by named_d4_array::allocate(), data_4array::allocate(), allocate(), d4_array(), deallocate(), and shallow_copy().

void d4_array::allocate ( const d4_array other)

Allocate d4_array with same dimensions as other.

Parameters
otherd4_array

Definition at line 167 of file d4arr.cpp.

void d4_array::allocate ( const dvar4_array )
void d4_array::allocate ( int  hsl,
int  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 arrays with dimension [hsl to hsu] x [sl to sh] x [nrl to nrh] x [ncl to nch].

Parameters
hsllower d4_array index
hsuupper d4_array index
sllower d3_array index
shupper d3_array index
nrllower row matrix index
nrhupper row matrix index
ncllower column matrix index
nchupper column matrix index

Definition at line 677 of file d4arr.cpp.

void d4_array::allocate ( ad_integer  hsl,
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 
)

Allocate arrays with dimension [hsl to hsu] x [sl to sh] x [nrl to nrh] x [ncl to nch].

Parameters
hsllower d4_array index
hsuupper d4_array index
sllower d3_array index
shupper d3_array index
nrllower row matrix index
nrhupper row matrix index
ncllower column matrix index
nchupper column matrix index

Definition at line 620 of file d4arr.cpp.

void d4_array::allocate ( ad_integer  hsl,
ad_integer  hsu,
const index_type sl,
const index_type sh,
const index_type nrl,
const index_type nrh 
)

Allocate arrays with empty columns matrices with dimension [hsl to hsu] x [sl to sh] x [nrl to nrh].

Parameters
hsllower d4_array index
hsuupper d4_array index
sllower d3_array index
shupper d3_array index
nrllower row matrix index
nrhupper row matrix index

Definition at line 730 of file d4arr.cpp.

void d4_array::allocate ( ad_integer  hsl,
ad_integer  hsu,
const index_type sl,
const index_type sh 
)

Allocate 2d arrays with empty matrices with dimension [hsl to hsu] x [sl to sh].

Parameters
hsllower d4_array index
hsuupper d4_array index
sllower d3_array index
shupper d3_array index

Definition at line 778 of file d4arr.cpp.

void d4_array::allocate ( ad_integer  hsl,
ad_integer  hsu 
)

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

Parameters
hsllower vector index
hsuupper vector index

Definition at line 822 of file d4arr.cpp.

int d4_array::colmax ( void  )
inline

Definition at line 5286 of file fvar.hpp.

Referenced by colsize().

int d4_array::colmax ( void  ) const
inline

Definition at line 5341 of file fvar.hpp.

int d4_array::colmin ( void  )
inline

Definition at line 5282 of file fvar.hpp.

Referenced by colsize().

int d4_array::colmin ( void  ) const
inline

Definition at line 5337 of file fvar.hpp.

int d4_array::colsize ( )
inline

Definition at line 5301 of file fvar.hpp.

int d4_array::colsize ( ) const
inline

Definition at line 5372 of file fvar.hpp.

void d4_array::deallocate ( void  )

Deallocates d4_array memory.

Definition at line 107 of file d4arr.cpp.

Referenced by ~d4_array().

d3_array& d4_array::elem ( int  i)
inline

Definition at line 5220 of file fvar.hpp.

dmatrix& d4_array::elem ( int  i,
int  j 
)
inline

Definition at line 5224 of file fvar.hpp.

dvector& d4_array::elem ( int  i,
int  j,
int  k 
)
inline

Definition at line 5228 of file fvar.hpp.

double& d4_array::elem ( int  i,
int  j,
int  k,
int  l 
)
inline

Definition at line 5232 of file fvar.hpp.

const d3_array& d4_array::elem ( int  i) const
inline

Definition at line 5236 of file fvar.hpp.

const dmatrix& d4_array::elem ( int  i,
int  j 
) const
inline

Definition at line 5240 of file fvar.hpp.

const dvector& d4_array::elem ( int  i,
int  j,
int  k 
) const
inline

Definition at line 5244 of file fvar.hpp.

const double& d4_array::elem ( int  i,
int  j,
int  k,
int  l 
) const
inline

Definition at line 5248 of file fvar.hpp.

unsigned int d4_array::get_ncopies ( void  ) const
inline

Definition at line 5378 of file fvar.hpp.

int d4_array::hslicemax ( ) const
inline
int d4_array::hslicemin ( ) const
inline
unsigned int d4_array::hslicesize ( ) const
inline

Definition at line 5356 of file fvar.hpp.

Referenced by allocate().

int d4_array::indexmax ( void  ) const
inline

Definition at line 5309 of file fvar.hpp.

Referenced by colmax(), operator/(), operator/=(), operator>>(), size_count(), sub_unallocated(), and sum().

int d4_array::indexmin ( void  ) const
inline
void d4_array::initialize ( void  )

Description not yet available.

Parameters

Definition at line 534 of file d4arr.cpp.

Referenced by d5_array::initialize().

int d4_array::operator! ( void  ) const
inline

Definition at line 5185 of file fvar.hpp.

const d3_array & d4_array::operator() ( int  i) const
inline

Definition at line 5401 of file fvar.hpp.

const dmatrix & d4_array::operator() ( int  i,
int  j 
) const
inline

Definition at line 5409 of file fvar.hpp.

const dvector & d4_array::operator() ( int  i,
int  j,
int  k 
) const
inline

Definition at line 5413 of file fvar.hpp.

const double & d4_array::operator() ( int  i,
int  j,
int  k,
int  l 
) const
inline

Definition at line 5417 of file fvar.hpp.

d3_array & d4_array::operator() ( int  i)
inline

Definition at line 5381 of file fvar.hpp.

dmatrix & d4_array::operator() ( int  i,
int  j 
)
inline

Definition at line 5389 of file fvar.hpp.

dvector & d4_array::operator() ( int  i,
int  j,
int  k 
)
inline

Definition at line 5393 of file fvar.hpp.

double & d4_array::operator() ( int  i,
int  j,
int  k,
int  l 
)
inline

Definition at line 5397 of file fvar.hpp.

void d4_array::operator/= ( double  d)

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

Divides all elements of d4_array by d.

Parameters
ddouble

Definition at line 12 of file d4arr2.cpp.

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

Assigns element values from other to d4_array.

Parameters
otherd4_array

Definition at line 141 of file d4arr.cpp.

Referenced by named_d4_array::operator=().

const d3_array & d4_array::operator[] ( int  i) const
inline

Definition at line 5405 of file fvar.hpp.

d3_array & d4_array::operator[] ( int  i)
inline

Definition at line 5385 of file fvar.hpp.

int d4_array::rowmax ( void  )
inline

Definition at line 5278 of file fvar.hpp.

Referenced by colmax(), colmin(), rowmax(), and rowsize().

int d4_array::rowmax ( void  ) const
inline

Definition at line 5333 of file fvar.hpp.

int d4_array::rowmin ( void  )
inline

Definition at line 5274 of file fvar.hpp.

Referenced by rowmin(), and rowsize().

int d4_array::rowmin ( void  ) const
inline

Definition at line 5329 of file fvar.hpp.

int d4_array::rowsize ( void  )
inline

Definition at line 5296 of file fvar.hpp.

int d4_array::rowsize ( void  ) const
inline

Definition at line 5367 of file fvar.hpp.

void d4_array::shallow_copy ( const d4_array other)

Copies pointer locations from other to d4_array.

Parameters
otherd4_array

Definition at line 90 of file d4arr.cpp.

Referenced by d4_array(), and sub().

int d4_array::slicemax ( void  )
inline

Definition at line 5270 of file fvar.hpp.

Referenced by slicemax(), and slicesize().

int d4_array::slicemax ( void  ) const
inline

Definition at line 5325 of file fvar.hpp.

int d4_array::slicemin ( void  )
inline

Definition at line 5266 of file fvar.hpp.

Referenced by colmax(), colmin(), rowmax(), rowmin(), slicemin(), and slicesize().

int d4_array::slicemin ( void  ) const
inline

Definition at line 5321 of file fvar.hpp.

int d4_array::slicesize ( )
inline

Definition at line 5291 of file fvar.hpp.

int d4_array::slicesize ( ) const
inline

Definition at line 5362 of file fvar.hpp.

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

Description not yet available.

Parameters

Definition at line 64 of file d4arr.cpp.

Friends And Related Function Documentation

friend class four_array_shape
friend

Definition at line 5264 of file fvar.hpp.

Referenced by allocate().

Member Data Documentation

four_array_shape* d4_array::shape
private

Definition at line 5163 of file fvar.hpp.

Referenced by allocate(), deallocate(), get_ncopies(), hslicemax(), hslicemin(), operator!(), and shallow_copy().

d3_array* d4_array::t
private

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