vtkDoubleArray - dynamic, self-adjusting double precision array

Super Class: vtkDataArray

Description:

vtkDoubleArray is an array of double precision numbers. It provides methods for insertion and retrieval of double precision values, and will automatically resize itself to hold new data.

Methods:

• vtkDoubleArray (int numComp);
• ~vtkDoubleArray ();
• vtkDoubleArray *New ();
• char *GetClassName ();
• void PrintSelf (ostream &os, vtkIndent indent);
• int Allocate (int sz, int ext);
• void Initialize ();
• vtkDataArray *MakeObject ();
• int GetDataType ();
• void SetNumberOfTuples (int number);
• float *GetTuple (int i);
• void GetTuple (int i, float *tuple);
• void SetTuple (int i, float *tuple);
• void InsertTuple (int i, float *tuple);
• int InsertNextTuple (float *tuple);
• void Squeeze ();
• double GetValue (int id);
• void SetValue (int id, double value);
• void SetNumberOfValues (int number);
• void InsertValue (int id, double f);
• int InsertNextValue (double f);
• double *WritePointer (int id, int number);
• double *GetPointer (int id);
• void *GetVoidPointer (int id);
• void DeepCopy (vtkDataArray *da);
• void SetArray (double *array, int size, int save);
• void DeepCopy (vtkDataArray &da);
• double *Arraydouble *Resize (int sz);

Detailed Method Descriptions:

• int Allocate (int sz, int ext);

Allocate memory for this array. Delete old storage only if necessary.

• void Initialize ();

Release storage and reset array to initial state.

• vtkDataArray *MakeObject ();

Create a similar type object

• int GetDataType ();

Get the data type.

• void SetNumberOfTuples (int number);

Set the number of n-tuples in the array.

• float *GetTuple (int i);

Get a pointer to a tuple at the ith location. This is a dangerous method (it is not thread safe since a pointer is returned).

• void GetTuple (int i, float *tuple);

Copy the tuple value into a user-provided array.

• void SetTuple (int i, float *tuple);

Set the tuple value at the ith location in the array.

• void InsertTuple (int i, float *tuple);

Insert (memory allocation performed) the tuple into the ith location in the array.

• int InsertNextTuple (float *tuple);

Insert (memory allocation performed) the tuple onto the end of the array.

• void Squeeze ();

Resize object to just fit data requirement. Reclaims extra memory.

• double GetValue (int id);
• void SetValue (int id, double value);

Set the data at a particular index. Does not do range checking. Make sure you use the method SetNumberOfValues() before inserting data.

• void SetNumberOfValues (int number);

Specify the number of values for this object to hold. Does an allocation as well as setting the MaxId ivar. Used in conjunction with SetValue() method for fast insertion.

• void InsertValue (int id, double f);

Insert data at a specified position in the array.

• int InsertNextValue (double f);

Insert data at the end of the array. Return its location in the array.

• double *WritePointer (int id, int number);

Get the address of a particular data index. Make sure data is allocated for the number of items requested. Set MaxId according to the number of data values requested.

• double *GetPointer (int id);
• void *GetVoidPointer (int id);

Get the address of a particular data index. Performs no checks to verify that the memory has been allocated etc.

• void DeepCopy (vtkDataArray *da);

Deep copy of another double array.

• void SetArray (double *array, int size, int save);

This method lets the user specify data to be held by the array. The array argument is a pointer to the data. size is the size of the array supplied by the user. Set save to 1 to keep the class from deleting the array when it cleans up or reallocates memory. The class uses the actual array provided; it does not copy the data from the suppled array.