150#ifndef vtkCellArray_h
151#define vtkCellArray_h
153#include "vtkCommonDataModelModule.h"
159#include "vtkFeatures.h"
161#include "vtkTypeInt32Array.h"
162#include "vtkTypeInt64Array.h"
166#include <initializer_list>
167#include <type_traits>
190#define VTK_CELL_ARRAY_V2
244 return this->AllocateExact(sz, sz) ? 1 : 0;
258 return this->AllocateExact(numCells, numCells * maxCellSize);
408 void SetData(vtkTypeInt32Array* offsets, vtkTypeInt32Array* connectivity);
409 void SetData(vtkTypeInt64Array* offsets, vtkTypeInt64Array* connectivity);
528 return this->GetOffsetsArray64();
532 return this->GetOffsetsArray32();
549 return this->GetConnectivityArray64();
553 return this->GetConnectivityArray32();
579 void InitTraversal();
641 VTK_EXPECTS(0 <= cellId && cellId < GetNumberOfCells());
674 return this->InsertNextCell(
static_cast<vtkIdType>(cell.size()), cell.begin());
695 void UpdateCellCount(
int npts);
735 return this->ReplaceCellAtId(cellId,
static_cast<vtkIdType>(cell.size()), cell.begin());
810 unsigned long GetActualMemorySize() const;
818 template <
typename ArrayT>
823 using CellRangeType =
decltype(vtk::DataArrayValueRange<1>(std::declval<ArrayType>()));
830 static constexpr bool ValueTypeIsSameAsIdType = std::is_integral<ValueType>::value &&
856 this->Offsets->InsertNextValue(0);
859 this->IsInMemkind =
true;
863 void*
operator new(
size_t nSize)
866#ifdef VTK_USE_MEMKIND
873 void operator delete(
void* p)
875#ifdef VTK_USE_MEMKIND
896 bool IsInMemkind =
false;
900 template <
typename Functor,
typename... Args>
901 using GetReturnType =
decltype(
902 std::declval<Functor>()(std::declval<VisitState<ArrayType32>&>(), std::declval<Args>()...));
904 template <
typename Functor,
typename... Args>
905 struct ReturnsVoid : std::is_same<GetReturnType<Functor, Args...>, void>
979 template <
typename Functor,
typename... Args,
980 typename =
typename std::enable_if<ReturnsVoid<Functor, Args...>::value>::type>
981 void Visit(Functor&& functor, Args&&... args)
999 template <
typename Functor,
typename... Args,
1000 typename =
typename std::enable_if<ReturnsVoid<Functor, Args...>::value>::type>
1001 void Visit(Functor&& functor, Args&&... args)
const
1019 template <
typename Functor,
typename... Args,
1020 typename =
typename std::enable_if<!ReturnsVoid<Functor, Args...>::value>::type>
1021 GetReturnType<Functor, Args...>
Visit(Functor&& functor, Args&&... args)
1038 template <
typename Functor,
typename... Args,
1039 typename =
typename std::enable_if<!ReturnsVoid<Functor, Args...>::value>::type>
1040 GetReturnType<Functor, Args...>
Visit(Functor&& functor, Args&&... args)
const
1123 VTK_EXPECTS(0 <= loc && loc < GetNumberOfConnectivityEntries());
1218#ifdef VTK_USE_MEMKIND
1226#ifdef VTK_USE_64BIT_IDS
1229 this->StorageIs64Bit =
true;
1234 this->StorageIs64Bit =
false;
1237#ifdef VTK_USE_MEMKIND
1240 this->IsInMemkind =
true;
1243 (void)this->IsInMemkind;
1249 if (this->StorageIs64Bit)
1251 this->Arrays->Int64->~VisitState();
1252 delete this->Arrays->Int64;
1256 this->Arrays->Int32->~VisitState();
1257 delete this->Arrays->Int32;
1259#ifdef VTK_USE_MEMKIND
1260 if (this->IsInMemkind)
1269 delete this->Arrays;
1277 if (!this->StorageIs64Bit)
1282 this->Arrays->Int64->~VisitState();
1283 delete this->Arrays->Int64;
1285 this->StorageIs64Bit =
false;
1294 if (this->StorageIs64Bit)
1299 this->Arrays->Int32->~VisitState();
1300 delete this->Arrays->Int32;
1302 this->StorageIs64Bit =
true;
1308 bool Is64Bit()
const {
return this->StorageIs64Bit; }
1313 assert(!this->StorageIs64Bit);
1314 return *this->Arrays->Int32;
1319 assert(!this->StorageIs64Bit);
1320 return *this->Arrays->Int32;
1326 assert(this->StorageIs64Bit);
1327 return *this->Arrays->Int64;
1332 assert(this->StorageIs64Bit);
1333 return *this->Arrays->Int64;
1339 ArraySwitch* Arrays;
1340 bool StorageIs64Bit;
1341 bool IsInMemkind =
false;
1355template <
typename ArrayT>
1358 return this->Offsets->GetNumberOfValues() - 1;
1361template <
typename ArrayT>
1364 return static_cast<vtkIdType>(this->Offsets->GetValue(cellId));
1367template <
typename ArrayT>
1370 return static_cast<vtkIdType>(this->Offsets->GetValue(cellId + 1));
1373template <
typename ArrayT>
1376 return this->GetEndOffset(cellId) - this->GetBeginOffset(cellId);
1379template <
typename ArrayT>
1383 return vtk::DataArrayValueRange<1>(
1384 this->GetConnectivity(), this->GetBeginOffset(cellId), this->GetEndOffset(cellId));
1393 template <
typename CellStateT>
1396 using ValueType =
typename CellStateT::ValueType;
1397 auto* conn = state.GetConnectivity();
1398 auto* offsets = state.GetOffsets();
1400 const vtkIdType cellId = offsets->GetNumberOfValues() - 1;
1402 offsets->InsertNextValue(
static_cast<ValueType
>(conn->GetNumberOfValues() + npts));
1406 conn->InsertNextValue(
static_cast<ValueType
>(pts[i]));
1413 template <
typename CellStateT>
1416 using ValueType =
typename CellStateT::ValueType;
1417 auto* conn = state.GetConnectivity();
1418 auto* offsets = state.GetOffsets();
1420 const vtkIdType cellId = offsets->GetNumberOfValues() - 1;
1422 offsets->InsertNextValue(
static_cast<ValueType
>(conn->GetNumberOfValues() + npts));
1431 template <
typename CellStateT>
1434 using ValueType =
typename CellStateT::ValueType;
1436 auto* offsets = state.GetOffsets();
1437 const ValueType cellBegin = offsets->GetValue(offsets->GetMaxId() - 1);
1438 offsets->SetValue(offsets->GetMaxId(),
static_cast<ValueType
>(cellBegin + npts));
1444 template <
typename CellStateT>
1447 return state.GetCellSize(cellId);
1453 template <
typename CellStateT>
1456 using ValueType =
typename CellStateT::ValueType;
1458 const auto cellPts = state.GetCellRange(cellId);
1463 for (ValueType ptId : cellPts)
1465 *idPtr++ =
static_cast<vtkIdType>(ptId);
1471 template <
typename CellStateT>
1475 using ValueType =
typename CellStateT::ValueType;
1476 using ArrayType =
typename CellStateT::ArrayType;
1478 static constexpr bool ValueTypeCompat = CellStateT::ValueTypeIsSameAsIdType;
1479 static constexpr bool ArrayTypeCompat = std::is_base_of<AOSArrayType, ArrayType>::value;
1482 static constexpr bool value = ValueTypeCompat && ArrayTypeCompat;
1485 template <
typename CellStateT>
1486 typename std::enable_if<CanShareConnPtr<CellStateT>::value,
void>::type
operator()(
1490 const vtkIdType beginOffset = state.GetBeginOffset(cellId);
1491 const vtkIdType endOffset = state.GetEndOffset(cellId);
1492 cellSize = endOffset - beginOffset;
1494 cellPoints =
reinterpret_cast<vtkIdType*
>(state.GetConnectivity()->GetPointer(beginOffset));
1497 template <
typename CellStateT>
1498 typename std::enable_if<!CanShareConnPtr<CellStateT>::value,
void>::type
operator()(
1502 using ValueType =
typename CellStateT::ValueType;
1504 const auto cellPts = state.GetCellRange(cellId);
1505 cellSize = cellPts.size();
1511 for (ValueType ptId : cellPts)
1513 *tempPtr++ =
static_cast<vtkIdType>(ptId);
1522 template <
typename CellStateT>
1525 state.GetOffsets()->Reset();
1526 state.GetConnectivity()->Reset();
1527 state.GetOffsets()->InsertNextValue(0);
1542 if (this->TraversalCellId < this->GetNumberOfCells())
1544 this->GetCellAtId(this->TraversalCellId, npts, pts);
1545 ++this->TraversalCellId;
1611 using ValueType =
typename ArrayType64::ValueType;
1616 using ValueType =
typename ArrayType32::ValueType;
Array-Of-Structs implementation of vtkGenericDataArray.
Encapsulate traversal logic for vtkCellArray.
object to represent cell connectivity
void SetData(vtkAOSDataArrayTemplate< int > *offsets, vtkAOSDataArrayTemplate< int > *connectivity)
Set the internal data arrays to the supplied offsets and connectivity arrays.
int GetNextCell(vtkIdType &npts, vtkIdType const *&pts)
vtkIdType GetNumberOfConnectivityEntries()
Return the size of the array that would be returned from ExportLegacyFormat().
vtkTypeBool Allocate(vtkIdType sz, vtkIdType vtkNotUsed(ext)=1000)
Allocate memory.
void UseDefaultStorage()
Initialize internal data structures to use 32- or 64-bit storage.
vtkIdType GetOffset(vtkIdType cellId)
Get the offset (into the connectivity) for a specified cell id.
bool AllocateCopy(vtkCellArray *other)
Pre-allocate memory in internal data structures to match the used size of the input vtkCellArray.
void AppendLegacyFormat(vtkIdTypeArray *data, vtkIdType ptOffset=0)
Append an array of data with the legacy vtkCellArray layout, e.g.:
bool IsStorageShareable() const
bool IsValid()
Check that internal storage is consistent and in a valid state.
void AppendLegacyFormat(const vtkIdType *data, vtkIdType len, vtkIdType ptOffset=0)
Append an array of data with the legacy vtkCellArray layout, e.g.:
GetReturnType< Functor, Args... > Visit(Functor &&functor, Args &&... args) const
bool SetData(vtkIdType cellSize, vtkDataArray *connectivity)
Sets the internal arrays to the supported connectivity array with an offsets array automatically gene...
vtkIdType GetTraversalCellId()
Get/Set the current cellId for traversal.
void Visit(Functor &&functor, Args &&... args)
vtkTypeInt32Array ArrayType32
ArrayType64 * GetConnectivityArray64()
Return the array used to store the point ids that define the cells' connectivity.
ArrayType32 * GetConnectivityArray32()
Return the array used to store the point ids that define the cells' connectivity.
void SetData(vtkAOSDataArrayTemplate< long long > *offsets, vtkAOSDataArrayTemplate< long long > *connectivity)
Set the internal data arrays to the supplied offsets and connectivity arrays.
bool AllocateExact(vtkIdType numCells, vtkIdType connectivitySize)
Pre-allocate memory in internal data structures.
bool ResizeExact(vtkIdType numCells, vtkIdType connectivitySize)
ResizeExact() resizes the internal structures to hold numCells total cell offsets and connectivitySiz...
vtkIdType EstimateSize(vtkIdType numCells, int maxPtsPerCell)
Utility routines help manage memory of cell array.
ArrayType32 * GetOffsetsArray32()
Return the array used to store cell offsets.
bool AllocateEstimate(vtkIdType numCells, vtkIdType maxCellSize)
Pre-allocate memory in internal data structures.
vtkIdType GetNumberOfOffsets() const
Get the number of elements in the offsets array.
vtkTypeInt64Array ArrayType64
vtkIdType TraversalCellId
void Use64BitStorage()
Initialize internal data structures to use 32- or 64-bit storage.
bool ConvertToDefaultStorage()
Convert internal data structures to use 32- or 64-bit storage.
bool CanConvertToDefaultStorage() const
Check if the existing data can safely be converted to use 32- or 64- bit storage.
void GetCell(vtkIdType loc, vtkIdType &npts, const vtkIdType *&pts)
Internal method used to retrieve a cell given a legacy offset location.
bool CanConvertTo32BitStorage() const
Check if the existing data can safely be converted to use 32- or 64- bit storage.
vtkDataArray * GetConnectivityArray()
Return the array used to store the point ids that define the cells' connectivity.
void InsertCellPoint(vtkIdType id)
Used in conjunction with InsertNextCell(npts) to add another point to the list of cells.
void GetCellAtId(vtkIdType cellId, vtkIdType &cellSize, vtkIdType const *&cellPoints)
Return the point ids for the cell at cellId.
vtkCellArrayIterator * NewIterator()
NewIterator returns a new instance of vtkCellArrayIterator that is initialized to point at the first ...
void ReplaceCellAtId(vtkIdType cellId, vtkIdList *list)
Replaces the point ids for the specified cell with the supplied list.
void ReverseCellAtId(vtkIdType cellId)
Reverses the order of the point ids for the specified cell.
bool SetData(vtkDataArray *offsets, vtkDataArray *connectivity)
Sets the internal arrays to the supplied offsets and connectivity arrays.
void Squeeze()
Reclaim any extra memory while preserving data.
void SetData(vtkIdTypeArray *offsets, vtkIdTypeArray *connectivity)
Set the internal data arrays to the supplied offsets and connectivity arrays.
bool ConvertTo32BitStorage()
Convert internal data structures to use 32- or 64-bit storage.
vtkIdType IsHomogeneous()
Check if all cells have the same number of vertices.
void Visit(Functor &&functor, Args &&... args) const
int GetMaxCellSize()
Returns the size of the largest cell.
ArrayType64 * GetOffsetsArray64()
Return the array used to store cell offsets.
bool ConvertToSmallestStorage()
Convert internal data structures to use 32- or 64-bit storage.
void ShallowCopy(vtkCellArray *ca)
Shallow copy ca into this cell array.
void ExportLegacyFormat(vtkIdTypeArray *data)
Fill data with the old-style vtkCellArray data layout, e.g.
bool ConvertTo64BitStorage()
Convert internal data structures to use 32- or 64-bit storage.
void SetData(vtkAOSDataArrayTemplate< long > *offsets, vtkAOSDataArrayTemplate< long > *connectivity)
Set the internal data arrays to the supplied offsets and connectivity arrays.
void ImportLegacyFormat(const vtkIdType *data, vtkIdType len)
Import an array of data with the legacy vtkCellArray layout, e.g.:
void ImportLegacyFormat(vtkIdTypeArray *data)
Import an array of data with the legacy vtkCellArray layout, e.g.:
void Use32BitStorage()
Initialize internal data structures to use 32- or 64-bit storage.
void Initialize()
Free any memory and reset to an empty state.
void DeepCopy(vtkCellArray *ca)
Perform a deep copy (no reference counting) of the given cell array.
typename vtkTypeList::Unique< vtkTypeList::Create< vtkAOSDataArrayTemplate< int >, vtkAOSDataArrayTemplate< long >, vtkAOSDataArrayTemplate< long long > > >::Result InputArrayList
List of possible ArrayTypes that are compatible with internal storage.
void SetTraversalCellId(vtkIdType cellId)
Get/Set the current cellId for traversal.
void SetData(vtkTypeInt64Array *offsets, vtkTypeInt64Array *connectivity)
Set the internal data arrays to the supplied offsets and connectivity arrays.
vtkIdType GetNumberOfCells() const
Get the number of cells in the array.
vtkIdType InsertNextCell(vtkCell *cell)
Insert a cell object.
virtual void SetNumberOfCells(vtkIdType)
Set the number of cells in the array.
vtkIdType GetNumberOfConnectivityIds() const
Get the size of the connectivity array that stores the point ids.
vtkDataArray * GetOffsetsArray()
Return the array used to store cell offsets.
vtkNew< vtkIdTypeArray > LegacyData
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for instantiation, type information, and printing.
void PrintDebug(ostream &os)
Standard methods for instantiation, type information, and printing.
void UpdateCellCount(int npts)
Used in conjunction with InsertNextCell(int npts) and InsertCellPoint() to update the number of point...
GetReturnType< Functor, Args... > Visit(Functor &&functor, Args &&... args)
static vtkCellArray * New()
Standard methods for instantiation, type information, and printing.
vtkNew< vtkIdList > TempCell
vtkIdType GetSize()
Get the size of the allocated connectivity array.
vtkTypeList::Create< ArrayType32, ArrayType64 > StorageArrayList
List of possible array types used for storage.
vtkIdType InsertNextCell(const std::initializer_list< vtkIdType > &cell)
Overload that allows InsertNextCell({0, 1, 2}) syntax.
void Append(vtkCellArray *src, vtkIdType pointOffset=0)
Append cells from src into this.
vtkIdType GetCellSize(const vtkIdType cellId) const
Return the size of the cell at cellId.
bool IsStorage64Bit() const
void ReplaceCellAtId(vtkIdType cellId, vtkIdType cellSize, const vtkIdType *cellPoints)
Replaces the point ids for the specified cell with the supplied list.
bool CanConvertTo64BitStorage() const
Check if the existing data can safely be converted to use 32- or 64- bit storage.
abstract class to specify cell behavior
vtkIdList * GetPointIds()
Return the list of point ids defining the cell.
abstract superclass for arrays of numeric data
list of point or cell ids
vtkIdType GetNumberOfIds() const noexcept
Return the number of id's in the list.
void Reset()
Reset to an empty state but retain previously allocated memory.
vtkIdType * GetPointer(const vtkIdType i)
Get a pointer to a particular data index.
void SetNumberOfIds(const vtkIdType number)
Specify the number of ids for this object to hold.
dynamic, self-adjusting array of vtkIdType
a simple class to control print indentation
Allocate and hold a VTK object.
static vtkMallocingFunction GetCurrentMallocFunction()
static vtkFreeingFunction GetAlternateFreeFunction()
static bool GetUsingMemkind()
A global state flag that controls whether vtkObjects are constructed in the usual way (the default) o...
abstract base class for most VTK objects
Hold a reference to a vtkObjectBase instance.
static vtkSmartPointer< T > New()
Create an instance of a VTK object.
VisitState< ArrayType64 > & GetArrays64()
const VisitState< ArrayType64 > & GetArrays64() const
const VisitState< ArrayType32 > & GetArrays32() const
VisitState< ArrayType32 > & GetArrays32()
vtkIdType GetNumberOfCells() const
vtkIdType GetEndOffset(vtkIdType cellId) const
vtkSmartPointer< ArrayType > Offsets
vtkSmartPointer< ArrayType > Connectivity
static constexpr bool ValueTypeIsSameAsIdType
const ArrayType * GetOffsets() const
decltype(vtk::DataArrayValueRange< 1 >(std::declval< ArrayType >())) CellRangeType
CellRangeType GetCellRange(vtkIdType cellId)
vtkIdType GetBeginOffset(vtkIdType cellId) const
vtkIdType GetCellSize(vtkIdType cellId) const
const ArrayType * GetConnectivity() const
typename ArrayType::ValueType ValueType
ArrayType * GetConnectivity()
std::enable_if<!CanShareConnPtr< CellStateT >::value, void >::type operator()(CellStateT &state, const vtkIdType cellId, vtkIdType &cellSize, vtkIdType const *&cellPoints, vtkIdList *temp)
std::enable_if< CanShareConnPtr< CellStateT >::value, void >::type operator()(CellStateT &state, const vtkIdType cellId, vtkIdType &cellSize, vtkIdType const *&cellPoints, vtkIdList *vtkNotUsed(temp))
void operator()(CellStateT &state, const vtkIdType cellId, vtkIdList *ids)
vtkIdType operator()(CellStateT &state, const vtkIdType cellId)
vtkIdType operator()(CellStateT &state, const vtkIdType npts, const vtkIdType pts[])
vtkIdType operator()(CellStateT &state, const vtkIdType npts)
void operator()(CellStateT &state)
void operator()(CellStateT &state, const vtkIdType npts)
Remove all duplicate types from TypeList TList, storing the new list in Result.
VisitState< ArrayType32 > * Int32
VisitState< ArrayType64 > * Int64
STL-compatible iterable ranges that provide access to vtkDataArray elements.
#define VTK_SIZEHINT(...)