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

Derived class of index types for i3_array. More...

#include <fvar.hpp>

Public Member Functions

 i3_index (i3_array &v)
 
virtual int dimension () const
 
virtual int indexmax () const
 
virtual int indexmin () const
 
- Public Member Functions inherited from i3_array
 i3_array (int sl, int sh, int nrl, int nrh, const ivector &nc)
 
 i3_array (void)
 Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California. More...
 
 i3_array (int sl, int sh, const index_type &nrl, const index_type &nrh, const index_type &ncl, const index_type &nch)
 Description not yet available. More...
 
 i3_array (int _sl, int _sh, const imatrix &m1)
 Allocate vector [sl to sh] of integer matrices with same dimension as m1. More...
 
 i3_array (int sl, int sh)
 Construct vector of empty matrices with dimension [sl to sh]. More...
 
 i3_array (int sl, int sh, int nrl, int nrh, int ncl, int nch)
 Allocate vector of integer matrices with dimensions [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
 
 i3_array (int sl, int sh, int nrl, int nrh, const ivector &ncl, int nch)
 
 i3_array (int sl, int sh, const ivector &nrl, const ivector &nrh, const imatrix &ncl, const imatrix &nch)
 
 i3_array (int sl, int sh, const ivector &nrl, const ivector &nrh, int ncl, const imatrix &nch)
 
 i3_array (int sl, int sh, const ivector &nrl, const ivector &nrh, const ivector &ncl, const ivector &nch)
 
 i3_array (int sl, int sh, int nrl, int nrh, const ivector &ncl, const ivector &nch)
 Construct vector of integer matrices with dimensions [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
 
 i3_array (int sl, int sh, int nrl, const ivector &nrh, int ncl, const ivector &nch)
 
 i3_array (int sl, int sh, int nrl, const ivector &nrh, int ncl, int nch)
 Construct vector of integer matrices with dimensions [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
 
 i3_array (int sl, int sh, int nrl, const ivector &nrh, int ncl, const imatrix &nch)
 Construct vector of integer matrices with dimensions [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
 
 i3_array (const i3_array &m2)
 Copy constructor (shallow) More...
 
 ~i3_array ()
 Destructor. More...
 
void allocate (int sl, int sh, int nrl, int nrh, const ivector &nc)
 
void allocate (int sl, int sh, int nrl, const ivector &nrh, int ncl, int nch)
 Allocate vector of integer matrices with dimensions [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
 
void allocate (const dvar3_array &)
 
void allocate (const i3_array &i3v)
 Allocate i3_array with same dimension as other. More...
 
void allocate (int sl, int sh, int nrl, int nrh, int ncl, int nch)
 Allocate vector of integer matrices with dimensions [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
 
void allocate (int sl, int sh)
 Allocate vector of empty matrices with dimension [sl to sh]. More...
 
void allocate (int sl, int sh, int nrl, int nrh, const ivector &ncl, int nch)
 
void allocate (int sl, int sh, const index_type &nrl, const index_type &nrh, const index_type &ncl, const index_type &nch)
 Allocate array of matrices with dimensions [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
 
void allocate (int sl, int sh, const ivector &nrl, const ivector &nrh, const imatrix &ncl, const imatrix &nch)
 
void allocate (int sl, int sh, int nrl, const ivector &nrh, int ncl, const imatrix &nch)
 Allocate vector of integer matrices with dimensions [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
 
void allocate (int sl, int sh, const ivector &nrl, const ivector &nrh, int ncl, const imatrix &nch)
 
void allocate (int sl, int sh, const ivector &nrl, const ivector &nrh, int ncl, int nch)
 
void allocate (int sl, int sh, const ivector &nrl, int nrh, int ncl, int nch)
 
void allocate (int sl, int sh, const ivector &nrl, const ivector &nrh, const ivector &ncl, const ivector &nch)
 
void allocate (int sl, int sh, int nrl, const ivector &nrh, int ncl, const ivector &nch)
 
void allocate (int sl, int sh, int nrl, int nrh, const ivector &ncl, const ivector &nch)
 Allocate vector of integer matrices with dimensions [sl to sh] x [nrl to nrh] x [ncl to nch]. More...
 
void allocate (int sl, int sh, int nrl, int nrh, int ncl, const ivector &nch)
 
void allocate (void)
 Does NOT allocate, but set empty i3_array. More...
 
int colmax (void) const
 
int colmin (void) const
 
int colsize () const
 
void deallocate (void)
 Deallocate i3_array memory. More...
 
imatrixelem (int i)
 
const imatrixelem (int i) const
 
void fill_randn (long int &n)
 
void fill_randn_ni (long int &n)
 
void fill_randu (long int &n)
 
void fill_randu_ni (long int &n)
 
unsigned int get_ncopies () const
 
int indexmax () const
 
int indexmin () const
 
void initialize (int sl, int sh, int nrl, const ivector &nrh, int ncl, const ivector &nch)
 
void initialize ()
 Initialize all elements of i3_array to zero. More...
 
int operator! (void) const
 
int & operator() (int i, int j, int k)
 
ivectoroperator() (int i, int j)
 
imatrixoperator() (int i)
 
const int & operator() (int i, int j, int k) const
 
const ivectoroperator() (int i, int j) const
 
const imatrixoperator() (int i) const
 
i3_arrayoperator= (const i3_array &other)
 Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California. More...
 
i3_arrayoperator= (int value)
 Assigns value to all elements of i3_array. More...
 
imatrixoperator[] (int i)
 
const imatrixoperator[] (int i) const
 
int rowmax (void) const
 
int rowmin (void) const
 
int rowsize () const
 
void shallow_copy (const i3_array &)
 Shallow copy other data structure pointers. More...
 
int slicemax () const
 
int slicemin () const
 
unsigned int slicesize () const
 
- Public Member Functions inherited from index_guts
 index_guts ()
 Default constructor. More...
 
 index_guts (const index_guts &ig)
 Copy constructor. More...
 
virtual ~index_guts ()
 Destructor. More...
 
virtual int isinteger () const
 
virtual operator int ()
 

Private Member Functions

virtual index_gutsoperator[] (int i)
 

Friends

class index_type
 

Additional Inherited Members

- Protected Attributes inherited from index_guts
int * ncopies
 

Detailed Description

Derived class of index types for i3_array.

Definition at line 7866 of file fvar.hpp.

Constructor & Destructor Documentation

i3_index::i3_index ( i3_array v)
inline

Definition at line 7873 of file fvar.hpp.

Member Function Documentation

virtual int i3_index::dimension ( ) const
inlinevirtual

Reimplemented from index_guts.

Definition at line 7877 of file fvar.hpp.

virtual int i3_index::indexmax ( void  ) const
inlinevirtual

Implements index_guts.

Definition at line 7885 of file fvar.hpp.

virtual int i3_index::indexmin ( void  ) const
inlinevirtual

Implements index_guts.

Definition at line 7881 of file fvar.hpp.

virtual index_guts* i3_index::operator[] ( int  i)
inlineprivatevirtual

Implements index_guts.

Definition at line 7868 of file fvar.hpp.

Friends And Related Function Documentation

friend class index_type
friend

Definition at line 7890 of file fvar.hpp.


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