236#ifndef vtkCellArray_h
237#define vtkCellArray_h
240#include "vtkCommonDataModelModule.h"
248#include "vtkFeatures.h"
250#include "vtkTypeInt32Array.h"
251#include "vtkTypeInt64Array.h"
255#include <initializer_list>
256#include <type_traits>
279#define VTK_CELL_ARRAY_V2
281VTK_ABI_NAMESPACE_BEGIN
315 return this->
AllocateExact(numCells, numCells * maxCellSize);
407 this->
Offsets->SetComponent(cellId, 0,
static_cast<double>(offset));
539 return std::is_same_v<vtkTypeInt32, vtkIdType>;
542 return std::is_same_v<vtkTypeInt64, vtkIdType>;
803 inline vtkIdType InsertNextCell(
int npts);
815 void UpdateCellCount(
int npts);
951 template <
class ArrayT>
954 template <
class OffsetsT>
957 return offsets->GetNumberOfValues() - 1;
960 template <
class ArrayT>
967 template <
class OffsetsT>
973 template <
class OffsetsT>
979 template <
class OffsetsT>
982 auto offsetsRange =
GetRange(offsets);
983 return static_cast<vtkIdType>(offsetsRange[cellId + 1] - offsetsRange[cellId]);
986 template <
class OffsetsT,
class ConnectivityT>
990 auto offsetsRange =
GetRange(offsets);
992 conn, offsetsRange[cellId], offsetsRange[cellId + 1]);
1060 template <
typename Functor,
typename... Args>
1067 static_cast<AOSArray32*
>(this->Connectivity.Get()), std::forward<Args>(args)...);
1071 static_cast<AOSArray64*
>(this->Connectivity.Get()), std::forward<Args>(args)...);
1075 static_cast<AOSArray32*
>(this->Connectivity.Get()), std::forward<Args>(args)...);
1079 static_cast<AOSArray64*
>(this->Connectivity.Get()), std::forward<Args>(args)...);
1083 functor(this->
Offsets.Get(), this->Connectivity.Get(), std::forward<Args>(args)...);
1087 template <
typename Functor,
typename... Args>
1094 static_cast<AOSArray32*
>(this->Connectivity.Get()), std::forward<Args>(args)...);
1098 static_cast<AOSArray64*
>(this->Connectivity.Get()), std::forward<Args>(args)...);
1102 static_cast<AOSArray32*
>(this->Connectivity.Get()), std::forward<Args>(args)...);
1106 static_cast<AOSArray64*
>(this->Connectivity.Get()), std::forward<Args>(args)...);
1110 functor(this->
Offsets.Get(), this->Connectivity.Get(), std::forward<Args>(args)...);
1118 template <typename ArrayT>
1147 CellRangeType GetCellRange(
vtkIdType cellId);
1156 this->
Offsets->InsertNextValue(0);
1159 this->IsInMemkind =
true;
1163 void*
operator new(
size_t nSize)
1166#ifdef VTK_USE_MEMKIND
1173 void operator delete(
void* p)
1175#ifdef VTK_USE_MEMKIND
1196 bool IsInMemkind =
false;
1200 template <
typename Functor,
typename... Args>
1201 using GetReturnType =
decltype(std::declval<Functor>()(
1202 std::declval<VisitState<AOSArray32>&>(), std::declval<Args>()...));
1204 template <
typename Functor,
typename... Args>
1205 struct ReturnsVoid : std::is_same<GetReturnType<Functor, Args...>, void>
1239template <
typename ArrayT>
1242 return this->
Offsets->GetNumberOfValues() - 1;
1245template <
typename ArrayT>
1251template <
typename ArrayT>
1257template <
typename ArrayT>
1263template <
typename ArrayT>
1270VTK_ABI_NAMESPACE_END
1274VTK_ABI_NAMESPACE_BEGIN
1279 template <
class OffsetsT,
class ConnectivityT>
1286 OffsetsAccessorType offsetsAccesor(offsets);
1287 ConnectivityAccessorType connAccesor(conn);
1289 cellId = offsets->GetNumberOfValues() - 1;
1291 offsetsAccesor.InsertNext(
static_cast<ValueType
>(conn->GetNumberOfValues() + npts));
1295 connAccesor.InsertNext(
static_cast<ValueType
>(pts[i]));
1300 template <
class OffsetsT,
class ConnectivityT>
1305 AccessorType offsetsAccesor(offsets);
1307 cellId = offsets->GetNumberOfValues() - 1;
1309 offsetsAccesor.InsertNext(
static_cast<ValueType
>(conn->GetNumberOfValues() + npts));
1316 template <
class OffsetsT,
class ConnectivityT>
1321 auto offsetsRange =
GetRange(offsets);
1322 const ValueType cellBegin = offsetsRange[offsets->GetMaxId() - 1];
1323 offsetsRange[offsets->GetMaxId()] =
static_cast<ValueType
>(cellBegin + npts);
1329 template <
class OffsetsT,
class ConnectivityT>
1331 OffsetsT* offsets, ConnectivityT* vtkNotUsed(conn),
vtkIdType cellId,
vtkIdType& cellSize)
1339 template <
class OffsetsT,
class ConnectivityT>
1342 auto offsetsRange =
GetRange(offsets);
1343 const auto& beginOffset = offsetsRange[cellId];
1344 const auto& endOffset = offsetsRange[cellId + 1];
1346 const auto cellConnectivity =
GetRange(conn).begin() + beginOffset;
1351 for (
vtkIdType i = 0; i < cellSize; ++i)
1353 idPtr[i] =
static_cast<vtkIdType>(cellConnectivity[i]);
1357 template <
class OffsetsT,
class ConnectivityT>
1361 auto offsetsRange =
GetRange(offsets);
1362 const auto& beginOffset = offsetsRange[cellId];
1363 const auto& endOffset = offsetsRange[cellId + 1];
1364 cellSize =
static_cast<vtkIdType>(endOffset - beginOffset);
1365 const auto cellConnectivity =
GetRange(conn).begin() + beginOffset;
1368 for (
vtkIdType i = 0; i < cellSize; ++i)
1370 cellPoints[i] =
static_cast<vtkIdType>(cellConnectivity[i]);
1375 template <
typename ConnectivityT>
1379 std::is_base_of_v<vtkAOSDataArrayTemplate<vtkIdType>, ConnectivityT>;
1382 template <
class OffsetsT,
class ConnectivityT>
1383 typename std::enable_if_t<CanShareConnPtr<ConnectivityT>::value,
void>
operator()(
1387 auto offsetsRange =
GetRange(offsets);
1388 const auto& beginOffset = offsetsRange[cellId];
1389 const auto& endOffset = offsetsRange[cellId + 1];
1390 cellSize =
static_cast<vtkIdType>(endOffset - beginOffset);
1392 cellPoints = conn->GetPointer(beginOffset);
1395 template <
class OffsetsT,
class ConnectivityT>
1396 typename std::enable_if_t<!CanShareConnPtr<ConnectivityT>::value,
void>
operator()(
1400 auto offsetsRange =
GetRange(offsets);
1401 const auto& beginOffset = offsetsRange[cellId];
1402 const auto& endOffset = offsetsRange[cellId + 1];
1403 cellSize =
static_cast<vtkIdType>(endOffset - beginOffset);
1404 const auto cellConnectivity =
GetRange(conn).begin() + beginOffset;
1408 for (
vtkIdType i = 0; i < cellSize; ++i)
1410 tempPtr[i] =
static_cast<vtkIdType>(cellConnectivity[i]);
1413 cellPoints = tempPtr;
1419 template <
class OffsetsT,
class ConnectivityT>
1430 template <
class OffsetsT,
class ConnectivityT>
1437 AccessorType accessor(offsets);
1438 ValueType firstOffset = 0;
1439 accessor.InsertNext(firstOffset);
1445 template <
class OffsetsT,
class ConnectivityT>
1450 AccessorType accessor(conn);
1451 accessor.InsertNext(
static_cast<ValueType
>(
id));
1455VTK_ABI_NAMESPACE_END
1458VTK_ABI_NAMESPACE_BEGIN
1581VTK_ABI_NAMESPACE_END
Array-Of-Structs implementation of vtkGenericDataArray.
virtual vtkIdType GetNumberOfCells() const =0
Get the number of cells in the array.
void GetCellAtId(vtkIdType cellId, vtkIdType &cellSize, vtkIdType const *&cellPoints)
Return the point ids for the cell at cellId.
virtual vtkIdType GetCellSize(vtkIdType cellId) const =0
Return the size of the cell at cellId.
A utility array for wrapping affine functions in implicit arrays.
static vtkAffineArray< ValueType > * FastDownCast(vtkAbstractArray *source)
Encapsulate traversal logic for vtkCellArray.
vtkIdType GetCellSize(vtkIdType cellId) const override
Return the size of the cell at cellId.
vtkDataArray * GetOffsetsArray() const
Return the array used to store cell offsets.
int GetNextCell(vtkIdType &npts, vtkIdType const *&pts)
void UseFixedSizeDefaultStorage(vtkIdType cellSize)
Initialize internal data structures to use 32- or 64-bit storage.
vtkIdType GetOffset(vtkIdType cellId) override
Get the offset (into the connectivity) for a specified cell id.
void UseDefaultStorage()
Initialize internal data structures to use 32- or 64-bit storage.
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.:
static void SetDefaultStorageIs64Bit(bool val)
Control the default internal storage size.
void DeepCopy(vtkAbstractCellArray *ca) override
Perform a deep copy (no reference counting) of the given cell array.
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.:
friend class vtkCellArrayIterator
bool SetData(vtkIdType cellSize, vtkDataArray *connectivity)
Sets the internal arrays to the supported connectivity array with an offsets array automatically gene...
void ShallowCopy(vtkAbstractCellArray *ca) override
Shallow copy ca into this cell array.
vtkIdType GetNumberOfOffsets() const override
Get the number of elements in the offsets array.
bool CanConvertToFixedSize64BitStorage() const
Check if the existing data can safely be converted to use 32- or 64- bit storage.
vtkIdType GetTraversalCellId()
Get/Set the current cellId for traversal.
void SetData(AOSArray64 *, AOSArray64 *connectivity)
Set the internal data arrays to the supplied offsets and connectivity arrays.
vtkIdType GetNumberOfCells() const override
Get the number of cells in the array.
vtkAOSDataArrayTemplate< vtkTypeInt32 > AOSArray32
bool CanConvertToFixedSizeDefaultStorage() const
Check if the existing data can safely be converted to use 32- or 64- bit storage.
vtkIdType GetNumberOfConnectivityIds() const override
Get the size of the connectivity array that stores the point ids.
vtkAOSDataArrayTemplate< vtkTypeInt64 > AOSArray64
bool CanConvertToStorageType(StorageTypes type) const
Check if the existing data can safely be converted to use 32- or 64- bit storage.
void SetData(AffineArray32 *, AOSArray32 *connectivity)
Set the internal data arrays to the supplied offsets and connectivity arrays.
bool ConvertToFixedSize64BitStorage()
Convert internal data structures to use 32- or 64-bit storage.
vtkAffineArray< vtkTypeInt64 > AffineArray64
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...
AOSArray64 * GetOffsetsAOSArray64() const
Return the array used to store cell offsets.
bool AllocateEstimate(vtkIdType numCells, vtkIdType maxCellSize)
Pre-allocate memory in internal data structures.
vtkIdType TraversalCellId
void UseFixedSize64BitStorage(vtkIdType cellSize)
Initialize internal data structures to use 32- or 64-bit storage.
bool IsStorageShareable() const override
bool IsStorageGeneric() const
void Use64BitStorage()
Initialize internal data structures to use 32- or 64-bit storage.
vtkSmartPointer< vtkDataArray > Offsets
vtkDataArray * GetConnectivityArray() const
Return the array used to store the point ids that define the cells' connectivity.
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.
static bool DefaultStorageIs64Bit
bool CanConvertTo32BitStorage() const
Check if the existing data can safely be converted to use 32- or 64- bit storage.
void GetCellAtId(vtkIdType cellId, vtkIdType &cellSize, vtkIdType const *&cellPoints, vtkIdList *ptIds) override
Return the point ids for the cell at cellId.
void SetData(AffineArray64 *, AOSArray64 *connectivity)
Set the internal data arrays to the supplied offsets and connectivity arrays.
void InsertCellPoint(vtkIdType id)
Used in conjunction with InsertNextCell(npts) to add another point to the list of cells.
unsigned long GetActualMemorySize() const
Return the memory in kibibytes (1024 bytes) consumed by this cell array.
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 UseFixedSize32BitStorage(vtkIdType cellSize)
Initialize internal data structures to use 32- or 64-bit storage.
void ReverseCellAtId(vtkIdType cellId)
Reverses the order of the point ids for the specified cell.
bool IsStorage32Bit() const
bool SetData(vtkDataArray *offsets, vtkDataArray *connectivity)
Set the internal data arrays to the supplied offsets and connectivity arrays.
void Initialize() override
Free any memory and reset to an empty state.
void Squeeze()
Reclaim any extra memory while preserving data.
vtkSmartPointer< vtkDataArray > Connectivity
bool IsStorageFixedSize32Bit() const
bool ConvertTo32BitStorage()
Convert internal data structures to use 32- or 64-bit storage.
AffineArray64 * GetOffsetsAffineArray64() const
Return the array used to store cell offsets.
bool ConvertToFixedSizeDefaultStorage()
Convert internal data structures to use 32- or 64-bit storage.
void SetData(AOSArray32 *, AOSArray32 *connectivity)
Set the internal data arrays to the supplied offsets and connectivity arrays.
bool ConvertToStorageType(StorageTypes type)
Convert internal data structures to use 32- or 64-bit storage.
AffineArray32 * GetOffsetsAffineArray32() const
Return the array used to store cell offsets.
void SetOffset(vtkIdType cellId, vtkIdType offset)
Set the offset (into the connectivity) for a specified cell id.
bool ConvertToSmallestStorage()
Convert internal data structures to use 32- or 64-bit storage.
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.
bool ConvertToFixedSize32BitStorage()
Convert internal data structures to use 32- or 64-bit storage.
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.:
vtkAffineArray< vtkTypeInt32 > AffineArray32
void Use32BitStorage()
Initialize internal data structures to use 32- or 64-bit storage.
vtkIdType GetCellPointAtId(vtkIdType cellId, vtkIdType cellPointIndex) const
Return the point id at cellPointIndex for the cell at cellId.
void SetTraversalCellId(vtkIdType cellId)
Get/Set the current cellId for traversal.
bool IsStorageFixedSize64Bit() const
static bool GetDefaultStorageIs64Bit()
Control the default internal storage size.
int GetMaxCellSize() override
Returns the size of the largest cell.
vtkIdType InsertNextCell(vtkCell *cell)
Insert a cell object.
void Dispatch(Functor &&functor, Args &&... args)
AOSArray32 * GetOffsetsAOSArray32() const
Return the array used to store cell offsets.
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.
vtkIdType IsHomogeneous() const override
Check if all cells have the same number of vertices.
void UpdateCellCount(int npts)
Used in conjunction with InsertNextCell(int npts) and InsertCellPoint() to update the number of point...
void Dispatch(Functor &&functor, Args &&... args) const
bool IsStorageFixedSize() const
static vtkCellArray * New()
Standard methods for instantiation, type information, and printing.
StorageTypes GetStorageType() const noexcept
void ReplaceCellPointAtId(vtkIdType cellId, vtkIdType cellPointIndex, vtkIdType newPointId)
Replaces the pointId at cellPointIndex of a cell with newPointId.
bool CanConvertToFixedSize32BitStorage() const
Check if the existing data can safely be converted to use 32- or 64- bit storage.
AOSArray32 * GetConnectivityAOSArray32() const
Return the array used to store the point ids that define the cells' connectivity.
void Append(vtkCellArray *src, vtkIdType pointOffset=0)
Append cells from src into this.
bool IsStorage64Bit() const
void ReplaceCellAtId(vtkIdType cellId, vtkIdType cellSize, const vtkIdType *cellPoints)
Replaces the point ids for the specified cell with the supplied list.
AOSArray64 * GetConnectivityAOSArray64() const
Return the array used to store the point ids that define the cells' connectivity.
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.
static vtkDataArray * FastDownCast(vtkAbstractArray *source)
Perform a fast, safe cast from a vtkAbstractArray to a vtkDataArray.
list of point or cell ids
void SetNumberOfIds(vtkIdType number)
Specify the number of ids for this object to hold.
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(vtkIdType i)
Get a pointer to a particular data index.
dynamic, self-adjusting array of vtkIdType
a simple class to control print indentation
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...
Hold a reference to a vtkObjectBase instance.
static vtkSmartPointer< T > New()
Create an instance of a VTK object.
typename detail::GetAPITypeImpl< ArrayType, ForceValueTypeForVtkDataArray >::APIType GetAPIType
VTK_ITER_INLINE auto DataArrayValueRange(const ArrayTypePtr &array, ValueIdType start=-1, ValueIdType end=-1) -> typename detail::SelectValueRange< ArrayTypePtr, TupleSize, ForceValueTypeForVtkDataArray >::type
Generate an stl and for-range compatible range of flat AOS iterators from a vtkDataArray.
vtkIdType GetNumberOfCells(OffsetsT *offsets)
static vtkIdType GetCellSize(OffsetsT *offsets, vtkIdType cellId)
static vtkIdType GetEndOffset(OffsetsT *offsets, vtkIdType cellId)
static decltype(vtk::DataArrayValueRange< 1, vtkIdType >(std::declval< ConnectivityT >())) GetCellRange(OffsetsT *offsets, ConnectivityT *conn, vtkIdType cellId)
static vtkIdType GetBeginOffset(OffsetsT *offsets, vtkIdType cellId)
static decltype(vtk::DataArrayValueRange< 1, vtkIdType >(std::declval< ArrayT >())) GetRange(ArrayT *array)
vtk::GetAPIType< ArrayT, vtkIdType > GetAPIType
vtkIdType GetNumberOfCells() const
friend class vtkCellArray
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()
void operator()(OffsetsT *offsets, ConnectivityT *conn, vtkIdType cellId, vtkIdType cellPointIndex, vtkIdType &pointId)
static constexpr bool value
void operator()(OffsetsT *offsets, ConnectivityT *conn, const vtkIdType cellId, vtkIdList *ids)
void operator()(OffsetsT *offsets, ConnectivityT *conn, const vtkIdType cellId, vtkIdType &cellSize, vtkIdType *cellPoints)
std::enable_if_t< CanShareConnPtr< ConnectivityT >::value, void > operator()(OffsetsT *offsets, ConnectivityT *conn, const vtkIdType cellId, vtkIdType &cellSize, vtkIdType const *&cellPoints, vtkIdList *temp)
std::enable_if_t<!CanShareConnPtr< ConnectivityT >::value, void > operator()(OffsetsT *offsets, ConnectivityT *conn, const vtkIdType cellId, vtkIdType &cellSize, vtkIdType const *&cellPoints, vtkIdList *temp)
void operator()(OffsetsT *offsets, ConnectivityT *conn, vtkIdType cellId, vtkIdType &cellSize)
void operator()(OffsetsT *offsets, ConnectivityT *conn, vtkIdType id)
void operator()(OffsetsT *offsets, ConnectivityT *conn, const vtkIdType npts, vtkIdType &cellId)
void operator()(OffsetsT *offsets, ConnectivityT *conn, const vtkIdType npts, const vtkIdType pts[], vtkIdType &cellId)
void operator()(OffsetsT *offsets, ConnectivityT *conn)
void operator()(OffsetsT *offsets, ConnectivityT *conn, const vtkIdType npts)
Efficient templated access to vtkDataArray.
STL-compatible iterable ranges that provide access to vtkDataArray elements.
#define VTK_DEPRECATED_IN_9_8_0(reason)
#define VTK_SIZEHINT(...)
#define VTK_MARSHALMANUAL