Shuenhoy/vtk-m
1
0
Fork 0
mirror of https://gitlab.kitware.com/vtk/vtk-m synced 2024-09-16 17:22:55 +00:00
Code Issues 2 Actions Packages Projects Releases Wiki Activity

Add ChangeLog

Browse Source
This commit is contained in:
Li-Ta Lo 2021-12-13 09:23:35 -07:00
parent 0e3cc80767
commit 161391656a
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/changelog/NewFitlerInterface.md Normal file
View File

@ -0,0 +1,20 @@
## New Filter Interface Design ##
An overhaul of the Filter interface is undergoing. This refactoring effort will
address many problems we faced in the old design. The most important one is to
remove the requirement to compiler every single Filter users with a Device Compiler.
This is addressed by removing C++ template (and CRTP) from Filter and is subclasses.
A new non-templated NewFilter class is added with many old templated public interface
removed.
This new design also made Filter implementations thread-safe by default. Filter
implementations are encouraged to take advantage of the new design and removing
shared metatable states from their `DoExecute`, see Docygen documentation in
NewFilter.h
Filter implementrations are also re-orgnized into submodules, with each submodile
in its own `vtkm/filter` subdirectory. User should update their code to include
the new header files for example, `vtkm/filter/field_transform/GenerateIds.h`and
link to submoudle library file, for example, `libvtkm_filter_field_transform.so`.
To maintain backward compatability, old `vtkm/filter/FooFilter.h` header files
can still be used but will be deprecated in release 2.0.