buffer_info.h 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108
  1. /*
  2. pybind11/buffer_info.h: Python buffer object interface
  3. Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch>
  4. All rights reserved. Use of this source code is governed by a
  5. BSD-style license that can be found in the LICENSE file.
  6. */
  7. #pragma once
  8. #include "detail/common.h"
  9. NAMESPACE_BEGIN(PYBIND11_NAMESPACE)
  10. /// Information record describing a Python buffer object
  11. struct buffer_info {
  12. void *ptr = nullptr; // Pointer to the underlying storage
  13. ssize_t itemsize = 0; // Size of individual items in bytes
  14. ssize_t size = 0; // Total number of entries
  15. std::string format; // For homogeneous buffers, this should be set to format_descriptor<T>::format()
  16. ssize_t ndim = 0; // Number of dimensions
  17. std::vector<ssize_t> shape; // Shape of the tensor (1 entry per dimension)
  18. std::vector<ssize_t> strides; // Number of entries between adjacent entries (for each per dimension)
  19. buffer_info() { }
  20. buffer_info(void *ptr, ssize_t itemsize, const std::string &format, ssize_t ndim,
  21. detail::any_container<ssize_t> shape_in, detail::any_container<ssize_t> strides_in)
  22. : ptr(ptr), itemsize(itemsize), size(1), format(format), ndim(ndim),
  23. shape(std::move(shape_in)), strides(std::move(strides_in)) {
  24. if (ndim != (ssize_t) shape.size() || ndim != (ssize_t) strides.size())
  25. pybind11_fail("buffer_info: ndim doesn't match shape and/or strides length");
  26. for (size_t i = 0; i < (size_t) ndim; ++i)
  27. size *= shape[i];
  28. }
  29. template <typename T>
  30. buffer_info(T *ptr, detail::any_container<ssize_t> shape_in, detail::any_container<ssize_t> strides_in)
  31. : buffer_info(private_ctr_tag(), ptr, sizeof(T), format_descriptor<T>::format(), static_cast<ssize_t>(shape_in->size()), std::move(shape_in), std::move(strides_in)) { }
  32. buffer_info(void *ptr, ssize_t itemsize, const std::string &format, ssize_t size)
  33. : buffer_info(ptr, itemsize, format, 1, {size}, {itemsize}) { }
  34. template <typename T>
  35. buffer_info(T *ptr, ssize_t size)
  36. : buffer_info(ptr, sizeof(T), format_descriptor<T>::format(), size) { }
  37. explicit buffer_info(Py_buffer *view, bool ownview = true)
  38. : buffer_info(view->buf, view->itemsize, view->format, view->ndim,
  39. {view->shape, view->shape + view->ndim}, {view->strides, view->strides + view->ndim}) {
  40. this->view = view;
  41. this->ownview = ownview;
  42. }
  43. buffer_info(const buffer_info &) = delete;
  44. buffer_info& operator=(const buffer_info &) = delete;
  45. buffer_info(buffer_info &&other) {
  46. (*this) = std::move(other);
  47. }
  48. buffer_info& operator=(buffer_info &&rhs) {
  49. ptr = rhs.ptr;
  50. itemsize = rhs.itemsize;
  51. size = rhs.size;
  52. format = std::move(rhs.format);
  53. ndim = rhs.ndim;
  54. shape = std::move(rhs.shape);
  55. strides = std::move(rhs.strides);
  56. std::swap(view, rhs.view);
  57. std::swap(ownview, rhs.ownview);
  58. return *this;
  59. }
  60. ~buffer_info() {
  61. if (view && ownview) { PyBuffer_Release(view); delete view; }
  62. }
  63. private:
  64. struct private_ctr_tag { };
  65. buffer_info(private_ctr_tag, void *ptr, ssize_t itemsize, const std::string &format, ssize_t ndim,
  66. detail::any_container<ssize_t> &&shape_in, detail::any_container<ssize_t> &&strides_in)
  67. : buffer_info(ptr, itemsize, format, ndim, std::move(shape_in), std::move(strides_in)) { }
  68. Py_buffer *view = nullptr;
  69. bool ownview = false;
  70. };
  71. NAMESPACE_BEGIN(detail)
  72. template <typename T, typename SFINAE = void> struct compare_buffer_info {
  73. static bool compare(const buffer_info& b) {
  74. return b.format == format_descriptor<T>::format() && b.itemsize == (ssize_t) sizeof(T);
  75. }
  76. };
  77. template <typename T> struct compare_buffer_info<T, detail::enable_if_t<std::is_integral<T>::value>> {
  78. static bool compare(const buffer_info& b) {
  79. return (size_t) b.itemsize == sizeof(T) && (b.format == format_descriptor<T>::value ||
  80. ((sizeof(T) == sizeof(long)) && b.format == (std::is_unsigned<T>::value ? "L" : "l")) ||
  81. ((sizeof(T) == sizeof(size_t)) && b.format == (std::is_unsigned<T>::value ? "N" : "n")));
  82. }
  83. };
  84. NAMESPACE_END(detail)
  85. NAMESPACE_END(PYBIND11_NAMESPACE)