Skip to content

Add helpers to array that return the size and strides as a std::span #5974

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dbs4261 wants to merge 2 commits into
base: master
Choose a base branch
from
+22 −0
Open

Add helpers to array that return the size and strides as a std::span #5974

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f880da4
Add helper functions to pybind11::array to return the shape and strid…
dbs4261 Jan 26, 2026
341d5ad
style: pre-commit fixes
pre-commit-ci[bot] Jan 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions include/pybind11/detail/common.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,10 @@
# define PYBIND11_HAS_STRING_VIEW 1
#endif

#if defined(PYBIND11_CPP20) && defined(__has_include) && __has_include(<span>)
# define PYBIND11_HAS_SPAN 1
#endif

#if (defined(PYPY_VERSION) || defined(GRAALVM_PYTHON)) && !defined(PYBIND11_SIMPLE_GIL_MANAGEMENT)
# define PYBIND11_SIMPLE_GIL_MANAGEMENT
#endif
Expand Down
18 changes: 18 additions & 0 deletions include/pybind11/numpy.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@
#include <utility>
#include <vector>

#ifdef PYBIND11_HAS_SPAN
# include <span>
#endif

#if defined(PYBIND11_NUMPY_1_ONLY)
# error "PYBIND11_NUMPY_1_ONLY is no longer supported (see PR #5595)."
#endif
Expand Down Expand Up @@ -1143,6 +1147,13 @@ class array : public buffer {
/// Dimensions of the array
const ssize_t *shape() const { return detail::array_proxy(m_ptr)->dimensions; }

#ifdef PYBIND11_HAS_SPAN
/// Dimensions of the array as a span
std::span<const ssize_t, std::dynamic_extent> shape_span() const {
return std::span(shape(), static_cast<std::size_t>(ndim()));
}
#endif

/// Dimension along a given axis
ssize_t shape(ssize_t dim) const {
if (dim >= ndim()) {
Expand All @@ -1154,6 +1165,13 @@ class array : public buffer {
/// Strides of the array
const ssize_t *strides() const { return detail::array_proxy(m_ptr)->strides; }

#ifdef PYBIND11_HAS_SPAN
/// Strides of the array as a span
std::span<const ssize_t, std::dynamic_extent> strides_span() const {
return std::span(strides(), static_cast<std::size_t>(ndim()));
}
#endif

/// Stride along a given axis
ssize_t strides(ssize_t dim) const {
if (dim >= ndim()) {
Expand Down
Loading