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

Description not yet available. More...

#include <fvar.hpp>

Public Member Functions

 dmatrix_index (const dmatrix &v)
 
virtual ~dmatrix_index ()
 Destructor. More...
 
virtual int indexmax (void)
 
virtual int indexmin (void)
 
- Public Member Functions inherited from dmatrix
 dmatrix (void)
 Default constructor. More...
 
 dmatrix (int, int, kkludge_object)
 
 dmatrix (int, int)
 Description not yet available. More...
 
 dmatrix (int, int, int, int)
 Description not yet available. More...
 
 dmatrix (const ad_integer &nrl, const ad_integer &nrh, const index_type &ncl, const index_type &nch)
 Description not yet available. More...
 
 dmatrix (int, int, const ivector &coll, const ivector &colh)
 Description not yet available. More...
 
 dmatrix (int, int, int coll, const ivector &colh)
 Description not yet available. More...
 
 dmatrix (const dvar_matrix_position &)
 Description not yet available. More...
 
 dmatrix (const dmatrix_position &)
 Description not yet available. More...
 
 dmatrix (const dmatrix &)
 Copy constructor. More...
 
 dmatrix (const banded_symmetric_dmatrix &)
 Description not yet available. More...
 
 dmatrix (const banded_lower_triangular_dmatrix &)
 Description not yet available. More...
 
 dmatrix (char *)
 Description not yet available. More...
 
 dmatrix (const tdmatrix &t)
 
 ~dmatrix ()
 Destructor. More...
 
void allocate (void)
 Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California. More...
 
void allocate (const dmatrix &dm)
 Allocate dmatrix using the same dimensions as other. More...
 
void allocate (const dvar_matrix &)
 Description not yet available. More...
 
void allocate (int nrl, int nrh, int ncl, int nch)
 Allocate dmatrix with dimension [nrl to nrh] x [ncl to nch] where ncl to nch are vector of indexes. More...
 
void allocate (int nrl, int nrh)
 Allocate dmatrix with row dimension [nrl to nrh] and empty columns. More...
 
void allocate (ad_integer nrl, ad_integer nrh)
 Allocate dmatrix with row dimension [nrl to nrh] and empty columns. More...
 
void allocate (int nrl, int nrh, int ncl, const ivector &nch)
 Allocate dmatrix with dimension [nrl to nrh] x [ncl to nch] where nch is vector of indexes. More...
 
void allocate (int nrl, int nrh, const ivector &ncl, int nch)
 Allocate dmatrix with dimension [nrl to nrh] x [ncl to nch] where nch is vector of indexes. More...
 
void allocate (const ad_integer &nrl, const ad_integer &nrh, const index_type &ncl, const index_type &nch)
 Allocate matrix with dimensions [nrl to nrh] x [ncl to nch]. More...
 
void allocate (int nrl, int nrh, const ivector &ncl, const ivector &nch)
 Allocate dmatrix with dimension [nrl to nrh] x [ncl to nch] where ncl to nch are vector of indexes. More...
 
dvectorbegin () const
 
void colfill (int j, const dvector &v)
 Fills dmatrix column at index column with values from vec. More...
 
void colfill_randn (const int &j, long int &n)
 Fill random numbers into specified column j of matrix. More...
 
void colfill_randn (const int &j, const random_number_generator &rng)
 Description not yet available. More...
 
void colfill_randn_ni (const int &j, long int &n)
 Description not yet available. More...
 
void colfill_randu (const int &j, long int &n)
 Fill random numbers into specified column j of matrix. More...
 
void colfill_randu (const int &j, const random_number_generator &rng)
 Description not yet available. More...
 
void colfill_randu_ni (const int &j, long int &n)
 Description not yet available. More...
 
void colfill_seqadd (const int &, const int &, const int &)
 
void colfill_seqadd (const int &, double, double)
 Fills dmatrix at index column with elements with values starting from base and incremented by offset. More...
 
int colmax (void) const
 
int colmin (void) const
 
void colshift (int min)
 Description not yet available. More...
 
unsigned int colsize () const
 
void deallocate ()
 Deallocate dmatrix memory. More...
 
friend dvar_matrix::dvar_matrix (const dmatrix &)
 
dvectorelem (int i)
 
double & elem (int i, int j)
 
const dvectorelem (int i) const
 
const double & elem (int i, int j) const
 
dvectorend () const
 
void fill (const char *)
 Fill allocated dmatrix with values from input parameter s. More...
 
void fill_randcau (const random_number_generator &rng)
 Description not yet available. More...
 
void fill_randn (long int &n)
 Fill matrix with random numbers. More...
 
void fill_randn (const random_number_generator &rng)
 Description not yet available. More...
 
void fill_randn_ni (long int &n)
 Description not yet available. More...
 
void fill_randu (long int &n)
 Fill matrix with random numbers. More...
 
void fill_randu (const random_number_generator &rng)
 Description not yet available. More...
 
void fill_randu_ni (long int &n)
 Description not yet available. More...
 
