mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-19 02:25:42 +00:00
c3a3184d51
Sandia National Laboratories recently changed management from the Sandia Corporation to the National Technology & Engineering Solutions of Sandia, LLC (NTESS). The copyright statements need to be updated accordingly.
146 lines
4.4 KiB
C++
146 lines
4.4 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 2015 National Technology & Engineering Solutions of Sandia, LLC (NTESS).
|
|
// Copyright 2015 UT-Battelle, LLC.
|
|
// Copyright 2015 Los Alamos National Security.
|
|
//
|
|
// Under the terms of Contract DE-NA0003525 with NTESS,
|
|
// 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_ArrayHandleImplicit_h
|
|
#define vtk_m_cont_ArrayHandleImplicit_h
|
|
|
|
#include <vtkm/cont/ArrayHandle.h>
|
|
#include <vtkm/cont/StorageImplicit.h>
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace cont
|
|
{
|
|
|
|
namespace detail
|
|
{
|
|
|
|
template <class FunctorType_>
|
|
class VTKM_ALWAYS_EXPORT ArrayPortalImplicit;
|
|
|
|
/// A convenience class that provides a typedef to the appropriate tag for
|
|
/// a implicit array container.
|
|
template <typename FunctorType>
|
|
struct ArrayHandleImplicitTraits
|
|
{
|
|
using ValueType = decltype(FunctorType{}(vtkm::Id{}));
|
|
using StorageTag = vtkm::cont::StorageTagImplicit<ArrayPortalImplicit<FunctorType>>;
|
|
using Superclass = vtkm::cont::ArrayHandle<ValueType, StorageTag>;
|
|
};
|
|
|
|
/// \brief An array portal that returns the result of a functor
|
|
///
|
|
/// This array portal is similar to an implicit array i.e an array that is
|
|
/// defined functionally rather than actually stored in memory. The array
|
|
/// comprises a functor that is called for each index.
|
|
///
|
|
/// The \c ArrayPortalImplicit is used in an ArrayHandle with an
|
|
/// \c StorageImplicit container.
|
|
///
|
|
template <class FunctorType_>
|
|
class VTKM_ALWAYS_EXPORT ArrayPortalImplicit
|
|
{
|
|
public:
|
|
using ValueType = typename ArrayHandleImplicitTraits<FunctorType_>::ValueType;
|
|
using FunctorType = FunctorType_;
|
|
|
|
VTKM_EXEC_CONT
|
|
ArrayPortalImplicit()
|
|
: Functor()
|
|
, NumberOfValues(0)
|
|
{
|
|
}
|
|
|
|
VTKM_EXEC_CONT
|
|
ArrayPortalImplicit(FunctorType f, vtkm::Id numValues)
|
|
: Functor(f)
|
|
, NumberOfValues(numValues)
|
|
{
|
|
}
|
|
|
|
VTKM_EXEC_CONT
|
|
vtkm::Id GetNumberOfValues() const { return this->NumberOfValues; }
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
VTKM_EXEC_CONT
|
|
ValueType Get(vtkm::Id index) const { return this->Functor(index); }
|
|
|
|
VTKM_EXEC_CONT
|
|
void Set(vtkm::Id vtkmNotUsed(index), const ValueType& vtkmNotUsed(value)) const
|
|
{
|
|
#if !(defined(VTKM_MSVC) && defined(VTKM_CUDA))
|
|
VTKM_ASSERT(false && "Cannot write to read-only implicit array.");
|
|
#endif
|
|
}
|
|
|
|
using IteratorType =
|
|
vtkm::cont::internal::IteratorFromArrayPortal<ArrayPortalImplicit<FunctorType>>;
|
|
|
|
VTKM_CONT
|
|
IteratorType GetIteratorBegin() const { return IteratorType(*this); }
|
|
|
|
private:
|
|
FunctorType Functor;
|
|
vtkm::Id NumberOfValues;
|
|
};
|
|
|
|
} // namespace detail
|
|
|
|
/// \brief An \c ArrayHandle that computes values on the fly.
|
|
///
|
|
/// \c ArrayHandleImplicit is a specialization of ArrayHandle.
|
|
/// It takes a user defined functor which is called with a given index value.
|
|
/// The functor returns the result of the functor as the value of this
|
|
/// array at that position.
|
|
///
|
|
template <class FunctorType>
|
|
class ArrayHandleImplicit : public detail::ArrayHandleImplicitTraits<FunctorType>::Superclass
|
|
{
|
|
private:
|
|
using ArrayTraits = typename detail::ArrayHandleImplicitTraits<FunctorType>;
|
|
|
|
public:
|
|
VTKM_ARRAY_HANDLE_SUBCLASS(ArrayHandleImplicit,
|
|
(ArrayHandleImplicit<FunctorType>),
|
|
(typename ArrayTraits::Superclass));
|
|
|
|
VTKM_CONT
|
|
ArrayHandleImplicit(FunctorType functor, vtkm::Id length)
|
|
: Superclass(typename Superclass::PortalConstControl(functor, length))
|
|
{
|
|
}
|
|
};
|
|
|
|
/// make_ArrayHandleImplicit is convenience function to generate an
|
|
/// ArrayHandleImplicit. It takes a functor and the virtual length of the
|
|
/// arry.
|
|
|
|
template <typename FunctorType>
|
|
VTKM_CONT vtkm::cont::ArrayHandleImplicit<FunctorType> make_ArrayHandleImplicit(FunctorType functor,
|
|
vtkm::Id length)
|
|
{
|
|
return ArrayHandleImplicit<FunctorType>(functor, length);
|
|
}
|
|
}
|
|
} // namespace vtkm::cont
|
|
|
|
#endif //vtk_m_cont_ArrayHandleImplicit_h
|