Commit e58d7d7d authored by Shawn Waldon's avatar Shawn Waldon Committed by Code Review

Merge topic 'update-data-array-docs' into master

2d448c8a Update the documentation on data array subclasses
parents b9962f8c 2d448c8a
......@@ -17,6 +17,10 @@
// vtkIntArray is an array of values of type int. It provides
// methods for insertion and retrieval of values and will
// automatically resize itself to hold new data.
//
// The C++ standard does not define the exact size of the int type, so use
// of this type directly is discouraged. If an array of 32 bit integers is
// needed, prefer vtkTypeInt32Array to this class.
#ifndef vtkIntArray_h
#define vtkIntArray_h
......
......@@ -17,6 +17,11 @@
// vtkLongArray is an array of values of type long. It provides
// methods for insertion and retrieval of values and will
// automatically resize itself to hold new data.
//
// The C++ standard does not define the exact size of the long type, so use
// of this type directly is discouraged. If an array of 32 bit integers is
// needed, prefer vtkTypeInt32Array to this class. If an array of 64 bit
// integers is needed, prefer vtkTypeInt64Array to this class.
#ifndef vtkLongArray_h
#define vtkLongArray_h
......
......@@ -17,6 +17,10 @@
// vtkLongLongArray is an array of values of type long long.
// It provides methods for insertion and retrieval of values and will
// automatically resize itself to hold new data.
//
// This class should not be used directly, as it only exists on systems
// where the long long type is defined. If you need a 64 bit integer
// data array, use vtkTypeInt64Array instead.
#ifndef vtkLongLongArray_h
#define vtkLongLongArray_h
......
......@@ -17,6 +17,10 @@
// vtkShortArray is an array of values of type short. It provides
// methods for insertion and retrieval of values and will
// automatically resize itself to hold new data.
//
// The C++ standard does not define the exact size of the short type,
// so use of this type directly is discouraged. If an array of 16 bit
// integers is needed, prefer vtkTypeInt16Array to this class.
#ifndef vtkShortArray_h
#define vtkShortArray_h
......
......@@ -17,6 +17,11 @@
// vtkType@VTK_TYPE_NAME@Array is an array of values of type vtkType@VTK_TYPE_NAME@. It
// provides methods for insertion and retrieval of values and will
// automatically resize itself to hold new data.
//
// This array should be preferred for data of type @VTK_TYPE_NAME@ as this
// array will use the correct underlying datatype based on the desired number of bits
// and the current platform. The superclass of this type will change depending on the
// machine and compiler in use so that the data contained always uses the proper type.
#ifndef vtkType@VTK_TYPE_NAME@Array_h
#define vtkType@VTK_TYPE_NAME@Array_h
......
......@@ -17,6 +17,10 @@
// vtkUnsignedIntArray is an array of values of type unsigned int. It
// provides methods for insertion and retrieval of values and will
// automatically resize itself to hold new data.
//
// The C++ standard does not define the exact size of the unsigned int type,
// so use of this type directly is discouraged. If an array of 32 bit unsigned
// integers is needed, prefer vtkTypeUInt32Array to this class.
#ifndef vtkUnsignedIntArray_h
#define vtkUnsignedIntArray_h
......
......@@ -17,6 +17,12 @@
// vtkUnsignedLongArray is an array of values of type unsigned long.
// It provides methods for insertion and retrieval of values and will
// automatically resize itself to hold new data.
//
// The C++ standard does not define the exact size of the unsigned long type,
// so use of this type directly is discouraged. If an array of 32 bit
// unsigned integers is needed, prefer vtkTypeUInt32Array to this class.
// If an array of 64 bit unsigned integers is needed, prefer
// vtkUTypeInt64Array to this class.
#ifndef vtkUnsignedLongArray_h
#define vtkUnsignedLongArray_h
......
......@@ -17,6 +17,10 @@
// vtkUnsignedLongLongArray is an array of values of type unsigned long long.
// It provides methods for insertion and retrieval of values and will
// automatically resize itself to hold new data.
//
// This class should not be used directly, as it only exists on systems
// where the unsigned long long type is defined. If you need an unsigned
// 64 bit integer data array, use vtkTypeUInt64Array instead.
#ifndef vtkUnsignedLongLongArray_h
#define vtkUnsignedLongLongArray_h
......
......@@ -17,6 +17,10 @@
// vtkUnsignedShortArray is an array of values of type unsigned short.
// It provides methods for insertion and retrieval of values and will
// automatically resize itself to hold new data.
//
// The C++ standard does not define the exact size of the unsigned short type,
// so use of this type directly is discouraged. If an array of 16 bit
// unsigned integers is needed, prefer vtkTypeUInt16Array to this class.
#ifndef vtkUnsignedShortArray_h
#define vtkUnsignedShortArray_h
......
......@@ -17,6 +17,12 @@
// vtkUnsigned__Int64Array is an array of values of type unsigned __int64.
// It provides methods for insertion and retrieval of values and will
// automatically resize itself to hold new data.
//
// This class is intended to give an array of unsigned 64 bit integers
// on systems where unsigned __int64 is the only unsigned 64 bit integer
// type. If an array of unsigned 64 bit
// integers is needed, prefer vtkTypeUInt64Array, which will always uses
// the system's most appropriate datatype for unsigned 64 bit integers.
#ifndef vtkUnsigned__Int64Array_h
#define vtkUnsigned__Int64Array_h
......
......@@ -17,6 +17,11 @@
// vtk__Int64Array is an array of values of type __int64.
// It provides methods for insertion and retrieval of values and will
// automatically resize itself to hold new data.
//
// This class is intended to give an array of 64 bit integers on systems
// where __int64 is the only 64 bit integer type. If an array of 64 bit
// integers is needed, prefer vtkTypeInt64Array, which will always uses
// the system's most appropriate datatype for 64 bit integers.
#ifndef vtk__Int64Array_h
#define vtk__Int64Array_h
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment