Shuenhoy/vtk-m
1
0
Fork 0
mirror of https://gitlab.kitware.com/vtk/vtk-m synced 2024-09-19 18:45:43 +00:00
Code Issues 2 Actions Packages Projects Releases Wiki Activity
ddf630da1c
vtk-m/vtkm/ListTag.h

217 lines
5.3 KiB
C
Raw Normal View History

Add tag-based type list templates Provies a list of types in a template like boost::mpl::vector and a method to call a functor on each type. However, rather than explicitly list each type, uses tags to identify the list. This provides the following main advantages: 1. Can use these type lists without creating horrendously long class names based on them, making compiler errors easier to read. For example, you would have a typename like MyClass<TypeListTagVectors> instead of MyClass<TypeList<Id3,Vector2,Vector3,Vector4> > (or worse if variadic templates are not supported). This is the main motivation for this implementation. 2. Do not require variadic templates and usually few constructions. That should speed compile times. There is one main disadvantage to this approach: It is difficult to get a printed list of items in a list during an error. If necessary, it probably would not be too hard to make a template to convert a tag to a boost mpl vector.
2014-03-31 21:28:09 +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_ListTag_h
#define vtk_m_ListTag_h
#include <vtkm/internal/ExportMacros.h>
namespace vtkm {
namespace detail {
Add classes to manage point coordinates. Each type of point coordinates has its own class with the name PointCoordinates*. Currently there is a PointCoordiantesArray that contains an ArrayHandle holding the point coordinates and a PointCoordinatesUniform that takes the standard extent, origin, and spacing for a uniform rectilinear grid and defines point coordiantes for that. Creating new PointCoordinates arrays is pretty easy, and we will almost definitely add more. For example, we should have an elevation version that takes uniform coordinates for a 2D grid and then an elevation in the third dimension. We can probably also use a basic composite point coordinates that can build them from other coordinates. There is also a DynamicPointCoordinates class that polymorphically stores an instance of a PointCoordinates class. It has a CastAndCall method that behaves like DynamicArrayHandle; it can call a functor with an array handle (possible implicit) that holds the point coordinates.
2014-05-14 21:05:38 +00:00
struct ListEmpty { };
Add tag-based type list templates Provies a list of types in a template like boost::mpl::vector and a method to call a functor on each type. However, rather than explicitly list each type, uses tags to identify the list. This provides the following main advantages: 1. Can use these type lists without creating horrendously long class names based on them, making compiler errors easier to read. For example, you would have a typename like MyClass<TypeListTagVectors> instead of MyClass<TypeList<Id3,Vector2,Vector3,Vector4> > (or worse if variadic templates are not supported). This is the main motivation for this implementation. 2. Do not require variadic templates and usually few constructions. That should speed compile times. There is one main disadvantage to this approach: It is difficult to get a printed list of items in a list during an error. If necessary, it probably would not be too hard to make a template to convert a tag to a boost mpl vector.
2014-03-31 21:28:09 +00:00
template<typename T>
struct ListBase { };
template<typename T1, typename T2>
struct ListBase2 { };
template<typename T1, typename T2, typename T3>
struct ListBase3 { };
template<typename T1, typename T2, typename T3, typename T4>
struct ListBase4 { };
template<typename ListTag1, typename ListTag2>
struct ListJoin { };
} // namespace detail
template<typename T> struct ListTagBase;
Add classes to manage point coordinates. Each type of point coordinates has its own class with the name PointCoordinates*. Currently there is a PointCoordiantesArray that contains an ArrayHandle holding the point coordinates and a PointCoordinatesUniform that takes the standard extent, origin, and spacing for a uniform rectilinear grid and defines point coordiantes for that. Creating new PointCoordinates arrays is pretty easy, and we will almost definitely add more. For example, we should have an elevation version that takes uniform coordinates for a 2D grid and then an elevation in the third dimension. We can probably also use a basic composite point coordinates that can build them from other coordinates. There is also a DynamicPointCoordinates class that polymorphically stores an instance of a PointCoordinates class. It has a CastAndCall method that behaves like DynamicArrayHandle; it can call a functor with an array handle (possible implicit) that holds the point coordinates.
2014-05-14 21:05:38 +00:00
/// A special tag for an empty list.
///
struct ListTagEmpty {
typedef detail::ListEmpty List;
};
Add tag-based type list templates Provies a list of types in a template like boost::mpl::vector and a method to call a functor on each type. However, rather than explicitly list each type, uses tags to identify the list. This provides the following main advantages: 1. Can use these type lists without creating horrendously long class names based on them, making compiler errors easier to read. For example, you would have a typename like MyClass<TypeListTagVectors> instead of MyClass<TypeList<Id3,Vector2,Vector3,Vector4> > (or worse if variadic templates are not supported). This is the main motivation for this implementation. 2. Do not require variadic templates and usually few constructions. That should speed compile times. There is one main disadvantage to this approach: It is difficult to get a printed list of items in a list during an error. If necessary, it probably would not be too hard to make a template to convert a tag to a boost mpl vector.
2014-03-31 21:28:09 +00:00
/// A basic tag for a list of one typename. This struct can be subclassed
/// and still behave like a list tag.
template<typename T>
struct ListTagBase {
typedef detail::ListBase<T> List;
};
/// A basic tag for a list of two typenames. This struct can be subclassed
/// and still behave like a list tag.
template<typename T1, typename T2>
struct ListTagBase2 {
typedef detail::ListBase2<T1, T2> List;
};
/// A basic tag for a list of three typenames. This struct can be subclassed
/// and still behave like a list tag.
template<typename T1, typename T2, typename T3>
struct ListTagBase3 {
typedef detail::ListBase3<T1, T2, T3> List;
};
/// A basic tag for a list of four typenames. This struct can be subclassed
/// and still behave like a list tag.
template<typename T1, typename T2, typename T3, typename T4>
struct ListTagBase4 {
typedef detail::ListBase4<T1, T2, T3, T4> List;
};
/// A tag that is a construction of two other tags joined together. This struct
/// can be subclassed and still behave like a list tag.
template<typename ListTag1, typename ListTag2>
struct ListTagJoin {
typedef detail::ListJoin<ListTag1, ListTag2> List;
};
template<typename Functor, typename ListTag>
VTKM_CONT_EXPORT
void ListForEach(Functor &f, ListTag);
template<typename Functor, typename ListTag>
VTKM_CONT_EXPORT
void ListForEach(const Functor &f, ListTag);
namespace detail {
Add classes to manage point coordinates. Each type of point coordinates has its own class with the name PointCoordinates*. Currently there is a PointCoordiantesArray that contains an ArrayHandle holding the point coordinates and a PointCoordinatesUniform that takes the standard extent, origin, and spacing for a uniform rectilinear grid and defines point coordiantes for that. Creating new PointCoordinates arrays is pretty easy, and we will almost definitely add more. For example, we should have an elevation version that takes uniform coordinates for a 2D grid and then an elevation in the third dimension. We can probably also use a basic composite point coordinates that can build them from other coordinates. There is also a DynamicPointCoordinates class that polymorphically stores an instance of a PointCoordinates class. It has a CastAndCall method that behaves like DynamicArrayHandle; it can call a functor with an array handle (possible implicit) that holds the point coordinates.
2014-05-14 21:05:38 +00:00
template<typename Functor>
VTKM_CONT_EXPORT
void ListForEachImpl(Functor, ListEmpty)
{
// Nothing to do for empty list
}
Add tag-based type list templates Provies a list of types in a template like boost::mpl::vector and a method to call a functor on each type. However, rather than explicitly list each type, uses tags to identify the list. This provides the following main advantages: 1. Can use these type lists without creating horrendously long class names based on them, making compiler errors easier to read. For example, you would have a typename like MyClass<TypeListTagVectors> instead of MyClass<TypeList<Id3,Vector2,Vector3,Vector4> > (or worse if variadic templates are not supported). This is the main motivation for this implementation. 2. Do not require variadic templates and usually few constructions. That should speed compile times. There is one main disadvantage to this approach: It is difficult to get a printed list of items in a list during an error. If necessary, it probably would not be too hard to make a template to convert a tag to a boost mpl vector.
2014-03-31 21:28:09 +00:00
template<typename Functor, typename T>
VTKM_CONT_EXPORT
void ListForEachImpl(Functor &f, ListBase<T>)
{
f(T());
}
template<typename Functor, typename T1, typename T2>
VTKM_CONT_EXPORT
void ListForEachImpl(Functor &f, ListBase2<T1,T2>)
{
f(T1());
f(T2());
}
template<typename Functor, typename T1, typename T2, typename T3>
VTKM_CONT_EXPORT
void ListForEachImpl(Functor &f, ListBase3<T1,T2,T3>)
{
f(T1());
f(T2());
f(T3());
}
template<typename Functor, typename T1, typename T2, typename T3, typename T4>
VTKM_CONT_EXPORT
void ListForEachImpl(Functor &f, ListBase4<T1,T2,T3,T4>)
{
f(T1());
f(T2());
f(T3());
f(T4());
}
template<typename Functor, typename ListTag1, typename ListTag2>
VTKM_CONT_EXPORT
void ListForEachImpl(Functor &f, ListJoin<ListTag1, ListTag2>)
{
vtkm::ListForEach(f, ListTag1());
vtkm::ListForEach(f, ListTag2());
}
template<typename Functor, typename T>
VTKM_CONT_EXPORT
void ListForEachImpl(const Functor &f, ListBase<T>)
{
f(T());
}
template<typename Functor, typename T1, typename T2>
VTKM_CONT_EXPORT
void ListForEachImpl(const Functor &f, ListBase2<T1,T2>)
{
f(T1());
f(T2());
}
template<typename Functor, typename T1, typename T2, typename T3>
VTKM_CONT_EXPORT
void ListForEachImpl(const Functor &f, ListBase3<T1,T2,T3>)
{
f(T1());
f(T2());
f(T3());
}
template<typename Functor, typename T1, typename T2, typename T3, typename T4>
VTKM_CONT_EXPORT
void ListForEachImpl(const Functor &f, ListBase4<T1,T2,T3,T4>)
{
f(T1());
f(T2());
f(T3());
f(T4());
}
template<typename Functor, typename ListTag1, typename ListTag2>
VTKM_CONT_EXPORT
void ListForEachImpl(const Functor &f, ListJoin<ListTag1, ListTag2>)
{
vtkm::ListForEach(f, ListTag1());
vtkm::ListForEach(f, ListTag2());
}
} // namespace detail
/// For each typename represented by the list tag, call the functor with a
/// default instance of that type.
///
template<typename Functor, typename ListTag>
VTKM_CONT_EXPORT
void ListForEach(Functor &f, ListTag)
{
detail::ListForEachImpl(f, typename ListTag::List());
}
/// For each typename represented by the list tag, call the functor with a
/// default instance of that type.
///
template<typename Functor, typename ListTag>
VTKM_CONT_EXPORT
void ListForEach(const Functor &f, ListTag)
{
detail::ListForEachImpl(f, typename ListTag::List());
}
} // namespace vtkm
#endif //vtk_m_ListTag_h
Reference in New Issue Copy Permalink