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

Description not yet available. More...

#include <fvar.hpp>

Public Member Functions

 i4_array (int hsl, int hsu, int sl, int sh, ivector nrl, ivector nrh, ivector ncl, ivector nch)
 
 i4_array (int hsl, int hsu)
 Construct vector of empty i3_array with dimension [hsl to hsu]. More...
 
 i4_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...
 
 i4_array (const ad_integer &hsl, const ad_integer &hsh, const index_type &sl, const index_type &sh, const index_type &nrl, const index_type &nrh, const index_type &ncl, const index_type &nch)
 
 i4_array (const i4_array &m2)
 Copy constructor. More...
 
 i4_array (int, int, int, int, int, int, int, int)
 Construct integer array with dimensions [hsl to hsu] x [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
 
 i4_array (int hsl, int hsu, int sl, const ivector &sh, int nrl, const imatrix &nrh, int ncl, int nch)
 
 i4_array ()
 Default constructor. More...
 
 ~i4_array ()
 Destructor. More...
 
void allocate (int hsl, int hsu, int sl, int sh, int nrl, int nrh, int ncl, int nch)
 Allocate array with dimensions [hsl to hsu] x [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
 
void 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)
 Allocate array with dimensions [hsl to hsu] x [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
 
void allocate (void)
 Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California. More...
 
void allocate (const i4_array &)
 
void allocate (const dvar4_array &)
 
void allocate (int hsl, int 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)
 Deallocate i4_array memory. More...
 
i3_array & elem (int i)
 
const i3_array & elem (int i) const
 
imatrix & elem (int i, int j)
 
ivector & elem (int i, int j, int k)
 
int & elem (int i, int j, int k, int l)
 
unsigned int get_ncopies () const
 
int hslicemax () const
 
int hslicemin () const
 
int hslicesize ()
 
int hslicesize () const
 
int indexmax () const
 
int indexmin () const
 
void initialize ()
 Initializes elements of i4_array to zero. More...
 
int operator! (void) const
 
i3_array & operator() (int i)
 
imatrix & operator() (int i, int j)
 
ivector & operator() (int i, int j, int k)
 
int & operator() (int i, int j, int k, int l)
 
const i3_array & operator() (int i) const
 
const imatrix & operator() (int i, int j) const
 
const ivector & operator() (int i, int j, int k) const
 
const int & operator() (int i, int j, int k, int l) const
 
i4_array & operator= (const i4_array &)
 
i3_array & operator[] (int j)
 
const i3_array & operator[] (int i) const
 
int rowmax (void)
 
int rowmax (void) const
 
int rowmin (void)
 
int rowmin (void) const
 
int rowsize ()
 
int rowsize () const
 
void shallow_copy (const i4_array &)
 Shallow copy other data structure pointers. More...
 
int size ()
 
int size () const
 
int slicemax (void)
 
int slicemax (void) const
 
int slicemin (void)
 
int slicemin (void) const
 
int slicesize ()
 
int slicesize () const
 

Private Attributes

vector_shapex * shape
 
i3_array * t
 

Friends

class four_array_shape
 

Detailed Description

Description not yet available.

Parameters

Definition at line 5769 of file fvar.hpp.

Constructor & Destructor Documentation

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

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

Parameters
hsllower vector index
hsuupper vector index

Definition at line 37 of file i4arr.cpp.

i4_array::i4_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 76 of file i4arr.cpp.

i4_array::i4_array ( const ad_integer &  hsl,
const ad_integer &  hsh,
const index_type &  sl,
const index_type &  sh,
const index_type &  nrl,
const index_type &  nrh,
const index_type &  ncl,
const index_type &  nch 
)
i4_array::i4_array ( const i4_array &  m2)

Copy constructor.

Definition at line 185 of file i4arr.cpp.

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

Construct integer array with dimensions [hsl to hsu] x [sl to sh] x [nrl to nrh] x [ncl to nch].

Parameters
hsllower i4_array index
hsuupper i4_array index
sllower i3_array index
suupper i3_array index
nrllower matrix row index
nrhupper matrix row index
ncllower matrix column index
nchupper matrix column index

Definition at line 97 of file i4arr.cpp.

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

Default constructor.

Definition at line 26 of file i4arr.cpp.

Referenced by data_4iarray::allocate().

i4_array::~i4_array ( )

Destructor.

Definition at line 211 of file i4arr.cpp.

Member Function Documentation

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

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

Parameters
hsllower i4_array index
hsuupper i4_array index
sllower i3_array index
suupper i3_array index
nrllower matrix row index
nrhupper matrix row index
ncllower matrix column index
nchupper matrix column index

Definition at line 118 of file i4arr.cpp.

Referenced by i5_array::allocate().

void i4_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 
)

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

Parameters
hsllower i4_array index
hsuupper i4_array index
sllower i3_array index
suupper i3_array index
nrllower matrix row index
nrhupper matrix row index
ncllower matrix column index
nchupper matrix column index

Definition at line 147 of file i4arr.cpp.

void i4_array::allocate ( void  )

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

Does NOT allocate, but initializes empty i4_array.

Definition at line 9 of file i4arr.cpp.

Referenced by named_i4_array::allocate(), data_4iarray::allocate(), allocate(), deallocate(), i4_array(), and shallow_copy().

void i4_array::allocate ( const i4_array &  )
void i4_array::allocate ( const dvar4_array &  )
void i4_array::allocate ( int  hsl,
int  hsu 
)

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

Parameters
hsllower vector index
hsuupper vector index

Definition at line 48 of file i4arr.cpp.

int i4_array::colmax ( void  )
inline

Definition at line 5864 of file fvar.hpp.

Referenced by colsize().

int i4_array::colmax ( void  ) const
inline

Definition at line 5929 of file fvar.hpp.

int i4_array::colmin ( void  )
inline

Definition at line 5860 of file fvar.hpp.

Referenced by colsize().

int i4_array::colmin ( void  ) const
inline

Definition at line 5925 of file fvar.hpp.

int i4_array::colsize ( )
inline

Definition at line 5889 of file fvar.hpp.

int i4_array::colsize ( ) const
inline

Definition at line 5952 of file fvar.hpp.

void i4_array::deallocate ( void  )

Deallocate i4_array memory.

Definition at line 216 of file i4arr.cpp.

Referenced by ~i4_array().

i3_array & i4_array::elem ( int  i)
inline

Definition at line 5959 of file fvar.hpp.

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

const i3_array & i4_array::elem ( int  i) const
inline

Definition at line 5969 of file fvar.hpp.

imatrix& i4_array::elem ( int  i,
int  j 
)
inline

Definition at line 5817 of file fvar.hpp.

ivector& i4_array::elem ( int  i,
int  j,
int  k 
)
inline

Definition at line 5821 of file fvar.hpp.

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

Definition at line 5825 of file fvar.hpp.

unsigned int i4_array::get_ncopies ( void  ) const
inline

Definition at line 5957 of file fvar.hpp.

int i4_array::hslicemax ( ) const
inline

Definition at line 5905 of file fvar.hpp.

Referenced by allocate(), hslicesize(), indexmax(), and initialize().

int i4_array::hslicemin ( ) const
inline

Definition at line 5901 of file fvar.hpp.

Referenced by allocate(), colmax(), colmin(), hslicesize(), indexmin(), initialize(), rowmax(), rowmin(), slicemax(), and slicemin().

int i4_array::hslicesize ( )
inline

Definition at line 5869 of file fvar.hpp.

int i4_array::hslicesize ( ) const
inline

Definition at line 5933 of file fvar.hpp.

int i4_array::indexmax ( void  ) const
inline

Definition at line 5897 of file fvar.hpp.

Referenced by colmax(), elem(), hslicesize(), operator<<(), named_i4_array::operator=(), operator>>(), size(), and sub_unallocated().

int i4_array::indexmin ( void  ) const
inline

Definition at line 5893 of file fvar.hpp.

Referenced by allocate(), colmin(), elem(), hslicesize(), operator<<(), named_i4_array::operator=(), operator>>(), size(), and sub_unallocated().

void i4_array::initialize ( void  )

Initializes elements of i4_array to zero.

Definition at line 15 of file i4arr.cpp.

Referenced by nested_calls_shape::initialize().

int i4_array::operator! ( void  ) const
inline

Definition at line 5787 of file fvar.hpp.

i3_array & i4_array::operator() ( int  i)
inline

Definition at line 5979 of file fvar.hpp.

Referenced by named_i4_array::operator=().

imatrix & i4_array::operator() ( int  i,
int  j 
)
inline

Definition at line 5995 of file fvar.hpp.

ivector & i4_array::operator() ( int  i,
int  j,
int  k 
)
inline

Definition at line 6003 of file fvar.hpp.

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

Definition at line 6011 of file fvar.hpp.

const i3_array & i4_array::operator() ( int  i) const
inline

Definition at line 6019 of file fvar.hpp.

const imatrix & i4_array::operator() ( int  i,
int  j 
) const
inline

Definition at line 6035 of file fvar.hpp.

const ivector & i4_array::operator() ( int  i,
int  j,
int  k 
) const
inline

Definition at line 6043 of file fvar.hpp.

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

Definition at line 6051 of file fvar.hpp.

i4_array& i4_array::operator= ( const i4_array &  )
i3_array & i4_array::operator[] ( int  j)
inline

Definition at line 5987 of file fvar.hpp.

const i3_array & i4_array::operator[] ( int  i) const
inline

Definition at line 6027 of file fvar.hpp.

int i4_array::rowmax ( void  )
inline

Definition at line 5856 of file fvar.hpp.

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

int i4_array::rowmax ( void  ) const
inline

Definition at line 5921 of file fvar.hpp.

int i4_array::rowmin ( void  )
inline

Definition at line 5852 of file fvar.hpp.

Referenced by rowmin(), and rowsize().

int i4_array::rowmin ( void  ) const
inline

Definition at line 5917 of file fvar.hpp.

int i4_array::rowsize ( void  )
inline

Definition at line 5884 of file fvar.hpp.

int i4_array::rowsize ( void  ) const
inline

Definition at line 5947 of file fvar.hpp.

void i4_array::shallow_copy ( const i4_array &  other)

Shallow copy other data structure pointers.

Parameters
otheri4_array

Definition at line 194 of file i4arr.cpp.

Referenced by i4_array().

int i4_array::size ( void  )
inline

Definition at line 5874 of file fvar.hpp.

int i4_array::size ( void  ) const
inline

Definition at line 5937 of file fvar.hpp.

int i4_array::slicemax ( void  )
inline

Definition at line 5848 of file fvar.hpp.

Referenced by i4_index::indexmax(), operator<<(), slicemax(), and slicesize().

int i4_array::slicemax ( void  ) const
inline

Definition at line 5913 of file fvar.hpp.

int i4_array::slicemin ( void  )
inline

Definition at line 5844 of file fvar.hpp.

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

int i4_array::slicemin ( void  ) const
inline

Definition at line 5909 of file fvar.hpp.

int i4_array::slicesize ( )
inline

Definition at line 5879 of file fvar.hpp.

int i4_array::slicesize ( ) const
inline

Definition at line 5942 of file fvar.hpp.

Friends And Related Function Documentation

friend class four_array_shape
friend

Definition at line 5842 of file fvar.hpp.

Member Data Documentation

vector_shapex* i4_array::shape
private

Definition at line 5771 of file fvar.hpp.

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

i3_array* i4_array::t
private

Definition at line 5772 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:34 for ADMB Documentation by doxygen 1.8.5