IntVector Class Reference

an integer Vector data structure More...

#include <OSGeneral.h>

Inheritance diagram for IntVector:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 IntVector ()
 ~IntVector ()
 IntVector (int n)
bool IsEqual (IntVector *that)
 A method to compare two invectors.
bool setRandom (double density, bool conformant, int iMin, int iMax)
 A function to make a random instance of this class.
bool deepCopyFrom (IntVector *that)
 A function to make a deep copy of an instance of this class.
bool setIntVector (int *i, int ni)
 set values into an IntVector
bool extendIntVector (int i)
 append a value to an IntVector
int getNumberOfEl ()
 get the dimension of an IntVector
int getEl (int j)
 get an entry in the data array of an IntVector
bool getEl (int *i)
 Get the integer data array of an IntVector.

Public Attributes

bool bDeleteArrays
 bDeleteArrays is true if we delete the arrays in garbage collection set to true by default
int numberOfEl
int * el

Detailed Description

an integer Vector data structure

Definition at line 419 of file OSGeneral.h.


Constructor & Destructor Documentation

IntVector::IntVector (  ) 

Definition at line 364 of file OSGeneral.cpp.

IntVector::~IntVector (  ) 

Definition at line 386 of file OSGeneral.cpp.

IntVector::IntVector ( int  n  ) 

Definition at line 375 of file OSGeneral.cpp.


Member Function Documentation

bool IntVector::IsEqual ( IntVector that  ) 

A method to compare two invectors.

Reimplemented in OtherOptionEnumeration.

Definition at line 456 of file OSGeneral.cpp.

bool IntVector::setRandom ( double  density,
bool  conformant,
int  iMin,
int  iMax 
)

A function to make a random instance of this class.

Parameters:
density,: corresponds to the probability that a particular child element is created
conformant,: if true enforces side constraints not enforceable in the schema (e.g., agreement of "numberOfXXX" attributes and <XXX> children)
iMin,: lowest value (inclusive) that an entry in this vector can take
iMax,: greatest value (inclusive) that an entry in this vector can take

Reimplemented in OtherOptionEnumeration.

Definition at line 515 of file OSGeneral.cpp.

bool IntVector::deepCopyFrom ( IntVector that  ) 

A function to make a deep copy of an instance of this class.

Parameters:
that,: the instance from which information is to be copied
Returns:
whether the copy was created successfully

Reimplemented in OtherOptionEnumeration.

Definition at line 534 of file OSGeneral.cpp.

bool IntVector::setIntVector ( int *  i,
int  ni 
)

set values into an IntVector

Parameters:
ni contains the dimension of the IntVector
i contains the array of values

Definition at line 398 of file OSGeneral.cpp.

bool IntVector::extendIntVector ( int  i  ) 

append a value to an IntVector

Parameters:
i contains the value to be appended

Definition at line 412 of file OSGeneral.cpp.

int IntVector::getNumberOfEl (  ) 

get the dimension of an IntVector

Definition at line 437 of file OSGeneral.cpp.

int IntVector::getEl ( int  j  ) 

get an entry in the data array of an IntVector

Parameters:
j is the index of the entry that is to be retrieved

Definition at line 442 of file OSGeneral.cpp.

bool IntVector::getEl ( int *  i  ) 

Get the integer data array of an IntVector.

Parameters:
i is the location where the user wants to store the array
Returns:
the value
Note:
it is the user's responsibility to reserve sufficient memory to hold the vector being returned.

Definition at line 449 of file OSGeneral.cpp.


Member Data Documentation

bDeleteArrays is true if we delete the arrays in garbage collection set to true by default

Definition at line 432 of file OSGeneral.h.

Definition at line 433 of file OSGeneral.h.

Definition at line 434 of file OSGeneral.h.


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

Generated on 24 Jul 2013 by  doxygen 1.6.1