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

Description not yet available. More...

#include <fvar.hpp>

Public Member Functions

 d5_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...
 
 d5_array (int imin, int imax)
 Construct vector of empty d4_arrays with dimension [hsl to hsu]. More...
 
 d5_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...
 
 d5_array (const d5_array &m2)
 Copy constructor (shallow) More...
 
 d5_array ()
 Description not yet available. More...
 
 ~d5_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 d5_array with specified dimensions. More...
 
void allocate (int imin, int imax)
 Allocate vector of d4_array with range [hsl, 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 d5_array with specified dimensions. More...
 
void allocate (void)
 Description not yet available. More...
 
void allocate (const d5_array &)
 Allocate d5_array using other dimensions. More...
 
void deallocate (void)
 Deallocate d5_array memory. More...
 
d4_array & elem (int i)
 
d3_array & elem (int i, int j)
 
dmatrix & elem (int i, int j, int k)
 
dvector & elem (int i, int j, int k, int l)
 
double & elem (int i, int j, int k, int l, int _m)
 
const d4_array & elem (int i) const
 
const d3_array & elem (int i, int j) const
 
const dmatrix & elem (int i, int j, int k) const
 
const dvector & elem (int i, int j, int k, int l) const
 
const double & 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 ()
 Initialize all elements of d5_array to zero. More...
 
int operator! (void) const
 
d4_array & operator() (int i)
 
d3_array & operator() (int i, int j)
 
dmatrix & operator() (int i, int j, int k)
 
dvector & operator() (int i, int j, int k, int l)
 
double & operator() (int i, int j, int k, int l, int _m)
 
const d4_array & operator() (int i) const
 
const d3_array & operator() (int i, int j) const
 
const dmatrix & operator() (int i, int j, int k) const
 
const dvector & operator() (int i, int j, int k, int l) const
 
const double & operator() (int i, int j, int k, int l, int _m) const
 
void operator/= (double d)
 Divides all elements of d5_array by d. More...
 
d5_array & operator= (const d5_array &)
 Assigns element values from other to d5_array. More...
 
d4_array & operator[] (int i)
 
const d4_array & operator[] (int i) const
 
void shallow_copy (const d5_array &)
 Shallow copy pointers from other data structure. More...
 
unsigned int size () const
 

Private Attributes

vector_shape * shape
 
d4_array * t
 

Detailed Description

Description not yet available.

Parameters

Definition at line 6331 of file fvar.hpp.

Constructor & Destructor Documentation

d5_array::d5_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 331 of file d5arr.cpp.

d5_array::d5_array ( int  hsl,
int  hsu 
)

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

Parameters
hsllower index
hsuupper index

Definition at line 378 of file d5arr.cpp.

d5_array::d5_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 341 of file d5arr.cpp.

d5_array::d5_array ( const d5_array &  m2)

Copy constructor (shallow)

Definition at line 41 of file d5arr.cpp.

d5_array::d5_array ( )

Description not yet available.

Parameters

Definition at line 17 of file d5arr3.cpp.

Referenced by data_5array::allocate().

d5_array::~d5_array ( )

Destructor.

Definition at line 91 of file d5arr.cpp.

Member Function Documentation

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

Allocate d5_array with specified dimensions.

Definition at line 352 of file d5arr.cpp.

Referenced by d6_array::allocate(), and operator/().

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

Allocate vector of d4_array with range [hsl, hsu].

Parameters
hsllower index
hsuupper index

Definition at line 388 of file d5arr.cpp.

void d5_array::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 d5_array with specified dimensions.

Definition at line 407 of file d5arr.cpp.

void d5_array::allocate ( void  )

Description not yet available.

Parameters

Definition at line 26 of file d5arr3.cpp.

Referenced by named_d5_array::allocate(), data_5array::allocate(), allocate(), d5_array(), deallocate(), and shallow_copy().

void d5_array::allocate ( const d5_array &  other)

Allocate d5_array using other dimensions.

Parameters
otherd5_array

Definition at line 141 of file d5arr.cpp.

void d5_array::deallocate ( void  )

Deallocate d5_array memory.

Definition at line 67 of file d5arr.cpp.

Referenced by ~d5_array().

d4_array& d5_array::elem ( int  i)
inline

Definition at line 6371 of file fvar.hpp.

Referenced by allocate(), initialize(), operator=(), and sum().

d3_array& d5_array::elem ( int  i,
int  j 
)
inline

Definition at line 6375 of file fvar.hpp.

dmatrix& d5_array::elem ( int  i,
int  j,
int  k 
)
inline

Definition at line 6379 of file fvar.hpp.

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

Definition at line 6383 of file fvar.hpp.

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

Definition at line 6387 of file fvar.hpp.

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

Definition at line 6391 of file fvar.hpp.

const d3_array& d5_array::elem ( int  i,
int  j 
) const
inline

Definition at line 6395 of file fvar.hpp.

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

Definition at line 6399 of file fvar.hpp.

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

Definition at line 6403 of file fvar.hpp.

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

Definition at line 6407 of file fvar.hpp.

unsigned int d5_array::get_ncopies ( void  ) const
inline

Definition at line 6489 of file fvar.hpp.

int d5_array::indexmax ( void  ) const
inline

Definition at line 6479 of file fvar.hpp.

Referenced by allocate(), dvar5_array::allocate(), initialize(), operator/(), operator/=(), operator<<(), operator=(), dvar5_array::operator=(), operator>>(), size(), sub_unallocated(), and sum().

int d5_array::indexmin ( void  ) const
inline

Definition at line 6475 of file fvar.hpp.

Referenced by allocate(), dvar5_array::allocate(), deallocate(), initialize(), operator/(), operator/=(), operator<<(), operator=(), dvar5_array::operator=(), operator>>(), size(), sub_unallocated(), and sum().

void d5_array::initialize ( void  )

Initialize all elements of d5_array to zero.

Definition at line 117 of file d5arr.cpp.

Referenced by d6_array::initialize().

int d5_array::operator! ( void  ) const
inline

Definition at line 6362 of file fvar.hpp.

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

Definition at line 6412 of file fvar.hpp.

d3_array& d5_array::operator() ( int  i,
int  j 
)
inline

Definition at line 6420 of file fvar.hpp.

dmatrix& d5_array::operator() ( int  i,
int  j,
int  k 
)
inline

Definition at line 6424 of file fvar.hpp.

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

Definition at line 6428 of file fvar.hpp.

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

Definition at line 6432 of file fvar.hpp.

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

Definition at line 6436 of file fvar.hpp.

const d3_array& d5_array::operator() ( int  i,
int  j 
) const
inline

Definition at line 6444 of file fvar.hpp.

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

Definition at line 6448 of file fvar.hpp.

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

Definition at line 6452 of file fvar.hpp.

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

Definition at line 6456 of file fvar.hpp.

void d5_array::operator/= ( double  d)

Divides all elements of d5_array by d.

Parameters
ddenominator

Definition at line 28 of file d5arr1.cpp.

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

Assigns element values from other to d5_array.

Parameters
otherd5_array

Definition at line 100 of file d5arr.cpp.

Referenced by named_d5_array::operator=().

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

Definition at line 6416 of file fvar.hpp.

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

Definition at line 6440 of file fvar.hpp.

void d5_array::shallow_copy ( const d5_array &  other)

Shallow copy pointers from other data structure.

Parameters
otherd5_array

Definition at line 50 of file d5arr.cpp.

Referenced by d5_array().

unsigned int d5_array::size ( void  ) const
inline

Definition at line 6483 of file fvar.hpp.

Referenced by allocate(), initialize(), and sum().

Member Data Documentation

vector_shape* d5_array::shape
private

Definition at line 6333 of file fvar.hpp.

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

d4_array* d5_array::t
private

Definition at line 6334 of file fvar.hpp.

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

The documentation for this class was generated from the following files:
ADMB Generated on Wed Sep 7 2022 00:01:32 for ADMB Documentation by doxygen 1.8.5