21823500c3
After a talk with Robert Maynard, we decided to change the name ArrayContainerControl to Storage. There are several reasons for this change. 1. The name ArrayContainerControl is unwieldy. It is long, hard for humans to parse, and makes for long lines and wraparound. It is also hard to distinguish from other names like ArrayHandleFoo and ArrayExecutionManager. 2. The word container is getting overloaded. For example, there is a SimplePolymorphicContainer. Container is being used for an object that literally acts like a container for data. This class really manages data. 3. The data does not necessarily have to be on the control side. Implicit containers store the data nowhere. Derivative containers might have all the real data on the execution side. It is possible in the future to have storage on the execution environment instead of the control (think interfacing with a simulator on the GPU). Storage is not a perfect word (what does implicit storage really mean?), but its the best English word we came up with.
337 lines
12 KiB
C++
337 lines
12 KiB
C++
//============================================================================
|
|
// 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_cont_DynamicArrayHandle_h
|
|
#define vtk_m_cont_DynamicArrayHandle_h
|
|
|
|
#include <vtkm/TypeListTag.h>
|
|
|
|
#include <vtkm/cont/ArrayHandle.h>
|
|
#include <vtkm/cont/ErrorControlBadValue.h>
|
|
#include <vtkm/cont/StorageListTag.h>
|
|
|
|
#include <vtkm/cont/internal/DynamicTransform.h>
|
|
#include <vtkm/cont/internal/SimplePolymorphicContainer.h>
|
|
|
|
#include <boost/smart_ptr/shared_ptr.hpp>
|
|
#include <boost/utility/enable_if.hpp>
|
|
|
|
namespace vtkm {
|
|
namespace cont {
|
|
|
|
namespace internal {
|
|
|
|
/// Behaves like (and is interchangable with) a DynamicArrayHandle. The
|
|
/// difference is that the list of types and list of storage to try when
|
|
/// calling CastAndCall is set to the class template arguments.
|
|
///
|
|
template<typename TypeList, typename StorageList>
|
|
class DynamicArrayHandleCast;
|
|
|
|
} // namespace internal
|
|
|
|
/// \brief Holds an array handle without having to specify template parameters.
|
|
///
|
|
/// \c DynamicArrayHandle holds an \c ArrayHandle object using runtime
|
|
/// polymorphism to manage different value types and storage rather than
|
|
/// compile-time templates. This adds a programming convienience that helps
|
|
/// avoid a proliferation of templates. It also provides the management
|
|
/// necessary to interface VTK-m with data sources where types will not be
|
|
/// known until runtime.
|
|
///
|
|
/// To interface between the runtime polymorphism and the templated algorithms
|
|
/// in VTK-m, \c DynamicArrayHandle contains a method named \c CastAndCall that
|
|
/// will determine the correct type from some known list of types and storage
|
|
/// objects. This mechanism is used internally by VTK-m's worklet invocation
|
|
/// mechanism to determine the type when running algorithms.
|
|
///
|
|
/// By default, \c DynamicArrayHandle will assume that the value type in the
|
|
/// array matches one of the types specified by \c VTKM_DEFAULT_TYPE_LIST_TAG
|
|
/// and the storage matches one of the tags specified by \c
|
|
/// VTKM_DEFAULT_STORAGE_LIST_TAG. These lists can be changed by using the \c
|
|
/// ResetTypeList and \c ResetStorageList methods, respectively. It is
|
|
/// worthwhile to match these lists closely to the possible types that might be
|
|
/// used. If a type is missing you will get a runtime error. If there are more
|
|
/// types than necessary, then the template mechanism will create a lot of
|
|
/// object code that is never used, and keep in mind that the number of
|
|
/// combinations grows exponentally when using multiple \c DynamicArrayHandle
|
|
/// objects.
|
|
///
|
|
class DynamicArrayHandle
|
|
{
|
|
public:
|
|
VTKM_CONT_EXPORT
|
|
DynamicArrayHandle() { }
|
|
|
|
template<typename Type, typename Storage>
|
|
VTKM_CONT_EXPORT
|
|
DynamicArrayHandle(const vtkm::cont::ArrayHandle<Type,Storage> &array)
|
|
: ArrayStorage(new vtkm::cont::internal::SimplePolymorphicContainer<
|
|
vtkm::cont::ArrayHandle<Type,Storage> >(array))
|
|
{ }
|
|
|
|
template<typename TypeList, typename StorageList>
|
|
VTKM_CONT_EXPORT
|
|
DynamicArrayHandle(
|
|
const internal::DynamicArrayHandleCast<TypeList,StorageList> &dynamicArray)
|
|
: ArrayStorage(dynamicArray.ArrayStorage) { }
|
|
|
|
/// Returns true if this array is of the provided type and uses the provided
|
|
/// storage.
|
|
///
|
|
template<typename Type, typename Storage>
|
|
VTKM_CONT_EXPORT
|
|
bool IsTypeAndStorage(Type = Type(), Storage = Storage()) const {
|
|
return (this->TryCastStorage<Type,Storage>() != NULL);
|
|
}
|
|
|
|
/// Returns this array cast to an ArrayHandle object of the given type and
|
|
/// storage. Throws ErrorControlBadValue if the cast does not work. Use
|
|
/// IsTypeAndStorage to check if the cast can happen.
|
|
///
|
|
template<typename Type, typename Storage>
|
|
VTKM_CONT_EXPORT
|
|
vtkm::cont::ArrayHandle<Type, Storage>
|
|
CastToArrayHandle(Type = Type(), Storage = Storage()) const {
|
|
vtkm::cont::internal::SimplePolymorphicContainer<
|
|
vtkm::cont::ArrayHandle<Type,Storage> > *container =
|
|
this->TryCastStorage<Type,Storage>();
|
|
if (container == NULL)
|
|
{
|
|
throw vtkm::cont::ErrorControlBadValue("Bad cast of dynamic array.");
|
|
}
|
|
return container->Item;
|
|
}
|
|
|
|
/// Changes the types to try casting to when resolving this dynamic array,
|
|
/// which is specified with a list tag like those in TypeListTag.h. Since C++
|
|
/// does not allow you to actually change the template arguments, this method
|
|
/// returns a new dynamic array object. This method is particularly useful to
|
|
/// narrow down (or expand) the types when using an array of particular
|
|
/// constraints.
|
|
///
|
|
template<typename NewTypeList>
|
|
VTKM_CONT_EXPORT
|
|
internal::DynamicArrayHandleCast<NewTypeList,VTKM_DEFAULT_STORAGE_LIST_TAG>
|
|
ResetTypeList(NewTypeList = NewTypeList()) const {
|
|
return internal::DynamicArrayHandleCast<
|
|
NewTypeList,VTKM_DEFAULT_STORAGE_LIST_TAG>(*this);
|
|
}
|
|
|
|
/// Changes the array storage types to try casting to when resolving this
|
|
/// dynamic array, which is specified with a list tag like those in
|
|
/// StorageListTag.h. Since C++ does not allow you to actually change the
|
|
/// template arguments, this method returns a new dynamic array object. This
|
|
/// method is particularly useful to narrow down (or expand) the types when
|
|
/// using an array of particular constraints.
|
|
///
|
|
template<typename NewStorageList>
|
|
VTKM_CONT_EXPORT
|
|
internal::DynamicArrayHandleCast<VTKM_DEFAULT_TYPE_LIST_TAG,NewStorageList>
|
|
ResetStorageList(NewStorageList = NewStorageList()) const {
|
|
return internal::DynamicArrayHandleCast<
|
|
VTKM_DEFAULT_TYPE_LIST_TAG,NewStorageList>(*this);
|
|
}
|
|
|
|
/// Attempts to cast the held array to a specific value type and storage,
|
|
/// then call the given functor with the cast array. The types and storage
|
|
/// tried in the cast are those in the lists defined by
|
|
/// VTKM_DEFAULT_TYPE_LIST_TAG and VTK_DEFAULT_STORAGE_LIST_TAG,
|
|
/// respectively, unless they have been changed with a previous call to
|
|
/// ResetTypeList or ResetStorageList.
|
|
///
|
|
template<typename Functor>
|
|
VTKM_CONT_EXPORT
|
|
void CastAndCall(const Functor &f) const
|
|
{
|
|
this->CastAndCall(
|
|
f, VTKM_DEFAULT_TYPE_LIST_TAG(), VTKM_DEFAULT_STORAGE_LIST_TAG());
|
|
}
|
|
|
|
/// A version of CastAndCall that tries specified lists of types and
|
|
/// storage types.
|
|
///
|
|
template<typename Functor, typename TypeList, typename StorageList>
|
|
VTKM_CONT_EXPORT
|
|
void CastAndCall(const Functor &f, TypeList, StorageList) const;
|
|
|
|
private:
|
|
boost::shared_ptr<vtkm::cont::internal::SimplePolymorphicContainerBase>
|
|
ArrayStorage;
|
|
|
|
template<typename Type, typename Storage>
|
|
VTKM_CONT_EXPORT
|
|
vtkm::cont::internal::SimplePolymorphicContainer<
|
|
vtkm::cont::ArrayHandle<Type,Storage> > *
|
|
TryCastStorage() const {
|
|
return
|
|
dynamic_cast<
|
|
vtkm::cont::internal::SimplePolymorphicContainer<
|
|
vtkm::cont::ArrayHandle<Type,Storage> > *>(
|
|
this->ArrayStorage.get());
|
|
}
|
|
};
|
|
|
|
namespace detail {
|
|
|
|
template<typename Functor, typename Type>
|
|
struct DynamicArrayHandleTryStorage {
|
|
const DynamicArrayHandle Array;
|
|
const Functor &Function;
|
|
bool FoundCast;
|
|
|
|
VTKM_CONT_EXPORT
|
|
DynamicArrayHandleTryStorage(const DynamicArrayHandle &array,
|
|
const Functor &f)
|
|
: Array(array), Function(f), FoundCast(false) { }
|
|
|
|
template<typename Storage>
|
|
VTKM_CONT_EXPORT
|
|
typename boost::enable_if<
|
|
typename vtkm::cont::internal::IsValidArrayHandle<Type,Storage>::type
|
|
>::type
|
|
operator()(Storage) {
|
|
if (!this->FoundCast &&
|
|
this->Array.IsTypeAndStorage(Type(), Storage()))
|
|
{
|
|
this->Function(this->Array.CastToArrayHandle(Type(), Storage()));
|
|
this->FoundCast = true;
|
|
}
|
|
}
|
|
|
|
template<typename Storage>
|
|
VTKM_CONT_EXPORT
|
|
typename boost::disable_if<
|
|
typename vtkm::cont::internal::IsValidArrayHandle<Type,Storage>::type
|
|
>::type
|
|
operator()(Storage) {
|
|
// This type of array handle cannot exist, so do nothing.
|
|
}
|
|
};
|
|
|
|
template<typename Functor, typename StorageList>
|
|
struct DynamicArrayHandleTryType {
|
|
const DynamicArrayHandle Array;
|
|
const Functor &Function;
|
|
bool FoundCast;
|
|
|
|
VTKM_CONT_EXPORT
|
|
DynamicArrayHandleTryType(const DynamicArrayHandle &array, const Functor &f)
|
|
: Array(array), Function(f), FoundCast(false) { }
|
|
|
|
template<typename Type>
|
|
VTKM_CONT_EXPORT
|
|
void operator()(Type) {
|
|
if (this->FoundCast) { return; }
|
|
typedef DynamicArrayHandleTryStorage<Functor, Type> TryStorageType;
|
|
TryStorageType tryStorage =
|
|
TryStorageType(this->Array, this->Function);
|
|
vtkm::ListForEach(tryStorage, StorageList());
|
|
if (tryStorage.FoundCast)
|
|
{
|
|
this->FoundCast = true;
|
|
}
|
|
}
|
|
};
|
|
|
|
} // namespace detail
|
|
|
|
template<typename Functor, typename TypeList, typename StorageList>
|
|
VTKM_CONT_EXPORT
|
|
void DynamicArrayHandle::CastAndCall(const Functor &f,
|
|
TypeList,
|
|
StorageList) const
|
|
{
|
|
typedef detail::DynamicArrayHandleTryType<Functor, StorageList> TryTypeType;
|
|
TryTypeType tryType = TryTypeType(*this, f);
|
|
vtkm::ListForEach(tryType, TypeList());
|
|
if (!tryType.FoundCast)
|
|
{
|
|
throw vtkm::cont::ErrorControlBadValue(
|
|
"Could not find appropriate cast for array in CastAndCall.");
|
|
}
|
|
}
|
|
|
|
namespace internal {
|
|
|
|
template<typename TypeList, typename StorageList>
|
|
class DynamicArrayHandleCast : public vtkm::cont::DynamicArrayHandle
|
|
{
|
|
public:
|
|
VTKM_CONT_EXPORT
|
|
DynamicArrayHandleCast() : DynamicArrayHandle() { }
|
|
|
|
VTKM_CONT_EXPORT
|
|
DynamicArrayHandleCast(const vtkm::cont::DynamicArrayHandle &array)
|
|
: DynamicArrayHandle(array) { }
|
|
|
|
template<typename SrcTypeList, typename SrcStorageList>
|
|
VTKM_CONT_EXPORT
|
|
DynamicArrayHandleCast(
|
|
const DynamicArrayHandleCast<SrcTypeList,SrcStorageList> &array)
|
|
: DynamicArrayHandle(array) { }
|
|
|
|
template<typename NewTypeList>
|
|
VTKM_CONT_EXPORT
|
|
DynamicArrayHandleCast<NewTypeList,StorageList>
|
|
ResetTypeList(NewTypeList = NewTypeList()) const {
|
|
return DynamicArrayHandleCast<NewTypeList,StorageList>(*this);
|
|
}
|
|
|
|
template<typename NewStorageList>
|
|
VTKM_CONT_EXPORT
|
|
internal::DynamicArrayHandleCast<TypeList,NewStorageList>
|
|
ResetStorageList(NewStorageList = NewStorageList()) const {
|
|
return internal::DynamicArrayHandleCast<TypeList,NewStorageList>(*this);
|
|
}
|
|
|
|
template<typename Functor>
|
|
VTKM_CONT_EXPORT
|
|
void CastAndCall(const Functor &f) const
|
|
{
|
|
this->CastAndCall(f, TypeList(), StorageList());
|
|
}
|
|
|
|
template<typename Functor, typename TL, typename CL>
|
|
VTKM_CONT_EXPORT
|
|
void CastAndCall(const Functor &f, TL, CL) const
|
|
{
|
|
this->DynamicArrayHandle::CastAndCall(f, TL(), CL());
|
|
}
|
|
};
|
|
|
|
template<>
|
|
struct DynamicTransformTraits<vtkm::cont::DynamicArrayHandle> {
|
|
typedef vtkm::cont::internal::DynamicTransformTagCastAndCall DynamicTag;
|
|
};
|
|
|
|
template<typename TypeList, typename StorageList>
|
|
struct DynamicTransformTraits<
|
|
vtkm::cont::internal::DynamicArrayHandleCast<TypeList,StorageList> >
|
|
{
|
|
typedef vtkm::cont::internal::DynamicTransformTagCastAndCall DynamicTag;
|
|
};
|
|
|
|
} // namespace internal
|
|
|
|
}
|
|
} // namespace vtkm::cont
|
|
|
|
#endif //vtk_m_cont_DynamicArrayHandle_h
|