ADMB Documentation  11.2.2853
 All Classes Files Functions Variables Typedefs Friends Defines
Public Member Functions | Public Attributes | Friends
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.
unsigned int incr_ncopies (void)
int indexmax ()
int indexmin ()
void shift (int min)
 Description not yet available.

Public Attributes

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

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 49 of file vector_shapex.h.


Member Function Documentation

unsigned int vector_shapex::decr_ncopies ( void  ) [inline]

Definition at line 82 of file vector_shapex.h.

unsigned int vector_shapex::get_ncopies ( void  ) [inline]

Definition at line 86 of file vector_shapex.h.

void* vector_shapex::get_truepointer ( void  ) [inline]

Returns address of first element in the vector.

Definition at line 54 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 90 of file vector_shapex.h.

int vector_shapex::indexmax ( void  ) [inline]
int vector_shapex::indexmin ( void  ) [inline]
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 108 of file vector_shapex.h.

friend class dvector [friend]

Definition at line 106 of file vector_shapex.h.

friend class ivector [friend]

Definition at line 107 of file vector_shapex.h.

friend class lvector [friend]

Definition at line 104 of file vector_shapex.h.

friend class ptr_vector [friend]

Definition at line 105 of file vector_shapex.h.

friend class subdvector [friend]

Definition at line 103 of file vector_shapex.h.


Member Data Documentation

Maximum valid subscript.

Definition at line 68 of file vector_shapex.h.

Referenced by indexmax(), shift(), and dvector::testmax().

Minimum valid subscript.

Definition at line 67 of file vector_shapex.h.

Referenced by indexmin(), shift(), and dvector::testmin().

unsigned int vector_shapex::ncopies

List of all members.


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