VTK  9.7.20261120
vtk::keys::KeysBase< TKey, TElementId, TKeyId > Class Template Reference

#include <vtkKeys.h>

Detailed Description

template<typename TKey, typename TElementId, typename TKeyId>
class vtk::keys::KeysBase< TKey, TElementId, TKeyId >

What DenseKeys and SparseKeys share, and all that Reduce(), Group(), Compact() and ForEachKeyRange() use: the first element of every key id, the elements of key id k being at [GetOffset(k), GetOffset(k + 1)) of the Output.

KeyIdType is the type of the key ids.

Definition at line 149 of file vtkKeys.h.

Inheritance diagram for vtk::keys::KeysBase< TKey, TElementId, TKeyId >:
[legend]

Public Types

using KeyType = TKey
using ElementIdType = TElementId
using KeyIdType = TKeyId

Public Member Functions

vtkIdType GetNumberOfRecords () const
vtkIdType GetNumberOfElements () const
KeyIdType GetNumberOfKeys () const
ElementIdType GetOffset (KeyIdType keyId) const
 The first element of a key id, 0 <= keyId <= GetNumberOfKeys().
const ElementIdType * GetOffsets () const
 The first element of every key id, GetNumberOfKeys() + 1 values, nullptr without element.
ElementIdType GetNumberOfElementsOfKey (KeyIdType keyId) const

Protected Member Functions

void ResetBase ()
void CopyBaseFrom (const KeysBase &other)

Protected Attributes

vtkIdType NumberOfRecords = 0
vtkIdType NumberOfElements = 0
KeyIdType NumberOfKeys = 0
std::unique_ptr< ElementIdType[]> Offsets

Member Typedef Documentation

◆ KeyType

template<typename TKey, typename TElementId, typename TKeyId>
using vtk::keys::KeysBase< TKey, TElementId, TKeyId >::KeyType = TKey

Definition at line 152 of file vtkKeys.h.

◆ ElementIdType

template<typename TKey, typename TElementId, typename TKeyId>
using vtk::keys::KeysBase< TKey, TElementId, TKeyId >::ElementIdType = TElementId

Definition at line 153 of file vtkKeys.h.

◆ KeyIdType

template<typename TKey, typename TElementId, typename TKeyId>
using vtk::keys::KeysBase< TKey, TElementId, TKeyId >::KeyIdType = TKeyId

Definition at line 154 of file vtkKeys.h.

Member Function Documentation

◆ GetNumberOfRecords()

template<typename TKey, typename TElementId, typename TKeyId>
vtkIdType vtk::keys::KeysBase< TKey, TElementId, TKeyId >::GetNumberOfRecords ( ) const
inline

Definition at line 158 of file vtkKeys.h.

◆ GetNumberOfElements()

template<typename TKey, typename TElementId, typename TKeyId>
vtkIdType vtk::keys::KeysBase< TKey, TElementId, TKeyId >::GetNumberOfElements ( ) const
inline

Definition at line 159 of file vtkKeys.h.

◆ GetNumberOfKeys()

template<typename TKey, typename TElementId, typename TKeyId>
KeyIdType vtk::keys::KeysBase< TKey, TElementId, TKeyId >::GetNumberOfKeys ( ) const
inline

Definition at line 160 of file vtkKeys.h.

◆ GetOffset()

template<typename TKey, typename TElementId, typename TKeyId>
ElementIdType vtk::keys::KeysBase< TKey, TElementId, TKeyId >::GetOffset ( KeyIdType keyId) const
inline

The first element of a key id, 0 <= keyId <= GetNumberOfKeys().

Definition at line 165 of file vtkKeys.h.

◆ GetOffsets()

template<typename TKey, typename TElementId, typename TKeyId>
const ElementIdType * vtk::keys::KeysBase< TKey, TElementId, TKeyId >::GetOffsets ( ) const
inline

The first element of every key id, GetNumberOfKeys() + 1 values, nullptr without element.

Definition at line 170 of file vtkKeys.h.

◆ GetNumberOfElementsOfKey()

template<typename TKey, typename TElementId, typename TKeyId>
ElementIdType vtk::keys::KeysBase< TKey, TElementId, TKeyId >::GetNumberOfElementsOfKey ( KeyIdType keyId) const
inline

Definition at line 172 of file vtkKeys.h.

◆ ResetBase()

template<typename TKey, typename TElementId, typename TKeyId>
void vtk::keys::KeysBase< TKey, TElementId, TKeyId >::ResetBase ( )
inlineprotected

Definition at line 178 of file vtkKeys.h.

◆ CopyBaseFrom()

template<typename TKey, typename TElementId, typename TKeyId>
void vtk::keys::KeysBase< TKey, TElementId, TKeyId >::CopyBaseFrom ( const KeysBase< TKey, TElementId, TKeyId > & other)
inlineprotected

Definition at line 186 of file vtkKeys.h.

Member Data Documentation

◆ NumberOfRecords

template<typename TKey, typename TElementId, typename TKeyId>
vtkIdType vtk::keys::KeysBase< TKey, TElementId, TKeyId >::NumberOfRecords = 0
protected

Definition at line 192 of file vtkKeys.h.

◆ NumberOfElements

template<typename TKey, typename TElementId, typename TKeyId>
vtkIdType vtk::keys::KeysBase< TKey, TElementId, TKeyId >::NumberOfElements = 0
protected

Definition at line 193 of file vtkKeys.h.

◆ NumberOfKeys

template<typename TKey, typename TElementId, typename TKeyId>
KeyIdType vtk::keys::KeysBase< TKey, TElementId, TKeyId >::NumberOfKeys = 0
protected

Definition at line 194 of file vtkKeys.h.

◆ Offsets

template<typename TKey, typename TElementId, typename TKeyId>
std::unique_ptr<ElementIdType[]> vtk::keys::KeysBase< TKey, TElementId, TKeyId >::Offsets
protected

Definition at line 195 of file vtkKeys.h.


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