Shuenhoy/vtk-m
1
0
Fork 0
mirror of https://gitlab.kitware.com/vtk/vtk-m synced 2024-09-08 13:23:51 +00:00
Code Issues 2 Actions Packages Projects Releases Wiki Activity

Update documentation for Storage

Browse Source
This commit is contained in:
Kenneth Moreland 2021-01-28 14:37:10 -07:00
parent 7011cb8794
commit eb90a6080c
1 changed files with 23 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
vtkm/cont/Storage.h
View File

@ -100,10 +100,6 @@ class Storage
: public vtkm::cont::internal::UndefinedStorage
{
public:
// TODO: Deprecate these
using PortalType = vtkm::cont::internal::detail::UndefinedArrayPortal<T>;
using PortalConstType = vtkm::cont::internal::detail::UndefinedArrayPortal<T>;
using ReadPortalType = vtkm::cont::internal::detail::UndefinedArrayPortal<T>;
using WritePortalType = vtkm::cont::internal::detail::UndefinedArrayPortal<T>;
};
@ -114,68 +110,41 @@ public:
///
using ValueType = T;
/// \brief The type of portal objects for the array.
/// \brief The type of portal objects for the array (read only).
///
/// The actual portal object can take any form. This is a simple example of a
/// portal to a C array.
///
using PortalType = ::vtkm::cont::internal::ArrayPortalFromIterators<ValueType*>;
using ReadPortalType = vtkm::internal::ArrayPortalBasicRead<T>;
/// \brief The type of portal objects (const version) for the array.
/// \brief The type of portal objects for the array (read/write).
///
/// The actual portal object can take any form. This is a simple example of a
/// portal to a C array.
///
using PortalConstType = ::vtkm::cont::internal::ArrayPortalFromIterators<const ValueType*>;
using WritePortalType = vtkm::internal::ArrayPortalBasicWrite<T>;
VTKM_CONT Storage(const Storage& src);
VTKM_CONT Storage(Storage&& src) noexcept;
VTKM_CONT Storage& operator=(const Storage& src);
VTKM_CONT Storage& operator=(Storage&& src);
/// Returns a portal to the array.
/// \brief Returns the number of buffers required for this storage.
///
VTKM_CONT
PortalType GetPortal();
VTKM_CONT constexpr static vtkm::IdComponent GetNumberOfBuffers();
/// Returns a portal to the array with immutable values.
/// \brief Resizes the array by changing the size of the buffers.
///
VTKM_CONT
PortalConstType GetPortalConst() const;
/// Can also modify any metadata attached to the buffers.
///
VTKM_CONT static void ResizeBuffers(vtkm::Id numValues,
vtkm::cont::internal::Buffer* buffers,
vtkm::CopyFlag preserve,
vtkm::cont::Token& token);
/// Returns the number of entries allocated in the array.
VTKM_CONT
vtkm::Id GetNumberOfValues() const;
/// \brief Returns the number of entries allocated in the array.
VTKM_CONT static vtkm::Id GetNumberOfValues(const vtkm::cont::internal::Buffer* buffers);
/// \brief Allocates an array large enough to hold the given number of values.
/// \brief Create a read-only portal on the specified device.
///
/// The allocation may be done on an already existing array, but can wipe out
/// any data already in the array. This method can throw
/// ErrorBadAllocation if the array cannot be allocated or
/// ErrorBadValue if the allocation is not feasible (for example, the
/// array storage is read-only).
///
VTKM_CONT
void Allocate(vtkm::Id numberOfValues);
VTKM_CONT static ReadPortalType CreateReadPortal(const vtkm::cont::internal::Buffer* buffers,
vtkm::cont::DeviceAdapterId device,
vtkm::cont::Token& token);
/// \brief Reduces the size of the array without changing its values.
/// \brief Create a read/write portal on the specified device.
///
/// This method allows you to resize the array without reallocating it. The
/// number of entries in the array is changed to \c numberOfValues. The data
/// in the array (from indices 0 to \c numberOfValues - 1) are the same, but
/// \c numberOfValues must be equal or less than the preexisting size
/// (returned from GetNumberOfValues). That is, this method can only be used
/// to shorten the array, not lengthen.
VTKM_CONT
void Shrink(vtkm::Id numberOfValues);
/// \brief Frees any resources (i.e. memory) stored in this array.
///
/// After calling this method GetNumberOfValues will return 0. The
/// resources should also be released when the Storage class is
/// destroyed.
VTKM_CONT
void ReleaseResources();
VTKM_CONT static WritePortalType CreateWritePortal(vtkm::cont::internal::Buffer* buffers,
vtkm::cont::DeviceAdapterId device,
vtkm::cont::Token& token)
};
#endif // VTKM_DOXYGEN_ONLY