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

Description not yet available. More...

#include <fvar.hpp>

Public Member Functions

 i5_array (int hsl, int hsu)
 Construct vector of i4_array with dimensions [hsl to hsu]. More...
 
 i5_array (int hsl, int hsu, int sl, int sh, ivector nrl, ivector nrh, ivector ncl, ivector nch)
 
 i5_array (int hsl, int hsu, int sl, const ivector &sh, int nrl, const imatrix &nrh, int ncl, const i3_array &nch)
 
 i5_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, const index_type &aa, const index_type &bb)
 
 i5_array (const i5_array &m2)
 Copy constructor. More...
 
 i5_array (int, int, int, int, int, int, int, int)
 
 i5_array (int hsl, int hsu, int sl, const ivector &sh, int nrl, const imatrix &nrh, int ncl, int nch)
 
 i5_array ()
 Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California. More...
 
 ~i5_array ()
 Destructor. More...
 
void allocate (int hhsl, int hhsu)
 Allocate vector of i4_array with dimensions [hsl to hsu]. More...
 
void allocate (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...
 
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, const index_type &aa, const index_type &bb)
 Description not yet available. More...
 
void allocate (void)
 Does NOT allocate, but initializes i5_array members. More...
 
void allocate (const i5_array &)
 
int colmax (void)
 
int colmax (void) const
 
int colmin (void)
 
int colmin (void) const
 
int colsize ()
 
int colsize () const
 
void deallocate (void)
 Deallocates i5_array memory if no copies exists. More...
 
i4_array & elem (int i)
 
const i4_array & elem (int i) const
 
unsigned int get_ncopies () const
 
int hslicemax () const
 
int hslicemin () const
 
int hslicesize ()
 
int hslicesize () const
 
int indexmax () const
 
int indexmin () const
 
void initialize ()
 Initialize i5_array elements with zeros. More...
 
int operator! (void) const
 
i4_array & operator() (int)
 
i3_array & operator() (int, int)
 
imatrix & operator() (int, int, int)
 
ivector & operator() (int, int, int, int)
 
int & operator() (int, int, int, int, int)
 
const i4_array & operator() (int) const
 
const i3_array & operator() (int, int) const
 
const imatrix & operator() (int, int, int) const
 
const ivector & operator() (int, int, int, int) const
 
const int & operator() (int, int, int, int, int) const
 
i5_array & operator= (const i5_array &)
 
i4_array & operator[] (int)
 
const i4_array & operator[] (int) const
 
int rowmax (void)
 
int rowmax (void) const
 
int rowmin (void)
 
int rowmin (void) const
 
int rowsize ()
 
int rowsize () const
 
void shallow_copy (const i5_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
 
i4_array * t
 

Friends

class four_array_shape
 

Detailed Description

Description not yet available.

Parameters

Definition at line 6067 of file fvar.hpp.

Constructor & Destructor Documentation

i5_array::i5_array ( int  hsl,
int  hsu 
)

Construct vector of i4_array with dimensions [hsl to hsu].

Parameters
hsllower vector index
hsuupper vector index

Definition at line 56 of file i5arr.cpp.

i5_array::i5_array ( int  hsl,
int  hsu,
int  sl,
int  sh,
ivector  nrl,
ivector  nrh,
ivector  ncl,
ivector  nch 
)
i5_array::i5_array ( int  hsl,
int  hsu,
int  sl,
const ivector &  sh,
int  nrl,
const imatrix &  nrh,
int  ncl,
const i3_array &  nch 
)
i5_array::i5_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,
const index_type &  aa,
const index_type &  bb 
)
i5_array::i5_array ( const i5_array &  m2)

Copy constructor.

Definition at line 14 of file i5arr.cpp.

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

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

Default constructor

Definition at line 9 of file i5arr.cpp.

i5_array::~i5_array ( )

Destructor.

Definition at line 40 of file i5arr.cpp.

Member Function Documentation

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

Allocate vector of i4_array with dimensions [hsl to hsu].

Parameters
hsllower vector index
hsuupper vector index

Definition at line 66 of file i5arr.cpp.

void i5_array::allocate ( int  hsl,
int  hsu,
int  sl,
int  sh,
int  nrl,
int  nrh,
int  ncl,
int  nch,
int  aa,
int  bb 
)

Description not yet available.

Parameters

Definition at line 92 of file i5arr.cpp.

void i5_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 &  aa,
const index_type &  bb 
)

Description not yet available.

Parameters

Definition at line 110 of file i5arr.cpp.

void i5_array::allocate ( void  )

Does NOT allocate, but initializes i5_array members.

Definition at line 45 of file i5arr.cpp.

Referenced by allocate(), deallocate(), i5_array(), and shallow_copy().

void i5_array::allocate ( const i5_array &  )
int i5_array::colmax ( void  )
inline

Definition at line 6152 of file fvar.hpp.

