2014-02-10 18:57:46 +00:00
|
|
|
//============================================================================
|
|
|
|
// Copyright (c) Kitware, Inc.
|
|
|
|
// All rights reserved.
|
|
|
|
// See LICENSE.txt for details.
|
2019-04-15 23:24:21 +00:00
|
|
|
//
|
2014-02-10 18:57:46 +00:00
|
|
|
// 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.
|
|
|
|
//============================================================================
|
2014-10-07 23:27:31 +00:00
|
|
|
#ifndef vtk_m_VecTraits_h
|
|
|
|
#define vtk_m_VecTraits_h
|
2014-02-10 18:57:46 +00:00
|
|
|
|
|
|
|
#include <vtkm/Types.h>
|
|
|
|
|
2017-05-18 14:29:41 +00:00
|
|
|
namespace vtkm
|
|
|
|
{
|
2014-02-10 18:57:46 +00:00
|
|
|
|
|
|
|
/// A tag for vectors that are "true" vectors (i.e. have more than one
|
|
|
|
/// component).
|
|
|
|
///
|
2017-05-18 14:29:41 +00:00
|
|
|
struct VecTraitsTagMultipleComponents
|
|
|
|
{
|
|
|
|
};
|
2014-02-10 18:57:46 +00:00
|
|
|
|
2014-10-07 23:27:31 +00:00
|
|
|
/// A tag for vectors that are really just scalars (i.e. have only one
|
|
|
|
/// component)
|
2014-02-10 18:57:46 +00:00
|
|
|
///
|
2017-05-18 14:29:41 +00:00
|
|
|
struct VecTraitsTagSingleComponent
|
|
|
|
{
|
|
|
|
};
|
2014-02-10 18:57:46 +00:00
|
|
|
|
2015-08-07 23:58:52 +00:00
|
|
|
/// A tag for vectors where the number of components are known at compile time.
|
|
|
|
///
|
2017-05-18 14:29:41 +00:00
|
|
|
struct VecTraitsTagSizeStatic
|
|
|
|
{
|
|
|
|
};
|
2015-08-07 23:58:52 +00:00
|
|
|
|
|
|
|
/// A tag for vectors where the number of components are not determined until
|
|
|
|
/// run time.
|
|
|
|
///
|
2017-05-18 14:29:41 +00:00
|
|
|
struct VecTraitsTagSizeVariable
|
|
|
|
{
|
|
|
|
};
|
2015-08-07 23:58:52 +00:00
|
|
|
|
2017-05-18 14:29:41 +00:00
|
|
|
namespace internal
|
|
|
|
{
|
2014-02-10 18:57:46 +00:00
|
|
|
|
2017-05-18 14:29:41 +00:00
|
|
|
template <vtkm::IdComponent numComponents>
|
2014-10-07 23:27:31 +00:00
|
|
|
struct VecTraitsMultipleComponentChooser
|
2014-02-11 21:20:30 +00:00
|
|
|
{
|
2017-06-23 18:50:34 +00:00
|
|
|
using Type = vtkm::VecTraitsTagMultipleComponents;
|
2014-02-10 18:57:46 +00:00
|
|
|
};
|
|
|
|
|
2017-05-18 14:29:41 +00:00
|
|
|
template <>
|
2014-10-07 23:27:31 +00:00
|
|
|
struct VecTraitsMultipleComponentChooser<1>
|
2014-02-11 21:20:30 +00:00
|
|
|
{
|
2017-06-23 18:50:34 +00:00
|
|
|
using Type = vtkm::VecTraitsTagSingleComponent;
|
2014-02-10 18:57:46 +00:00
|
|
|
};
|
|
|
|
|
2019-06-06 21:28:47 +00:00
|
|
|
} // namespace internal
|
2014-02-10 18:57:46 +00:00
|
|
|
|
2014-10-07 23:27:31 +00:00
|
|
|
/// The VecTraits class gives several static members that define how
|
2014-02-10 18:57:46 +00:00
|
|
|
/// to use a given type as a vector.
|
|
|
|
///
|
2017-05-18 14:29:41 +00:00
|
|
|
template <class VecType>
|
2019-06-06 21:28:47 +00:00
|
|
|
struct VTKM_NEVER_EXPORT VecTraits
|
2014-02-10 18:57:46 +00:00
|
|
|
{
|
2019-06-06 21:28:47 +00:00
|
|
|
#ifdef VTKM_DOXYGEN_ONLY
|
2019-09-03 03:52:56 +00:00
|
|
|
/// \brief Type of the components in the vector.
|
|
|
|
///
|
|
|
|
/// If the type is really a scalar, then the component type is the same as the scalar type.
|
2014-02-10 18:57:46 +00:00
|
|
|
///
|
2017-06-23 18:50:34 +00:00
|
|
|
using ComponentType = typename VecType::ComponentType;
|
2014-02-10 18:57:46 +00:00
|
|
|
|
2019-09-03 03:52:56 +00:00
|
|
|
/// \brief Base component type in the vector.
|
|
|
|
///
|
|
|
|
/// Similar to ComponentType except that for nested vectors (e.g. Vec<Vec<T, M>, N>), it
|
|
|
|
/// returns the base scalar type at the end of the composition (T in this example).
|
|
|
|
///
|
|
|
|
using BaseComponentType = typename vtkm::VecTraits<ComponentType>::BaseComponentType;
|
|
|
|
|
2015-08-20 12:50:19 +00:00
|
|
|
/// \brief Number of components in the vector.
|
|
|
|
///
|
|
|
|
/// This is only defined for vectors of a static size.
|
2014-02-10 18:57:46 +00:00
|
|
|
///
|
2018-02-27 14:25:25 +00:00
|
|
|
static constexpr vtkm::IdComponent NUM_COMPONENTS = VecType::NUM_COMPONENTS;
|
2014-02-10 18:57:46 +00:00
|
|
|
|
2015-08-07 23:58:52 +00:00
|
|
|
/// Number of components in the given vector.
|
|
|
|
///
|
2017-05-18 14:29:41 +00:00
|
|
|
static vtkm::IdComponent GetNumberOfComponents(const VecType& vec);
|
2015-08-07 23:58:52 +00:00
|
|
|
|
2015-08-20 12:50:19 +00:00
|
|
|
/// \brief A tag specifying whether this vector has multiple components (i.e. is a "real" vector).
|
|
|
|
///
|
|
|
|
/// This tag can be useful for creating specialized functions when a vector
|
|
|
|
/// is really just a scalar.
|
2014-02-10 18:57:46 +00:00
|
|
|
///
|
2017-06-23 18:50:34 +00:00
|
|
|
using HasMultipleComponents =
|
|
|
|
typename internal::VecTraitsMultipleComponentChooser<NUM_COMPONENTS>::Type;
|
2014-02-10 18:57:46 +00:00
|
|
|
|
2015-08-20 12:50:19 +00:00
|
|
|
/// \brief A tag specifying whether the size of this vector is known at compile time.
|
|
|
|
///
|
|
|
|
/// If set to \c VecTraitsTagSizeStatic, then \c NUM_COMPONENTS is set. If
|
|
|
|
/// set to \c VecTraitsTagSizeVariable, then the number of components is not
|
|
|
|
/// known at compile time and must be queried with \c GetNumberOfComponents.
|
2015-08-07 23:58:52 +00:00
|
|
|
///
|
2017-06-23 18:50:34 +00:00
|
|
|
using IsSizeStatic = vtkm::VecTraitsTagSizeStatic;
|
2015-08-07 23:58:52 +00:00
|
|
|
|
2014-02-10 18:57:46 +00:00
|
|
|
/// Returns the value in a given component of the vector.
|
|
|
|
///
|
2017-05-18 14:29:41 +00:00
|
|
|
VTKM_EXEC_CONT static const ComponentType& GetComponent(
|
2017-05-26 17:53:28 +00:00
|
|
|
const typename std::remove_const<VecType>::type& vector,
|
|
|
|
vtkm::IdComponent component);
|
2017-05-18 14:29:41 +00:00
|
|
|
VTKM_EXEC_CONT static ComponentType& GetComponent(
|
2017-05-26 17:53:28 +00:00
|
|
|
typename std::remove_const<VecType>::type& vector,
|
|
|
|
vtkm::IdComponent component);
|
2014-02-10 18:57:46 +00:00
|
|
|
|
|
|
|
/// Changes the value in a given component of the vector.
|
|
|
|
///
|
2017-05-26 17:53:28 +00:00
|
|
|
VTKM_EXEC_CONT static void SetComponent(VecType& vector,
|
|
|
|
vtkm::IdComponent component,
|
2017-05-18 14:29:41 +00:00
|
|
|
ComponentType value);
|
2014-02-10 18:57:46 +00:00
|
|
|
|
2019-09-03 03:52:56 +00:00
|
|
|
/// \brief Get a vector of the same type but with a different component.
|
|
|
|
///
|
|
|
|
/// This type resolves to another vector with a different component type. For example,
|
2020-06-01 15:36:07 +00:00
|
|
|
/// @code vtkm::VecTraits<vtkm::Vec<T, N>>::ReplaceComponentType<T2> @endcode is vtkm::Vec<T2, N>.
|
|
|
|
/// This replacement is not recursive. So @code VecTraits<Vec<Vec<T, M>, N>::ReplaceComponentType<T2> @endcode
|
2019-09-03 03:52:56 +00:00
|
|
|
/// is vtkm::Vec<T2, N>.
|
|
|
|
///
|
|
|
|
template <typename NewComponentType>
|
|
|
|
using ReplaceComponentType = VecTemplate<NewComponentType, N>;
|
|
|
|
|
|
|
|
/// \brief Get a vector of the same type but with a different base component.
|
|
|
|
///
|
|
|
|
/// This type resolves to another vector with a different base component type. The replacement
|
|
|
|
/// is recursive for nested types. For example,
|
2021-02-01 16:35:00 +00:00
|
|
|
/// @code VecTraits<Vec<Vec<T, M>, N>::ReplaceBaseComponentType<T2> @endcode is Vec<Vec<T2, M>, N>.
|
2019-09-03 03:52:56 +00:00
|
|
|
///
|
|
|
|
template <typename NewComponentType>
|
|
|
|
using ReplaceBaseComponentType = VecTemplate<
|
|
|
|
typename VecTraits<ComponentType>::template ReplaceBaseComponentType<NewComponentType>,
|
|
|
|
N>;
|
|
|
|
|
2015-08-13 22:53:34 +00:00
|
|
|
/// Copies the components in the given vector into a given Vec object.
|
2014-02-10 18:57:46 +00:00
|
|
|
///
|
2017-05-18 14:29:41 +00:00
|
|
|
template <vktm::IdComponent destSize>
|
|
|
|
VTKM_EXEC_CONT static void CopyInto(const VecType& src, vtkm::Vec<ComponentType, destSize>& dest);
|
2014-02-10 18:57:46 +00:00
|
|
|
#endif // VTKM_DOXYGEN_ONLY
|
2019-06-06 21:28:47 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
namespace detail
|
|
|
|
{
|
|
|
|
|
2019-08-07 14:04:06 +00:00
|
|
|
template <typename T>
|
|
|
|
struct HasVecTraitsImpl
|
|
|
|
{
|
|
|
|
template <typename A, typename S = typename vtkm::VecTraits<A>::ComponentType>
|
|
|
|
static std::true_type Test(A*);
|
2019-06-06 21:28:47 +00:00
|
|
|
|
2019-08-07 14:04:06 +00:00
|
|
|
static std::false_type Test(...);
|
|
|
|
|
|
|
|
using Type = decltype(Test(std::declval<T*>()));
|
|
|
|
};
|
2019-06-06 21:28:47 +00:00
|
|
|
|
|
|
|
} // namespace detail
|
|
|
|
|
|
|
|
/// \brief Determines whether the given type has VecTraits defined.
|
|
|
|
///
|
|
|
|
/// If the given type T has a valid VecTraits class, then HasVecTraits<T> will be set to
|
|
|
|
/// std::true_type. Otherwise it will be set to std::false_type. For example,
|
|
|
|
/// HasVecTraits<vtkm::Id> is the same as std::true_type whereas HasVecTraits<void *> is the same
|
|
|
|
/// as std::false_type. This is useful to block the definition of methods using VecTraits when
|
|
|
|
/// VecTraits are not defined.
|
|
|
|
///
|
|
|
|
template <typename T>
|
2019-08-07 14:04:06 +00:00
|
|
|
using HasVecTraits = typename detail::HasVecTraitsImpl<T>::Type;
|
2014-02-10 18:57:46 +00:00
|
|
|
|
|
|
|
// This partial specialization allows you to define a non-const version of
|
2014-10-07 23:27:31 +00:00
|
|
|
// VecTraits and have it still work for const version.
|
2014-02-10 18:57:46 +00:00
|
|
|
//
|
2017-05-18 14:29:41 +00:00
|
|
|
template <typename T>
|
2019-06-06 21:28:47 +00:00
|
|
|
struct VTKM_NEVER_EXPORT VecTraits<const T> : VecTraits<T>
|
2017-05-18 14:29:41 +00:00
|
|
|
{
|
|
|
|
};
|
2014-02-10 18:57:46 +00:00
|
|
|
|
2019-09-19 15:54:44 +00:00
|
|
|
#if defined(VTKM_GCC) && (__GNUC__ <= 5)
|
2019-09-13 00:12:02 +00:00
|
|
|
namespace detail
|
|
|
|
{
|
|
|
|
|
|
|
|
template <typename NewT, vtkm::IdComponent Size>
|
2019-09-19 15:54:44 +00:00
|
|
|
struct VecReplaceComponentTypeGCC4or5
|
2019-09-13 00:12:02 +00:00
|
|
|
{
|
|
|
|
using type = vtkm::Vec<NewT, Size>;
|
|
|
|
};
|
|
|
|
|
|
|
|
template <typename T, vtkm::IdComponent Size, typename NewT>
|
2019-09-19 15:54:44 +00:00
|
|
|
struct VecReplaceBaseComponentTypeGCC4or5
|
2019-09-13 00:12:02 +00:00
|
|
|
{
|
|
|
|
using type =
|
|
|
|
vtkm::Vec<typename vtkm::VecTraits<T>::template ReplaceBaseComponentType<NewT>, Size>;
|
|
|
|
};
|
|
|
|
|
|
|
|
} // namespace detail
|
|
|
|
#endif // GCC Version 4.8
|
|
|
|
|
2017-05-18 14:29:41 +00:00
|
|
|
template <typename T, vtkm::IdComponent Size>
|
2019-06-06 21:28:47 +00:00
|
|
|
struct VTKM_NEVER_EXPORT VecTraits<vtkm::Vec<T, Size>>
|
2014-02-10 18:57:46 +00:00
|
|
|
{
|
2017-06-23 18:50:34 +00:00
|
|
|
using VecType = vtkm::Vec<T, Size>;
|
2014-02-10 18:57:46 +00:00
|
|
|
|
2019-09-03 03:52:56 +00:00
|
|
|
/// \brief Type of the components in the vector.
|
|
|
|
///
|
|
|
|
/// If the type is really a scalar, then the component type is the same as the scalar type.
|
2014-02-10 18:57:46 +00:00
|
|
|
///
|
2017-06-23 18:50:34 +00:00
|
|
|
using ComponentType = typename VecType::ComponentType;
|
2014-02-10 18:57:46 +00:00
|
|
|
|
2019-09-03 03:52:56 +00:00
|
|
|
/// \brief Base component type in the vector.
|
|
|
|
///
|
|
|
|
/// Similar to ComponentType except that for nested vectors (e.g. Vec<Vec<T, M>, N>), it
|
|
|
|
/// returns the base scalar type at the end of the composition (T in this example).
|
|
|
|
///
|
|
|
|
using BaseComponentType = typename vtkm::VecTraits<ComponentType>::BaseComponentType;
|
|
|
|
|
2014-02-10 18:57:46 +00:00
|
|
|
/// Number of components in the vector.
|
|
|
|
///
|
2018-02-27 14:25:25 +00:00
|
|
|
static constexpr vtkm::IdComponent NUM_COMPONENTS = VecType::NUM_COMPONENTS;
|
2014-02-10 18:57:46 +00:00
|
|
|
|
2015-08-07 23:58:52 +00:00
|
|
|
/// Number of components in the given vector.
|
|
|
|
///
|
2016-10-19 22:42:58 +00:00
|
|
|
VTKM_EXEC_CONT
|
2017-05-18 14:29:41 +00:00
|
|
|
static vtkm::IdComponent GetNumberOfComponents(const VecType&) { return NUM_COMPONENTS; }
|
2015-08-07 23:58:52 +00:00
|
|
|
|
2014-02-10 18:57:46 +00:00
|
|
|
/// A tag specifying whether this vector has multiple components (i.e. is a
|
|
|
|
/// "real" vector). This tag can be useful for creating specialized functions
|
|
|
|
/// when a vector is really just a scalar.
|
|
|
|
///
|
2017-06-23 18:50:34 +00:00
|
|
|
using HasMultipleComponents =
|
|
|
|
typename internal::VecTraitsMultipleComponentChooser<NUM_COMPONENTS>::Type;
|
2014-02-10 18:57:46 +00:00
|
|
|
|
2015-08-07 23:58:52 +00:00
|
|
|
/// A tag specifying whether the size of this vector is known at compile
|
|
|
|
/// time. If set to \c VecTraitsTagSizeStatic, then \c NUM_COMPONENTS is set.
|
|
|
|
/// If set to \c VecTraitsTagSizeVariable, then the number of components is
|
|
|
|
/// not known at compile time and must be queried with \c
|
|
|
|
/// GetNumberOfComponents.
|
|
|
|
///
|
2017-06-23 18:50:34 +00:00
|
|
|
using IsSizeStatic = vtkm::VecTraitsTagSizeStatic;
|
2015-08-07 23:58:52 +00:00
|
|
|
|
2014-02-10 18:57:46 +00:00
|
|
|
/// Returns the value in a given component of the vector.
|
|
|
|
///
|
2016-10-19 22:42:58 +00:00
|
|
|
VTKM_EXEC_CONT
|
2017-05-18 14:29:41 +00:00
|
|
|
static const ComponentType& GetComponent(const VecType& vector, vtkm::IdComponent component)
|
2014-02-10 18:57:46 +00:00
|
|
|
{
|
|
|
|
return vector[component];
|
|
|
|
}
|
2016-10-19 22:42:58 +00:00
|
|
|
VTKM_EXEC_CONT
|
2017-05-18 14:29:41 +00:00
|
|
|
static ComponentType& GetComponent(VecType& vector, vtkm::IdComponent component)
|
|
|
|
{
|
2014-02-10 18:57:46 +00:00
|
|
|
return vector[component];
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Changes the value in a given component of the vector.
|
|
|
|
///
|
2017-05-26 17:53:28 +00:00
|
|
|
VTKM_EXEC_CONT static void SetComponent(VecType& vector,
|
|
|
|
vtkm::IdComponent component,
|
2017-05-18 14:29:41 +00:00
|
|
|
ComponentType value)
|
|
|
|
{
|
2014-02-10 18:57:46 +00:00
|
|
|
vector[component] = value;
|
|
|
|
}
|
|
|
|
|
2019-09-13 00:12:02 +00:00
|
|
|
/// \brief Get a vector of the same type but with a different component.
|
|
|
|
///
|
|
|
|
/// This type resolves to another vector with a different component type. For example,
|
2020-06-01 15:36:07 +00:00
|
|
|
/// @code vtkm::VecTraits<vtkm::Vec<T, N>>::ReplaceComponentType<T2> @endcode is vtkm::Vec<T2, N>.
|
|
|
|
/// This replacement is not recursive. So @code VecTraits<Vec<Vec<T, M>, N>::ReplaceComponentType<T2> @endcode
|
2019-09-13 00:12:02 +00:00
|
|
|
/// is vtkm::Vec<T2, N>.
|
|
|
|
///@{
|
2019-09-19 15:54:44 +00:00
|
|
|
#if defined(VTKM_GCC) && (__GNUC__ <= 5)
|
2019-09-19 16:30:59 +00:00
|
|
|
// Silly workaround for bug in GCC <= 5
|
2019-09-13 00:12:02 +00:00
|
|
|
template <typename NewComponentType>
|
|
|
|
using ReplaceComponentType =
|
2019-09-19 15:54:44 +00:00
|
|
|
typename detail::VecReplaceComponentTypeGCC4or5<NewComponentType, Size>::type;
|
2019-09-19 16:30:59 +00:00
|
|
|
#else // !GCC <= 5
|
2019-09-03 03:52:56 +00:00
|
|
|
template <typename NewComponentType>
|
|
|
|
using ReplaceComponentType = vtkm::Vec<NewComponentType, Size>;
|
2019-09-13 00:12:02 +00:00
|
|
|
#endif
|
|
|
|
///@}
|
2019-09-03 03:52:56 +00:00
|
|
|
|
2019-09-13 00:12:02 +00:00
|
|
|
/// \brief Get a vector of the same type but with a different base component.
|
|
|
|
///
|
|
|
|
/// This type resolves to another vector with a different base component type. The replacement
|
|
|
|
/// is recursive for nested types. For example,
|
2020-06-01 15:36:07 +00:00
|
|
|
/// @code VecTraits<Vec<Vec<T, M>, N>::ReplaceComponentType<T2> @endcode is Vec<Vec<T2, M>, N>.
|
2019-09-13 00:12:02 +00:00
|
|
|
///@{
|
2019-09-19 15:54:44 +00:00
|
|
|
#if defined(VTKM_GCC) && (__GNUC__ <= 5)
|
2019-09-19 16:30:59 +00:00
|
|
|
// Silly workaround for bug in GCC <= 5
|
2019-09-13 00:12:02 +00:00
|
|
|
template <typename NewComponentType>
|
|
|
|
using ReplaceBaseComponentType =
|
2019-09-19 15:54:44 +00:00
|
|
|
typename detail::VecReplaceBaseComponentTypeGCC4or5<T, Size, NewComponentType>::type;
|
2019-09-19 16:30:59 +00:00
|
|
|
#else // !GCC <= 5
|
2019-09-03 03:52:56 +00:00
|
|
|
template <typename NewComponentType>
|
|
|
|
using ReplaceBaseComponentType = vtkm::Vec<
|
|
|
|
typename vtkm::VecTraits<ComponentType>::template ReplaceBaseComponentType<NewComponentType>,
|
|
|
|
Size>;
|
2019-09-13 00:12:02 +00:00
|
|
|
#endif
|
|
|
|
///@}
|
2019-09-03 03:52:56 +00:00
|
|
|
|
2014-02-10 18:57:46 +00:00
|
|
|
/// Converts whatever type this vector is into the standard VTKm Tuple.
|
|
|
|
///
|
2017-05-18 14:29:41 +00:00
|
|
|
template <vtkm::IdComponent destSize>
|
|
|
|
VTKM_EXEC_CONT static void CopyInto(const VecType& src, vtkm::Vec<ComponentType, destSize>& dest)
|
2014-02-10 18:57:46 +00:00
|
|
|
{
|
2015-08-07 23:58:52 +00:00
|
|
|
src.CopyInto(dest);
|
2014-02-10 18:57:46 +00:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2017-05-18 14:29:41 +00:00
|
|
|
template <typename T>
|
2019-06-06 21:28:47 +00:00
|
|
|
struct VTKM_NEVER_EXPORT VecTraits<vtkm::VecC<T>>
|
2016-11-30 22:03:30 +00:00
|
|
|
{
|
|
|
|
using VecType = vtkm::VecC<T>;
|
|
|
|
|
2019-09-03 03:52:56 +00:00
|
|
|
/// \brief Type of the components in the vector.
|
|
|
|
///
|
|
|
|
/// If the type is really a scalar, then the component type is the same as the scalar type.
|
2016-11-30 22:03:30 +00:00
|
|
|
///
|
|
|
|
using ComponentType = typename VecType::ComponentType;
|
|
|
|
|
2019-09-03 03:52:56 +00:00
|
|
|
/// \brief Base component type in the vector.
|
|
|
|
///
|
|
|
|
/// Similar to ComponentType except that for nested vectors (e.g. Vec<Vec<T, M>, N>), it
|
|
|
|
/// returns the base scalar type at the end of the composition (T in this example).
|
|
|
|
///
|
|
|
|
using BaseComponentType = typename vtkm::VecTraits<ComponentType>::BaseComponentType;
|
|
|
|
|
2016-11-30 22:03:30 +00:00
|
|
|
/// Number of components in the given vector.
|
|
|
|
///
|
|
|
|
VTKM_EXEC_CONT
|
2017-05-18 14:29:41 +00:00
|
|
|
static vtkm::IdComponent GetNumberOfComponents(const VecType& vector)
|
2016-11-30 22:03:30 +00:00
|
|
|
{
|
|
|
|
return vector.GetNumberOfComponents();
|
|
|
|
}
|
|
|
|
|
|
|
|
/// A tag specifying whether this vector has multiple components (i.e. is a
|
|
|
|
/// "real" vector). This tag can be useful for creating specialized functions
|
|
|
|
/// when a vector is really just a scalar.
|
|
|
|
///
|
|
|
|
/// The size of a \c VecC is not known until runtime and can always
|
|
|
|
/// potentially have multiple components, this is always set to \c
|
|
|
|
/// HasMultipleComponents.
|
|
|
|
///
|
|
|
|
using HasMultipleComponents = vtkm::VecTraitsTagMultipleComponents;
|
|
|
|
|
|
|
|
/// A tag specifying whether the size of this vector is known at compile
|
|
|
|
/// time. If set to \c VecTraitsTagSizeStatic, then \c NUM_COMPONENTS is set.
|
|
|
|
/// If set to \c VecTraitsTagSizeVariable, then the number of components is
|
|
|
|
/// not known at compile time and must be queried with \c
|
|
|
|
/// GetNumberOfComponents.
|
|
|
|
///
|
|
|
|
using IsSizeStatic = vtkm::VecTraitsTagSizeVariable;
|
|
|
|
|
|
|
|
/// Returns the value in a given component of the vector.
|
|
|
|
///
|
|
|
|
VTKM_EXEC_CONT
|
2017-05-18 14:29:41 +00:00
|
|
|
static const ComponentType& GetComponent(const VecType& vector, vtkm::IdComponent component)
|
2016-11-30 22:03:30 +00:00
|
|
|
{
|
|
|
|
return vector[component];
|
|
|
|
}
|
|
|
|
VTKM_EXEC_CONT
|
2017-05-18 14:29:41 +00:00
|
|
|
static ComponentType& GetComponent(VecType& vector, vtkm::IdComponent component)
|
|
|
|
{
|
2016-11-30 22:03:30 +00:00
|
|
|
return vector[component];
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Changes the value in a given component of the vector.
|
|
|
|
///
|
|
|
|
VTKM_EXEC_CONT
|
2017-05-18 14:29:41 +00:00
|
|
|
static void SetComponent(VecType& vector, vtkm::IdComponent component, ComponentType value)
|
|
|
|
{
|
2016-11-30 22:03:30 +00:00
|
|
|
vector[component] = value;
|
|
|
|
}
|
|
|
|
|
2019-09-03 03:52:56 +00:00
|
|
|
/// \brief Get a vector of the same type but with a different component.
|
|
|
|
///
|
|
|
|
/// This type resolves to another vector with a different component type. For example,
|
2020-06-01 15:36:07 +00:00
|
|
|
/// @code vtkm::VecTraits<vtkm::Vec<T, N>>::ReplaceComponentType<T2> @endcode is vtkm::Vec<T2, N>.
|
|
|
|
/// This replacement is not recursive. So @code VecTraits<Vec<Vec<T, M>, N>::ReplaceComponentType<T2> @endcode
|
2019-09-03 03:52:56 +00:00
|
|
|
/// is vtkm::Vec<T2, N>.
|
|
|
|
///
|
|
|
|
template <typename NewComponentType>
|
|
|
|
using ReplaceComponentType = vtkm::VecC<NewComponentType>;
|
|
|
|
|
|
|
|
/// \brief Get a vector of the same type but with a different base component.
|
|
|
|
///
|
|
|
|
/// This type resolves to another vector with a different base component type. The replacement
|
|
|
|
/// is recursive for nested types. For example,
|
2020-06-01 15:36:07 +00:00
|
|
|
/// @code VecTraits<Vec<Vec<T, M>, N>::ReplaceComponentType<T2> @endcode is Vec<Vec<T2, M>, N>.
|
2019-09-03 03:52:56 +00:00
|
|
|
///
|
|
|
|
template <typename NewComponentType>
|
|
|
|
using ReplaceBaseComponentType = vtkm::VecC<
|
|
|
|
typename vtkm::VecTraits<ComponentType>::template ReplaceBaseComponentType<NewComponentType>>;
|
|
|
|
|
2016-11-30 22:03:30 +00:00
|
|
|
/// Converts whatever type this vector is into the standard VTKm Tuple.
|
|
|
|
///
|
2017-05-18 14:29:41 +00:00
|
|
|
template <vtkm::IdComponent destSize>
|
|
|
|
VTKM_EXEC_CONT static void CopyInto(const VecType& src, vtkm::Vec<ComponentType, destSize>& dest)
|
2016-11-30 22:03:30 +00:00
|
|
|
{
|
|
|
|
src.CopyInto(dest);
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2017-05-18 14:29:41 +00:00
|
|
|
template <typename T>
|
2019-06-06 21:28:47 +00:00
|
|
|
struct VTKM_NEVER_EXPORT VecTraits<vtkm::VecCConst<T>>
|
2016-11-30 22:03:30 +00:00
|
|
|
{
|
|
|
|
using VecType = vtkm::VecCConst<T>;
|
|
|
|
|
2019-09-03 03:52:56 +00:00
|
|
|
/// \brief Type of the components in the vector.
|
|
|
|
///
|
|
|
|
/// If the type is really a scalar, then the component type is the same as the scalar type.
|
2016-11-30 22:03:30 +00:00
|
|
|
///
|
|
|
|
using ComponentType = typename VecType::ComponentType;
|
|
|
|
|
2019-09-03 03:52:56 +00:00
|
|
|
/// \brief Base component type in the vector.
|
|
|
|
///
|
|
|
|
/// Similar to ComponentType except that for nested vectors (e.g. Vec<Vec<T, M>, N>), it
|
|
|
|
/// returns the base scalar type at the end of the composition (T in this example).
|
|
|
|
///
|
|
|
|
using BaseComponentType = typename vtkm::VecTraits<ComponentType>::BaseComponentType;
|
|
|
|
|
2016-11-30 22:03:30 +00:00
|
|
|
/// Number of components in the given vector.
|
|
|
|
///
|
|
|
|
VTKM_EXEC_CONT
|
2017-05-18 14:29:41 +00:00
|
|
|
static vtkm::IdComponent GetNumberOfComponents(const VecType& vector)
|
2016-11-30 22:03:30 +00:00
|
|
|
{
|
|
|
|
return vector.GetNumberOfComponents();
|
|
|
|
}
|
|
|
|
|
|
|
|
/// A tag specifying whether this vector has multiple components (i.e. is a
|
|
|
|
/// "real" vector). This tag can be useful for creating specialized functions
|
|
|
|
/// when a vector is really just a scalar.
|
|
|
|
///
|
|
|
|
/// The size of a \c VecCConst is not known until runtime and can always
|
|
|
|
/// potentially have multiple components, this is always set to \c
|
|
|
|
/// HasMultipleComponents.
|
|
|
|
///
|
|
|
|
using HasMultipleComponents = vtkm::VecTraitsTagMultipleComponents;
|
|
|
|
|
|
|
|
/// A tag specifying whether the size of this vector is known at compile
|
|
|
|
/// time. If set to \c VecTraitsTagSizeStatic, then \c NUM_COMPONENTS is set.
|
|
|
|
/// If set to \c VecTraitsTagSizeVariable, then the number of components is
|
|
|
|
/// not known at compile time and must be queried with \c
|
|
|
|
/// GetNumberOfComponents.
|
|
|
|
///
|
|
|
|
using IsSizeStatic = vtkm::VecTraitsTagSizeVariable;
|
|
|
|
|
|
|
|
/// Returns the value in a given component of the vector.
|
|
|
|
///
|
|
|
|
VTKM_EXEC_CONT
|
2017-05-18 14:29:41 +00:00
|
|
|
static const ComponentType& GetComponent(const VecType& vector, vtkm::IdComponent component)
|
2016-11-30 22:03:30 +00:00
|
|
|
{
|
|
|
|
return vector[component];
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Changes the value in a given component of the vector.
|
|
|
|
///
|
|
|
|
VTKM_EXEC_CONT
|
2017-05-18 14:29:41 +00:00
|
|
|
static void SetComponent(VecType& vector, vtkm::IdComponent component, ComponentType value)
|
|
|
|
{
|
2016-11-30 22:03:30 +00:00
|
|
|
vector[component] = value;
|
|
|
|
}
|
|
|
|
|
2019-09-03 03:52:56 +00:00
|
|
|
/// \brief Get a vector of the same type but with a different component.
|
|
|
|
///
|
|
|
|
/// This type resolves to another vector with a different component type. For example,
|
2020-06-01 15:36:07 +00:00
|
|
|
/// @code vtkm::VecTraits<vtkm::Vec<T, N>>::ReplaceComponentType<T2> @endcode is vtkm::Vec<T2, N>.
|
|
|
|
/// This replacement is not recursive. So @code VecTraits<Vec<Vec<T, M>, N>::ReplaceComponentType<T2> @endcode
|
2019-09-03 03:52:56 +00:00
|
|
|
/// is vtkm::Vec<T2, N>.
|
|
|
|
///
|
|
|
|
template <typename NewComponentType>
|
|
|
|
using ReplaceComponentType = vtkm::VecCConst<NewComponentType>;
|
|
|
|
|
|
|
|
/// \brief Get a vector of the same type but with a different base component.
|
|
|
|
///
|
|
|
|
/// This type resolves to another vector with a different base component type. The replacement
|
|
|
|
/// is recursive for nested types. For example,
|
2020-06-01 15:36:07 +00:00
|
|
|
/// @code VecTraits<Vec<Vec<T, M>, N>::ReplaceComponentType<T2> @endcode is Vec<Vec<T2, M>, N>.
|
2019-09-03 03:52:56 +00:00
|
|
|
///
|
|
|
|
template <typename NewComponentType>
|
|
|
|
using ReplaceBaseComponentType = vtkm::VecCConst<
|
|
|
|
typename vtkm::VecTraits<ComponentType>::template ReplaceBaseComponentType<NewComponentType>>;
|
|
|
|
|
2016-11-30 22:03:30 +00:00
|
|
|
/// Converts whatever type this vector is into the standard VTKm Tuple.
|
|
|
|
///
|
2017-05-18 14:29:41 +00:00
|
|
|
template <vtkm::IdComponent destSize>
|
|
|
|
VTKM_EXEC_CONT static void CopyInto(const VecType& src, vtkm::Vec<ComponentType, destSize>& dest)
|
2016-11-30 22:03:30 +00:00
|
|
|
{
|
|
|
|
src.CopyInto(dest);
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2017-05-18 14:29:41 +00:00
|
|
|
namespace internal
|
|
|
|
{
|
2022-05-24 18:56:20 +00:00
|
|
|
|
2014-10-07 23:27:31 +00:00
|
|
|
/// Used for overriding VecTraits for basic scalar types.
|
2014-02-10 18:57:46 +00:00
|
|
|
///
|
2017-05-18 14:29:41 +00:00
|
|
|
template <typename ScalarType>
|
2019-06-06 21:28:47 +00:00
|
|
|
struct VTKM_NEVER_EXPORT VecTraitsBasic
|
2017-05-18 14:29:41 +00:00
|
|
|
{
|
2017-06-23 18:50:34 +00:00
|
|
|
using ComponentType = ScalarType;
|
2019-09-03 03:52:56 +00:00
|
|
|
using BaseComponentType = ScalarType;
|
2018-02-27 14:25:25 +00:00
|
|
|
static constexpr vtkm::IdComponent NUM_COMPONENTS = 1;
|
2017-06-23 18:50:34 +00:00
|
|
|
using HasMultipleComponents = vtkm::VecTraitsTagSingleComponent;
|
|
|
|
using IsSizeStatic = vtkm::VecTraitsTagSizeStatic;
|
2015-08-07 23:58:52 +00:00
|
|
|
|
2016-10-19 22:42:58 +00:00
|
|
|
VTKM_EXEC_CONT
|
2017-05-18 14:29:41 +00:00
|
|
|
static vtkm::IdComponent GetNumberOfComponents(const ScalarType&) { return 1; }
|
2014-02-10 18:57:46 +00:00
|
|
|
|
2016-10-19 22:42:58 +00:00
|
|
|
VTKM_EXEC_CONT
|
2017-05-18 14:29:41 +00:00
|
|
|
static const ComponentType& GetComponent(const ScalarType& vector, vtkm::IdComponent)
|
|
|
|
{
|
2014-02-10 18:57:46 +00:00
|
|
|
return vector;
|
|
|
|
}
|
2016-10-19 22:42:58 +00:00
|
|
|
VTKM_EXEC_CONT
|
2017-05-18 14:29:41 +00:00
|
|
|
static ComponentType& GetComponent(ScalarType& vector, vtkm::IdComponent) { return vector; }
|
2014-02-10 18:57:46 +00:00
|
|
|
|
2017-05-26 17:53:28 +00:00
|
|
|
VTKM_EXEC_CONT static void SetComponent(ScalarType& vector,
|
|
|
|
vtkm::IdComponent,
|
2017-05-18 14:29:41 +00:00
|
|
|
ComponentType value)
|
|
|
|
{
|
2014-02-10 18:57:46 +00:00
|
|
|
vector = value;
|
|
|
|
}
|
|
|
|
|
2019-09-03 03:52:56 +00:00
|
|
|
template <typename NewComponentType>
|
|
|
|
using ReplaceComponentType = NewComponentType;
|
|
|
|
|
|
|
|
template <typename NewComponentType>
|
|
|
|
using ReplaceBaseComponentType = NewComponentType;
|
|
|
|
|
2017-05-18 14:29:41 +00:00
|
|
|
template <vtkm::IdComponent destSize>
|
|
|
|
VTKM_EXEC_CONT static void CopyInto(const ScalarType& src, vtkm::Vec<ScalarType, destSize>& dest)
|
2014-02-10 18:57:46 +00:00
|
|
|
{
|
2015-08-07 23:58:52 +00:00
|
|
|
dest[0] = src;
|
2014-02-10 18:57:46 +00:00
|
|
|
}
|
|
|
|
};
|
2022-05-24 18:56:20 +00:00
|
|
|
|
|
|
|
namespace detail
|
|
|
|
{
|
|
|
|
|
|
|
|
template <typename T, typename = vtkm::HasVecTraits<T>>
|
|
|
|
struct VTKM_NEVER_EXPORT SafeVecTraitsImpl;
|
|
|
|
|
|
|
|
template <typename T>
|
|
|
|
struct VTKM_NEVER_EXPORT SafeVecTraitsImpl<T, std::true_type> : vtkm::VecTraits<T>
|
|
|
|
{
|
|
|
|
};
|
|
|
|
|
|
|
|
template <typename T>
|
|
|
|
struct VTKM_NEVER_EXPORT SafeVecTraitsImpl<T, std::false_type> : vtkm::internal::VecTraitsBasic<T>
|
|
|
|
{
|
|
|
|
};
|
|
|
|
|
|
|
|
} // namespace detail
|
|
|
|
|
|
|
|
/// \brief A version of VecTraits that will be available for any type.
|
|
|
|
///
|
|
|
|
/// The `VecTraits` template is only defined for types that have a specific specialization
|
|
|
|
/// for it. That means if you use `VecTraits` in a template, that template will likely
|
|
|
|
/// fail to build for types that are not defined for `VecTraits`.
|
|
|
|
///
|
|
|
|
/// To use `VecTraits` in a class that should support all types, not just those with
|
|
|
|
/// defined `VecTraits`, you can use this "safe" version. `SafeVecTraits` is the same as
|
|
|
|
/// `VecTraits` if the latter is defined. If the `VecTraits` are not defined, then
|
|
|
|
/// `SafeVecTraits` treats the type as a simple scalar value.
|
|
|
|
///
|
|
|
|
/// This template ensures that it will work reasonably well for all types. But be careful
|
|
|
|
/// as if `VecTraits` is later defined, the template is likely to change.
|
|
|
|
///
|
|
|
|
template <typename T>
|
|
|
|
struct VTKM_NEVER_EXPORT SafeVecTraits : detail::SafeVecTraitsImpl<T>
|
|
|
|
{
|
|
|
|
};
|
|
|
|
|
2015-05-07 22:34:06 +00:00
|
|
|
} // namespace internal
|
|
|
|
|
2015-09-20 06:01:04 +00:00
|
|
|
/// \brief VecTraits for Pair types
|
|
|
|
///
|
2018-01-30 00:24:31 +00:00
|
|
|
/// Although a pair would seem better as a size-2 vector, we treat it as a
|
2015-09-20 06:01:04 +00:00
|
|
|
/// scalar. This is because a \c Vec is assumed to have the same type for
|
|
|
|
/// every component, and a pair in general has a different type for each
|
|
|
|
/// component. Thus we treat a pair as a "scalar" unit.
|
|
|
|
///
|
2017-05-18 14:29:41 +00:00
|
|
|
template <typename T, typename U>
|
2019-06-06 21:28:47 +00:00
|
|
|
struct VTKM_NEVER_EXPORT VecTraits<vtkm::Pair<T, U>>
|
|
|
|
: public vtkm::internal::VecTraitsBasic<vtkm::Pair<T, U>>
|
2015-09-20 06:01:04 +00:00
|
|
|
{
|
|
|
|
};
|
|
|
|
|
2022-05-24 18:56:20 +00:00
|
|
|
} // namespace vtkm
|
2014-02-10 18:57:46 +00:00
|
|
|
|
2020-08-17 14:18:24 +00:00
|
|
|
#define VTKM_BASIC_TYPE_VECTOR(type) \
|
|
|
|
namespace vtkm \
|
|
|
|
{ \
|
|
|
|
template <> \
|
|
|
|
struct VTKM_NEVER_EXPORT VecTraits<type> : public vtkm::internal::VecTraitsBasic<type> \
|
|
|
|
{ \
|
|
|
|
}; \
|
2015-05-07 22:34:06 +00:00
|
|
|
}
|
2014-02-10 18:57:46 +00:00
|
|
|
|
|
|
|
/// Allows you to treat basic types as if they were vectors.
|
|
|
|
|
2016-02-12 21:31:00 +00:00
|
|
|
VTKM_BASIC_TYPE_VECTOR(float)
|
|
|
|
VTKM_BASIC_TYPE_VECTOR(double)
|
|
|
|
|
2018-08-06 17:09:05 +00:00
|
|
|
VTKM_BASIC_TYPE_VECTOR(bool)
|
2016-02-12 21:31:00 +00:00
|
|
|
VTKM_BASIC_TYPE_VECTOR(char)
|
|
|
|
VTKM_BASIC_TYPE_VECTOR(signed char)
|
|
|
|
VTKM_BASIC_TYPE_VECTOR(unsigned char)
|
|
|
|
VTKM_BASIC_TYPE_VECTOR(short)
|
|
|
|
VTKM_BASIC_TYPE_VECTOR(unsigned short)
|
|
|
|
VTKM_BASIC_TYPE_VECTOR(int)
|
|
|
|
VTKM_BASIC_TYPE_VECTOR(unsigned int)
|
|
|
|
VTKM_BASIC_TYPE_VECTOR(long)
|
|
|
|
VTKM_BASIC_TYPE_VECTOR(unsigned long)
|
|
|
|
VTKM_BASIC_TYPE_VECTOR(long long)
|
|
|
|
VTKM_BASIC_TYPE_VECTOR(unsigned long long)
|
|
|
|
|
2015-05-07 22:34:06 +00:00
|
|
|
//#undef VTKM_BASIC_TYPE_VECTOR
|
2014-02-10 18:57:46 +00:00
|
|
|
|
2014-10-07 23:27:31 +00:00
|
|
|
#endif //vtk_m_VecTraits_h
|