OS  2.10.2
Public Member Functions | Public Attributes | List of all members
IntVector Class Reference

an integer Vector data structure More...

#include <OSGeneral.h>

+ Inheritance diagram for IntVector:

Public Member Functions

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

Public Attributes

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

Detailed Description

an integer Vector data structure

Definition at line 469 of file OSGeneral.h.

Constructor & Destructor Documentation

◆ IntVector() [1/2]

IntVector::IntVector ( )

◆ ~IntVector()

IntVector::~IntVector ( )

◆ IntVector() [2/2]

IntVector::IntVector ( int  n)

alternate constructor

Member Function Documentation

◆ IsEqual()

bool IntVector::IsEqual ( IntVector that)

A method to compare two invectors.

◆ setRandom()

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

A function to make a random instance of this class.

Parameters
densitycorresponds to the probability that a particular child element is created
conformantif true enforces side constraints not enforceable in the schema (e.g., agreement of "numberOfXXX" attributes and <XXX> children)
iMinlowest value (inclusive) that an entry in this vector can take
iMaxgreatest value (inclusive) that an entry in this vector can take

◆ deepCopyFrom()

bool IntVector::deepCopyFrom ( IntVector that)

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

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

◆ setIntVector()

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

set values into an IntVector

Parameters
nicontains the dimension of the IntVector
icontains the array of values

◆ extendIntVector()

bool IntVector::extendIntVector ( int  i)

append a value to an IntVector

Parameters
icontains the value to be appended

◆ getNumberOfEl()

int IntVector::getNumberOfEl ( )

get the dimension of an IntVector

◆ getEl() [1/2]

int IntVector::getEl ( int  j)

get an entry in the data array of an IntVector

Parameters
jis the index of the entry that is to be retrieved

◆ getEl() [2/2]

bool IntVector::getEl ( int *  i)

Get the integer data array of an IntVector.

Parameters
iis 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.

Member Data Documentation

◆ bDeleteArrays

bool IntVector::bDeleteArrays

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

Definition at line 482 of file OSGeneral.h.

◆ numberOfEl

int IntVector::numberOfEl

Definition at line 483 of file OSGeneral.h.

◆ el

int* IntVector::el

Definition at line 484 of file OSGeneral.h.


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