Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

vtkDoubleArray Class Reference

#include <vtkDoubleArray.h>

Inheritance diagram for vtkDoubleArray:

Inheritance graph
[legend]
Collaboration diagram for vtkDoubleArray:

Collaboration graph
[legend]
List of all members.

Detailed Description

dynamic, self-adjusting double precision array

Date
2002/11/12 18:32:04
Revision
1.57

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.

Examples:
vtkDoubleArray (Examples)
Tests:
vtkDoubleArray (Tests)

Definition at line 38 of file vtkDoubleArray.h.

Public Types

typedef vtkDataArray Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
int Allocate (const vtkIdType sz, const vtkIdType ext=1000)
void Initialize ()
int GetDataType ()
int GetDataTypeSize ()
void SetNumberOfTuples (const vtkIdType number)
float * GetTuple (const vtkIdType i)
void Squeeze ()
virtual void Resize (vtkIdType numTuples)
double GetValue (const vtkIdType id)
void SetNumberOfValues (const vtkIdType number)
void InsertValue (const vtkIdType id, const double f)
vtkIdType InsertNextValue (const double f)
float GetComponent (const vtkIdType i, const int j)
void SetComponent (const vtkIdType i, const int j, float c)
virtual void InsertComponent (const vtkIdType i, const int j, float c)
double * WritePointer (const vtkIdType id, const vtkIdType number)
void DeepCopy (vtkDataArray *da)
void GetTuple (const vtkIdType i, float *tuple)
void GetTuple (const vtkIdType i, double *tuple)
void SetTuple (const vtkIdType i, const float *tuple)
void SetTuple (const vtkIdType i, const double *tuple)
void InsertTuple (const vtkIdType i, const float *tuple)
void InsertTuple (const vtkIdType i, const double *tuple)
vtkIdType InsertNextTuple (const float *tuple)
vtkIdType InsertNextTuple (const double *tuple)
void SetValue (const vtkIdType id, const double value)
double * GetPointer (const vtkIdType id)
void * GetVoidPointer (const vtkIdType id)
void SetArray (double *array, vtkIdType size, int save)
void SetVoidArray (void *array, vtkIdType size, int save)

Static Public Member Functions

vtkDoubleArrayNew ()
int IsTypeOf (const char *type)
vtkDoubleArraySafeDownCast (vtkObject *o)

Protected Member Functions

 vtkDoubleArray (vtkIdType numComp=1)
 ~vtkDoubleArray ()
double * ResizeAndExtend (const vtkIdType sz)

Protected Attributes

double * Array
int TupleSize
float * Tuple
int SaveUserArray


Member Typedef Documentation

typedef vtkDataArray vtkDoubleArray::Superclass
 

Reimplemented from vtkDataArray.

Definition at line 43 of file vtkDoubleArray.h.


Constructor & Destructor Documentation

vtkDoubleArray::vtkDoubleArray vtkIdType  numComp = 1  )  [protected]
 

vtkDoubleArray::~vtkDoubleArray  )  [protected]
 


Member Function Documentation

vtkDoubleArray* vtkDoubleArray::New  )  [static]
 

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual const char* vtkDoubleArray::GetClassName  )  [virtual]
 

Reimplemented from vtkDataArray.

int vtkDoubleArray::IsTypeOf const char *  type  )  [static]
 

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkDataArray.

virtual int vtkDoubleArray::IsA const char *  type  )  [virtual]
 

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkDataArray.

vtkDoubleArray* vtkDoubleArray::SafeDownCast vtkObject o  )  [static]
 

Reimplemented from vtkDataArray.

void vtkDoubleArray::PrintSelf ostream &  os,
vtkIndent  indent
[virtual]
 

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkDataArray.

int vtkDoubleArray::Allocate const vtkIdType  sz,
const vtkIdType  ext = 1000
[virtual]
 

Allocate memory for this array. Delete old storage only if necessary. Note that ext is no longer used.

Implements vtkDataArray.

Referenced by SetNumberOfValues().

void vtkDoubleArray::Initialize  )  [virtual]
 

Release storage and reset array to initial state.

Implements vtkDataArray.

int vtkDoubleArray::GetDataType  )  [inline, virtual]
 

Get the data type.

Implements vtkDataArray.

Definition at line 54 of file vtkDoubleArray.h.

References VTK_DOUBLE.

int vtkDoubleArray::GetDataTypeSize  )  [inline, virtual]
 

Return the size of the data type.

Implements vtkDataArray.

Definition at line 57 of file vtkDoubleArray.h.

void vtkDoubleArray::SetNumberOfTuples const vtkIdType  number  )  [virtual]
 

Set the number of n-tuples in the array.

Implements vtkDataArray.

float* vtkDoubleArray::GetTuple const vtkIdType  i  )  [virtual]
 

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).

Implements vtkDataArray.

void vtkDoubleArray::GetTuple const vtkIdType  i,
float *  tuple
[virtual]
 

Copy the tuple value into a user-provided array.

Implements vtkDataArray.

void vtkDoubleArray::GetTuple const vtkIdType  i,
double *  tuple
[virtual]
 