Referenced by colsize().

int i5_array::colmax ( void  ) const
inline

Definition at line 6218 of file fvar.hpp.

int i5_array::colmin ( void  )
inline

Definition at line 6148 of file fvar.hpp.

Referenced by colsize().

int i5_array::colmin ( void  ) const
inline

Definition at line 6214 of file fvar.hpp.

int i5_array::colsize ( )
inline

Definition at line 6178 of file fvar.hpp.

int i5_array::colsize ( ) const
inline

Definition at line 6241 of file fvar.hpp.

void i5_array::deallocate ( void  )

Deallocates i5_array memory if no copies exists.

Definition at line 144 of file i5arr.cpp.

Referenced by ~i5_array().

i4_array & i5_array::elem ( int  i)
inline

Definition at line 6248 of file fvar.hpp.

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

Definition at line 6259 of file fvar.hpp.

unsigned int i5_array::get_ncopies ( void  ) const
inline

Definition at line 6246 of file fvar.hpp.

int i5_array::hslicemax ( ) const
inline

Definition at line 6186 of file fvar.hpp.

Referenced by hslicesize(), and indexmax().

int i5_array::hslicemin ( ) const
inline

Definition at line 6182 of file fvar.hpp.

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

int i5_array::hslicesize ( )
inline

Definition at line 6158 of file fvar.hpp.

int i5_array::hslicesize ( ) const
inline

Definition at line 6222 of file fvar.hpp.

int i5_array::indexmax ( void  ) const
inline

Definition at line 6194 of file fvar.hpp.

Referenced by allocate(), colmax(), elem(), hslicesize(), operator<<(), operator>>(), size(), and sub_unallocated().

int i5_array::indexmin ( void  ) const
inline

Definition at line 6190 of file fvar.hpp.

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

void i5_array::initialize ( void  )

Initialize i5_array elements with zeros.

Definition at line 232 of file i5arr.cpp.

int i5_array::operator! ( void  ) const
inline

Definition at line 6087 of file fvar.hpp.

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

Definition at line 6271 of file fvar.hpp.

i3_array & i5_array::operator() ( int  i,
int  j 
)
inline

Definition at line 6279 of file fvar.hpp.

imatrix & i5_array::operator() ( int  i,
int  j,
int  k 
)
inline

Definition at line 6283 of file fvar.hpp.

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

Definition at line 6287 of file fvar.hpp.

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

Definition at line 6291 of file fvar.hpp.

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

Definition at line 6295 of file fvar.hpp.

const i3_array & i5_array::operator() ( int  i,
int  j 
) const
inline

Definition at line 6303 of file fvar.hpp.

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

Definition at line 6307 of file fvar.hpp.

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

Definition at line 6311 of file fvar.hpp.

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

Definition at line 6315 of file fvar.hpp.

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

Definition at line 6275 of file fvar.hpp.

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

Definition at line 6299 of file fvar.hpp.

int i5_array::rowmax ( void  )
inline

Definition at line 6144 of file fvar.hpp.

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

int i5_array::rowmax ( void  ) const
inline

Definition at line 6210 of file fvar.hpp.

int i5_array::rowmin ( void  )
inline

Definition at line 6140 of file fvar.hpp.

Referenced by rowmin(), and rowsize().

int i5_array::rowmin ( void  ) const
inline

Definition at line 6206 of file fvar.hpp.

int i5_array::rowsize ( void  )
inline

Definition at line 6173 of file fvar.hpp.

int i5_array::rowsize ( void  ) const
inline

Definition at line 6236 of file fvar.hpp.

void i5_array::shallow_copy ( const i5_array &  other)

Shallow copy other data structure pointers.

Parameters
otheri5_array

Definition at line 23 of file i5arr.cpp.

Referenced by i5_array().

int i5_array::size ( void  )
inline

Definition at line 6163 of file fvar.hpp.

int i5_array::size ( void  ) const
inline

Definition at line 6226 of file fvar.hpp.

int i5_array::slicemax ( void  )
inline

Definition at line 6136 of file fvar.hpp.

Referenced by slicemax(), and slicesize().

int i5_array::slicemax ( void  ) const
inline

Definition at line 6202 of file fvar.hpp.

int i5_array::slicemin ( void  )
inline

Definition at line 6132 of file fvar.hpp.

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

int i5_array::slicemin ( void  ) const
inline

Definition at line 6198 of file fvar.hpp.

int i5_array::slicesize ( )
inline

Definition at line 6168 of file fvar.hpp.

int i5_array::slicesize ( ) const
inline

Definition at line 6231 of file fvar.hpp.

Friends And Related Function Documentation

friend class four_array_shape
friend

Definition at line 6130 of file fvar.hpp.

Member Data Documentation

vector_shapex* i5_array::shape
private

Definition at line 6069 of file fvar.hpp.

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

i4_array* i5_array::t
private

Definition at line 6070 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