Shuenhoy/vtk-m
1
0
Fork 0
mirror of https://gitlab.kitware.com/vtk/vtk-m synced 2024-09-20 02:55:47 +00:00
Code Issues 2 Actions Packages Projects Releases Wiki Activity
dee28a3089
vtk-m/vtkm/filter/PolicyBase.h

159 lines
6.1 KiB
C
Raw Normal View History

First draft of vtkm::filter design.
2016-01-19 14:59:31 +00:00
//============================================================================
// Copyright (c) Kitware, Inc.
// All rights reserved.
// See LICENSE.txt for details.
// This software is distributed WITHOUT ANY WARRANTY; without even
// the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
// PURPOSE. See the above copyright notice for more information.
//
// Copyright 2014 Sandia Corporation.
// Copyright 2014 UT-Battelle, LLC.
// Copyright 2014 Los Alamos National Security.
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Under the terms of Contract DE-AC52-06NA25396 with Los Alamos National
// Laboratory (LANL), the U.S. Government retains certain rights in
// this software.
//============================================================================
#ifndef vtk_m_filter_PolicyBase_h
#define vtk_m_filter_PolicyBase_h
Allow all policies to inherit defaults Previously, all declared policies had to implement every tag required by the policy, even if it was the same as the default. In addition to being annoying, this makes us less forward compatible because if we add a new item to the policy any unchanged policy would become incorrect. This change moves the default policy declarations from the default policy to PolicyBase. The default policy inherits all of them without any change. Other policies need only override those that are different than the default.
2016-11-23 21:00:49 +00:00
#include <vtkm/TypeListTag.h>
#include <vtkm/cont/CellSetListTag.h>
First draft of vtkm::filter design.
2016-01-19 14:59:31 +00:00
#include <vtkm/cont/CoordinateSystem.h>
Allow all policies to inherit defaults Previously, all declared policies had to implement every tag required by the policy, even if it was the same as the default. In addition to being annoying, this makes us less forward compatible because if we add a new item to the policy any unchanged policy would become incorrect. This change moves the default policy declarations from the default policy to PolicyBase. The default policy inherits all of them without any change. Other policies need only override those that are different than the default.
2016-11-23 21:00:49 +00:00
#include <vtkm/cont/DeviceAdapterListTag.h>
First draft of vtkm::filter design.
2016-01-19 14:59:31 +00:00
#include <vtkm/cont/DynamicCellSet.h>
#include <vtkm/cont/Field.h>
Allow all policies to inherit defaults Previously, all declared policies had to implement every tag required by the policy, even if it was the same as the default. In addition to being annoying, this makes us less forward compatible because if we add a new item to the policy any unchanged policy would become incorrect. This change moves the default policy declarations from the default policy to PolicyBase. The default policy inherits all of them without any change. Other policies need only override those that are different than the default.
2016-11-23 21:00:49 +00:00
#include <vtkm/cont/StorageListTag.h>
First draft of vtkm::filter design.
2016-01-19 14:59:31 +00:00
#include <vtkm/filter/FilterTraits.h>
namespace vtkm {
namespace filter {
template<typename Derived>
Allow all policies to inherit defaults Previously, all declared policies had to implement every tag required by the policy, even if it was the same as the default. In addition to being annoying, this makes us less forward compatible because if we add a new item to the policy any unchanged policy would become incorrect. This change moves the default policy declarations from the default policy to PolicyBase. The default policy inherits all of them without any change. Other policies need only override those that are different than the default.
2016-11-23 21:00:49 +00:00
struct PolicyBase
First draft of vtkm::filter design.
2016-01-19 14:59:31 +00:00
{
Allow all policies to inherit defaults Previously, all declared policies had to implement every tag required by the policy, even if it was the same as the default. In addition to being annoying, this makes us less forward compatible because if we add a new item to the policy any unchanged policy would become incorrect. This change moves the default policy declarations from the default policy to PolicyBase. The default policy inherits all of them without any change. Other policies need only override those that are different than the default.
2016-11-23 21:00:49 +00:00
typedef VTKM_DEFAULT_TYPE_LIST_TAG FieldTypeList;
typedef VTKM_DEFAULT_STORAGE_LIST_TAG FieldStorageList;
typedef vtkm::cont::CellSetListTagStructured StructuredCellSetList;
typedef vtkm::cont::CellSetListTagUnstructured UnstructuredCellSetList;
typedef VTKM_DEFAULT_CELL_SET_LIST_TAG AllCellSetList;
First draft of vtkm::filter design.
2016-01-19 14:59:31 +00:00
Allow all policies to inherit defaults Previously, all declared policies had to implement every tag required by the policy, even if it was the same as the default. In addition to being annoying, this makes us less forward compatible because if we add a new item to the policy any unchanged policy would become incorrect. This change moves the default policy declarations from the default policy to PolicyBase. The default policy inherits all of them without any change. Other policies need only override those that are different than the default.
2016-11-23 21:00:49 +00:00
typedef VTKM_DEFAULT_COORDINATE_SYSTEM_TYPE_LIST_TAG CoordinateTypeList;
typedef VTKM_DEFAULT_COORDINATE_SYSTEM_STORAGE_LIST_TAG CoordinateStorageList;
First draft of vtkm::filter design.
2016-01-19 14:59:31 +00:00
Allow all policies to inherit defaults Previously, all declared policies had to implement every tag required by the policy, even if it was the same as the default. In addition to being annoying, this makes us less forward compatible because if we add a new item to the policy any unchanged policy would become incorrect. This change moves the default policy declarations from the default policy to PolicyBase. The default policy inherits all of them without any change. Other policies need only override those that are different than the default.
2016-11-23 21:00:49 +00:00
// List of backends to try in sequence (if one fails, the next is attempted).
typedef VTKM_DEFAULT_DEVICE_ADAPTER_LIST_TAG DeviceAdapterList;
First draft of vtkm::filter design.
2016-01-19 14:59:31 +00:00
};
//-----------------------------------------------------------------------------
template<typename DerivedPolicy>
Remove exports for header-only functions/methods Change the VTKM_CONT_EXPORT to VTKM_CONT. (Likewise for EXEC and EXEC_CONT.) Remove the inline from these macros so that they can be applied to everything, including implementations in a library. Because inline is not declared in these modifies, you have to add the keyword to functions and methods where the implementation is not inlined in the class.
2016-10-19 22:42:58 +00:00
VTKM_CONT
First draft of vtkm::filter design.
2016-01-19 14:59:31 +00:00
vtkm::cont::DynamicArrayHandleBase<
typename DerivedPolicy::FieldTypeList,
typename DerivedPolicy::FieldStorageList
>
Renamed the ```Convert``` method to ```ApplyPolicy``` The original name was a really bad name, so thank to Ken for suggesting a better name.
2016-02-15 16:38:51 +00:00
ApplyPolicy(const vtkm::cont::Field& field,
const vtkm::filter::PolicyBase<DerivedPolicy>&)
First draft of vtkm::filter design.
2016-01-19 14:59:31 +00:00
{
typedef typename DerivedPolicy::FieldTypeList TypeList;
typedef typename DerivedPolicy::FieldStorageList StorageList;
return field.GetData().ResetTypeAndStorageLists(TypeList(),StorageList());
}
//-----------------------------------------------------------------------------
template<typename DerivedPolicy, typename FilterType>
Remove exports for header-only functions/methods Change the VTKM_CONT_EXPORT to VTKM_CONT. (Likewise for EXEC and EXEC_CONT.) Remove the inline from these macros so that they can be applied to everything, including implementations in a library. Because inline is not declared in these modifies, you have to add the keyword to functions and methods where the implementation is not inlined in the class.
2016-10-19 22:42:58 +00:00
VTKM_CONT
First draft of vtkm::filter design.
2016-01-19 14:59:31 +00:00
vtkm::cont::DynamicArrayHandleBase<
vtkm::filter now deduces the subset of valid field types. Previously the ApplyPolicy logic was to use the filters field set, and ignore the policy field set. But this caused problems, as a filter couldn't express that it was able to work on all valid types. This caused certain complex types Vec of Vec's to fail to work properly, and would cause compile use code paths that would never be valid for a given policy.
2016-12-29 22:27:27 +00:00
typename vtkm::filter::DeduceFilterFieldTypes<DerivedPolicy, FilterType>::TypeList,
typename DerivedPolicy::FieldStorageList
>
Renamed the ```Convert``` method to ```ApplyPolicy``` The original name was a really bad name, so thank to Ken for suggesting a better name.
2016-02-15 16:38:51 +00:00
ApplyPolicy(const vtkm::cont::Field& field,
const vtkm::filter::PolicyBase<DerivedPolicy>&,
const vtkm::filter::FilterTraits<FilterType>&)
First draft of vtkm::filter design.
2016-01-19 14:59:31 +00:00
{
vtkm::filter now deduces the subset of valid field types. Previously the ApplyPolicy logic was to use the filters field set, and ignore the policy field set. But this caused problems, as a filter couldn't express that it was able to work on all valid types. This caused certain complex types Vec of Vec's to fail to work properly, and would cause compile use code paths that would never be valid for a given policy.
2016-12-29 22:27:27 +00:00
typedef typename vtkm::filter::DeduceFilterFieldTypes<
DerivedPolicy, FilterType>::TypeList TypeList;
First draft of vtkm::filter design.
2016-01-19 14:59:31 +00:00
typedef typename DerivedPolicy::FieldStorageList StorageList;
return field.GetData().ResetTypeAndStorageLists(TypeList(),StorageList());
}
//-----------------------------------------------------------------------------
template<typename DerivedPolicy>
Remove exports for header-only functions/methods Change the VTKM_CONT_EXPORT to VTKM_CONT. (Likewise for EXEC and EXEC_CONT.) Remove the inline from these macros so that they can be applied to everything, including implementations in a library. Because inline is not declared in these modifies, you have to add the keyword to functions and methods where the implementation is not inlined in the class.
2016-10-19 22:42:58 +00:00
VTKM_CONT
First draft of vtkm::filter design.
2016-01-19 14:59:31 +00:00
vtkm::cont::DynamicArrayHandleBase<
typename DerivedPolicy::CoordinateTypeList,
typename DerivedPolicy::CoordinateStorageList
>
Renamed the ```Convert``` method to ```ApplyPolicy``` The original name was a really bad name, so thank to Ken for suggesting a better name.
2016-02-15 16:38:51 +00:00
ApplyPolicy(const vtkm::cont::CoordinateSystem& coordinates,
const vtkm::filter::PolicyBase<DerivedPolicy>&)
First draft of vtkm::filter design.
2016-01-19 14:59:31 +00:00
{
typedef typename DerivedPolicy::CoordinateTypeList TypeList;
typedef typename DerivedPolicy::CoordinateStorageList StorageList;
return coordinates.GetData().ResetTypeAndStorageLists(TypeList(),StorageList());
}
//-----------------------------------------------------------------------------
template<typename DerivedPolicy, typename FilterType>
Remove exports for header-only functions/methods Change the VTKM_CONT_EXPORT to VTKM_CONT. (Likewise for EXEC and EXEC_CONT.) Remove the inline from these macros so that they can be applied to everything, including implementations in a library. Because inline is not declared in these modifies, you have to add the keyword to functions and methods where the implementation is not inlined in the class.
2016-10-19 22:42:58 +00:00
VTKM_CONT
First draft of vtkm::filter design.
2016-01-19 14:59:31 +00:00
vtkm::cont::DynamicArrayHandleBase<
Fix ApplyPolicy for CoordinateSystem objects There was a mismatch in the ApplyPolicy function for CoordinateSystem objects. The return type declared for the function was not the same as the type of object actually returned. Also added a test that actually uses a filter with a CoordinateSystem as a field to actually test this functionality.
2016-10-23 00:01:42 +00:00
typename DerivedPolicy::CoordinateTypeList,
typename DerivedPolicy::CoordinateStorageList
>
Renamed the ```Convert``` method to ```ApplyPolicy``` The original name was a really bad name, so thank to Ken for suggesting a better name.
2016-02-15 16:38:51 +00:00
ApplyPolicy(const vtkm::cont::CoordinateSystem& coordinates,
const vtkm::filter::PolicyBase<DerivedPolicy>&,
const vtkm::filter::FilterTraits<FilterType>&)
First draft of vtkm::filter design.
2016-01-19 14:59:31 +00:00
{
//todo: we need to intersect the policy field type list and the
//filter traits to the get smallest set of valid types
Properly use the policy to determine the coordiante policy conversions.
2016-03-29 14:12:49 +00:00
typedef typename DerivedPolicy::CoordinateTypeList TypeList;
First draft of vtkm::filter design.
2016-01-19 14:59:31 +00:00
typedef typename DerivedPolicy::CoordinateStorageList StorageList;
return coordinates.GetData().ResetTypeAndStorageLists(TypeList(),StorageList());
}
//-----------------------------------------------------------------------------
template<typename DerivedPolicy>
Remove exports for header-only functions/methods Change the VTKM_CONT_EXPORT to VTKM_CONT. (Likewise for EXEC and EXEC_CONT.) Remove the inline from these macros so that they can be applied to everything, including implementations in a library. Because inline is not declared in these modifies, you have to add the keyword to functions and methods where the implementation is not inlined in the class.
2016-10-19 22:42:58 +00:00
VTKM_CONT
Allow filters to have finer control on what cell sets they support Certain algorithms like VertexClustering only work on certain cellset types. It is pointless to generate the code paths for structured data cell sets, when the algorithm can't operate on those dataset types.
2016-05-26 15:25:51 +00:00
vtkm::cont::DynamicCellSetBase< typename DerivedPolicy::AllCellSetList >
Renamed the ```Convert``` method to ```ApplyPolicy``` The original name was a really bad name, so thank to Ken for suggesting a better name.
2016-02-15 16:38:51 +00:00
ApplyPolicy(const vtkm::cont::DynamicCellSet& cellset,
const vtkm::filter::PolicyBase<DerivedPolicy>&)
First draft of vtkm::filter design.
2016-01-19 14:59:31 +00:00
{
Allow filters to have finer control on what cell sets they support Certain algorithms like VertexClustering only work on certain cellset types. It is pointless to generate the code paths for structured data cell sets, when the algorithm can't operate on those dataset types.
2016-05-26 15:25:51 +00:00
typedef typename DerivedPolicy::AllCellSetList CellSetList;
return cellset.ResetCellSetList(CellSetList());
}
//-----------------------------------------------------------------------------
template<typename DerivedPolicy>
Remove exports for header-only functions/methods Change the VTKM_CONT_EXPORT to VTKM_CONT. (Likewise for EXEC and EXEC_CONT.) Remove the inline from these macros so that they can be applied to everything, including implementations in a library. Because inline is not declared in these modifies, you have to add the keyword to functions and methods where the implementation is not inlined in the class.
2016-10-19 22:42:58 +00:00
VTKM_CONT
Allow filters to have finer control on what cell sets they support Certain algorithms like VertexClustering only work on certain cellset types. It is pointless to generate the code paths for structured data cell sets, when the algorithm can't operate on those dataset types.
2016-05-26 15:25:51 +00:00
vtkm::cont::DynamicCellSetBase< typename DerivedPolicy::StructuredCellSetList >
ApplyPolicyStructured(const vtkm::cont::DynamicCellSet& cellset,
const vtkm::filter::PolicyBase<DerivedPolicy>&)
{
typedef typename DerivedPolicy::StructuredCellSetList CellSetList;
return cellset.ResetCellSetList(CellSetList());
}
//-----------------------------------------------------------------------------
template<typename DerivedPolicy>
Remove exports for header-only functions/methods Change the VTKM_CONT_EXPORT to VTKM_CONT. (Likewise for EXEC and EXEC_CONT.) Remove the inline from these macros so that they can be applied to everything, including implementations in a library. Because inline is not declared in these modifies, you have to add the keyword to functions and methods where the implementation is not inlined in the class.
2016-10-19 22:42:58 +00:00
VTKM_CONT
Allow filters to have finer control on what cell sets they support Certain algorithms like VertexClustering only work on certain cellset types. It is pointless to generate the code paths for structured data cell sets, when the algorithm can't operate on those dataset types.
2016-05-26 15:25:51 +00:00
vtkm::cont::DynamicCellSetBase< typename DerivedPolicy::UnstructuredCellSetList >
ApplyPolicyUnstructured(const vtkm::cont::DynamicCellSet& cellset,
const vtkm::filter::PolicyBase<DerivedPolicy>&)
{
typedef typename DerivedPolicy::UnstructuredCellSetList CellSetList;
First draft of vtkm::filter design.
2016-01-19 14:59:31 +00:00
return cellset.ResetCellSetList(CellSetList());
}
}
}
Add missing new lines and #endif comments to vtkm::filter
2016-04-07 21:09:11 +00:00
#endif //vtk_m_filter_PolicyBase_h
Reference in New Issue Copy Permalink