double fill_seqadd (double, double)
 Description not yet available. More...
 
int indexmax () const
 
int indexmin () const
 
void initialize (void)
 Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California. More...
 
bool is_valid_row (const int i) const
 Check index i is in matrix row bounds [index_min, index_max]. More...
 
bool operator! () const
 Returns true if dmatrix is empty, else false. More...
 
dvectoroperator() (int i)
 
const dvectoroperator() (int i) const
 
double & operator() (int i, int j)
 
const double & operator() (int i, int j) const
 
dmatrix operator() (const ivector &t)
 Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California. More...
 
dmatrixoperator*= (double d)
 Multiply value to all elements in dmatrix. More...
 
dmatrixoperator++ (void)
 
dmatrixoperator+= (const dmatrix &t)
 Add element-wise matrix values other to dmatrix. More...
 
dmatrixoperator-- (void)
 
dmatrixoperator-= (const dmatrix &t)
 Substract element-wise matrix values other from dmatrix. More...
 
dmatrixoperator/= (double d)
 Divide value to all elements in dmatrix. More...
 
dmatrixoperator= (const dmatrix &t)
 Assign values in other to dmatrix. More...
 
dmatrixoperator= (double t)
 Author: David Fournier Copyright (c) 2008-2012 Regents of the University of California. More...
 
dvectoroperator[] (int)
 
const dvectoroperator[] (int) const
 
void read_from (const istream &)
 Description not yet available. More...
 
uistreamread_from (const uistream &)
 Read dmatrix from input. More...
 
void rowfill (int j, const dvector &v)
 Fills dmatrix row at index row with values from vec. More...
 
void rowfill_randn (const int &i, long int &n)
 Fill random numbers into specified row i of matrix. More...
 
void rowfill_randn (const int &i, const random_number_generator &rng)
 Description not yet available. More...
 
void rowfill_randn_ni (const int &i, long int &n)
 Description not yet available. More...
 
void rowfill_randu (const int &i, long int &n)
 Fill random numbers into specified row i of matrix. More...
 
void rowfill_randu (const int &i, const random_number_generator &rng)
 Description not yet available. More...
 
void rowfill_randu_ni (const int &i, long int &n)
 Description not yet available. More...
 
void rowfill_seqadd (const int &, double, double)
 Fills dmatrix row at index with elements with values starting from base and incremented by offset. More...
 
int rowmax () const
 
int rowmin () const
 
void rowshift (int min)
 Changes the range of valid indices for the rows. More...
 
unsigned int rowsize () const
 
void save_dmatrix_derivatives (const dvar_matrix_position &pos) const
 Description not yet available. More...
 
void save_dmatrix_derivatives_na (const dvar_matrix_position &pos) const
 Description not yet available. More...
 
void save_dmatrix_position () const
 Saves size and address information for a dmatrix to adjoint data file. More...
 
void save_dmatrix_value () const
 Description not yet available. More...
 
void shallow_copy (const dmatrix &)
 Shallow copy values and dimensions from other to dmatrix. More...
 
dmatrix sub (int, int)
 Description not yet available. More...
 
void write_on (const ostream &) const
 Description not yet available. More...
 
uostreamwrite_on (const uostream &) const
 Write dmatrix to output. More...
 
- Public Member Functions inherited from double_index_guts
 double_index_guts ()
 Description not yet available. More...
 
 double_index_guts (const double_index_guts &ig)
 Description not yet available. More...
 
virtual ~double_index_guts ()
 Description not yet available. More...
 
virtual int isdouble (void) const
 
virtual operator double ()
 

Private Member Functions

virtual double_index_gutsoperator[] (int i)
 Description not yet available. More...
 

Friends

class double_index_type
 

Additional Inherited Members

- Protected Attributes inherited from dmatrix
int index_max
 
int index_min
 
dvectorm
 
mat_shapexshape
 
- Protected Attributes inherited from double_index_guts
int * ncopies
 

Detailed Description

Description not yet available.

Parameters

Definition at line 8661 of file fvar.hpp.

Constructor & Destructor Documentation

dmatrix_index::~dmatrix_index ( )
virtual

Destructor.

Definition at line 80 of file doublind.cpp.

dmatrix_index::dmatrix_index ( const dmatrix v)
inline

Definition at line 8670 of file fvar.hpp.

Member Function Documentation

virtual int dmatrix_index::indexmax ( void  )
inlinevirtual

Implements double_index_guts.

Definition at line 8677 of file fvar.hpp.

virtual int dmatrix_index::indexmin ( void  )
inlinevirtual

Implements double_index_guts.

Definition at line 8673 of file fvar.hpp.

double_index_guts * dmatrix_index::operator[] ( int  i)
privatevirtual

Description not yet available.

Parameters

Implements double_index_guts.

Definition at line 29 of file doublind.cpp.

Friends And Related Function Documentation

friend class double_index_type
friend

Definition at line 8681 of file fvar.hpp.


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