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

Holds "shape" information for vector objects. More...

#include <vector_shapex.h>

Public Member Functions

 vector_shapex (int lb, int ub, void *p)
 
unsigned int decr_ncopies (void)
 
unsigned int get_ncopies (void)
 
void * get_truepointer (void)
 Returns address of first element in the vector. More...
 
unsigned int incr_ncopies (void)
 
int indexmax ()
 
int indexmin ()
 
void shift (int min)
 Description not yet available. More...
 

Public Attributes

int index_max
 Maximum valid subscript. More...
 
int index_min
 Minimum valid subscript. More...
 
unsigned int ncopies
 Copy counter to enable shallow copies. More...
 
void * trueptr
 Address of first element in the vector. More...
 

Friends

class dvar_vector
 
class dvector
 
class ivector
 
class lvector
 
class ptr_vector
 
class subdvector
 

Detailed Description

Holds "shape" information for vector objects.

Definition at line 46 of file vector_shapex.h.

Constructor & Destructor Documentation

vector_shapex::vector_shapex ( int  lb,
int  ub,
void *  p 
)
inline

Definition at line 59 of file vector_shapex.h.

Member Function Documentation

unsigned int vector_shapex::decr_ncopies ( void  )
inline

Definition at line 85 of file vector_shapex.h.

unsigned int vector_shapex::get_ncopies ( void  )
inline

Definition at line 89 of file vector_shapex.h.

Referenced by ivector::get_ncopies(), and dvector::get_ncopies().

void* vector_shapex::get_truepointer ( void  )
inline

Returns address of first element in the vector.

Definition at line 64 of file vector_shapex.h.

Referenced by i4_array::deallocate(), and i5_array::deallocate().

unsigned int vector_shapex::incr_ncopies ( void  )
inline

Definition at line 93 of file vector_shapex.h.

int vector_shapex::indexmax ( void  )
inline

Definition at line 101 of file vector_shapex.h.

Referenced by i4_array::hslicemax(), and i5_array::hslicemax().

int vector_shapex::indexmin ( void  )
inline

Definition at line 97 of file vector_shapex.h.

Referenced by i4_array::hslicemin(), and i5_array::hslicemin().

void vector_shapex::shift ( int  min)

Description not yet available.

Parameters

Definition at line 33 of file shape.cpp.

Referenced by ivector::shift(), dvector::shift(), and dvar_vector::shift().

Friends And Related Function Documentation

friend class dvar_vector
friend

Definition at line 111 of file vector_shapex.h.

friend class dvector
friend

Definition at line 109 of file vector_shapex.h.

friend class ivector
friend

Definition at line 110 of file vector_shapex.h.

friend class lvector
friend

Definition at line 107 of file vector_shapex.h.

friend class ptr_vector
friend

Definition at line 108 of file vector_shapex.h.

friend class subdvector
friend

Definition at line 106 of file vector_shapex.h.

Member Data Documentation

int vector_shapex::index_max

Maximum valid subscript.

Definition at line 71 of file vector_shapex.h.

Referenced by indexmax(), shift(), and ivector::shift().

int vector_shapex::index_min

Minimum valid subscript.

Definition at line 70 of file vector_shapex.h.

Referenced by indexmin(), shift(), and ivector::shift().

unsigned int vector_shapex::ncopies
void* vector_shapex::trueptr

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