2017-02-07 17:53:53 +00:00
|
|
|
//============================================================================
|
|
|
|
// Copyright (c) Kitware, Inc.
|
|
|
|
// All rights reserved.
|
|
|
|
// See LICENSE.txt for details.
|
2019-04-15 23:24:21 +00:00
|
|
|
//
|
2017-02-07 17:53:53 +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.
|
|
|
|
//============================================================================
|
|
|
|
#ifndef vtk_m_cont_ArrayHandleDiscard_h
|
|
|
|
#define vtk_m_cont_ArrayHandleDiscard_h
|
|
|
|
|
|
|
|
#include <vtkm/TypeTraits.h>
|
2017-05-18 14:51:24 +00:00
|
|
|
#include <vtkm/cont/ArrayHandle.h>
|
2017-08-25 16:49:32 +00:00
|
|
|
#include <vtkm/internal/Unreachable.h>
|
2017-02-07 17:53:53 +00:00
|
|
|
|
2017-08-24 14:20:39 +00:00
|
|
|
#include <type_traits>
|
|
|
|
|
2017-05-18 14:29:41 +00:00
|
|
|
namespace vtkm
|
|
|
|
{
|
|
|
|
namespace exec
|
|
|
|
{
|
|
|
|
namespace internal
|
|
|
|
{
|
2017-02-07 17:53:53 +00:00
|
|
|
|
|
|
|
/// \brief An output-only array portal with no storage. All written values are
|
|
|
|
/// discarded.
|
|
|
|
template <typename ValueType_>
|
|
|
|
class ArrayPortalDiscard
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
using ValueType = ValueType_;
|
|
|
|
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
|
|
VTKM_EXEC_CONT
|
|
|
|
ArrayPortalDiscard()
|
|
|
|
: NumberOfValues(0)
|
2017-05-18 14:29:41 +00:00
|
|
|
{
|
|
|
|
} // needs to be host and device so that cuda can create lvalue of these
|
2017-02-07 17:53:53 +00:00
|
|
|
|
|
|
|
VTKM_CONT
|
|
|
|
explicit ArrayPortalDiscard(vtkm::Id numValues)
|
|
|
|
: NumberOfValues(numValues)
|
2017-05-18 14:29:41 +00:00
|
|
|
{
|
|
|
|
}
|
2017-02-07 17:53:53 +00:00
|
|
|
|
|
|
|
/// Copy constructor for any other ArrayPortalDiscard with an iterator
|
|
|
|
/// type that can be copied to this iterator type. This allows us to do any
|
|
|
|
/// type casting that the iterators do (like the non-const to const cast).
|
|
|
|
///
|
2017-05-18 14:29:41 +00:00
|
|
|
template <class OtherV>
|
|
|
|
VTKM_CONT ArrayPortalDiscard(const ArrayPortalDiscard<OtherV>& src)
|
2017-02-07 17:53:53 +00:00
|
|
|
: NumberOfValues(src.NumberOfValues)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
2017-05-18 14:29:41 +00:00
|
|
|
VTKM_EXEC_CONT
|
|
|
|
vtkm::Id GetNumberOfValues() const { return this->NumberOfValues; }
|
|
|
|
|
2017-08-25 16:49:32 +00:00
|
|
|
ValueType Get(vtkm::Id) const
|
2017-05-18 14:29:41 +00:00
|
|
|
{
|
2017-08-25 16:49:32 +00:00
|
|
|
VTKM_UNREACHABLE("Cannot read from ArrayHandleDiscard.");
|
2017-02-07 17:53:53 +00:00
|
|
|
return vtkm::TypeTraits<ValueType>::ZeroInitialization();
|
|
|
|
}
|
|
|
|
|
|
|
|
VTKM_EXEC
|
2017-05-18 14:29:41 +00:00
|
|
|
void Set(vtkm::Id index, const ValueType&) const
|
2017-02-07 17:53:53 +00:00
|
|
|
{
|
|
|
|
VTKM_ASSERT(index < this->GetNumberOfValues());
|
|
|
|
(void)index;
|
|
|
|
// no-op
|
|
|
|
}
|
|
|
|
|
|
|
|
private:
|
|
|
|
vtkm::Id NumberOfValues;
|
|
|
|
};
|
|
|
|
|
|
|
|
} // end namespace internal
|
|
|
|
} // end namespace exec
|
|
|
|
|
2017-05-18 14:29:41 +00:00
|
|
|
namespace cont
|
|
|
|
{
|
2017-02-07 17:53:53 +00:00
|
|
|
|
2017-05-18 14:29:41 +00:00
|
|
|
namespace internal
|
|
|
|
{
|
2017-02-07 17:53:53 +00:00
|
|
|
|
2017-05-18 14:29:41 +00:00
|
|
|
struct VTKM_ALWAYS_EXPORT StorageTagDiscard
|
|
|
|
{
|
|
|
|
};
|
2017-02-07 17:53:53 +00:00
|
|
|
|
2020-11-10 23:22:05 +00:00
|
|
|
struct VTKM_ALWAYS_EXPORT DiscardMetaData
|
2017-02-07 17:53:53 +00:00
|
|
|
{
|
2020-11-09 22:45:45 +00:00
|
|
|
vtkm::Id NumberOfValues = 0;
|
2017-02-07 17:53:53 +00:00
|
|
|
};
|
|
|
|
|
2020-11-09 22:45:45 +00:00
|
|
|
template <typename ValueType>
|
|
|
|
class Storage<ValueType, StorageTagDiscard>
|
|
|
|
{
|
2017-02-07 17:53:53 +00:00
|
|
|
public:
|
2020-11-09 22:45:45 +00:00
|
|
|
using WritePortalType = vtkm::exec::internal::ArrayPortalDiscard<ValueType>;
|
2017-02-07 17:53:53 +00:00
|
|
|
|
2020-11-09 22:45:45 +00:00
|
|
|
// Note that this portal is write-only, so you will probably run into problems if
|
|
|
|
// you actually try to use this read portal.
|
|
|
|
using ReadPortalType = vtkm::exec::internal::ArrayPortalDiscard<ValueType>;
|
2017-02-07 17:53:53 +00:00
|
|
|
|
2020-11-17 19:25:11 +00:00
|
|
|
VTKM_CONT constexpr static vtkm::IdComponent GetNumberOfBuffers() { return 1; }
|
2017-02-07 17:53:53 +00:00
|
|
|
|
2020-11-09 22:45:45 +00:00
|
|
|
VTKM_CONT static void ResizeBuffers(vtkm::Id numValues,
|
|
|
|
vtkm::cont::internal::Buffer* buffers,
|
|
|
|
vtkm::CopyFlag,
|
|
|
|
vtkm::cont::Token&)
|
2017-02-07 17:53:53 +00:00
|
|
|
{
|
2020-11-09 22:45:45 +00:00
|
|
|
VTKM_ASSERT(numValues >= 0);
|
2020-11-10 23:22:05 +00:00
|
|
|
buffers[0].GetMetaData<DiscardMetaData>().NumberOfValues = numValues;
|
2017-02-07 17:53:53 +00:00
|
|
|
}
|
|
|
|
|
2020-11-09 22:45:45 +00:00
|
|
|
VTKM_CONT static vtkm::Id GetNumberOfValues(const vtkm::cont::internal::Buffer* buffers)
|
2017-02-07 17:53:53 +00:00
|
|
|
{
|
2020-11-10 23:22:05 +00:00
|
|
|
return buffers[0].GetMetaData<DiscardMetaData>().NumberOfValues;
|
2017-02-07 17:53:53 +00:00
|
|
|
}
|
|
|
|
|
2020-11-09 22:45:45 +00:00
|
|
|
VTKM_CONT static ReadPortalType CreateReadPortal(const vtkm::cont::internal::Buffer*,
|
|
|
|
vtkm::cont::DeviceAdapterId,
|
|
|
|
vtkm::cont::Token&)
|
2017-02-07 17:53:53 +00:00
|
|
|
{
|
2020-11-09 22:45:45 +00:00
|
|
|
throw vtkm::cont::ErrorBadValue("Cannot read from ArrayHandleDiscard.");
|
2017-02-07 17:53:53 +00:00
|
|
|
}
|
|
|
|
|
2020-11-09 22:45:45 +00:00
|
|
|
VTKM_CONT static WritePortalType CreateWritePortal(vtkm::cont::internal::Buffer* buffers,
|
|
|
|
vtkm::cont::DeviceAdapterId,
|
|
|
|
vtkm::cont::Token&)
|
2017-02-07 17:53:53 +00:00
|
|
|
{
|
2020-11-09 22:45:45 +00:00
|
|
|
return WritePortalType(GetNumberOfValues(buffers));
|
2017-02-07 17:53:53 +00:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
template <typename ValueType_>
|
|
|
|
struct ArrayHandleDiscardTraits
|
|
|
|
{
|
|
|
|
using ValueType = ValueType_;
|
|
|
|
using StorageTag = StorageTagDiscard;
|
|
|
|
using Superclass = vtkm::cont::ArrayHandle<ValueType, StorageTag>;
|
|
|
|
};
|
|
|
|
|
|
|
|
} // end namespace internal
|
|
|
|
|
|
|
|
/// ArrayHandleDiscard is a write-only array that discards all data written to
|
|
|
|
/// it. This can be used to save memory when a filter provides optional outputs
|
|
|
|
/// that are not needed.
|
|
|
|
template <typename ValueType_>
|
2017-05-18 14:29:41 +00:00
|
|
|
class ArrayHandleDiscard : public internal::ArrayHandleDiscardTraits<ValueType_>::Superclass
|
2017-02-07 17:53:53 +00:00
|
|
|
{
|
|
|
|
public:
|
2017-05-26 17:53:28 +00:00
|
|
|
VTKM_ARRAY_HANDLE_SUBCLASS(ArrayHandleDiscard,
|
|
|
|
(ArrayHandleDiscard<ValueType_>),
|
2017-05-18 14:29:41 +00:00
|
|
|
(typename internal::ArrayHandleDiscardTraits<ValueType_>::Superclass));
|
2017-02-07 17:53:53 +00:00
|
|
|
};
|
|
|
|
|
2017-08-24 14:20:39 +00:00
|
|
|
/// Helper to determine if an ArrayHandle type is an ArrayHandleDiscard.
|
|
|
|
template <typename T>
|
2018-02-27 14:25:25 +00:00
|
|
|
struct IsArrayHandleDiscard : std::false_type
|
2017-08-24 14:20:39 +00:00
|
|
|
{
|
|
|
|
};
|
|
|
|
|
2018-02-27 14:25:25 +00:00
|
|
|
template <typename T>
|
|
|
|
struct IsArrayHandleDiscard<ArrayHandle<T, internal::StorageTagDiscard>> : std::true_type
|
2017-08-24 14:20:39 +00:00
|
|
|
{
|
|
|
|
};
|
|
|
|
|
2017-02-07 17:53:53 +00:00
|
|
|
} // end namespace cont
|
|
|
|
} // end namespace vtkm
|
|
|
|
|
|
|
|
#endif // vtk_m_cont_ArrayHandleDiscard_h
|