Shuenhoy/vtk-m
1
0
Fork 0
mirror of https://gitlab.kitware.com/vtk/vtk-m synced 2024-09-08 13:23:51 +00:00
Code Issues 2 Actions Packages Projects Releases Wiki Activity
fc3845ec89
vtk-m/docs/changelog/arrayhandle-getcomponents.md
Kenneth Moreland 9b992dcdde Add GetNumberOfComponentsFlat method to ArrayHandle 
Getting the number of components (or the number of flattened components)
from an `ArrayHandle` is usually trivial. However, if the `ArrayHandle` is
special in that the number of components is specified at runtime, then it
becomes much more difficult to determine.

Getting the number of components is most important when extracting
component arrays (or reconstructions using component arrays) with
`UnknownArrayHandle`. Previously, `UnknownArrayHandle` used a hack to get
the number of components, which mostly worked but broke down when wrapping
a runtime array inside another array such as `ArrayHandleView`.

To prevent this issue, the ability to get the number of components has been
added to `ArrayHandle` proper. All `Storage` objects for `ArrayHandle`s now
need a method named `GetNumberOfComponentsFlat`. The implementation of this
method is usually trivial. The `ArrayHandle` template now also provides a
`GetNumberOfComponentsFlat` method that gets this information from the
`Storage`. This provides an easy access point for the `UnknownArrayHandle`
to pull this information.
2023-10-03 10:31:38 -04:00

1.1 KiB
Raw Blame History

Add GetNumberOfComponentsFlat method to ArrayHandle

Getting the number of components (or the number of flattened components) from an ArrayHandle is usually trivial. However, if the ArrayHandle is special in that the number of components is specified at runtime, then it becomes much more difficult to determine.

Getting the number of components is most important when extracting component arrays (or reconstructions using component arrays) with UnknownArrayHandle. Previously, UnknownArrayHandle used a hack to get the number of components, which mostly worked but broke down when wrapping a runtime array inside another array such as ArrayHandleView.

To prevent this issue, the ability to get the number of components has been added to ArrayHandle proper. All Storage objects for ArrayHandles now need a method named GetNumberOfComponentsFlat. The implementation of this method is usually trivial. The ArrayHandle template now also provides a GetNumberOfComponentsFlat method that gets this information from the Storage. This provides an easy access point for the UnknownArrayHandle to pull this information.