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

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

#include <fvar.hpp>

Public Member Functions

 matrix_index (const imatrix &v)
 
virtual ~matrix_index ()
 Destructor. More...
 
virtual int dimension () const
 
virtual int indexmax () const
 
virtual int indexmin () const
 
- Public Member Functions inherited from imatrix
 imatrix (int, int)
 Construct integer matrix with row dimension [nrl to nrh] where each column is empty. More...
 
 imatrix (int nrl, int nrh, const ivector &iv)
 Construct integer matrix with row dimension [nrl to nrh] where columns of imatrix references column. More...
 
 imatrix (int, int, int, int)
 Construct integer matrix with the dimensions [nrl to nrh] x [ncl to nch]. More...
 
 imatrix (int, int, int, const ivector &)
 Description not yet available. More...
 
 imatrix (int, int, const ivector &, const ivector &)
 Description not yet available. More...
 
 imatrix (const ad_integer &nrl, const ad_integer &nrh, const index_type &ncl, const index_type &nch)
 Description not yet available. More...
 
 imatrix (const imatrix &)
 Copy constructor - Shallow. More...
 
 imatrix (const imatrix_position &)
 Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California. More...
 
 imatrix (void)
 Default constructor. More...
 
 ~imatrix ()
 Destructor. More...
 
void allocate (void)
 Does not allocate, but initializes imatrix members. More...
 
void allocate (int nrl, int nrh, const ivector &iv)
 Allocate integer matrix with row dimension [nrl to nrh] where columns of imatrix references column. More...
 
void allocate (const imatrix &dm)
 Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California. More...
 
void allocate (int nrl, int nrh, int ncl, int nch)
 Allocate integer matrix with the dimensions [nrl to nrh] x [ncl to nch]. More...
 
void allocate (int nrl, int nrh)
 Allocate integer matrix with row dimension [nrl to nrh] where each column is empty. More...
 
void allocate (int nrl, int nrh, int ncl, const ivector &nch)
 Allocate ragged matrix with dimensions [nrl to nrh] x [ncl to nch] where nch is vector of upper column indexes. More...
 
void allocate (int nrl, int nrh, const ivector &ncl, const ivector &nch)
 Allocate ragged matrix with dimensions [nrl to nrh] x [ncl to nch] where ncl and nch are vectors on lower and upper column indexes. More...
 
void allocate (const ad_integer &nrl, const ad_integer &nrh, const index_type &ncl, const index_type &nch)
 Allocate matrix on integers with dimension [nrl to nrh] x [ncl to nch]. More...
 
ivectorbegin () const
 
void colfill_seqadd (int, int, int)
 Fills column of a matrix with a sequence of the form base, base+offset, base+2*offset,... More...
 
int colmax (void) const
 
int colmin (void) const
 
unsigned int colsize () const
 Returns the number of columns. More...
 
void deallocate ()
 Deallocate imatrix memory. More...
 
ivectorelem (int i)
 
const ivectorelem (int i) const
 
int & elem (int i, int j)
 
const int & elem (int i, int j) const
 
ivectorend () const
 
void fill_seqadd (int, int)
 Fill imatrix with sequence of integers from start and adding with increment. More...
 
unsigned int get_ncopies () const
 
int indexmax () const
 
int indexmin () const
 
void initialize (void)
 Description not yet available. More...
 
bool is_valid_row (const int i) const
 Check index i is in matrix row bounds [index_min, index_max]. More...
 
int operator! (void) const
 
ivectoroperator() (int)
 
int & operator() (int, int)
 
const ivectoroperator() (int) const
 
const int & operator() (int, int) const
 
imatrixoperator= (const imatrix &t)
 Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California. More...
 
imatrixoperator= (const int)
 Assigns value to all elements of imatrix. More...
 
ivectoroperator[] (int)
 
const ivectoroperator[] (int) const
 
void read_from (const istream &)
 
void read_from (const uistream &)
 
imatrix_position restore_imatrix_position (void)
 
imatrix restore_imatrix_value (const imatrix_position &mpos)
 
int rowmax () const
 
int rowmin () const
 
void rowshift (int min)
 Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California. More...
 
unsigned int rowsize () const
 Returns the number of rows. More...
 
void save_imatrix_position ()
 Saves the size and address information for a imatrix. More...
 
void save_imatrix_value ()
 Saves the size, address, and value information for a imatrix. More...
 
void shallow_copy (const imatrix &)
 Shallow copy other data structure pointers. More...
 
imatrix sub (int, int)
 Description not yet available. More...
 
void write_on (const ostream &) const
 
void write_on (const uostream &) 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 imatrix
int index_max
 
int index_min
 
ivectorm
 
mat_shapexshape
 
- Protected Attributes inherited from index_guts
int * ncopies
 

Detailed Description

Derived class of index types for imatrix.

Definition at line 7837 of file fvar.hpp.

Constructor & Destructor Documentation

matrix_index::matrix_index ( const imatrix v)
inline

Definition at line 7845 of file fvar.hpp.

matrix_index::~matrix_index ( )
virtual

Destructor.

Definition at line 536 of file indextyp.cpp.

Member Function Documentation

virtual int matrix_index::dimension ( ) const
inlinevirtual

Reimplemented from index_guts.

Definition at line 7850 of file fvar.hpp.

virtual int matrix_index::indexmax ( void  ) const
inlinevirtual

Implements index_guts.

Definition at line 7858 of file fvar.hpp.

virtual int matrix_index::indexmin ( void  ) const
inlinevirtual

Implements index_guts.

Definition at line 7854 of file fvar.hpp.

index_guts * matrix_index::operator[] ( int  i)
privatevirtual

Implements index_guts.

Definition at line 531 of file indextyp.cpp.

Friends And Related Function Documentation

friend class index_type
friend

Definition at line 7863 of file fvar.hpp.


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