Copy the tuple value into a user-provided array.

Reimplemented from vtkDataArray.

void vtkDoubleArray::SetTuple const vtkIdType  i,
const float *  tuple
[virtual]
 

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

Implements vtkDataArray.

void vtkDoubleArray::SetTuple const vtkIdType  i,
const double *  tuple
[virtual]
 

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

Reimplemented from vtkDataArray.

void vtkDoubleArray::InsertTuple const vtkIdType  i,
const float *  tuple
[virtual]
 

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

Implements vtkDataArray.

void vtkDoubleArray::InsertTuple const vtkIdType  i,
const double *  tuple
[virtual]
 

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

Reimplemented from vtkDataArray.

vtkIdType vtkDoubleArray::InsertNextTuple const float *  tuple  )  [virtual]
 

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

Implements vtkDataArray.

vtkIdType vtkDoubleArray::InsertNextTuple const double *  tuple  )  [virtual]
 

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

Reimplemented from vtkDataArray.

void vtkDoubleArray::Squeeze  )  [inline, virtual]
 

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

Implements vtkDataArray.

Definition at line 93 of file vtkDoubleArray.h.

virtual void vtkDoubleArray::Resize vtkIdType  numTuples  )  [virtual]
 

Resize the array while conserving the data.

Implements vtkDataArray.

double vtkDoubleArray::GetValue const vtkIdType  id  )  [inline]
 

Get the data at a particular index. Definition at line 99 of file vtkDoubleArray.h.

void vtkDoubleArray::SetValue const vtkIdType  id,
const double  value
[inline]
 

Set the data at a particular index. Does not do range checking. Make sure you use the method SetNumberOfValues() before inserting data. Definition at line 104 of file vtkDoubleArray.h.

void vtkDoubleArray::SetNumberOfValues const vtkIdType  number  )  [inline]
 

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. Definition at line 180 of file vtkDoubleArray.h.

References Allocate().

void vtkDoubleArray::InsertValue const vtkIdType  id,
const double  f
[inline]
 

Insert data at a specified position in the array. Definition at line 201 of file vtkDoubleArray.h.

References Array, and ResizeAndExtend().

Referenced by InsertNextValue().

vtkIdType vtkDoubleArray::InsertNextValue const double  f  )  [inline]
 

Insert data at the end of the array. Return its location in the array. Definition at line 214 of file vtkDoubleArray.h.

References InsertValue().

float vtkDoubleArray::GetComponent const vtkIdType  i,
const int  j
[virtual]
 

Return the data component at the ith tuple and jth component location. Note that i is less then NumberOfTuples and j is less then NumberOfComponents.

Reimplemented from vtkDataArray.

void vtkDoubleArray::SetComponent const vtkIdType  i,
const int  j,
float  c
[virtual]
 

Set the data component at the ith tuple and jth component location. Note that i is less then NumberOfTuples and j is less then NumberOfComponents. Make sure enough memory has been allocated (use SetNumberOfTuples() and SetNumberOfComponents()).

Reimplemented from vtkDataArray.

virtual void vtkDoubleArray::InsertComponent const vtkIdType  i,
const int  j,
float  c
[virtual]
 

Insert the data component at ith tuple and jth component location. Note that memory allocation is performed as necessary to hold the data.

Reimplemented from vtkDataArray.

double * vtkDoubleArray::WritePointer const vtkIdType  id,
const vtkIdType  number
[inline]
 

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. Definition at line 186 of file vtkDoubleArray.h.

References Array, and ResizeAndExtend().

double* vtkDoubleArray::GetPointer const vtkIdType  id  )  [inline]
 

Get the address of a particular data index. Performs no checks to verify that the memory has been allocated etc. Definition at line 144 of file vtkDoubleArray.h.

void* vtkDoubleArray::GetVoidPointer const vtkIdType  id  )  [inline, virtual]
 

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

Implements vtkDataArray.

Definition at line 145 of file vtkDoubleArray.h.

void vtkDoubleArray::DeepCopy vtkDataArray da  )  [virtual]
 

Deep copy of another double array.

Reimplemented from vtkDataArray.

void vtkDoubleArray::SetArray double *  array,
vtkIdType  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.

void vtkDoubleArray::SetVoidArray void *  array,
vtkIdType  size,
int  save
[inline]
 

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. Definition at line 160 of file vtkDoubleArray.h.

double* vtkDoubleArray::ResizeAndExtend const vtkIdType  sz  )  [protected]
 

Referenced by InsertValue(), and WritePointer().


Member Data Documentation

double* vtkDoubleArray::Array [protected]
 

Definition at line 168 of file vtkDoubleArray.h.

Referenced by InsertValue(), and WritePointer().

int vtkDoubleArray::TupleSize [protected]
 

Definition at line 171 of file vtkDoubleArray.h.

float* vtkDoubleArray::Tuple [protected]
 

Definition at line 172 of file vtkDoubleArray.h.

int vtkDoubleArray::SaveUserArray [protected]
 

Definition at line 174 of file vtkDoubleArray.h.


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