Storage.h

Go to the documentation of this file.

//============================================================================
//  The contents of this file are covered by the Viskores license. See
//  LICENSE.txt for details.
//
//  By contributing to this file, all contributors agree to the Developer
//  Certificate of Origin Version 1.1 (DCO 1.1) as stated in DCO.txt.
//============================================================================
 
//============================================================================
//  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.
//============================================================================
#ifndef viskores_cont_Storage_h
#define viskores_cont_Storage_h
 
#define VISKORES_STORAGE_ERROR -2
#define VISKORES_STORAGE_UNDEFINED -1
#define VISKORES_STORAGE_BASIC 1
 
#ifndef VISKORES_STORAGE
#define VISKORES_STORAGE VISKORES_STORAGE_BASIC
#endif
 
#include <viskores/Flags.h>
#include <viskores/StaticAssert.h>
 
#include <viskores/internal/ArrayPortalDummy.h>
 
#include <viskores/cont/ErrorBadAllocation.h>
#include <viskores/cont/Logging.h>
#include <viskores/cont/Token.h>
 
#include <viskores/cont/internal/Buffer.h>
 
namespace viskores
{
namespace cont
{
 
#ifdef VISKORES_DOXYGEN_ONLY
struct VISKORES_ALWAYS_EXPORT StorageTag___
{
};
#endif // VISKORES_DOXYGEN_ONLY
 
namespace internal
{
 
struct UndefinedStorage
{
};
 
namespace detail
{
 
// This class should never be used. It is used as a placeholder for undefined
// Storage objects. If you get a compiler error involving this object, then it
// probably comes from trying to use an ArrayHandle with bad template
// arguments.
template <typename T>
struct UndefinedArrayPortal
{
  VISKORES_STATIC_ASSERT(sizeof(T) == static_cast<size_t>(-1));
};
 
} // namespace detail
 
template <typename T, class StorageTag>
class Storage
#ifndef VISKORES_DOXYGEN_ONLY
  : public viskores::cont::internal::UndefinedStorage
{
public:
  using ReadPortalType = viskores::cont::internal::detail::UndefinedArrayPortal<T>;
  using WritePortalType = viskores::cont::internal::detail::UndefinedArrayPortal<T>;
};
#else  //VISKORES_DOXYGEN_ONLY
{
public:
  using ValueType = T;
 
  using ReadPortalType = viskores::internal::ArrayPortalBasicRead<T>;
 
  using WritePortalType = viskores::internal::ArrayPortalBasicWrite<T>;
 
  VISKORES_CONT static std::vector<viskores::cont::internal::Buffer> CreateBuffers();
 
  VISKORES_CONT static void ResizeBuffers(
    viskores::Id numValues,
    const std::vector<viskores::cont::internal::Buffer>& buffers,
    viskores::CopyFlag preserve,
    viskores::cont::Token& token);
 
  VISKORES_CONT static viskores::Id GetNumberOfValues(
    const std::vector<viskores::cont::internal::Buffer>& buffers);
 
  VISKORES_CONT static void Fill(const std::vector<viskores::cont::internal::Buffer>& buffers,
                                 const ValueType& fillValue,
                                 viskores::Id startIndex,
                                 viskores::Id endIndex,
                                 viskores::cont::Token& token);
 
  VISKORES_CONT static ReadPortalType CreateReadPortal(
    const std::vector<viskores::cont::internal::Buffer>& buffers,
    viskores::cont::DeviceAdapterId device,
    viskores::cont::Token& token);
 
  VISKORES_CONT static WritePortalType CreateWritePortal(
    const std::vector<viskores::cont::internal::Buffer>& buffers,
    viskores::cont::DeviceAdapterId device,
    viskores::cont::Token& token)
};
#endif // VISKORES_DOXYGEN_ONLY
 
namespace detail
{
 
VISKORES_CONT_EXPORT void StorageNoResizeImpl(viskores::Id currentNumValues,
                                              viskores::Id requestedNumValues,
                                              std::string storageTagName);
 
} // namespace detail
 
template <typename StorageType>
struct StorageTraits;
 
template <typename T, typename S>
struct StorageTraits<viskores::cont::internal::Storage<T, S>>
{
  using ValueType = T;
  using Tag = S;
};
 
#define VISKORES_STORAGE_NO_RESIZE                                          \
  VISKORES_CONT static void ResizeBuffers(                                  \
    viskores::Id numValues,                                                 \
    const std::vector<viskores::cont::internal::Buffer>& buffers,           \
    viskores::CopyFlag,                                                     \
    viskores::cont::Token&)                                                 \
  {                                                                         \
    viskores::cont::internal::detail::StorageNoResizeImpl(                  \
      GetNumberOfValues(buffers),                                           \
      numValues,                                                            \
      viskores::cont::TypeToString<                                         \
        typename viskores::cont::internal::StorageTraits<Storage>::Tag>()); \
  }                                                                         \
  using ResizeBuffersEatComma = void
 
#define VISKORES_STORAGE_NO_WRITE_PORTAL                                         \
  using WritePortalType = viskores::internal::ArrayPortalDummy<                  \
    typename viskores::cont::internal::StorageTraits<Storage>::ValueType>;       \
  VISKORES_CONT static void Fill(                                                \
    const std::vector<viskores::cont::internal::Buffer>&,                        \
    const typename viskores::cont::internal::StorageTraits<Storage>::ValueType&, \
    viskores::Id,                                                                \
    viskores::Id,                                                                \
    viskores::cont::Token&)                                                      \
  {                                                                              \
    throw viskores::cont::ErrorBadAllocation(                                    \
      "Cannot write to arrays with storage type of " +                           \
      viskores::cont::TypeToString<                                              \
        typename viskores::cont::internal::StorageTraits<Storage>::Tag>());      \
  }                                                                              \
  VISKORES_CONT static WritePortalType CreateWritePortal(                        \
    const std::vector<viskores::cont::internal::Buffer>&,                        \
    viskores::cont::DeviceAdapterId,                                             \
    viskores::cont::Token&)                                                      \
  {                                                                              \
    throw viskores::cont::ErrorBadAllocation(                                    \
      "Cannot write to arrays with storage type of " +                           \
      viskores::cont::TypeToString<                                              \
        typename viskores::cont::internal::StorageTraits<Storage>::Tag>());      \
  }                                                                              \
  using CreateWritePortalEatComma = void
 
} // namespace internal
}
} // namespace viskores::cont
 
#endif //viskores_cont_Storage_h