2014-02-10 18:57:46 +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.
|
2015-05-21 12:09:22 +00:00
|
|
|
// Copyright 2014 Los Alamos National Security.
|
2014-02-10 18:57:46 +00:00
|
|
|
//
|
|
|
|
// 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.
|
|
|
|
//============================================================================
|
2014-03-07 15:19:09 +00:00
|
|
|
#ifndef vtk_m_TypeTraits_h
|
|
|
|
#define vtk_m_TypeTraits_h
|
2014-02-10 18:57:46 +00:00
|
|
|
|
|
|
|
#include <vtkm/Types.h>
|
2015-06-10 12:57:21 +00:00
|
|
|
#include <vtkm/Pair.h>
|
2014-02-10 18:57:46 +00:00
|
|
|
|
|
|
|
namespace vtkm {
|
|
|
|
|
|
|
|
/// Tag used to identify types that store real (floating-point) numbers. A
|
|
|
|
/// TypeTraits class will typedef this class to NumericTag if it stores real
|
|
|
|
/// numbers (or vectors of real numbers).
|
|
|
|
///
|
|
|
|
struct TypeTraitsRealTag {};
|
|
|
|
|
|
|
|
/// Tag used to identify types that store integer numbers. A TypeTraits class
|
|
|
|
/// will typedef this class to NumericTag if it stores integer numbers (or
|
|
|
|
/// vectors of integers).
|
|
|
|
///
|
|
|
|
struct TypeTraitsIntegerTag {};
|
|
|
|
|
|
|
|
/// Tag used to identify 0 dimensional types (scalars). Scalars can also be
|
2014-10-07 23:27:31 +00:00
|
|
|
/// treated like vectors when used with VecTraits. A TypeTraits class will
|
2014-02-10 18:57:46 +00:00
|
|
|
/// typedef this class to DimensionalityTag.
|
|
|
|
///
|
|
|
|
struct TypeTraitsScalarTag {};
|
|
|
|
|
|
|
|
/// Tag used to identify 1 dimensional types (vectors). A TypeTraits class will
|
|
|
|
/// typedef this class to DimensionalityTag.
|
|
|
|
///
|
|
|
|
struct TypeTraitsVectorTag {};
|
|
|
|
|
|
|
|
template<typename T> struct TypeTraits;
|
|
|
|
|
|
|
|
#ifdef VTKM_DOXYGEN_ONLY
|
|
|
|
|
|
|
|
/// The TypeTraits class provides helpful compile-time information about the
|
|
|
|
/// basic types used in VTKm (and a few others for convienience). The majority
|
|
|
|
/// of TypeTraits contents are typedefs to tags that can be used to easily
|
|
|
|
/// override behavior of called functions.
|
|
|
|
///
|
|
|
|
template<typename T>
|
2014-02-11 21:20:30 +00:00
|
|
|
class TypeTraits
|
|
|
|
{
|
2014-02-10 18:57:46 +00:00
|
|
|
typedef int tag_type; // Shut up, test compile.
|
|
|
|
public:
|
|
|
|
|
|
|
|
/// \brief A tag to determing whether the type is integer or real.
|
|
|
|
///
|
|
|
|
/// This tag is either TypeTraitsRealTag or TypeTraitsIntegerTag.
|
|
|
|
typedef tag_type NumericTag;
|
|
|
|
|
|
|
|
/// \brief A tag to determine whether the type has multiple components.
|
|
|
|
///
|
|
|
|
/// This tag is either TypeTraitsScalarTag or TypeTraitsVectorTag. Scalars can
|
|
|
|
/// also be treated as vectors.
|
|
|
|
typedef tag_type DimensionalityTag;
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif //VTKM_DOXYGEN_ONLY
|
|
|
|
|
|
|
|
// Const types should have the same traits as their non-const counterparts.
|
|
|
|
//
|
|
|
|
template<typename T>
|
|
|
|
struct TypeTraits<const T> : TypeTraits<T>
|
|
|
|
{ };
|
|
|
|
|
|
|
|
#define VTKM_BASIC_REAL_TYPE(T) \
|
2014-02-11 21:20:30 +00:00
|
|
|
template<> struct TypeTraits<T> { \
|
|
|
|
typedef TypeTraitsRealTag NumericTag; \
|
|
|
|
typedef TypeTraitsScalarTag DimensionalityTag; \
|
|
|
|
}
|
2014-02-10 18:57:46 +00:00
|
|
|
|
|
|
|
#define VTKM_BASIC_INTEGER_TYPE(T) \
|
2014-02-11 21:20:30 +00:00
|
|
|
template<> struct TypeTraits<T> { \
|
|
|
|
typedef TypeTraitsIntegerTag NumericTag; \
|
|
|
|
typedef TypeTraitsScalarTag DimensionalityTag; \
|
|
|
|
}
|
2014-02-10 18:57:46 +00:00
|
|
|
|
|
|
|
/// Traits for basic C++ types.
|
|
|
|
///
|
|
|
|
|
2014-10-08 21:40:20 +00:00
|
|
|
VTKM_BASIC_REAL_TYPE(vtkm::Float32);
|
|
|
|
VTKM_BASIC_REAL_TYPE(vtkm::Float64);
|
|
|
|
VTKM_BASIC_INTEGER_TYPE(vtkm::Int8);
|
|
|
|
VTKM_BASIC_INTEGER_TYPE(vtkm::UInt8);
|
|
|
|
VTKM_BASIC_INTEGER_TYPE(vtkm::Int16);
|
|
|
|
VTKM_BASIC_INTEGER_TYPE(vtkm::UInt16);
|
|
|
|
VTKM_BASIC_INTEGER_TYPE(vtkm::Int32);
|
|
|
|
VTKM_BASIC_INTEGER_TYPE(vtkm::UInt32);
|
|
|
|
VTKM_BASIC_INTEGER_TYPE(vtkm::Int64);
|
|
|
|
VTKM_BASIC_INTEGER_TYPE(vtkm::UInt64);
|
2014-02-10 18:57:46 +00:00
|
|
|
|
|
|
|
#undef VTKM_BASIC_REAL_TYPE
|
|
|
|
#undef VTKM_BASIC_INTEGER_TYPE
|
|
|
|
|
2014-10-09 14:54:56 +00:00
|
|
|
/// Traits for Vec types.
|
2014-02-10 18:57:46 +00:00
|
|
|
///
|
2014-10-07 16:59:34 +00:00
|
|
|
template<typename T, vtkm::IdComponent Size>
|
2014-10-09 14:54:56 +00:00
|
|
|
struct TypeTraits<vtkm::Vec<T,Size> >
|
2014-02-11 21:20:30 +00:00
|
|
|
{
|
2014-10-09 14:54:56 +00:00
|
|
|
typedef typename vtkm::TypeTraits<T>::NumericTag NumericTag;
|
2014-02-10 18:57:46 +00:00
|
|
|
typedef TypeTraitsVectorTag DimensionalityTag;
|
|
|
|
};
|
|
|
|
|
2015-06-10 12:57:21 +00:00
|
|
|
/// Traits for Pair types.
|
|
|
|
///
|
|
|
|
template<typename T, typename U>
|
|
|
|
struct TypeTraits<vtkm::Pair<T,U> >
|
|
|
|
{
|
|
|
|
typedef typename vtkm::TypeTraits<T>::NumericTag NumericTag;
|
|
|
|
typedef TypeTraitsScalarTag DimensionalityTag;
|
|
|
|
};
|
|
|
|
|
2014-02-10 18:57:46 +00:00
|
|
|
} // namespace vtkm
|
|
|
|
|
2014-06-11 16:43:36 +00:00
|
|
|
#endif //vtk_m_TypeTraits_h
|