Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

VectorOfPointersToPatternEntry Class Reference

Simple owning-vector class This is a vector class that is designed to be used with pointer types and which implements owning semantics. More...

#include <tables.h>

List of all members.

Public Types

enum  EGrowthRate { GROWTH_RATE = 4 }
 The chunk size by which the array is grown. More...


Public Methods

 VectorOfPointersToPatternEntry (int32_t initialSize = 0)
 Creates a vector that contains elements of PointerToPatternEntry. More...

 VectorOfPointersToPatternEntry (const VectorOfPointersToPatternEntry& that)
 Copy constructor.

 ~VectorOfPointersToPatternEntry ()
 Destructor.

const VectorOfPointersToPatternEntry& operator= (const VectorOfPointersToPatternEntry& that)
 Assignment operator.

PointerToPatternEntry operator[] (int32_t index)
 Return a modifiable smart-pointer to the contraction table at the given index. More...

PointerToPatternEntry at (int32_t index)
PatternEntryoperator[] (int32_t index) const
 Return a pointer to the EntryPair at the given index. More...

PatternEntryat (int32_t index) const
void atPut ( int32_t index, PatternEntry* value)
 Sets the element at the specified index to a different value. More...

void atInsert ( int32_t index, PatternEntry* value)
 Inserts a value at the specified index, sliding the rest of the elements in the array over to make room. More...

PatternEntryorphanAt (int32_t index)
 "Orphan" the pointer at the specified index. More...

void clear (void)
 Remove all elements from the vector.

int32_t size (void) const
 Returns the number of elements in the vector. More...

int32_t indexOf (const PatternEntry* value) const
 If the specified value exists in the vector, return its index. More...

int32_t lastIndexOf (const PatternEntry* value) const
 Return the index of the last occurance of value in the vector, or -1 if the vector doesn't contain value.

UBool isBogus (void) const
 Checks if this vector object is valid. More...


Detailed Description

Simple owning-vector class This is a vector class that is designed to be used with pointer types and which implements owning semantics.

That is, once a value is placed an element of the vector, the vector is considered to own it and is responsible for disposing it. This will happen both when the element is changed using atPut() or through an PointerTo****, and when the vector itself is disposed.

WARNING: The caller must be careful to avoid holding onto any dangling references after the vector is disposed, and the caller must also be careful not to put the same value into more than one element in the vector (unless the value is NULL).

As with VectorOf***>, the vector grows as necessary to accommodate all elements, the size is one plus the index of the highest element that's been set, and any elements below the highest element that aren't explicitly initialized are initialized to NULL.

Definition at line 917 of file tables.h.


Member Enumeration Documentation

enum VectorOfPointersToPatternEntry::EGrowthRate
 

The chunk size by which the array is grown.

This probably shouldn't be in the API

Enumeration values:
GROWTH_RATE  

Definition at line 923 of file tables.h.


Constructor & Destructor Documentation

VectorOfPointersToPatternEntry::VectorOfPointersToPatternEntry ( int32_t initialSize = 0 )
 

Creates a vector that contains elements of PointerToPatternEntry.

Parameters:
initialSize   the initial size of the vector object.

VectorOfPointersToPatternEntry::VectorOfPointersToPatternEntry ( const VectorOfPointersToPatternEntry & that )
 

Copy constructor.

VectorOfPointersToPatternEntry::~VectorOfPointersToPatternEntry ( )
 

Destructor.


Member Function Documentation

PatternEntry * VectorOfPointersToPatternEntry::at ( int32_t index ) const [inline]
 

Definition at line 969 of file tables.h.

PointerToPatternEntry VectorOfPointersToPatternEntry::at ( int32_t index ) [inline]
 

Definition at line 955 of file tables.h.

void VectorOfPointersToPatternEntry::atInsert ( int32_t index,
PatternEntry * value )
 

Inserts a value at the specified index, sliding the rest of the elements in the array over to make room.

Parameters:
index   the specified index.
value   the value.

void VectorOfPointersToPatternEntry::atPut ( int32_t index,
PatternEntry * value )
 

Sets the element at the specified index to a different value.

If there was aready an object stored at this index, it is deleted.

Parameters:
index   the specified index.
value   the new value.

void VectorOfPointersToPatternEntry::clear ( void )
 

Remove all elements from the vector.

int32_t VectorOfPointersToPatternEntry::indexOf ( const PatternEntry * value ) const
 

If the specified value exists in the vector, return its index.

If not, return -1.

UBool VectorOfPointersToPatternEntry::isBogus ( void ) const
 

Checks if this vector object is valid.

Returns:
TRUE if the vector object is valid, FALSE otherwise.

int32_t VectorOfPointersToPatternEntry::lastIndexOf ( const PatternEntry * value ) const
 

Return the index of the last occurance of value in the vector, or -1 if the vector doesn't contain value.

const VectorOfPointersToPatternEntry & VectorOfPointersToPatternEntry::operator= ( const VectorOfPointersToPatternEntry & that )
 

Assignment operator.

PatternEntry * VectorOfPointersToPatternEntry::operator[] ( int32_t index ) const
 

Return a pointer to the EntryPair at the given index.

The pointer itself cannot be modified, but the elements it points to may:

  const VectorOfPointersToPatternEntryfoo = ....;
  foo[5] = ....;              // NOT ALLOWED
  foo[5]->getStrength();      // ok
 
This does not do range-checking; an invalid index may cause a crash.
Returns:
the accessed element.

PointerToPatternEntry VectorOfPointersToPatternEntry::operator[] ( int32_t index )
 

Return a modifiable smart-pointer to the contraction table at the given index.

Assigning to this smart pointer will work, e.g.

  VectorOfPointersToPatternEntry foo = ....;
  foo[5] = ...;
 
This does range-checking; access to elements beyond the end of the array will cause the array to grow.

PatternEntry * VectorOfPointersToPatternEntry::orphanAt ( int32_t index )
 

"Orphan" the pointer at the specified index.

The array will no longer contain a reference to the object, and the caller is now responsible for deleting its storage.

int32_t VectorOfPointersToPatternEntry::size ( void ) const
 

Returns the number of elements in the vector.

Returns:
the size of vector.


The documentation for this class was generated from the following file:
Generated at Tue Dec 5 17:56:36 2000 for ICU by doxygen1.2.3 written by Dimitri van Heesch, © 1997-2000