numpy.h revision 12391
111986Sandreas.sandberg@arm.com/* 211986Sandreas.sandberg@arm.com pybind11/numpy.h: Basic NumPy support, vectorize() wrapper 311986Sandreas.sandberg@arm.com 411986Sandreas.sandberg@arm.com Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> 511986Sandreas.sandberg@arm.com 611986Sandreas.sandberg@arm.com All rights reserved. Use of this source code is governed by a 711986Sandreas.sandberg@arm.com BSD-style license that can be found in the LICENSE file. 811986Sandreas.sandberg@arm.com*/ 911986Sandreas.sandberg@arm.com 1011986Sandreas.sandberg@arm.com#pragma once 1111986Sandreas.sandberg@arm.com 1211986Sandreas.sandberg@arm.com#include "pybind11.h" 1311986Sandreas.sandberg@arm.com#include "complex.h" 1411986Sandreas.sandberg@arm.com#include <numeric> 1511986Sandreas.sandberg@arm.com#include <algorithm> 1611986Sandreas.sandberg@arm.com#include <array> 1711986Sandreas.sandberg@arm.com#include <cstdlib> 1811986Sandreas.sandberg@arm.com#include <cstring> 1911986Sandreas.sandberg@arm.com#include <sstream> 2011986Sandreas.sandberg@arm.com#include <string> 2111986Sandreas.sandberg@arm.com#include <initializer_list> 2211986Sandreas.sandberg@arm.com#include <functional> 2311986Sandreas.sandberg@arm.com#include <utility> 2411986Sandreas.sandberg@arm.com#include <typeindex> 2511986Sandreas.sandberg@arm.com 2611986Sandreas.sandberg@arm.com#if defined(_MSC_VER) 2711986Sandreas.sandberg@arm.com# pragma warning(push) 2811986Sandreas.sandberg@arm.com# pragma warning(disable: 4127) // warning C4127: Conditional expression is constant 2911986Sandreas.sandberg@arm.com#endif 3011986Sandreas.sandberg@arm.com 3111986Sandreas.sandberg@arm.com/* This will be true on all flat address space platforms and allows us to reduce the 3212391Sjason@lowepower.com whole npy_intp / ssize_t / Py_intptr_t business down to just ssize_t for all size 3311986Sandreas.sandberg@arm.com and dimension types (e.g. shape, strides, indexing), instead of inflicting this 3411986Sandreas.sandberg@arm.com upon the library user. */ 3512391Sjason@lowepower.comstatic_assert(sizeof(ssize_t) == sizeof(Py_intptr_t), "ssize_t != Py_intptr_t"); 3611986Sandreas.sandberg@arm.com 3712391Sjason@lowepower.comNAMESPACE_BEGIN(PYBIND11_NAMESPACE) 3812037Sandreas.sandberg@arm.com 3912037Sandreas.sandberg@arm.comclass array; // Forward declaration 4012037Sandreas.sandberg@arm.com 4111986Sandreas.sandberg@arm.comNAMESPACE_BEGIN(detail) 4212037Sandreas.sandberg@arm.comtemplate <typename type, typename SFINAE = void> struct npy_format_descriptor; 4311986Sandreas.sandberg@arm.com 4411986Sandreas.sandberg@arm.comstruct PyArrayDescr_Proxy { 4511986Sandreas.sandberg@arm.com PyObject_HEAD 4611986Sandreas.sandberg@arm.com PyObject *typeobj; 4711986Sandreas.sandberg@arm.com char kind; 4811986Sandreas.sandberg@arm.com char type; 4911986Sandreas.sandberg@arm.com char byteorder; 5011986Sandreas.sandberg@arm.com char flags; 5111986Sandreas.sandberg@arm.com int type_num; 5211986Sandreas.sandberg@arm.com int elsize; 5311986Sandreas.sandberg@arm.com int alignment; 5411986Sandreas.sandberg@arm.com char *subarray; 5511986Sandreas.sandberg@arm.com PyObject *fields; 5611986Sandreas.sandberg@arm.com PyObject *names; 5711986Sandreas.sandberg@arm.com}; 5811986Sandreas.sandberg@arm.com 5911986Sandreas.sandberg@arm.comstruct PyArray_Proxy { 6011986Sandreas.sandberg@arm.com PyObject_HEAD 6111986Sandreas.sandberg@arm.com char *data; 6211986Sandreas.sandberg@arm.com int nd; 6311986Sandreas.sandberg@arm.com ssize_t *dimensions; 6411986Sandreas.sandberg@arm.com ssize_t *strides; 6511986Sandreas.sandberg@arm.com PyObject *base; 6611986Sandreas.sandberg@arm.com PyObject *descr; 6711986Sandreas.sandberg@arm.com int flags; 6811986Sandreas.sandberg@arm.com}; 6911986Sandreas.sandberg@arm.com 7011986Sandreas.sandberg@arm.comstruct PyVoidScalarObject_Proxy { 7111986Sandreas.sandberg@arm.com PyObject_VAR_HEAD 7211986Sandreas.sandberg@arm.com char *obval; 7311986Sandreas.sandberg@arm.com PyArrayDescr_Proxy *descr; 7411986Sandreas.sandberg@arm.com int flags; 7511986Sandreas.sandberg@arm.com PyObject *base; 7611986Sandreas.sandberg@arm.com}; 7711986Sandreas.sandberg@arm.com 7811986Sandreas.sandberg@arm.comstruct numpy_type_info { 7911986Sandreas.sandberg@arm.com PyObject* dtype_ptr; 8011986Sandreas.sandberg@arm.com std::string format_str; 8111986Sandreas.sandberg@arm.com}; 8211986Sandreas.sandberg@arm.com 8311986Sandreas.sandberg@arm.comstruct numpy_internals { 8411986Sandreas.sandberg@arm.com std::unordered_map<std::type_index, numpy_type_info> registered_dtypes; 8511986Sandreas.sandberg@arm.com 8611986Sandreas.sandberg@arm.com numpy_type_info *get_type_info(const std::type_info& tinfo, bool throw_if_missing = true) { 8711986Sandreas.sandberg@arm.com auto it = registered_dtypes.find(std::type_index(tinfo)); 8811986Sandreas.sandberg@arm.com if (it != registered_dtypes.end()) 8911986Sandreas.sandberg@arm.com return &(it->second); 9011986Sandreas.sandberg@arm.com if (throw_if_missing) 9111986Sandreas.sandberg@arm.com pybind11_fail(std::string("NumPy type info missing for ") + tinfo.name()); 9211986Sandreas.sandberg@arm.com return nullptr; 9311986Sandreas.sandberg@arm.com } 9411986Sandreas.sandberg@arm.com 9511986Sandreas.sandberg@arm.com template<typename T> numpy_type_info *get_type_info(bool throw_if_missing = true) { 9611986Sandreas.sandberg@arm.com return get_type_info(typeid(typename std::remove_cv<T>::type), throw_if_missing); 9711986Sandreas.sandberg@arm.com } 9811986Sandreas.sandberg@arm.com}; 9911986Sandreas.sandberg@arm.com 10011986Sandreas.sandberg@arm.cominline PYBIND11_NOINLINE void load_numpy_internals(numpy_internals* &ptr) { 10111986Sandreas.sandberg@arm.com ptr = &get_or_create_shared_data<numpy_internals>("_numpy_internals"); 10211986Sandreas.sandberg@arm.com} 10311986Sandreas.sandberg@arm.com 10411986Sandreas.sandberg@arm.cominline numpy_internals& get_numpy_internals() { 10511986Sandreas.sandberg@arm.com static numpy_internals* ptr = nullptr; 10611986Sandreas.sandberg@arm.com if (!ptr) 10711986Sandreas.sandberg@arm.com load_numpy_internals(ptr); 10811986Sandreas.sandberg@arm.com return *ptr; 10911986Sandreas.sandberg@arm.com} 11011986Sandreas.sandberg@arm.com 11111986Sandreas.sandberg@arm.comstruct npy_api { 11211986Sandreas.sandberg@arm.com enum constants { 11312037Sandreas.sandberg@arm.com NPY_ARRAY_C_CONTIGUOUS_ = 0x0001, 11412037Sandreas.sandberg@arm.com NPY_ARRAY_F_CONTIGUOUS_ = 0x0002, 11511986Sandreas.sandberg@arm.com NPY_ARRAY_OWNDATA_ = 0x0004, 11611986Sandreas.sandberg@arm.com NPY_ARRAY_FORCECAST_ = 0x0010, 11712037Sandreas.sandberg@arm.com NPY_ARRAY_ENSUREARRAY_ = 0x0040, 11811986Sandreas.sandberg@arm.com NPY_ARRAY_ALIGNED_ = 0x0100, 11911986Sandreas.sandberg@arm.com NPY_ARRAY_WRITEABLE_ = 0x0400, 12011986Sandreas.sandberg@arm.com NPY_BOOL_ = 0, 12111986Sandreas.sandberg@arm.com NPY_BYTE_, NPY_UBYTE_, 12211986Sandreas.sandberg@arm.com NPY_SHORT_, NPY_USHORT_, 12311986Sandreas.sandberg@arm.com NPY_INT_, NPY_UINT_, 12411986Sandreas.sandberg@arm.com NPY_LONG_, NPY_ULONG_, 12511986Sandreas.sandberg@arm.com NPY_LONGLONG_, NPY_ULONGLONG_, 12611986Sandreas.sandberg@arm.com NPY_FLOAT_, NPY_DOUBLE_, NPY_LONGDOUBLE_, 12711986Sandreas.sandberg@arm.com NPY_CFLOAT_, NPY_CDOUBLE_, NPY_CLONGDOUBLE_, 12811986Sandreas.sandberg@arm.com NPY_OBJECT_ = 17, 12911986Sandreas.sandberg@arm.com NPY_STRING_, NPY_UNICODE_, NPY_VOID_ 13011986Sandreas.sandberg@arm.com }; 13111986Sandreas.sandberg@arm.com 13212391Sjason@lowepower.com typedef struct { 13312391Sjason@lowepower.com Py_intptr_t *ptr; 13412391Sjason@lowepower.com int len; 13512391Sjason@lowepower.com } PyArray_Dims; 13612391Sjason@lowepower.com 13711986Sandreas.sandberg@arm.com static npy_api& get() { 13811986Sandreas.sandberg@arm.com static npy_api api = lookup(); 13911986Sandreas.sandberg@arm.com return api; 14011986Sandreas.sandberg@arm.com } 14111986Sandreas.sandberg@arm.com 14211986Sandreas.sandberg@arm.com bool PyArray_Check_(PyObject *obj) const { 14311986Sandreas.sandberg@arm.com return (bool) PyObject_TypeCheck(obj, PyArray_Type_); 14411986Sandreas.sandberg@arm.com } 14511986Sandreas.sandberg@arm.com bool PyArrayDescr_Check_(PyObject *obj) const { 14611986Sandreas.sandberg@arm.com return (bool) PyObject_TypeCheck(obj, PyArrayDescr_Type_); 14711986Sandreas.sandberg@arm.com } 14811986Sandreas.sandberg@arm.com 14912391Sjason@lowepower.com unsigned int (*PyArray_GetNDArrayCFeatureVersion_)(); 15011986Sandreas.sandberg@arm.com PyObject *(*PyArray_DescrFromType_)(int); 15111986Sandreas.sandberg@arm.com PyObject *(*PyArray_NewFromDescr_) 15211986Sandreas.sandberg@arm.com (PyTypeObject *, PyObject *, int, Py_intptr_t *, 15311986Sandreas.sandberg@arm.com Py_intptr_t *, void *, int, PyObject *); 15411986Sandreas.sandberg@arm.com PyObject *(*PyArray_DescrNewFromType_)(int); 15512391Sjason@lowepower.com int (*PyArray_CopyInto_)(PyObject *, PyObject *); 15611986Sandreas.sandberg@arm.com PyObject *(*PyArray_NewCopy_)(PyObject *, int); 15711986Sandreas.sandberg@arm.com PyTypeObject *PyArray_Type_; 15811986Sandreas.sandberg@arm.com PyTypeObject *PyVoidArrType_Type_; 15911986Sandreas.sandberg@arm.com PyTypeObject *PyArrayDescr_Type_; 16011986Sandreas.sandberg@arm.com PyObject *(*PyArray_DescrFromScalar_)(PyObject *); 16111986Sandreas.sandberg@arm.com PyObject *(*PyArray_FromAny_) (PyObject *, PyObject *, int, int, int, PyObject *); 16211986Sandreas.sandberg@arm.com int (*PyArray_DescrConverter_) (PyObject *, PyObject **); 16311986Sandreas.sandberg@arm.com bool (*PyArray_EquivTypes_) (PyObject *, PyObject *); 16411986Sandreas.sandberg@arm.com int (*PyArray_GetArrayParamsFromObject_)(PyObject *, PyObject *, char, PyObject **, int *, 16511986Sandreas.sandberg@arm.com Py_ssize_t *, PyObject **, PyObject *); 16611986Sandreas.sandberg@arm.com PyObject *(*PyArray_Squeeze_)(PyObject *); 16712037Sandreas.sandberg@arm.com int (*PyArray_SetBaseObject_)(PyObject *, PyObject *); 16812391Sjason@lowepower.com PyObject* (*PyArray_Resize_)(PyObject*, PyArray_Dims*, int, int); 16911986Sandreas.sandberg@arm.comprivate: 17011986Sandreas.sandberg@arm.com enum functions { 17112391Sjason@lowepower.com API_PyArray_GetNDArrayCFeatureVersion = 211, 17211986Sandreas.sandberg@arm.com API_PyArray_Type = 2, 17311986Sandreas.sandberg@arm.com API_PyArrayDescr_Type = 3, 17411986Sandreas.sandberg@arm.com API_PyVoidArrType_Type = 39, 17511986Sandreas.sandberg@arm.com API_PyArray_DescrFromType = 45, 17611986Sandreas.sandberg@arm.com API_PyArray_DescrFromScalar = 57, 17711986Sandreas.sandberg@arm.com API_PyArray_FromAny = 69, 17812391Sjason@lowepower.com API_PyArray_Resize = 80, 17912391Sjason@lowepower.com API_PyArray_CopyInto = 82, 18011986Sandreas.sandberg@arm.com API_PyArray_NewCopy = 85, 18111986Sandreas.sandberg@arm.com API_PyArray_NewFromDescr = 94, 18211986Sandreas.sandberg@arm.com API_PyArray_DescrNewFromType = 9, 18311986Sandreas.sandberg@arm.com API_PyArray_DescrConverter = 174, 18411986Sandreas.sandberg@arm.com API_PyArray_EquivTypes = 182, 18511986Sandreas.sandberg@arm.com API_PyArray_GetArrayParamsFromObject = 278, 18612037Sandreas.sandberg@arm.com API_PyArray_Squeeze = 136, 18712037Sandreas.sandberg@arm.com API_PyArray_SetBaseObject = 282 18811986Sandreas.sandberg@arm.com }; 18911986Sandreas.sandberg@arm.com 19011986Sandreas.sandberg@arm.com static npy_api lookup() { 19111986Sandreas.sandberg@arm.com module m = module::import("numpy.core.multiarray"); 19211986Sandreas.sandberg@arm.com auto c = m.attr("_ARRAY_API"); 19311986Sandreas.sandberg@arm.com#if PY_MAJOR_VERSION >= 3 19411986Sandreas.sandberg@arm.com void **api_ptr = (void **) PyCapsule_GetPointer(c.ptr(), NULL); 19511986Sandreas.sandberg@arm.com#else 19611986Sandreas.sandberg@arm.com void **api_ptr = (void **) PyCObject_AsVoidPtr(c.ptr()); 19711986Sandreas.sandberg@arm.com#endif 19811986Sandreas.sandberg@arm.com npy_api api; 19911986Sandreas.sandberg@arm.com#define DECL_NPY_API(Func) api.Func##_ = (decltype(api.Func##_)) api_ptr[API_##Func]; 20012391Sjason@lowepower.com DECL_NPY_API(PyArray_GetNDArrayCFeatureVersion); 20112391Sjason@lowepower.com if (api.PyArray_GetNDArrayCFeatureVersion_() < 0x7) 20212391Sjason@lowepower.com pybind11_fail("pybind11 numpy support requires numpy >= 1.7.0"); 20311986Sandreas.sandberg@arm.com DECL_NPY_API(PyArray_Type); 20411986Sandreas.sandberg@arm.com DECL_NPY_API(PyVoidArrType_Type); 20511986Sandreas.sandberg@arm.com DECL_NPY_API(PyArrayDescr_Type); 20611986Sandreas.sandberg@arm.com DECL_NPY_API(PyArray_DescrFromType); 20711986Sandreas.sandberg@arm.com DECL_NPY_API(PyArray_DescrFromScalar); 20811986Sandreas.sandberg@arm.com DECL_NPY_API(PyArray_FromAny); 20912391Sjason@lowepower.com DECL_NPY_API(PyArray_Resize); 21012391Sjason@lowepower.com DECL_NPY_API(PyArray_CopyInto); 21111986Sandreas.sandberg@arm.com DECL_NPY_API(PyArray_NewCopy); 21211986Sandreas.sandberg@arm.com DECL_NPY_API(PyArray_NewFromDescr); 21311986Sandreas.sandberg@arm.com DECL_NPY_API(PyArray_DescrNewFromType); 21411986Sandreas.sandberg@arm.com DECL_NPY_API(PyArray_DescrConverter); 21511986Sandreas.sandberg@arm.com DECL_NPY_API(PyArray_EquivTypes); 21611986Sandreas.sandberg@arm.com DECL_NPY_API(PyArray_GetArrayParamsFromObject); 21711986Sandreas.sandberg@arm.com DECL_NPY_API(PyArray_Squeeze); 21812037Sandreas.sandberg@arm.com DECL_NPY_API(PyArray_SetBaseObject); 21911986Sandreas.sandberg@arm.com#undef DECL_NPY_API 22011986Sandreas.sandberg@arm.com return api; 22111986Sandreas.sandberg@arm.com } 22211986Sandreas.sandberg@arm.com}; 22311986Sandreas.sandberg@arm.com 22411986Sandreas.sandberg@arm.cominline PyArray_Proxy* array_proxy(void* ptr) { 22511986Sandreas.sandberg@arm.com return reinterpret_cast<PyArray_Proxy*>(ptr); 22611986Sandreas.sandberg@arm.com} 22711986Sandreas.sandberg@arm.com 22811986Sandreas.sandberg@arm.cominline const PyArray_Proxy* array_proxy(const void* ptr) { 22911986Sandreas.sandberg@arm.com return reinterpret_cast<const PyArray_Proxy*>(ptr); 23011986Sandreas.sandberg@arm.com} 23111986Sandreas.sandberg@arm.com 23211986Sandreas.sandberg@arm.cominline PyArrayDescr_Proxy* array_descriptor_proxy(PyObject* ptr) { 23311986Sandreas.sandberg@arm.com return reinterpret_cast<PyArrayDescr_Proxy*>(ptr); 23411986Sandreas.sandberg@arm.com} 23511986Sandreas.sandberg@arm.com 23611986Sandreas.sandberg@arm.cominline const PyArrayDescr_Proxy* array_descriptor_proxy(const PyObject* ptr) { 23711986Sandreas.sandberg@arm.com return reinterpret_cast<const PyArrayDescr_Proxy*>(ptr); 23811986Sandreas.sandberg@arm.com} 23911986Sandreas.sandberg@arm.com 24011986Sandreas.sandberg@arm.cominline bool check_flags(const void* ptr, int flag) { 24111986Sandreas.sandberg@arm.com return (flag == (array_proxy(ptr)->flags & flag)); 24211986Sandreas.sandberg@arm.com} 24311986Sandreas.sandberg@arm.com 24412037Sandreas.sandberg@arm.comtemplate <typename T> struct is_std_array : std::false_type { }; 24512037Sandreas.sandberg@arm.comtemplate <typename T, size_t N> struct is_std_array<std::array<T, N>> : std::true_type { }; 24612037Sandreas.sandberg@arm.comtemplate <typename T> struct is_complex : std::false_type { }; 24712037Sandreas.sandberg@arm.comtemplate <typename T> struct is_complex<std::complex<T>> : std::true_type { }; 24812037Sandreas.sandberg@arm.com 24912391Sjason@lowepower.comtemplate <typename T> struct array_info_scalar { 25012391Sjason@lowepower.com typedef T type; 25112391Sjason@lowepower.com static constexpr bool is_array = false; 25212391Sjason@lowepower.com static constexpr bool is_empty = false; 25312391Sjason@lowepower.com static PYBIND11_DESCR extents() { return _(""); } 25412391Sjason@lowepower.com static void append_extents(list& /* shape */) { } 25512391Sjason@lowepower.com}; 25612391Sjason@lowepower.com// Computes underlying type and a comma-separated list of extents for array 25712391Sjason@lowepower.com// types (any mix of std::array and built-in arrays). An array of char is 25812391Sjason@lowepower.com// treated as scalar because it gets special handling. 25912391Sjason@lowepower.comtemplate <typename T> struct array_info : array_info_scalar<T> { }; 26012391Sjason@lowepower.comtemplate <typename T, size_t N> struct array_info<std::array<T, N>> { 26112391Sjason@lowepower.com using type = typename array_info<T>::type; 26212391Sjason@lowepower.com static constexpr bool is_array = true; 26312391Sjason@lowepower.com static constexpr bool is_empty = (N == 0) || array_info<T>::is_empty; 26412391Sjason@lowepower.com static constexpr size_t extent = N; 26512391Sjason@lowepower.com 26612391Sjason@lowepower.com // appends the extents to shape 26712391Sjason@lowepower.com static void append_extents(list& shape) { 26812391Sjason@lowepower.com shape.append(N); 26912391Sjason@lowepower.com array_info<T>::append_extents(shape); 27012391Sjason@lowepower.com } 27112391Sjason@lowepower.com 27212391Sjason@lowepower.com template<typename T2 = T, enable_if_t<!array_info<T2>::is_array, int> = 0> 27312391Sjason@lowepower.com static PYBIND11_DESCR extents() { 27412391Sjason@lowepower.com return _<N>(); 27512391Sjason@lowepower.com } 27612391Sjason@lowepower.com 27712391Sjason@lowepower.com template<typename T2 = T, enable_if_t<array_info<T2>::is_array, int> = 0> 27812391Sjason@lowepower.com static PYBIND11_DESCR extents() { 27912391Sjason@lowepower.com return concat(_<N>(), array_info<T>::extents()); 28012391Sjason@lowepower.com } 28112391Sjason@lowepower.com}; 28212391Sjason@lowepower.com// For numpy we have special handling for arrays of characters, so we don't include 28312391Sjason@lowepower.com// the size in the array extents. 28412391Sjason@lowepower.comtemplate <size_t N> struct array_info<char[N]> : array_info_scalar<char[N]> { }; 28512391Sjason@lowepower.comtemplate <size_t N> struct array_info<std::array<char, N>> : array_info_scalar<std::array<char, N>> { }; 28612391Sjason@lowepower.comtemplate <typename T, size_t N> struct array_info<T[N]> : array_info<std::array<T, N>> { }; 28712391Sjason@lowepower.comtemplate <typename T> using remove_all_extents_t = typename array_info<T>::type; 28812391Sjason@lowepower.com 28912037Sandreas.sandberg@arm.comtemplate <typename T> using is_pod_struct = all_of< 29012391Sjason@lowepower.com std::is_standard_layout<T>, // since we're accessing directly in memory we need a standard layout type 29112391Sjason@lowepower.com#if !defined(__GNUG__) || defined(_LIBCPP_VERSION) || defined(_GLIBCXX_USE_CXX11_ABI) 29212391Sjason@lowepower.com // _GLIBCXX_USE_CXX11_ABI indicates that we're using libstdc++ from GCC 5 or newer, independent 29312391Sjason@lowepower.com // of the actual compiler (Clang can also use libstdc++, but it always defines __GNUC__ == 4). 29412391Sjason@lowepower.com std::is_trivially_copyable<T>, 29512391Sjason@lowepower.com#else 29612391Sjason@lowepower.com // GCC 4 doesn't implement is_trivially_copyable, so approximate it 29712391Sjason@lowepower.com std::is_trivially_destructible<T>, 29812391Sjason@lowepower.com satisfies_any_of<T, std::has_trivial_copy_constructor, std::has_trivial_copy_assign>, 29912391Sjason@lowepower.com#endif 30012037Sandreas.sandberg@arm.com satisfies_none_of<T, std::is_reference, std::is_array, is_std_array, std::is_arithmetic, is_complex, std::is_enum> 30112037Sandreas.sandberg@arm.com>; 30212037Sandreas.sandberg@arm.com 30312391Sjason@lowepower.comtemplate <ssize_t Dim = 0, typename Strides> ssize_t byte_offset_unsafe(const Strides &) { return 0; } 30412391Sjason@lowepower.comtemplate <ssize_t Dim = 0, typename Strides, typename... Ix> 30512391Sjason@lowepower.comssize_t byte_offset_unsafe(const Strides &strides, ssize_t i, Ix... index) { 30612037Sandreas.sandberg@arm.com return i * strides[Dim] + byte_offset_unsafe<Dim + 1>(strides, index...); 30712037Sandreas.sandberg@arm.com} 30812037Sandreas.sandberg@arm.com 30912391Sjason@lowepower.com/** 31012391Sjason@lowepower.com * Proxy class providing unsafe, unchecked const access to array data. This is constructed through 31112037Sandreas.sandberg@arm.com * the `unchecked<T, N>()` method of `array` or the `unchecked<N>()` method of `array_t<T>`. `Dims` 31212037Sandreas.sandberg@arm.com * will be -1 for dimensions determined at runtime. 31312037Sandreas.sandberg@arm.com */ 31412037Sandreas.sandberg@arm.comtemplate <typename T, ssize_t Dims> 31512037Sandreas.sandberg@arm.comclass unchecked_reference { 31612037Sandreas.sandberg@arm.comprotected: 31712037Sandreas.sandberg@arm.com static constexpr bool Dynamic = Dims < 0; 31812037Sandreas.sandberg@arm.com const unsigned char *data_; 31912037Sandreas.sandberg@arm.com // Storing the shape & strides in local variables (i.e. these arrays) allows the compiler to 32012037Sandreas.sandberg@arm.com // make large performance gains on big, nested loops, but requires compile-time dimensions 32112391Sjason@lowepower.com conditional_t<Dynamic, const ssize_t *, std::array<ssize_t, (size_t) Dims>> 32212391Sjason@lowepower.com shape_, strides_; 32312391Sjason@lowepower.com const ssize_t dims_; 32412037Sandreas.sandberg@arm.com 32512037Sandreas.sandberg@arm.com friend class pybind11::array; 32612037Sandreas.sandberg@arm.com // Constructor for compile-time dimensions: 32712037Sandreas.sandberg@arm.com template <bool Dyn = Dynamic> 32812391Sjason@lowepower.com unchecked_reference(const void *data, const ssize_t *shape, const ssize_t *strides, enable_if_t<!Dyn, ssize_t>) 32912037Sandreas.sandberg@arm.com : data_{reinterpret_cast<const unsigned char *>(data)}, dims_{Dims} { 33012391Sjason@lowepower.com for (size_t i = 0; i < (size_t) dims_; i++) { 33112037Sandreas.sandberg@arm.com shape_[i] = shape[i]; 33212037Sandreas.sandberg@arm.com strides_[i] = strides[i]; 33312037Sandreas.sandberg@arm.com } 33412037Sandreas.sandberg@arm.com } 33512037Sandreas.sandberg@arm.com // Constructor for runtime dimensions: 33612037Sandreas.sandberg@arm.com template <bool Dyn = Dynamic> 33712391Sjason@lowepower.com unchecked_reference(const void *data, const ssize_t *shape, const ssize_t *strides, enable_if_t<Dyn, ssize_t> dims) 33812037Sandreas.sandberg@arm.com : data_{reinterpret_cast<const unsigned char *>(data)}, shape_{shape}, strides_{strides}, dims_{dims} {} 33912037Sandreas.sandberg@arm.com 34012037Sandreas.sandberg@arm.compublic: 34112391Sjason@lowepower.com /** 34212391Sjason@lowepower.com * Unchecked const reference access to data at the given indices. For a compile-time known 34312037Sandreas.sandberg@arm.com * number of dimensions, this requires the correct number of arguments; for run-time 34412037Sandreas.sandberg@arm.com * dimensionality, this is not checked (and so is up to the caller to use safely). 34512037Sandreas.sandberg@arm.com */ 34612037Sandreas.sandberg@arm.com template <typename... Ix> const T &operator()(Ix... index) const { 34712391Sjason@lowepower.com static_assert(ssize_t{sizeof...(Ix)} == Dims || Dynamic, 34812037Sandreas.sandberg@arm.com "Invalid number of indices for unchecked array reference"); 34912391Sjason@lowepower.com return *reinterpret_cast<const T *>(data_ + byte_offset_unsafe(strides_, ssize_t(index)...)); 35012037Sandreas.sandberg@arm.com } 35112391Sjason@lowepower.com /** 35212391Sjason@lowepower.com * Unchecked const reference access to data; this operator only participates if the reference 35312037Sandreas.sandberg@arm.com * is to a 1-dimensional array. When present, this is exactly equivalent to `obj(index)`. 35412037Sandreas.sandberg@arm.com */ 35512391Sjason@lowepower.com template <ssize_t D = Dims, typename = enable_if_t<D == 1 || Dynamic>> 35612391Sjason@lowepower.com const T &operator[](ssize_t index) const { return operator()(index); } 35712037Sandreas.sandberg@arm.com 35812037Sandreas.sandberg@arm.com /// Pointer access to the data at the given indices. 35912391Sjason@lowepower.com template <typename... Ix> const T *data(Ix... ix) const { return &operator()(ssize_t(ix)...); } 36012037Sandreas.sandberg@arm.com 36112037Sandreas.sandberg@arm.com /// Returns the item size, i.e. sizeof(T) 36212391Sjason@lowepower.com constexpr static ssize_t itemsize() { return sizeof(T); } 36312037Sandreas.sandberg@arm.com 36412037Sandreas.sandberg@arm.com /// Returns the shape (i.e. size) of dimension `dim` 36512391Sjason@lowepower.com ssize_t shape(ssize_t dim) const { return shape_[(size_t) dim]; } 36612037Sandreas.sandberg@arm.com 36712037Sandreas.sandberg@arm.com /// Returns the number of dimensions of the array 36812391Sjason@lowepower.com ssize_t ndim() const { return dims_; } 36912037Sandreas.sandberg@arm.com 37012037Sandreas.sandberg@arm.com /// Returns the total number of elements in the referenced array, i.e. the product of the shapes 37112037Sandreas.sandberg@arm.com template <bool Dyn = Dynamic> 37212391Sjason@lowepower.com enable_if_t<!Dyn, ssize_t> size() const { 37312391Sjason@lowepower.com return std::accumulate(shape_.begin(), shape_.end(), (ssize_t) 1, std::multiplies<ssize_t>()); 37412037Sandreas.sandberg@arm.com } 37512037Sandreas.sandberg@arm.com template <bool Dyn = Dynamic> 37612391Sjason@lowepower.com enable_if_t<Dyn, ssize_t> size() const { 37712391Sjason@lowepower.com return std::accumulate(shape_, shape_ + ndim(), (ssize_t) 1, std::multiplies<ssize_t>()); 37812037Sandreas.sandberg@arm.com } 37912037Sandreas.sandberg@arm.com 38012037Sandreas.sandberg@arm.com /// Returns the total number of bytes used by the referenced data. Note that the actual span in 38112037Sandreas.sandberg@arm.com /// memory may be larger if the referenced array has non-contiguous strides (e.g. for a slice). 38212391Sjason@lowepower.com ssize_t nbytes() const { 38312037Sandreas.sandberg@arm.com return size() * itemsize(); 38412037Sandreas.sandberg@arm.com } 38512037Sandreas.sandberg@arm.com}; 38612037Sandreas.sandberg@arm.com 38712037Sandreas.sandberg@arm.comtemplate <typename T, ssize_t Dims> 38812037Sandreas.sandberg@arm.comclass unchecked_mutable_reference : public unchecked_reference<T, Dims> { 38912037Sandreas.sandberg@arm.com friend class pybind11::array; 39012037Sandreas.sandberg@arm.com using ConstBase = unchecked_reference<T, Dims>; 39112037Sandreas.sandberg@arm.com using ConstBase::ConstBase; 39212037Sandreas.sandberg@arm.com using ConstBase::Dynamic; 39312037Sandreas.sandberg@arm.compublic: 39412037Sandreas.sandberg@arm.com /// Mutable, unchecked access to data at the given indices. 39512037Sandreas.sandberg@arm.com template <typename... Ix> T& operator()(Ix... index) { 39612391Sjason@lowepower.com static_assert(ssize_t{sizeof...(Ix)} == Dims || Dynamic, 39712037Sandreas.sandberg@arm.com "Invalid number of indices for unchecked array reference"); 39812037Sandreas.sandberg@arm.com return const_cast<T &>(ConstBase::operator()(index...)); 39912037Sandreas.sandberg@arm.com } 40012391Sjason@lowepower.com /** 40112391Sjason@lowepower.com * Mutable, unchecked access data at the given index; this operator only participates if the 40212037Sandreas.sandberg@arm.com * reference is to a 1-dimensional array (or has runtime dimensions). When present, this is 40312037Sandreas.sandberg@arm.com * exactly equivalent to `obj(index)`. 40412037Sandreas.sandberg@arm.com */ 40512391Sjason@lowepower.com template <ssize_t D = Dims, typename = enable_if_t<D == 1 || Dynamic>> 40612391Sjason@lowepower.com T &operator[](ssize_t index) { return operator()(index); } 40712037Sandreas.sandberg@arm.com 40812037Sandreas.sandberg@arm.com /// Mutable pointer access to the data at the given indices. 40912391Sjason@lowepower.com template <typename... Ix> T *mutable_data(Ix... ix) { return &operator()(ssize_t(ix)...); } 41012037Sandreas.sandberg@arm.com}; 41112037Sandreas.sandberg@arm.com 41212391Sjason@lowepower.comtemplate <typename T, ssize_t Dim> 41312037Sandreas.sandberg@arm.comstruct type_caster<unchecked_reference<T, Dim>> { 41412037Sandreas.sandberg@arm.com static_assert(Dim == 0 && Dim > 0 /* always fail */, "unchecked array proxy object is not castable"); 41512037Sandreas.sandberg@arm.com}; 41612391Sjason@lowepower.comtemplate <typename T, ssize_t Dim> 41712037Sandreas.sandberg@arm.comstruct type_caster<unchecked_mutable_reference<T, Dim>> : type_caster<unchecked_reference<T, Dim>> {}; 41812037Sandreas.sandberg@arm.com 41911986Sandreas.sandberg@arm.comNAMESPACE_END(detail) 42011986Sandreas.sandberg@arm.com 42111986Sandreas.sandberg@arm.comclass dtype : public object { 42211986Sandreas.sandberg@arm.compublic: 42311986Sandreas.sandberg@arm.com PYBIND11_OBJECT_DEFAULT(dtype, object, detail::npy_api::get().PyArrayDescr_Check_); 42411986Sandreas.sandberg@arm.com 42511986Sandreas.sandberg@arm.com explicit dtype(const buffer_info &info) { 42611986Sandreas.sandberg@arm.com dtype descr(_dtype_from_pep3118()(PYBIND11_STR_TYPE(info.format))); 42711986Sandreas.sandberg@arm.com // If info.itemsize == 0, use the value calculated from the format string 42811986Sandreas.sandberg@arm.com m_ptr = descr.strip_padding(info.itemsize ? info.itemsize : descr.itemsize()).release().ptr(); 42911986Sandreas.sandberg@arm.com } 43011986Sandreas.sandberg@arm.com 43111986Sandreas.sandberg@arm.com explicit dtype(const std::string &format) { 43211986Sandreas.sandberg@arm.com m_ptr = from_args(pybind11::str(format)).release().ptr(); 43311986Sandreas.sandberg@arm.com } 43411986Sandreas.sandberg@arm.com 43511986Sandreas.sandberg@arm.com dtype(const char *format) : dtype(std::string(format)) { } 43611986Sandreas.sandberg@arm.com 43712391Sjason@lowepower.com dtype(list names, list formats, list offsets, ssize_t itemsize) { 43811986Sandreas.sandberg@arm.com dict args; 43911986Sandreas.sandberg@arm.com args["names"] = names; 44011986Sandreas.sandberg@arm.com args["formats"] = formats; 44111986Sandreas.sandberg@arm.com args["offsets"] = offsets; 44211986Sandreas.sandberg@arm.com args["itemsize"] = pybind11::int_(itemsize); 44311986Sandreas.sandberg@arm.com m_ptr = from_args(args).release().ptr(); 44411986Sandreas.sandberg@arm.com } 44511986Sandreas.sandberg@arm.com 44611986Sandreas.sandberg@arm.com /// This is essentially the same as calling numpy.dtype(args) in Python. 44711986Sandreas.sandberg@arm.com static dtype from_args(object args) { 44811986Sandreas.sandberg@arm.com PyObject *ptr = nullptr; 44911986Sandreas.sandberg@arm.com if (!detail::npy_api::get().PyArray_DescrConverter_(args.release().ptr(), &ptr) || !ptr) 45011986Sandreas.sandberg@arm.com throw error_already_set(); 45111986Sandreas.sandberg@arm.com return reinterpret_steal<dtype>(ptr); 45211986Sandreas.sandberg@arm.com } 45311986Sandreas.sandberg@arm.com 45411986Sandreas.sandberg@arm.com /// Return dtype associated with a C++ type. 45511986Sandreas.sandberg@arm.com template <typename T> static dtype of() { 45611986Sandreas.sandberg@arm.com return detail::npy_format_descriptor<typename std::remove_cv<T>::type>::dtype(); 45711986Sandreas.sandberg@arm.com } 45811986Sandreas.sandberg@arm.com 45911986Sandreas.sandberg@arm.com /// Size of the data type in bytes. 46012391Sjason@lowepower.com ssize_t itemsize() const { 46112391Sjason@lowepower.com return detail::array_descriptor_proxy(m_ptr)->elsize; 46211986Sandreas.sandberg@arm.com } 46311986Sandreas.sandberg@arm.com 46411986Sandreas.sandberg@arm.com /// Returns true for structured data types. 46511986Sandreas.sandberg@arm.com bool has_fields() const { 46611986Sandreas.sandberg@arm.com return detail::array_descriptor_proxy(m_ptr)->names != nullptr; 46711986Sandreas.sandberg@arm.com } 46811986Sandreas.sandberg@arm.com 46911986Sandreas.sandberg@arm.com /// Single-character type code. 47011986Sandreas.sandberg@arm.com char kind() const { 47111986Sandreas.sandberg@arm.com return detail::array_descriptor_proxy(m_ptr)->kind; 47211986Sandreas.sandberg@arm.com } 47311986Sandreas.sandberg@arm.com 47411986Sandreas.sandberg@arm.comprivate: 47511986Sandreas.sandberg@arm.com static object _dtype_from_pep3118() { 47611986Sandreas.sandberg@arm.com static PyObject *obj = module::import("numpy.core._internal") 47711986Sandreas.sandberg@arm.com .attr("_dtype_from_pep3118").cast<object>().release().ptr(); 47811986Sandreas.sandberg@arm.com return reinterpret_borrow<object>(obj); 47911986Sandreas.sandberg@arm.com } 48011986Sandreas.sandberg@arm.com 48112391Sjason@lowepower.com dtype strip_padding(ssize_t itemsize) { 48211986Sandreas.sandberg@arm.com // Recursively strip all void fields with empty names that are generated for 48311986Sandreas.sandberg@arm.com // padding fields (as of NumPy v1.11). 48411986Sandreas.sandberg@arm.com if (!has_fields()) 48511986Sandreas.sandberg@arm.com return *this; 48611986Sandreas.sandberg@arm.com 48711986Sandreas.sandberg@arm.com struct field_descr { PYBIND11_STR_TYPE name; object format; pybind11::int_ offset; }; 48811986Sandreas.sandberg@arm.com std::vector<field_descr> field_descriptors; 48911986Sandreas.sandberg@arm.com 49011986Sandreas.sandberg@arm.com for (auto field : attr("fields").attr("items")()) { 49111986Sandreas.sandberg@arm.com auto spec = field.cast<tuple>(); 49211986Sandreas.sandberg@arm.com auto name = spec[0].cast<pybind11::str>(); 49311986Sandreas.sandberg@arm.com auto format = spec[1].cast<tuple>()[0].cast<dtype>(); 49411986Sandreas.sandberg@arm.com auto offset = spec[1].cast<tuple>()[1].cast<pybind11::int_>(); 49511986Sandreas.sandberg@arm.com if (!len(name) && format.kind() == 'V') 49611986Sandreas.sandberg@arm.com continue; 49711986Sandreas.sandberg@arm.com field_descriptors.push_back({(PYBIND11_STR_TYPE) name, format.strip_padding(format.itemsize()), offset}); 49811986Sandreas.sandberg@arm.com } 49911986Sandreas.sandberg@arm.com 50011986Sandreas.sandberg@arm.com std::sort(field_descriptors.begin(), field_descriptors.end(), 50111986Sandreas.sandberg@arm.com [](const field_descr& a, const field_descr& b) { 50211986Sandreas.sandberg@arm.com return a.offset.cast<int>() < b.offset.cast<int>(); 50311986Sandreas.sandberg@arm.com }); 50411986Sandreas.sandberg@arm.com 50511986Sandreas.sandberg@arm.com list names, formats, offsets; 50611986Sandreas.sandberg@arm.com for (auto& descr : field_descriptors) { 50711986Sandreas.sandberg@arm.com names.append(descr.name); 50811986Sandreas.sandberg@arm.com formats.append(descr.format); 50911986Sandreas.sandberg@arm.com offsets.append(descr.offset); 51011986Sandreas.sandberg@arm.com } 51111986Sandreas.sandberg@arm.com return dtype(names, formats, offsets, itemsize); 51211986Sandreas.sandberg@arm.com } 51311986Sandreas.sandberg@arm.com}; 51411986Sandreas.sandberg@arm.com 51511986Sandreas.sandberg@arm.comclass array : public buffer { 51611986Sandreas.sandberg@arm.compublic: 51711986Sandreas.sandberg@arm.com PYBIND11_OBJECT_CVT(array, buffer, detail::npy_api::get().PyArray_Check_, raw_array) 51811986Sandreas.sandberg@arm.com 51911986Sandreas.sandberg@arm.com enum { 52012037Sandreas.sandberg@arm.com c_style = detail::npy_api::NPY_ARRAY_C_CONTIGUOUS_, 52112037Sandreas.sandberg@arm.com f_style = detail::npy_api::NPY_ARRAY_F_CONTIGUOUS_, 52211986Sandreas.sandberg@arm.com forcecast = detail::npy_api::NPY_ARRAY_FORCECAST_ 52311986Sandreas.sandberg@arm.com }; 52411986Sandreas.sandberg@arm.com 52512391Sjason@lowepower.com array() : array({{0}}, static_cast<const double *>(nullptr)) {} 52611986Sandreas.sandberg@arm.com 52712391Sjason@lowepower.com using ShapeContainer = detail::any_container<ssize_t>; 52812391Sjason@lowepower.com using StridesContainer = detail::any_container<ssize_t>; 52912391Sjason@lowepower.com 53012391Sjason@lowepower.com // Constructs an array taking shape/strides from arbitrary container types 53112391Sjason@lowepower.com array(const pybind11::dtype &dt, ShapeContainer shape, StridesContainer strides, 53212391Sjason@lowepower.com const void *ptr = nullptr, handle base = handle()) { 53312391Sjason@lowepower.com 53412391Sjason@lowepower.com if (strides->empty()) 53512391Sjason@lowepower.com *strides = c_strides(*shape, dt.itemsize()); 53612391Sjason@lowepower.com 53712391Sjason@lowepower.com auto ndim = shape->size(); 53812391Sjason@lowepower.com if (ndim != strides->size()) 53911986Sandreas.sandberg@arm.com pybind11_fail("NumPy: shape ndim doesn't match strides ndim"); 54011986Sandreas.sandberg@arm.com auto descr = dt; 54111986Sandreas.sandberg@arm.com 54211986Sandreas.sandberg@arm.com int flags = 0; 54311986Sandreas.sandberg@arm.com if (base && ptr) { 54411986Sandreas.sandberg@arm.com if (isinstance<array>(base)) 54512037Sandreas.sandberg@arm.com /* Copy flags from base (except ownership bit) */ 54611986Sandreas.sandberg@arm.com flags = reinterpret_borrow<array>(base).flags() & ~detail::npy_api::NPY_ARRAY_OWNDATA_; 54711986Sandreas.sandberg@arm.com else 54811986Sandreas.sandberg@arm.com /* Writable by default, easy to downgrade later on if needed */ 54911986Sandreas.sandberg@arm.com flags = detail::npy_api::NPY_ARRAY_WRITEABLE_; 55011986Sandreas.sandberg@arm.com } 55111986Sandreas.sandberg@arm.com 55212391Sjason@lowepower.com auto &api = detail::npy_api::get(); 55311986Sandreas.sandberg@arm.com auto tmp = reinterpret_steal<object>(api.PyArray_NewFromDescr_( 55412391Sjason@lowepower.com api.PyArray_Type_, descr.release().ptr(), (int) ndim, shape->data(), strides->data(), 55512037Sandreas.sandberg@arm.com const_cast<void *>(ptr), flags, nullptr)); 55611986Sandreas.sandberg@arm.com if (!tmp) 55712391Sjason@lowepower.com throw error_already_set(); 55811986Sandreas.sandberg@arm.com if (ptr) { 55911986Sandreas.sandberg@arm.com if (base) { 56012037Sandreas.sandberg@arm.com api.PyArray_SetBaseObject_(tmp.ptr(), base.inc_ref().ptr()); 56111986Sandreas.sandberg@arm.com } else { 56211986Sandreas.sandberg@arm.com tmp = reinterpret_steal<object>(api.PyArray_NewCopy_(tmp.ptr(), -1 /* any order */)); 56311986Sandreas.sandberg@arm.com } 56411986Sandreas.sandberg@arm.com } 56511986Sandreas.sandberg@arm.com m_ptr = tmp.release().ptr(); 56611986Sandreas.sandberg@arm.com } 56711986Sandreas.sandberg@arm.com 56812391Sjason@lowepower.com array(const pybind11::dtype &dt, ShapeContainer shape, const void *ptr = nullptr, handle base = handle()) 56912391Sjason@lowepower.com : array(dt, std::move(shape), {}, ptr, base) { } 57011986Sandreas.sandberg@arm.com 57112391Sjason@lowepower.com template <typename T, typename = detail::enable_if_t<std::is_integral<T>::value && !std::is_same<bool, T>::value>> 57212391Sjason@lowepower.com array(const pybind11::dtype &dt, T count, const void *ptr = nullptr, handle base = handle()) 57312391Sjason@lowepower.com : array(dt, {{count}}, ptr, base) { } 57411986Sandreas.sandberg@arm.com 57511986Sandreas.sandberg@arm.com template <typename T> 57612391Sjason@lowepower.com array(ShapeContainer shape, StridesContainer strides, const T *ptr, handle base = handle()) 57712391Sjason@lowepower.com : array(pybind11::dtype::of<T>(), std::move(shape), std::move(strides), ptr, base) { } 57811986Sandreas.sandberg@arm.com 57911986Sandreas.sandberg@arm.com template <typename T> 58012391Sjason@lowepower.com array(ShapeContainer shape, const T *ptr, handle base = handle()) 58112391Sjason@lowepower.com : array(std::move(shape), {}, ptr, base) { } 58212391Sjason@lowepower.com 58312391Sjason@lowepower.com template <typename T> 58412391Sjason@lowepower.com explicit array(ssize_t count, const T *ptr, handle base = handle()) : array({count}, {}, ptr, base) { } 58511986Sandreas.sandberg@arm.com 58611986Sandreas.sandberg@arm.com explicit array(const buffer_info &info) 58711986Sandreas.sandberg@arm.com : array(pybind11::dtype(info), info.shape, info.strides, info.ptr) { } 58811986Sandreas.sandberg@arm.com 58911986Sandreas.sandberg@arm.com /// Array descriptor (dtype) 59011986Sandreas.sandberg@arm.com pybind11::dtype dtype() const { 59111986Sandreas.sandberg@arm.com return reinterpret_borrow<pybind11::dtype>(detail::array_proxy(m_ptr)->descr); 59211986Sandreas.sandberg@arm.com } 59311986Sandreas.sandberg@arm.com 59411986Sandreas.sandberg@arm.com /// Total number of elements 59512391Sjason@lowepower.com ssize_t size() const { 59612391Sjason@lowepower.com return std::accumulate(shape(), shape() + ndim(), (ssize_t) 1, std::multiplies<ssize_t>()); 59711986Sandreas.sandberg@arm.com } 59811986Sandreas.sandberg@arm.com 59911986Sandreas.sandberg@arm.com /// Byte size of a single element 60012391Sjason@lowepower.com ssize_t itemsize() const { 60112391Sjason@lowepower.com return detail::array_descriptor_proxy(detail::array_proxy(m_ptr)->descr)->elsize; 60211986Sandreas.sandberg@arm.com } 60311986Sandreas.sandberg@arm.com 60411986Sandreas.sandberg@arm.com /// Total number of bytes 60512391Sjason@lowepower.com ssize_t nbytes() const { 60611986Sandreas.sandberg@arm.com return size() * itemsize(); 60711986Sandreas.sandberg@arm.com } 60811986Sandreas.sandberg@arm.com 60911986Sandreas.sandberg@arm.com /// Number of dimensions 61012391Sjason@lowepower.com ssize_t ndim() const { 61112391Sjason@lowepower.com return detail::array_proxy(m_ptr)->nd; 61211986Sandreas.sandberg@arm.com } 61311986Sandreas.sandberg@arm.com 61411986Sandreas.sandberg@arm.com /// Base object 61511986Sandreas.sandberg@arm.com object base() const { 61611986Sandreas.sandberg@arm.com return reinterpret_borrow<object>(detail::array_proxy(m_ptr)->base); 61711986Sandreas.sandberg@arm.com } 61811986Sandreas.sandberg@arm.com 61911986Sandreas.sandberg@arm.com /// Dimensions of the array 62012391Sjason@lowepower.com const ssize_t* shape() const { 62112391Sjason@lowepower.com return detail::array_proxy(m_ptr)->dimensions; 62211986Sandreas.sandberg@arm.com } 62311986Sandreas.sandberg@arm.com 62411986Sandreas.sandberg@arm.com /// Dimension along a given axis 62512391Sjason@lowepower.com ssize_t shape(ssize_t dim) const { 62611986Sandreas.sandberg@arm.com if (dim >= ndim()) 62711986Sandreas.sandberg@arm.com fail_dim_check(dim, "invalid axis"); 62811986Sandreas.sandberg@arm.com return shape()[dim]; 62911986Sandreas.sandberg@arm.com } 63011986Sandreas.sandberg@arm.com 63111986Sandreas.sandberg@arm.com /// Strides of the array 63212391Sjason@lowepower.com const ssize_t* strides() const { 63312391Sjason@lowepower.com return detail::array_proxy(m_ptr)->strides; 63411986Sandreas.sandberg@arm.com } 63511986Sandreas.sandberg@arm.com 63611986Sandreas.sandberg@arm.com /// Stride along a given axis 63712391Sjason@lowepower.com ssize_t strides(ssize_t dim) const { 63811986Sandreas.sandberg@arm.com if (dim >= ndim()) 63911986Sandreas.sandberg@arm.com fail_dim_check(dim, "invalid axis"); 64011986Sandreas.sandberg@arm.com return strides()[dim]; 64111986Sandreas.sandberg@arm.com } 64211986Sandreas.sandberg@arm.com 64311986Sandreas.sandberg@arm.com /// Return the NumPy array flags 64411986Sandreas.sandberg@arm.com int flags() const { 64511986Sandreas.sandberg@arm.com return detail::array_proxy(m_ptr)->flags; 64611986Sandreas.sandberg@arm.com } 64711986Sandreas.sandberg@arm.com 64811986Sandreas.sandberg@arm.com /// If set, the array is writeable (otherwise the buffer is read-only) 64911986Sandreas.sandberg@arm.com bool writeable() const { 65011986Sandreas.sandberg@arm.com return detail::check_flags(m_ptr, detail::npy_api::NPY_ARRAY_WRITEABLE_); 65111986Sandreas.sandberg@arm.com } 65211986Sandreas.sandberg@arm.com 65311986Sandreas.sandberg@arm.com /// If set, the array owns the data (will be freed when the array is deleted) 65411986Sandreas.sandberg@arm.com bool owndata() const { 65511986Sandreas.sandberg@arm.com return detail::check_flags(m_ptr, detail::npy_api::NPY_ARRAY_OWNDATA_); 65611986Sandreas.sandberg@arm.com } 65711986Sandreas.sandberg@arm.com 65811986Sandreas.sandberg@arm.com /// Pointer to the contained data. If index is not provided, points to the 65911986Sandreas.sandberg@arm.com /// beginning of the buffer. May throw if the index would lead to out of bounds access. 66011986Sandreas.sandberg@arm.com template<typename... Ix> const void* data(Ix... index) const { 66111986Sandreas.sandberg@arm.com return static_cast<const void *>(detail::array_proxy(m_ptr)->data + offset_at(index...)); 66211986Sandreas.sandberg@arm.com } 66311986Sandreas.sandberg@arm.com 66411986Sandreas.sandberg@arm.com /// Mutable pointer to the contained data. If index is not provided, points to the 66511986Sandreas.sandberg@arm.com /// beginning of the buffer. May throw if the index would lead to out of bounds access. 66611986Sandreas.sandberg@arm.com /// May throw if the array is not writeable. 66711986Sandreas.sandberg@arm.com template<typename... Ix> void* mutable_data(Ix... index) { 66811986Sandreas.sandberg@arm.com check_writeable(); 66911986Sandreas.sandberg@arm.com return static_cast<void *>(detail::array_proxy(m_ptr)->data + offset_at(index...)); 67011986Sandreas.sandberg@arm.com } 67111986Sandreas.sandberg@arm.com 67211986Sandreas.sandberg@arm.com /// Byte offset from beginning of the array to a given index (full or partial). 67311986Sandreas.sandberg@arm.com /// May throw if the index would lead to out of bounds access. 67412391Sjason@lowepower.com template<typename... Ix> ssize_t offset_at(Ix... index) const { 67512391Sjason@lowepower.com if ((ssize_t) sizeof...(index) > ndim()) 67611986Sandreas.sandberg@arm.com fail_dim_check(sizeof...(index), "too many indices for an array"); 67712391Sjason@lowepower.com return byte_offset(ssize_t(index)...); 67811986Sandreas.sandberg@arm.com } 67911986Sandreas.sandberg@arm.com 68012391Sjason@lowepower.com ssize_t offset_at() const { return 0; } 68111986Sandreas.sandberg@arm.com 68211986Sandreas.sandberg@arm.com /// Item count from beginning of the array to a given index (full or partial). 68311986Sandreas.sandberg@arm.com /// May throw if the index would lead to out of bounds access. 68412391Sjason@lowepower.com template<typename... Ix> ssize_t index_at(Ix... index) const { 68511986Sandreas.sandberg@arm.com return offset_at(index...) / itemsize(); 68611986Sandreas.sandberg@arm.com } 68711986Sandreas.sandberg@arm.com 68812391Sjason@lowepower.com /** 68912391Sjason@lowepower.com * Returns a proxy object that provides access to the array's data without bounds or 69012037Sandreas.sandberg@arm.com * dimensionality checking. Will throw if the array is missing the `writeable` flag. Use with 69112037Sandreas.sandberg@arm.com * care: the array must not be destroyed or reshaped for the duration of the returned object, 69212037Sandreas.sandberg@arm.com * and the caller must take care not to access invalid dimensions or dimension indices. 69312037Sandreas.sandberg@arm.com */ 69412391Sjason@lowepower.com template <typename T, ssize_t Dims = -1> detail::unchecked_mutable_reference<T, Dims> mutable_unchecked() & { 69512391Sjason@lowepower.com if (Dims >= 0 && ndim() != Dims) 69612037Sandreas.sandberg@arm.com throw std::domain_error("array has incorrect number of dimensions: " + std::to_string(ndim()) + 69712037Sandreas.sandberg@arm.com "; expected " + std::to_string(Dims)); 69812037Sandreas.sandberg@arm.com return detail::unchecked_mutable_reference<T, Dims>(mutable_data(), shape(), strides(), ndim()); 69912037Sandreas.sandberg@arm.com } 70012037Sandreas.sandberg@arm.com 70112391Sjason@lowepower.com /** 70212391Sjason@lowepower.com * Returns a proxy object that provides const access to the array's data without bounds or 70312037Sandreas.sandberg@arm.com * dimensionality checking. Unlike `mutable_unchecked()`, this does not require that the 70412037Sandreas.sandberg@arm.com * underlying array have the `writable` flag. Use with care: the array must not be destroyed or 70512037Sandreas.sandberg@arm.com * reshaped for the duration of the returned object, and the caller must take care not to access 70612037Sandreas.sandberg@arm.com * invalid dimensions or dimension indices. 70712037Sandreas.sandberg@arm.com */ 70812391Sjason@lowepower.com template <typename T, ssize_t Dims = -1> detail::unchecked_reference<T, Dims> unchecked() const & { 70912391Sjason@lowepower.com if (Dims >= 0 && ndim() != Dims) 71012037Sandreas.sandberg@arm.com throw std::domain_error("array has incorrect number of dimensions: " + std::to_string(ndim()) + 71112037Sandreas.sandberg@arm.com "; expected " + std::to_string(Dims)); 71212037Sandreas.sandberg@arm.com return detail::unchecked_reference<T, Dims>(data(), shape(), strides(), ndim()); 71312037Sandreas.sandberg@arm.com } 71412037Sandreas.sandberg@arm.com 71511986Sandreas.sandberg@arm.com /// Return a new view with all of the dimensions of length 1 removed 71611986Sandreas.sandberg@arm.com array squeeze() { 71711986Sandreas.sandberg@arm.com auto& api = detail::npy_api::get(); 71811986Sandreas.sandberg@arm.com return reinterpret_steal<array>(api.PyArray_Squeeze_(m_ptr)); 71911986Sandreas.sandberg@arm.com } 72011986Sandreas.sandberg@arm.com 72112391Sjason@lowepower.com /// Resize array to given shape 72212391Sjason@lowepower.com /// If refcheck is true and more that one reference exist to this array 72312391Sjason@lowepower.com /// then resize will succeed only if it makes a reshape, i.e. original size doesn't change 72412391Sjason@lowepower.com void resize(ShapeContainer new_shape, bool refcheck = true) { 72512391Sjason@lowepower.com detail::npy_api::PyArray_Dims d = { 72612391Sjason@lowepower.com new_shape->data(), int(new_shape->size()) 72712391Sjason@lowepower.com }; 72812391Sjason@lowepower.com // try to resize, set ordering param to -1 cause it's not used anyway 72912391Sjason@lowepower.com object new_array = reinterpret_steal<object>( 73012391Sjason@lowepower.com detail::npy_api::get().PyArray_Resize_(m_ptr, &d, int(refcheck), -1) 73112391Sjason@lowepower.com ); 73212391Sjason@lowepower.com if (!new_array) throw error_already_set(); 73312391Sjason@lowepower.com if (isinstance<array>(new_array)) { *this = std::move(new_array); } 73412391Sjason@lowepower.com } 73512391Sjason@lowepower.com 73611986Sandreas.sandberg@arm.com /// Ensure that the argument is a NumPy array 73711986Sandreas.sandberg@arm.com /// In case of an error, nullptr is returned and the Python error is cleared. 73811986Sandreas.sandberg@arm.com static array ensure(handle h, int ExtraFlags = 0) { 73911986Sandreas.sandberg@arm.com auto result = reinterpret_steal<array>(raw_array(h.ptr(), ExtraFlags)); 74011986Sandreas.sandberg@arm.com if (!result) 74111986Sandreas.sandberg@arm.com PyErr_Clear(); 74211986Sandreas.sandberg@arm.com return result; 74311986Sandreas.sandberg@arm.com } 74411986Sandreas.sandberg@arm.com 74511986Sandreas.sandberg@arm.comprotected: 74611986Sandreas.sandberg@arm.com template<typename, typename> friend struct detail::npy_format_descriptor; 74711986Sandreas.sandberg@arm.com 74812391Sjason@lowepower.com void fail_dim_check(ssize_t dim, const std::string& msg) const { 74911986Sandreas.sandberg@arm.com throw index_error(msg + ": " + std::to_string(dim) + 75011986Sandreas.sandberg@arm.com " (ndim = " + std::to_string(ndim()) + ")"); 75111986Sandreas.sandberg@arm.com } 75211986Sandreas.sandberg@arm.com 75312391Sjason@lowepower.com template<typename... Ix> ssize_t byte_offset(Ix... index) const { 75411986Sandreas.sandberg@arm.com check_dimensions(index...); 75512391Sjason@lowepower.com return detail::byte_offset_unsafe(strides(), ssize_t(index)...); 75611986Sandreas.sandberg@arm.com } 75711986Sandreas.sandberg@arm.com 75811986Sandreas.sandberg@arm.com void check_writeable() const { 75911986Sandreas.sandberg@arm.com if (!writeable()) 76012037Sandreas.sandberg@arm.com throw std::domain_error("array is not writeable"); 76111986Sandreas.sandberg@arm.com } 76211986Sandreas.sandberg@arm.com 76312391Sjason@lowepower.com // Default, C-style strides 76412391Sjason@lowepower.com static std::vector<ssize_t> c_strides(const std::vector<ssize_t> &shape, ssize_t itemsize) { 76511986Sandreas.sandberg@arm.com auto ndim = shape.size(); 76612391Sjason@lowepower.com std::vector<ssize_t> strides(ndim, itemsize); 76712391Sjason@lowepower.com for (size_t i = ndim - 1; i > 0; --i) 76812391Sjason@lowepower.com strides[i - 1] = strides[i] * shape[i]; 76912391Sjason@lowepower.com return strides; 77012391Sjason@lowepower.com } 77112391Sjason@lowepower.com 77212391Sjason@lowepower.com // F-style strides; default when constructing an array_t with `ExtraFlags & f_style` 77312391Sjason@lowepower.com static std::vector<ssize_t> f_strides(const std::vector<ssize_t> &shape, ssize_t itemsize) { 77412391Sjason@lowepower.com auto ndim = shape.size(); 77512391Sjason@lowepower.com std::vector<ssize_t> strides(ndim, itemsize); 77612391Sjason@lowepower.com for (size_t i = 1; i < ndim; ++i) 77712391Sjason@lowepower.com strides[i] = strides[i - 1] * shape[i - 1]; 77811986Sandreas.sandberg@arm.com return strides; 77911986Sandreas.sandberg@arm.com } 78011986Sandreas.sandberg@arm.com 78111986Sandreas.sandberg@arm.com template<typename... Ix> void check_dimensions(Ix... index) const { 78212391Sjason@lowepower.com check_dimensions_impl(ssize_t(0), shape(), ssize_t(index)...); 78311986Sandreas.sandberg@arm.com } 78411986Sandreas.sandberg@arm.com 78512391Sjason@lowepower.com void check_dimensions_impl(ssize_t, const ssize_t*) const { } 78611986Sandreas.sandberg@arm.com 78712391Sjason@lowepower.com template<typename... Ix> void check_dimensions_impl(ssize_t axis, const ssize_t* shape, ssize_t i, Ix... index) const { 78811986Sandreas.sandberg@arm.com if (i >= *shape) { 78911986Sandreas.sandberg@arm.com throw index_error(std::string("index ") + std::to_string(i) + 79011986Sandreas.sandberg@arm.com " is out of bounds for axis " + std::to_string(axis) + 79111986Sandreas.sandberg@arm.com " with size " + std::to_string(*shape)); 79211986Sandreas.sandberg@arm.com } 79311986Sandreas.sandberg@arm.com check_dimensions_impl(axis + 1, shape + 1, index...); 79411986Sandreas.sandberg@arm.com } 79511986Sandreas.sandberg@arm.com 79611986Sandreas.sandberg@arm.com /// Create array from any object -- always returns a new reference 79711986Sandreas.sandberg@arm.com static PyObject *raw_array(PyObject *ptr, int ExtraFlags = 0) { 79812391Sjason@lowepower.com if (ptr == nullptr) { 79912391Sjason@lowepower.com PyErr_SetString(PyExc_ValueError, "cannot create a pybind11::array from a nullptr"); 80011986Sandreas.sandberg@arm.com return nullptr; 80112391Sjason@lowepower.com } 80211986Sandreas.sandberg@arm.com return detail::npy_api::get().PyArray_FromAny_( 80312037Sandreas.sandberg@arm.com ptr, nullptr, 0, 0, detail::npy_api::NPY_ARRAY_ENSUREARRAY_ | ExtraFlags, nullptr); 80411986Sandreas.sandberg@arm.com } 80511986Sandreas.sandberg@arm.com}; 80611986Sandreas.sandberg@arm.com 80711986Sandreas.sandberg@arm.comtemplate <typename T, int ExtraFlags = array::forcecast> class array_t : public array { 80812391Sjason@lowepower.comprivate: 80912391Sjason@lowepower.com struct private_ctor {}; 81012391Sjason@lowepower.com // Delegating constructor needed when both moving and accessing in the same constructor 81112391Sjason@lowepower.com array_t(private_ctor, ShapeContainer &&shape, StridesContainer &&strides, const T *ptr, handle base) 81212391Sjason@lowepower.com : array(std::move(shape), std::move(strides), ptr, base) {} 81311986Sandreas.sandberg@arm.compublic: 81412391Sjason@lowepower.com static_assert(!detail::array_info<T>::is_array, "Array types cannot be used with array_t"); 81512391Sjason@lowepower.com 81612037Sandreas.sandberg@arm.com using value_type = T; 81712037Sandreas.sandberg@arm.com 81811986Sandreas.sandberg@arm.com array_t() : array(0, static_cast<const T *>(nullptr)) {} 81912391Sjason@lowepower.com array_t(handle h, borrowed_t) : array(h, borrowed_t{}) { } 82012391Sjason@lowepower.com array_t(handle h, stolen_t) : array(h, stolen_t{}) { } 82111986Sandreas.sandberg@arm.com 82211986Sandreas.sandberg@arm.com PYBIND11_DEPRECATED("Use array_t<T>::ensure() instead") 82312391Sjason@lowepower.com array_t(handle h, bool is_borrowed) : array(raw_array_t(h.ptr()), stolen_t{}) { 82411986Sandreas.sandberg@arm.com if (!m_ptr) PyErr_Clear(); 82511986Sandreas.sandberg@arm.com if (!is_borrowed) Py_XDECREF(h.ptr()); 82611986Sandreas.sandberg@arm.com } 82711986Sandreas.sandberg@arm.com 82812391Sjason@lowepower.com array_t(const object &o) : array(raw_array_t(o.ptr()), stolen_t{}) { 82911986Sandreas.sandberg@arm.com if (!m_ptr) throw error_already_set(); 83011986Sandreas.sandberg@arm.com } 83111986Sandreas.sandberg@arm.com 83211986Sandreas.sandberg@arm.com explicit array_t(const buffer_info& info) : array(info) { } 83311986Sandreas.sandberg@arm.com 83412391Sjason@lowepower.com array_t(ShapeContainer shape, StridesContainer strides, const T *ptr = nullptr, handle base = handle()) 83512391Sjason@lowepower.com : array(std::move(shape), std::move(strides), ptr, base) { } 83611986Sandreas.sandberg@arm.com 83712391Sjason@lowepower.com explicit array_t(ShapeContainer shape, const T *ptr = nullptr, handle base = handle()) 83812391Sjason@lowepower.com : array_t(private_ctor{}, std::move(shape), 83912391Sjason@lowepower.com ExtraFlags & f_style ? f_strides(*shape, itemsize()) : c_strides(*shape, itemsize()), 84012391Sjason@lowepower.com ptr, base) { } 84111986Sandreas.sandberg@arm.com 84211986Sandreas.sandberg@arm.com explicit array_t(size_t count, const T *ptr = nullptr, handle base = handle()) 84312391Sjason@lowepower.com : array({count}, {}, ptr, base) { } 84411986Sandreas.sandberg@arm.com 84512391Sjason@lowepower.com constexpr ssize_t itemsize() const { 84611986Sandreas.sandberg@arm.com return sizeof(T); 84711986Sandreas.sandberg@arm.com } 84811986Sandreas.sandberg@arm.com 84912391Sjason@lowepower.com template<typename... Ix> ssize_t index_at(Ix... index) const { 85011986Sandreas.sandberg@arm.com return offset_at(index...) / itemsize(); 85111986Sandreas.sandberg@arm.com } 85211986Sandreas.sandberg@arm.com 85311986Sandreas.sandberg@arm.com template<typename... Ix> const T* data(Ix... index) const { 85411986Sandreas.sandberg@arm.com return static_cast<const T*>(array::data(index...)); 85511986Sandreas.sandberg@arm.com } 85611986Sandreas.sandberg@arm.com 85711986Sandreas.sandberg@arm.com template<typename... Ix> T* mutable_data(Ix... index) { 85811986Sandreas.sandberg@arm.com return static_cast<T*>(array::mutable_data(index...)); 85911986Sandreas.sandberg@arm.com } 86011986Sandreas.sandberg@arm.com 86111986Sandreas.sandberg@arm.com // Reference to element at a given index 86211986Sandreas.sandberg@arm.com template<typename... Ix> const T& at(Ix... index) const { 86311986Sandreas.sandberg@arm.com if (sizeof...(index) != ndim()) 86411986Sandreas.sandberg@arm.com fail_dim_check(sizeof...(index), "index dimension mismatch"); 86512391Sjason@lowepower.com return *(static_cast<const T*>(array::data()) + byte_offset(ssize_t(index)...) / itemsize()); 86611986Sandreas.sandberg@arm.com } 86711986Sandreas.sandberg@arm.com 86811986Sandreas.sandberg@arm.com // Mutable reference to element at a given index 86911986Sandreas.sandberg@arm.com template<typename... Ix> T& mutable_at(Ix... index) { 87011986Sandreas.sandberg@arm.com if (sizeof...(index) != ndim()) 87111986Sandreas.sandberg@arm.com fail_dim_check(sizeof...(index), "index dimension mismatch"); 87212391Sjason@lowepower.com return *(static_cast<T*>(array::mutable_data()) + byte_offset(ssize_t(index)...) / itemsize()); 87311986Sandreas.sandberg@arm.com } 87411986Sandreas.sandberg@arm.com 87512391Sjason@lowepower.com /** 87612391Sjason@lowepower.com * Returns a proxy object that provides access to the array's data without bounds or 87712037Sandreas.sandberg@arm.com * dimensionality checking. Will throw if the array is missing the `writeable` flag. Use with 87812037Sandreas.sandberg@arm.com * care: the array must not be destroyed or reshaped for the duration of the returned object, 87912037Sandreas.sandberg@arm.com * and the caller must take care not to access invalid dimensions or dimension indices. 88012037Sandreas.sandberg@arm.com */ 88112391Sjason@lowepower.com template <ssize_t Dims = -1> detail::unchecked_mutable_reference<T, Dims> mutable_unchecked() & { 88212037Sandreas.sandberg@arm.com return array::mutable_unchecked<T, Dims>(); 88312037Sandreas.sandberg@arm.com } 88412037Sandreas.sandberg@arm.com 88512391Sjason@lowepower.com /** 88612391Sjason@lowepower.com * Returns a proxy object that provides const access to the array's data without bounds or 88712037Sandreas.sandberg@arm.com * dimensionality checking. Unlike `unchecked()`, this does not require that the underlying 88812037Sandreas.sandberg@arm.com * array have the `writable` flag. Use with care: the array must not be destroyed or reshaped 88912037Sandreas.sandberg@arm.com * for the duration of the returned object, and the caller must take care not to access invalid 89012037Sandreas.sandberg@arm.com * dimensions or dimension indices. 89112037Sandreas.sandberg@arm.com */ 89212391Sjason@lowepower.com template <ssize_t Dims = -1> detail::unchecked_reference<T, Dims> unchecked() const & { 89312037Sandreas.sandberg@arm.com return array::unchecked<T, Dims>(); 89412037Sandreas.sandberg@arm.com } 89512037Sandreas.sandberg@arm.com 89612037Sandreas.sandberg@arm.com /// Ensure that the argument is a NumPy array of the correct dtype (and if not, try to convert 89712037Sandreas.sandberg@arm.com /// it). In case of an error, nullptr is returned and the Python error is cleared. 89811986Sandreas.sandberg@arm.com static array_t ensure(handle h) { 89911986Sandreas.sandberg@arm.com auto result = reinterpret_steal<array_t>(raw_array_t(h.ptr())); 90011986Sandreas.sandberg@arm.com if (!result) 90111986Sandreas.sandberg@arm.com PyErr_Clear(); 90211986Sandreas.sandberg@arm.com return result; 90311986Sandreas.sandberg@arm.com } 90411986Sandreas.sandberg@arm.com 90512037Sandreas.sandberg@arm.com static bool check_(handle h) { 90611986Sandreas.sandberg@arm.com const auto &api = detail::npy_api::get(); 90711986Sandreas.sandberg@arm.com return api.PyArray_Check_(h.ptr()) 90811986Sandreas.sandberg@arm.com && api.PyArray_EquivTypes_(detail::array_proxy(h.ptr())->descr, dtype::of<T>().ptr()); 90911986Sandreas.sandberg@arm.com } 91011986Sandreas.sandberg@arm.com 91111986Sandreas.sandberg@arm.comprotected: 91211986Sandreas.sandberg@arm.com /// Create array from any object -- always returns a new reference 91311986Sandreas.sandberg@arm.com static PyObject *raw_array_t(PyObject *ptr) { 91412391Sjason@lowepower.com if (ptr == nullptr) { 91512391Sjason@lowepower.com PyErr_SetString(PyExc_ValueError, "cannot create a pybind11::array_t from a nullptr"); 91611986Sandreas.sandberg@arm.com return nullptr; 91712391Sjason@lowepower.com } 91811986Sandreas.sandberg@arm.com return detail::npy_api::get().PyArray_FromAny_( 91911986Sandreas.sandberg@arm.com ptr, dtype::of<T>().release().ptr(), 0, 0, 92012037Sandreas.sandberg@arm.com detail::npy_api::NPY_ARRAY_ENSUREARRAY_ | ExtraFlags, nullptr); 92111986Sandreas.sandberg@arm.com } 92211986Sandreas.sandberg@arm.com}; 92311986Sandreas.sandberg@arm.com 92411986Sandreas.sandberg@arm.comtemplate <typename T> 92511986Sandreas.sandberg@arm.comstruct format_descriptor<T, detail::enable_if_t<detail::is_pod_struct<T>::value>> { 92611986Sandreas.sandberg@arm.com static std::string format() { 92711986Sandreas.sandberg@arm.com return detail::npy_format_descriptor<typename std::remove_cv<T>::type>::format(); 92811986Sandreas.sandberg@arm.com } 92911986Sandreas.sandberg@arm.com}; 93011986Sandreas.sandberg@arm.com 93111986Sandreas.sandberg@arm.comtemplate <size_t N> struct format_descriptor<char[N]> { 93211986Sandreas.sandberg@arm.com static std::string format() { return std::to_string(N) + "s"; } 93311986Sandreas.sandberg@arm.com}; 93411986Sandreas.sandberg@arm.comtemplate <size_t N> struct format_descriptor<std::array<char, N>> { 93511986Sandreas.sandberg@arm.com static std::string format() { return std::to_string(N) + "s"; } 93611986Sandreas.sandberg@arm.com}; 93711986Sandreas.sandberg@arm.com 93811986Sandreas.sandberg@arm.comtemplate <typename T> 93911986Sandreas.sandberg@arm.comstruct format_descriptor<T, detail::enable_if_t<std::is_enum<T>::value>> { 94011986Sandreas.sandberg@arm.com static std::string format() { 94111986Sandreas.sandberg@arm.com return format_descriptor< 94211986Sandreas.sandberg@arm.com typename std::remove_cv<typename std::underlying_type<T>::type>::type>::format(); 94311986Sandreas.sandberg@arm.com } 94411986Sandreas.sandberg@arm.com}; 94511986Sandreas.sandberg@arm.com 94612391Sjason@lowepower.comtemplate <typename T> 94712391Sjason@lowepower.comstruct format_descriptor<T, detail::enable_if_t<detail::array_info<T>::is_array>> { 94812391Sjason@lowepower.com static std::string format() { 94912391Sjason@lowepower.com using detail::_; 95012391Sjason@lowepower.com PYBIND11_DESCR extents = _("(") + detail::array_info<T>::extents() + _(")"); 95112391Sjason@lowepower.com return extents.text() + format_descriptor<detail::remove_all_extents_t<T>>::format(); 95212391Sjason@lowepower.com } 95312391Sjason@lowepower.com}; 95412391Sjason@lowepower.com 95511986Sandreas.sandberg@arm.comNAMESPACE_BEGIN(detail) 95611986Sandreas.sandberg@arm.comtemplate <typename T, int ExtraFlags> 95711986Sandreas.sandberg@arm.comstruct pyobject_caster<array_t<T, ExtraFlags>> { 95811986Sandreas.sandberg@arm.com using type = array_t<T, ExtraFlags>; 95911986Sandreas.sandberg@arm.com 96012037Sandreas.sandberg@arm.com bool load(handle src, bool convert) { 96112037Sandreas.sandberg@arm.com if (!convert && !type::check_(src)) 96212037Sandreas.sandberg@arm.com return false; 96311986Sandreas.sandberg@arm.com value = type::ensure(src); 96411986Sandreas.sandberg@arm.com return static_cast<bool>(value); 96511986Sandreas.sandberg@arm.com } 96611986Sandreas.sandberg@arm.com 96711986Sandreas.sandberg@arm.com static handle cast(const handle &src, return_value_policy /* policy */, handle /* parent */) { 96811986Sandreas.sandberg@arm.com return src.inc_ref(); 96911986Sandreas.sandberg@arm.com } 97011986Sandreas.sandberg@arm.com PYBIND11_TYPE_CASTER(type, handle_type_name<type>::name()); 97111986Sandreas.sandberg@arm.com}; 97211986Sandreas.sandberg@arm.com 97311986Sandreas.sandberg@arm.comtemplate <typename T> 97412037Sandreas.sandberg@arm.comstruct compare_buffer_info<T, detail::enable_if_t<detail::is_pod_struct<T>::value>> { 97512037Sandreas.sandberg@arm.com static bool compare(const buffer_info& b) { 97612037Sandreas.sandberg@arm.com return npy_api::get().PyArray_EquivTypes_(dtype::of<T>().ptr(), dtype(b).ptr()); 97712037Sandreas.sandberg@arm.com } 97811986Sandreas.sandberg@arm.com}; 97911986Sandreas.sandberg@arm.com 98012037Sandreas.sandberg@arm.comtemplate <typename T> struct npy_format_descriptor<T, enable_if_t<satisfies_any_of<T, std::is_arithmetic, is_complex>::value>> { 98111986Sandreas.sandberg@arm.comprivate: 98212037Sandreas.sandberg@arm.com // NB: the order here must match the one in common.h 98312037Sandreas.sandberg@arm.com constexpr static const int values[15] = { 98412037Sandreas.sandberg@arm.com npy_api::NPY_BOOL_, 98512037Sandreas.sandberg@arm.com npy_api::NPY_BYTE_, npy_api::NPY_UBYTE_, npy_api::NPY_SHORT_, npy_api::NPY_USHORT_, 98612037Sandreas.sandberg@arm.com npy_api::NPY_INT_, npy_api::NPY_UINT_, npy_api::NPY_LONGLONG_, npy_api::NPY_ULONGLONG_, 98712037Sandreas.sandberg@arm.com npy_api::NPY_FLOAT_, npy_api::NPY_DOUBLE_, npy_api::NPY_LONGDOUBLE_, 98812037Sandreas.sandberg@arm.com npy_api::NPY_CFLOAT_, npy_api::NPY_CDOUBLE_, npy_api::NPY_CLONGDOUBLE_ 98912037Sandreas.sandberg@arm.com }; 99012037Sandreas.sandberg@arm.com 99111986Sandreas.sandberg@arm.compublic: 99212037Sandreas.sandberg@arm.com static constexpr int value = values[detail::is_fmt_numeric<T>::index]; 99312037Sandreas.sandberg@arm.com 99411986Sandreas.sandberg@arm.com static pybind11::dtype dtype() { 99511986Sandreas.sandberg@arm.com if (auto ptr = npy_api::get().PyArray_DescrFromType_(value)) 99611986Sandreas.sandberg@arm.com return reinterpret_borrow<pybind11::dtype>(ptr); 99711986Sandreas.sandberg@arm.com pybind11_fail("Unsupported buffer format!"); 99811986Sandreas.sandberg@arm.com } 99912037Sandreas.sandberg@arm.com template <typename T2 = T, enable_if_t<std::is_integral<T2>::value, int> = 0> 100012037Sandreas.sandberg@arm.com static PYBIND11_DESCR name() { 100112037Sandreas.sandberg@arm.com return _<std::is_same<T, bool>::value>(_("bool"), 100212037Sandreas.sandberg@arm.com _<std::is_signed<T>::value>("int", "uint") + _<sizeof(T)*8>()); 100312037Sandreas.sandberg@arm.com } 100412037Sandreas.sandberg@arm.com template <typename T2 = T, enable_if_t<std::is_floating_point<T2>::value, int> = 0> 100512037Sandreas.sandberg@arm.com static PYBIND11_DESCR name() { 100612037Sandreas.sandberg@arm.com return _<std::is_same<T, float>::value || std::is_same<T, double>::value>( 100712037Sandreas.sandberg@arm.com _("float") + _<sizeof(T)*8>(), _("longdouble")); 100812037Sandreas.sandberg@arm.com } 100912037Sandreas.sandberg@arm.com template <typename T2 = T, enable_if_t<is_complex<T2>::value, int> = 0> 101012037Sandreas.sandberg@arm.com static PYBIND11_DESCR name() { 101112037Sandreas.sandberg@arm.com return _<std::is_same<typename T2::value_type, float>::value || std::is_same<typename T2::value_type, double>::value>( 101212037Sandreas.sandberg@arm.com _("complex") + _<sizeof(typename T2::value_type)*16>(), _("longcomplex")); 101312037Sandreas.sandberg@arm.com } 101411986Sandreas.sandberg@arm.com}; 101511986Sandreas.sandberg@arm.com 101612037Sandreas.sandberg@arm.com#define PYBIND11_DECL_CHAR_FMT \ 101711986Sandreas.sandberg@arm.com static PYBIND11_DESCR name() { return _("S") + _<N>(); } \ 101811986Sandreas.sandberg@arm.com static pybind11::dtype dtype() { return pybind11::dtype(std::string("S") + std::to_string(N)); } 101912037Sandreas.sandberg@arm.comtemplate <size_t N> struct npy_format_descriptor<char[N]> { PYBIND11_DECL_CHAR_FMT }; 102012037Sandreas.sandberg@arm.comtemplate <size_t N> struct npy_format_descriptor<std::array<char, N>> { PYBIND11_DECL_CHAR_FMT }; 102112037Sandreas.sandberg@arm.com#undef PYBIND11_DECL_CHAR_FMT 102211986Sandreas.sandberg@arm.com 102312391Sjason@lowepower.comtemplate<typename T> struct npy_format_descriptor<T, enable_if_t<array_info<T>::is_array>> { 102412391Sjason@lowepower.comprivate: 102512391Sjason@lowepower.com using base_descr = npy_format_descriptor<typename array_info<T>::type>; 102612391Sjason@lowepower.compublic: 102712391Sjason@lowepower.com static_assert(!array_info<T>::is_empty, "Zero-sized arrays are not supported"); 102812391Sjason@lowepower.com 102912391Sjason@lowepower.com static PYBIND11_DESCR name() { return _("(") + array_info<T>::extents() + _(")") + base_descr::name(); } 103012391Sjason@lowepower.com static pybind11::dtype dtype() { 103112391Sjason@lowepower.com list shape; 103212391Sjason@lowepower.com array_info<T>::append_extents(shape); 103312391Sjason@lowepower.com return pybind11::dtype::from_args(pybind11::make_tuple(base_descr::dtype(), shape)); 103412391Sjason@lowepower.com } 103512391Sjason@lowepower.com}; 103612391Sjason@lowepower.com 103711986Sandreas.sandberg@arm.comtemplate<typename T> struct npy_format_descriptor<T, enable_if_t<std::is_enum<T>::value>> { 103811986Sandreas.sandberg@arm.comprivate: 103911986Sandreas.sandberg@arm.com using base_descr = npy_format_descriptor<typename std::underlying_type<T>::type>; 104011986Sandreas.sandberg@arm.compublic: 104111986Sandreas.sandberg@arm.com static PYBIND11_DESCR name() { return base_descr::name(); } 104211986Sandreas.sandberg@arm.com static pybind11::dtype dtype() { return base_descr::dtype(); } 104311986Sandreas.sandberg@arm.com}; 104411986Sandreas.sandberg@arm.com 104511986Sandreas.sandberg@arm.comstruct field_descriptor { 104611986Sandreas.sandberg@arm.com const char *name; 104712391Sjason@lowepower.com ssize_t offset; 104812391Sjason@lowepower.com ssize_t size; 104911986Sandreas.sandberg@arm.com std::string format; 105011986Sandreas.sandberg@arm.com dtype descr; 105111986Sandreas.sandberg@arm.com}; 105211986Sandreas.sandberg@arm.com 105311986Sandreas.sandberg@arm.cominline PYBIND11_NOINLINE void register_structured_dtype( 105411986Sandreas.sandberg@arm.com const std::initializer_list<field_descriptor>& fields, 105512391Sjason@lowepower.com const std::type_info& tinfo, ssize_t itemsize, 105611986Sandreas.sandberg@arm.com bool (*direct_converter)(PyObject *, void *&)) { 105711986Sandreas.sandberg@arm.com 105811986Sandreas.sandberg@arm.com auto& numpy_internals = get_numpy_internals(); 105911986Sandreas.sandberg@arm.com if (numpy_internals.get_type_info(tinfo, false)) 106011986Sandreas.sandberg@arm.com pybind11_fail("NumPy: dtype is already registered"); 106111986Sandreas.sandberg@arm.com 106211986Sandreas.sandberg@arm.com list names, formats, offsets; 106311986Sandreas.sandberg@arm.com for (auto field : fields) { 106411986Sandreas.sandberg@arm.com if (!field.descr) 106511986Sandreas.sandberg@arm.com pybind11_fail(std::string("NumPy: unsupported field dtype: `") + 106611986Sandreas.sandberg@arm.com field.name + "` @ " + tinfo.name()); 106711986Sandreas.sandberg@arm.com names.append(PYBIND11_STR_TYPE(field.name)); 106811986Sandreas.sandberg@arm.com formats.append(field.descr); 106911986Sandreas.sandberg@arm.com offsets.append(pybind11::int_(field.offset)); 107011986Sandreas.sandberg@arm.com } 107111986Sandreas.sandberg@arm.com auto dtype_ptr = pybind11::dtype(names, formats, offsets, itemsize).release().ptr(); 107211986Sandreas.sandberg@arm.com 107311986Sandreas.sandberg@arm.com // There is an existing bug in NumPy (as of v1.11): trailing bytes are 107411986Sandreas.sandberg@arm.com // not encoded explicitly into the format string. This will supposedly 107511986Sandreas.sandberg@arm.com // get fixed in v1.12; for further details, see these: 107611986Sandreas.sandberg@arm.com // - https://github.com/numpy/numpy/issues/7797 107711986Sandreas.sandberg@arm.com // - https://github.com/numpy/numpy/pull/7798 107811986Sandreas.sandberg@arm.com // Because of this, we won't use numpy's logic to generate buffer format 107911986Sandreas.sandberg@arm.com // strings and will just do it ourselves. 108011986Sandreas.sandberg@arm.com std::vector<field_descriptor> ordered_fields(fields); 108111986Sandreas.sandberg@arm.com std::sort(ordered_fields.begin(), ordered_fields.end(), 108211986Sandreas.sandberg@arm.com [](const field_descriptor &a, const field_descriptor &b) { return a.offset < b.offset; }); 108312391Sjason@lowepower.com ssize_t offset = 0; 108411986Sandreas.sandberg@arm.com std::ostringstream oss; 108512391Sjason@lowepower.com // mark the structure as unaligned with '^', because numpy and C++ don't 108612391Sjason@lowepower.com // always agree about alignment (particularly for complex), and we're 108712391Sjason@lowepower.com // explicitly listing all our padding. This depends on none of the fields 108812391Sjason@lowepower.com // overriding the endianness. Putting the ^ in front of individual fields 108912391Sjason@lowepower.com // isn't guaranteed to work due to https://github.com/numpy/numpy/issues/9049 109012391Sjason@lowepower.com oss << "^T{"; 109111986Sandreas.sandberg@arm.com for (auto& field : ordered_fields) { 109211986Sandreas.sandberg@arm.com if (field.offset > offset) 109311986Sandreas.sandberg@arm.com oss << (field.offset - offset) << 'x'; 109411986Sandreas.sandberg@arm.com oss << field.format << ':' << field.name << ':'; 109511986Sandreas.sandberg@arm.com offset = field.offset + field.size; 109611986Sandreas.sandberg@arm.com } 109711986Sandreas.sandberg@arm.com if (itemsize > offset) 109811986Sandreas.sandberg@arm.com oss << (itemsize - offset) << 'x'; 109911986Sandreas.sandberg@arm.com oss << '}'; 110011986Sandreas.sandberg@arm.com auto format_str = oss.str(); 110111986Sandreas.sandberg@arm.com 110211986Sandreas.sandberg@arm.com // Sanity check: verify that NumPy properly parses our buffer format string 110311986Sandreas.sandberg@arm.com auto& api = npy_api::get(); 110411986Sandreas.sandberg@arm.com auto arr = array(buffer_info(nullptr, itemsize, format_str, 1)); 110511986Sandreas.sandberg@arm.com if (!api.PyArray_EquivTypes_(dtype_ptr, arr.dtype().ptr())) 110611986Sandreas.sandberg@arm.com pybind11_fail("NumPy: invalid buffer descriptor!"); 110711986Sandreas.sandberg@arm.com 110811986Sandreas.sandberg@arm.com auto tindex = std::type_index(tinfo); 110911986Sandreas.sandberg@arm.com numpy_internals.registered_dtypes[tindex] = { dtype_ptr, format_str }; 111011986Sandreas.sandberg@arm.com get_internals().direct_conversions[tindex].push_back(direct_converter); 111111986Sandreas.sandberg@arm.com} 111211986Sandreas.sandberg@arm.com 111312037Sandreas.sandberg@arm.comtemplate <typename T, typename SFINAE> struct npy_format_descriptor { 111412037Sandreas.sandberg@arm.com static_assert(is_pod_struct<T>::value, "Attempt to use a non-POD or unimplemented POD type as a numpy dtype"); 111512037Sandreas.sandberg@arm.com 111612037Sandreas.sandberg@arm.com static PYBIND11_DESCR name() { return make_caster<T>::name(); } 111711986Sandreas.sandberg@arm.com 111811986Sandreas.sandberg@arm.com static pybind11::dtype dtype() { 111911986Sandreas.sandberg@arm.com return reinterpret_borrow<pybind11::dtype>(dtype_ptr()); 112011986Sandreas.sandberg@arm.com } 112111986Sandreas.sandberg@arm.com 112211986Sandreas.sandberg@arm.com static std::string format() { 112311986Sandreas.sandberg@arm.com static auto format_str = get_numpy_internals().get_type_info<T>(true)->format_str; 112411986Sandreas.sandberg@arm.com return format_str; 112511986Sandreas.sandberg@arm.com } 112611986Sandreas.sandberg@arm.com 112711986Sandreas.sandberg@arm.com static void register_dtype(const std::initializer_list<field_descriptor>& fields) { 112811986Sandreas.sandberg@arm.com register_structured_dtype(fields, typeid(typename std::remove_cv<T>::type), 112911986Sandreas.sandberg@arm.com sizeof(T), &direct_converter); 113011986Sandreas.sandberg@arm.com } 113111986Sandreas.sandberg@arm.com 113211986Sandreas.sandberg@arm.comprivate: 113311986Sandreas.sandberg@arm.com static PyObject* dtype_ptr() { 113411986Sandreas.sandberg@arm.com static PyObject* ptr = get_numpy_internals().get_type_info<T>(true)->dtype_ptr; 113511986Sandreas.sandberg@arm.com return ptr; 113611986Sandreas.sandberg@arm.com } 113711986Sandreas.sandberg@arm.com 113811986Sandreas.sandberg@arm.com static bool direct_converter(PyObject *obj, void*& value) { 113911986Sandreas.sandberg@arm.com auto& api = npy_api::get(); 114011986Sandreas.sandberg@arm.com if (!PyObject_TypeCheck(obj, api.PyVoidArrType_Type_)) 114111986Sandreas.sandberg@arm.com return false; 114211986Sandreas.sandberg@arm.com if (auto descr = reinterpret_steal<object>(api.PyArray_DescrFromScalar_(obj))) { 114311986Sandreas.sandberg@arm.com if (api.PyArray_EquivTypes_(dtype_ptr(), descr.ptr())) { 114411986Sandreas.sandberg@arm.com value = ((PyVoidScalarObject_Proxy *) obj)->obval; 114511986Sandreas.sandberg@arm.com return true; 114611986Sandreas.sandberg@arm.com } 114711986Sandreas.sandberg@arm.com } 114811986Sandreas.sandberg@arm.com return false; 114911986Sandreas.sandberg@arm.com } 115011986Sandreas.sandberg@arm.com}; 115111986Sandreas.sandberg@arm.com 115212391Sjason@lowepower.com#ifdef __CLION_IDE__ // replace heavy macro with dummy code for the IDE (doesn't affect code) 115312391Sjason@lowepower.com# define PYBIND11_NUMPY_DTYPE(Type, ...) ((void)0) 115412391Sjason@lowepower.com# define PYBIND11_NUMPY_DTYPE_EX(Type, ...) ((void)0) 115512391Sjason@lowepower.com#else 115612391Sjason@lowepower.com 115711986Sandreas.sandberg@arm.com#define PYBIND11_FIELD_DESCRIPTOR_EX(T, Field, Name) \ 115811986Sandreas.sandberg@arm.com ::pybind11::detail::field_descriptor { \ 115911986Sandreas.sandberg@arm.com Name, offsetof(T, Field), sizeof(decltype(std::declval<T>().Field)), \ 116011986Sandreas.sandberg@arm.com ::pybind11::format_descriptor<decltype(std::declval<T>().Field)>::format(), \ 116111986Sandreas.sandberg@arm.com ::pybind11::detail::npy_format_descriptor<decltype(std::declval<T>().Field)>::dtype() \ 116211986Sandreas.sandberg@arm.com } 116311986Sandreas.sandberg@arm.com 116411986Sandreas.sandberg@arm.com// Extract name, offset and format descriptor for a struct field 116511986Sandreas.sandberg@arm.com#define PYBIND11_FIELD_DESCRIPTOR(T, Field) PYBIND11_FIELD_DESCRIPTOR_EX(T, Field, #Field) 116611986Sandreas.sandberg@arm.com 116711986Sandreas.sandberg@arm.com// The main idea of this macro is borrowed from https://github.com/swansontec/map-macro 116811986Sandreas.sandberg@arm.com// (C) William Swanson, Paul Fultz 116911986Sandreas.sandberg@arm.com#define PYBIND11_EVAL0(...) __VA_ARGS__ 117011986Sandreas.sandberg@arm.com#define PYBIND11_EVAL1(...) PYBIND11_EVAL0 (PYBIND11_EVAL0 (PYBIND11_EVAL0 (__VA_ARGS__))) 117111986Sandreas.sandberg@arm.com#define PYBIND11_EVAL2(...) PYBIND11_EVAL1 (PYBIND11_EVAL1 (PYBIND11_EVAL1 (__VA_ARGS__))) 117211986Sandreas.sandberg@arm.com#define PYBIND11_EVAL3(...) PYBIND11_EVAL2 (PYBIND11_EVAL2 (PYBIND11_EVAL2 (__VA_ARGS__))) 117311986Sandreas.sandberg@arm.com#define PYBIND11_EVAL4(...) PYBIND11_EVAL3 (PYBIND11_EVAL3 (PYBIND11_EVAL3 (__VA_ARGS__))) 117411986Sandreas.sandberg@arm.com#define PYBIND11_EVAL(...) PYBIND11_EVAL4 (PYBIND11_EVAL4 (PYBIND11_EVAL4 (__VA_ARGS__))) 117511986Sandreas.sandberg@arm.com#define PYBIND11_MAP_END(...) 117611986Sandreas.sandberg@arm.com#define PYBIND11_MAP_OUT 117711986Sandreas.sandberg@arm.com#define PYBIND11_MAP_COMMA , 117811986Sandreas.sandberg@arm.com#define PYBIND11_MAP_GET_END() 0, PYBIND11_MAP_END 117911986Sandreas.sandberg@arm.com#define PYBIND11_MAP_NEXT0(test, next, ...) next PYBIND11_MAP_OUT 118011986Sandreas.sandberg@arm.com#define PYBIND11_MAP_NEXT1(test, next) PYBIND11_MAP_NEXT0 (test, next, 0) 118111986Sandreas.sandberg@arm.com#define PYBIND11_MAP_NEXT(test, next) PYBIND11_MAP_NEXT1 (PYBIND11_MAP_GET_END test, next) 118211986Sandreas.sandberg@arm.com#ifdef _MSC_VER // MSVC is not as eager to expand macros, hence this workaround 118311986Sandreas.sandberg@arm.com#define PYBIND11_MAP_LIST_NEXT1(test, next) \ 118411986Sandreas.sandberg@arm.com PYBIND11_EVAL0 (PYBIND11_MAP_NEXT0 (test, PYBIND11_MAP_COMMA next, 0)) 118511986Sandreas.sandberg@arm.com#else 118611986Sandreas.sandberg@arm.com#define PYBIND11_MAP_LIST_NEXT1(test, next) \ 118711986Sandreas.sandberg@arm.com PYBIND11_MAP_NEXT0 (test, PYBIND11_MAP_COMMA next, 0) 118811986Sandreas.sandberg@arm.com#endif 118911986Sandreas.sandberg@arm.com#define PYBIND11_MAP_LIST_NEXT(test, next) \ 119011986Sandreas.sandberg@arm.com PYBIND11_MAP_LIST_NEXT1 (PYBIND11_MAP_GET_END test, next) 119111986Sandreas.sandberg@arm.com#define PYBIND11_MAP_LIST0(f, t, x, peek, ...) \ 119211986Sandreas.sandberg@arm.com f(t, x) PYBIND11_MAP_LIST_NEXT (peek, PYBIND11_MAP_LIST1) (f, t, peek, __VA_ARGS__) 119311986Sandreas.sandberg@arm.com#define PYBIND11_MAP_LIST1(f, t, x, peek, ...) \ 119411986Sandreas.sandberg@arm.com f(t, x) PYBIND11_MAP_LIST_NEXT (peek, PYBIND11_MAP_LIST0) (f, t, peek, __VA_ARGS__) 119511986Sandreas.sandberg@arm.com// PYBIND11_MAP_LIST(f, t, a1, a2, ...) expands to f(t, a1), f(t, a2), ... 119611986Sandreas.sandberg@arm.com#define PYBIND11_MAP_LIST(f, t, ...) \ 119711986Sandreas.sandberg@arm.com PYBIND11_EVAL (PYBIND11_MAP_LIST1 (f, t, __VA_ARGS__, (), 0)) 119811986Sandreas.sandberg@arm.com 119911986Sandreas.sandberg@arm.com#define PYBIND11_NUMPY_DTYPE(Type, ...) \ 120011986Sandreas.sandberg@arm.com ::pybind11::detail::npy_format_descriptor<Type>::register_dtype \ 120111986Sandreas.sandberg@arm.com ({PYBIND11_MAP_LIST (PYBIND11_FIELD_DESCRIPTOR, Type, __VA_ARGS__)}) 120211986Sandreas.sandberg@arm.com 120311986Sandreas.sandberg@arm.com#ifdef _MSC_VER 120411986Sandreas.sandberg@arm.com#define PYBIND11_MAP2_LIST_NEXT1(test, next) \ 120511986Sandreas.sandberg@arm.com PYBIND11_EVAL0 (PYBIND11_MAP_NEXT0 (test, PYBIND11_MAP_COMMA next, 0)) 120611986Sandreas.sandberg@arm.com#else 120711986Sandreas.sandberg@arm.com#define PYBIND11_MAP2_LIST_NEXT1(test, next) \ 120811986Sandreas.sandberg@arm.com PYBIND11_MAP_NEXT0 (test, PYBIND11_MAP_COMMA next, 0) 120911986Sandreas.sandberg@arm.com#endif 121011986Sandreas.sandberg@arm.com#define PYBIND11_MAP2_LIST_NEXT(test, next) \ 121111986Sandreas.sandberg@arm.com PYBIND11_MAP2_LIST_NEXT1 (PYBIND11_MAP_GET_END test, next) 121211986Sandreas.sandberg@arm.com#define PYBIND11_MAP2_LIST0(f, t, x1, x2, peek, ...) \ 121311986Sandreas.sandberg@arm.com f(t, x1, x2) PYBIND11_MAP2_LIST_NEXT (peek, PYBIND11_MAP2_LIST1) (f, t, peek, __VA_ARGS__) 121411986Sandreas.sandberg@arm.com#define PYBIND11_MAP2_LIST1(f, t, x1, x2, peek, ...) \ 121511986Sandreas.sandberg@arm.com f(t, x1, x2) PYBIND11_MAP2_LIST_NEXT (peek, PYBIND11_MAP2_LIST0) (f, t, peek, __VA_ARGS__) 121611986Sandreas.sandberg@arm.com// PYBIND11_MAP2_LIST(f, t, a1, a2, ...) expands to f(t, a1, a2), f(t, a3, a4), ... 121711986Sandreas.sandberg@arm.com#define PYBIND11_MAP2_LIST(f, t, ...) \ 121811986Sandreas.sandberg@arm.com PYBIND11_EVAL (PYBIND11_MAP2_LIST1 (f, t, __VA_ARGS__, (), 0)) 121911986Sandreas.sandberg@arm.com 122011986Sandreas.sandberg@arm.com#define PYBIND11_NUMPY_DTYPE_EX(Type, ...) \ 122111986Sandreas.sandberg@arm.com ::pybind11::detail::npy_format_descriptor<Type>::register_dtype \ 122211986Sandreas.sandberg@arm.com ({PYBIND11_MAP2_LIST (PYBIND11_FIELD_DESCRIPTOR_EX, Type, __VA_ARGS__)}) 122311986Sandreas.sandberg@arm.com 122412391Sjason@lowepower.com#endif // __CLION_IDE__ 122512391Sjason@lowepower.com 122611986Sandreas.sandberg@arm.comtemplate <class T> 122711986Sandreas.sandberg@arm.comusing array_iterator = typename std::add_pointer<T>::type; 122811986Sandreas.sandberg@arm.com 122911986Sandreas.sandberg@arm.comtemplate <class T> 123011986Sandreas.sandberg@arm.comarray_iterator<T> array_begin(const buffer_info& buffer) { 123111986Sandreas.sandberg@arm.com return array_iterator<T>(reinterpret_cast<T*>(buffer.ptr)); 123211986Sandreas.sandberg@arm.com} 123311986Sandreas.sandberg@arm.com 123411986Sandreas.sandberg@arm.comtemplate <class T> 123511986Sandreas.sandberg@arm.comarray_iterator<T> array_end(const buffer_info& buffer) { 123611986Sandreas.sandberg@arm.com return array_iterator<T>(reinterpret_cast<T*>(buffer.ptr) + buffer.size); 123711986Sandreas.sandberg@arm.com} 123811986Sandreas.sandberg@arm.com 123911986Sandreas.sandberg@arm.comclass common_iterator { 124011986Sandreas.sandberg@arm.compublic: 124112391Sjason@lowepower.com using container_type = std::vector<ssize_t>; 124211986Sandreas.sandberg@arm.com using value_type = container_type::value_type; 124311986Sandreas.sandberg@arm.com using size_type = container_type::size_type; 124411986Sandreas.sandberg@arm.com 124511986Sandreas.sandberg@arm.com common_iterator() : p_ptr(0), m_strides() {} 124611986Sandreas.sandberg@arm.com 124712391Sjason@lowepower.com common_iterator(void* ptr, const container_type& strides, const container_type& shape) 124811986Sandreas.sandberg@arm.com : p_ptr(reinterpret_cast<char*>(ptr)), m_strides(strides.size()) { 124911986Sandreas.sandberg@arm.com m_strides.back() = static_cast<value_type>(strides.back()); 125011986Sandreas.sandberg@arm.com for (size_type i = m_strides.size() - 1; i != 0; --i) { 125111986Sandreas.sandberg@arm.com size_type j = i - 1; 125211986Sandreas.sandberg@arm.com value_type s = static_cast<value_type>(shape[i]); 125311986Sandreas.sandberg@arm.com m_strides[j] = strides[j] + m_strides[i] - strides[i] * s; 125411986Sandreas.sandberg@arm.com } 125511986Sandreas.sandberg@arm.com } 125611986Sandreas.sandberg@arm.com 125711986Sandreas.sandberg@arm.com void increment(size_type dim) { 125811986Sandreas.sandberg@arm.com p_ptr += m_strides[dim]; 125911986Sandreas.sandberg@arm.com } 126011986Sandreas.sandberg@arm.com 126111986Sandreas.sandberg@arm.com void* data() const { 126211986Sandreas.sandberg@arm.com return p_ptr; 126311986Sandreas.sandberg@arm.com } 126411986Sandreas.sandberg@arm.com 126511986Sandreas.sandberg@arm.comprivate: 126611986Sandreas.sandberg@arm.com char* p_ptr; 126711986Sandreas.sandberg@arm.com container_type m_strides; 126811986Sandreas.sandberg@arm.com}; 126911986Sandreas.sandberg@arm.com 127011986Sandreas.sandberg@arm.comtemplate <size_t N> class multi_array_iterator { 127111986Sandreas.sandberg@arm.compublic: 127212391Sjason@lowepower.com using container_type = std::vector<ssize_t>; 127311986Sandreas.sandberg@arm.com 127411986Sandreas.sandberg@arm.com multi_array_iterator(const std::array<buffer_info, N> &buffers, 127512391Sjason@lowepower.com const container_type &shape) 127611986Sandreas.sandberg@arm.com : m_shape(shape.size()), m_index(shape.size(), 0), 127711986Sandreas.sandberg@arm.com m_common_iterator() { 127811986Sandreas.sandberg@arm.com 127911986Sandreas.sandberg@arm.com // Manual copy to avoid conversion warning if using std::copy 128011986Sandreas.sandberg@arm.com for (size_t i = 0; i < shape.size(); ++i) 128112391Sjason@lowepower.com m_shape[i] = shape[i]; 128211986Sandreas.sandberg@arm.com 128311986Sandreas.sandberg@arm.com container_type strides(shape.size()); 128411986Sandreas.sandberg@arm.com for (size_t i = 0; i < N; ++i) 128511986Sandreas.sandberg@arm.com init_common_iterator(buffers[i], shape, m_common_iterator[i], strides); 128611986Sandreas.sandberg@arm.com } 128711986Sandreas.sandberg@arm.com 128811986Sandreas.sandberg@arm.com multi_array_iterator& operator++() { 128911986Sandreas.sandberg@arm.com for (size_t j = m_index.size(); j != 0; --j) { 129011986Sandreas.sandberg@arm.com size_t i = j - 1; 129111986Sandreas.sandberg@arm.com if (++m_index[i] != m_shape[i]) { 129211986Sandreas.sandberg@arm.com increment_common_iterator(i); 129311986Sandreas.sandberg@arm.com break; 129411986Sandreas.sandberg@arm.com } else { 129511986Sandreas.sandberg@arm.com m_index[i] = 0; 129611986Sandreas.sandberg@arm.com } 129711986Sandreas.sandberg@arm.com } 129811986Sandreas.sandberg@arm.com return *this; 129911986Sandreas.sandberg@arm.com } 130011986Sandreas.sandberg@arm.com 130112391Sjason@lowepower.com template <size_t K, class T = void> T* data() const { 130212391Sjason@lowepower.com return reinterpret_cast<T*>(m_common_iterator[K].data()); 130311986Sandreas.sandberg@arm.com } 130411986Sandreas.sandberg@arm.com 130511986Sandreas.sandberg@arm.comprivate: 130611986Sandreas.sandberg@arm.com 130711986Sandreas.sandberg@arm.com using common_iter = common_iterator; 130811986Sandreas.sandberg@arm.com 130911986Sandreas.sandberg@arm.com void init_common_iterator(const buffer_info &buffer, 131012391Sjason@lowepower.com const container_type &shape, 131112391Sjason@lowepower.com common_iter &iterator, 131212391Sjason@lowepower.com container_type &strides) { 131311986Sandreas.sandberg@arm.com auto buffer_shape_iter = buffer.shape.rbegin(); 131411986Sandreas.sandberg@arm.com auto buffer_strides_iter = buffer.strides.rbegin(); 131511986Sandreas.sandberg@arm.com auto shape_iter = shape.rbegin(); 131611986Sandreas.sandberg@arm.com auto strides_iter = strides.rbegin(); 131711986Sandreas.sandberg@arm.com 131811986Sandreas.sandberg@arm.com while (buffer_shape_iter != buffer.shape.rend()) { 131911986Sandreas.sandberg@arm.com if (*shape_iter == *buffer_shape_iter) 132012391Sjason@lowepower.com *strides_iter = *buffer_strides_iter; 132111986Sandreas.sandberg@arm.com else 132211986Sandreas.sandberg@arm.com *strides_iter = 0; 132311986Sandreas.sandberg@arm.com 132411986Sandreas.sandberg@arm.com ++buffer_shape_iter; 132511986Sandreas.sandberg@arm.com ++buffer_strides_iter; 132611986Sandreas.sandberg@arm.com ++shape_iter; 132711986Sandreas.sandberg@arm.com ++strides_iter; 132811986Sandreas.sandberg@arm.com } 132911986Sandreas.sandberg@arm.com 133011986Sandreas.sandberg@arm.com std::fill(strides_iter, strides.rend(), 0); 133111986Sandreas.sandberg@arm.com iterator = common_iter(buffer.ptr, strides, shape); 133211986Sandreas.sandberg@arm.com } 133311986Sandreas.sandberg@arm.com 133411986Sandreas.sandberg@arm.com void increment_common_iterator(size_t dim) { 133511986Sandreas.sandberg@arm.com for (auto &iter : m_common_iterator) 133611986Sandreas.sandberg@arm.com iter.increment(dim); 133711986Sandreas.sandberg@arm.com } 133811986Sandreas.sandberg@arm.com 133911986Sandreas.sandberg@arm.com container_type m_shape; 134011986Sandreas.sandberg@arm.com container_type m_index; 134111986Sandreas.sandberg@arm.com std::array<common_iter, N> m_common_iterator; 134211986Sandreas.sandberg@arm.com}; 134311986Sandreas.sandberg@arm.com 134412037Sandreas.sandberg@arm.comenum class broadcast_trivial { non_trivial, c_trivial, f_trivial }; 134512037Sandreas.sandberg@arm.com 134612037Sandreas.sandberg@arm.com// Populates the shape and number of dimensions for the set of buffers. Returns a broadcast_trivial 134712037Sandreas.sandberg@arm.com// enum value indicating whether the broadcast is "trivial"--that is, has each buffer being either a 134812037Sandreas.sandberg@arm.com// singleton or a full-size, C-contiguous (`c_trivial`) or Fortran-contiguous (`f_trivial`) storage 134912037Sandreas.sandberg@arm.com// buffer; returns `non_trivial` otherwise. 135011986Sandreas.sandberg@arm.comtemplate <size_t N> 135112391Sjason@lowepower.combroadcast_trivial broadcast(const std::array<buffer_info, N> &buffers, ssize_t &ndim, std::vector<ssize_t> &shape) { 135212391Sjason@lowepower.com ndim = std::accumulate(buffers.begin(), buffers.end(), ssize_t(0), [](ssize_t res, const buffer_info &buf) { 135311986Sandreas.sandberg@arm.com return std::max(res, buf.ndim); 135411986Sandreas.sandberg@arm.com }); 135511986Sandreas.sandberg@arm.com 135612037Sandreas.sandberg@arm.com shape.clear(); 135712391Sjason@lowepower.com shape.resize((size_t) ndim, 1); 135812037Sandreas.sandberg@arm.com 135912037Sandreas.sandberg@arm.com // Figure out the output size, and make sure all input arrays conform (i.e. are either size 1 or 136012037Sandreas.sandberg@arm.com // the full size). 136111986Sandreas.sandberg@arm.com for (size_t i = 0; i < N; ++i) { 136211986Sandreas.sandberg@arm.com auto res_iter = shape.rbegin(); 136312037Sandreas.sandberg@arm.com auto end = buffers[i].shape.rend(); 136412037Sandreas.sandberg@arm.com for (auto shape_iter = buffers[i].shape.rbegin(); shape_iter != end; ++shape_iter, ++res_iter) { 136512037Sandreas.sandberg@arm.com const auto &dim_size_in = *shape_iter; 136612037Sandreas.sandberg@arm.com auto &dim_size_out = *res_iter; 136711986Sandreas.sandberg@arm.com 136812037Sandreas.sandberg@arm.com // Each input dimension can either be 1 or `n`, but `n` values must match across buffers 136912037Sandreas.sandberg@arm.com if (dim_size_out == 1) 137012037Sandreas.sandberg@arm.com dim_size_out = dim_size_in; 137112037Sandreas.sandberg@arm.com else if (dim_size_in != 1 && dim_size_in != dim_size_out) 137211986Sandreas.sandberg@arm.com pybind11_fail("pybind11::vectorize: incompatible size/dimension of inputs!"); 137312037Sandreas.sandberg@arm.com } 137412037Sandreas.sandberg@arm.com } 137511986Sandreas.sandberg@arm.com 137612037Sandreas.sandberg@arm.com bool trivial_broadcast_c = true; 137712037Sandreas.sandberg@arm.com bool trivial_broadcast_f = true; 137812037Sandreas.sandberg@arm.com for (size_t i = 0; i < N && (trivial_broadcast_c || trivial_broadcast_f); ++i) { 137912037Sandreas.sandberg@arm.com if (buffers[i].size == 1) 138012037Sandreas.sandberg@arm.com continue; 138112037Sandreas.sandberg@arm.com 138212037Sandreas.sandberg@arm.com // Require the same number of dimensions: 138312037Sandreas.sandberg@arm.com if (buffers[i].ndim != ndim) 138412037Sandreas.sandberg@arm.com return broadcast_trivial::non_trivial; 138512037Sandreas.sandberg@arm.com 138612037Sandreas.sandberg@arm.com // Require all dimensions be full-size: 138712037Sandreas.sandberg@arm.com if (!std::equal(buffers[i].shape.cbegin(), buffers[i].shape.cend(), shape.cbegin())) 138812037Sandreas.sandberg@arm.com return broadcast_trivial::non_trivial; 138912037Sandreas.sandberg@arm.com 139012037Sandreas.sandberg@arm.com // Check for C contiguity (but only if previous inputs were also C contiguous) 139112037Sandreas.sandberg@arm.com if (trivial_broadcast_c) { 139212391Sjason@lowepower.com ssize_t expect_stride = buffers[i].itemsize; 139312037Sandreas.sandberg@arm.com auto end = buffers[i].shape.crend(); 139412037Sandreas.sandberg@arm.com for (auto shape_iter = buffers[i].shape.crbegin(), stride_iter = buffers[i].strides.crbegin(); 139512037Sandreas.sandberg@arm.com trivial_broadcast_c && shape_iter != end; ++shape_iter, ++stride_iter) { 139612037Sandreas.sandberg@arm.com if (expect_stride == *stride_iter) 139712037Sandreas.sandberg@arm.com expect_stride *= *shape_iter; 139812037Sandreas.sandberg@arm.com else 139912037Sandreas.sandberg@arm.com trivial_broadcast_c = false; 140012037Sandreas.sandberg@arm.com } 140111986Sandreas.sandberg@arm.com } 140212037Sandreas.sandberg@arm.com 140312037Sandreas.sandberg@arm.com // Check for Fortran contiguity (if previous inputs were also F contiguous) 140412037Sandreas.sandberg@arm.com if (trivial_broadcast_f) { 140512391Sjason@lowepower.com ssize_t expect_stride = buffers[i].itemsize; 140612037Sandreas.sandberg@arm.com auto end = buffers[i].shape.cend(); 140712037Sandreas.sandberg@arm.com for (auto shape_iter = buffers[i].shape.cbegin(), stride_iter = buffers[i].strides.cbegin(); 140812037Sandreas.sandberg@arm.com trivial_broadcast_f && shape_iter != end; ++shape_iter, ++stride_iter) { 140912037Sandreas.sandberg@arm.com if (expect_stride == *stride_iter) 141012037Sandreas.sandberg@arm.com expect_stride *= *shape_iter; 141112037Sandreas.sandberg@arm.com else 141212037Sandreas.sandberg@arm.com trivial_broadcast_f = false; 141312037Sandreas.sandberg@arm.com } 141412037Sandreas.sandberg@arm.com } 141511986Sandreas.sandberg@arm.com } 141612037Sandreas.sandberg@arm.com 141712037Sandreas.sandberg@arm.com return 141812037Sandreas.sandberg@arm.com trivial_broadcast_c ? broadcast_trivial::c_trivial : 141912037Sandreas.sandberg@arm.com trivial_broadcast_f ? broadcast_trivial::f_trivial : 142012037Sandreas.sandberg@arm.com broadcast_trivial::non_trivial; 142111986Sandreas.sandberg@arm.com} 142211986Sandreas.sandberg@arm.com 142312391Sjason@lowepower.comtemplate <typename T> 142412391Sjason@lowepower.comstruct vectorize_arg { 142512391Sjason@lowepower.com static_assert(!std::is_rvalue_reference<T>::value, "Functions with rvalue reference arguments cannot be vectorized"); 142612391Sjason@lowepower.com // The wrapped function gets called with this type: 142712391Sjason@lowepower.com using call_type = remove_reference_t<T>; 142812391Sjason@lowepower.com // Is this a vectorized argument? 142912391Sjason@lowepower.com static constexpr bool vectorize = 143012391Sjason@lowepower.com satisfies_any_of<call_type, std::is_arithmetic, is_complex, std::is_pod>::value && 143112391Sjason@lowepower.com satisfies_none_of<call_type, std::is_pointer, std::is_array, is_std_array, std::is_enum>::value && 143212391Sjason@lowepower.com (!std::is_reference<T>::value || 143312391Sjason@lowepower.com (std::is_lvalue_reference<T>::value && std::is_const<call_type>::value)); 143412391Sjason@lowepower.com // Accept this type: an array for vectorized types, otherwise the type as-is: 143512391Sjason@lowepower.com using type = conditional_t<vectorize, array_t<remove_cv_t<call_type>, array::forcecast>, T>; 143612391Sjason@lowepower.com}; 143712391Sjason@lowepower.com 143811986Sandreas.sandberg@arm.comtemplate <typename Func, typename Return, typename... Args> 143911986Sandreas.sandberg@arm.comstruct vectorize_helper { 144012391Sjason@lowepower.comprivate: 144112037Sandreas.sandberg@arm.com static constexpr size_t N = sizeof...(Args); 144212391Sjason@lowepower.com static constexpr size_t NVectorized = constexpr_sum(vectorize_arg<Args>::vectorize...); 144312391Sjason@lowepower.com static_assert(NVectorized >= 1, 144412391Sjason@lowepower.com "pybind11::vectorize(...) requires a function with at least one vectorizable argument"); 144511986Sandreas.sandberg@arm.com 144612391Sjason@lowepower.compublic: 144711986Sandreas.sandberg@arm.com template <typename T> 144812391Sjason@lowepower.com explicit vectorize_helper(T &&f) : f(std::forward<T>(f)) { } 144911986Sandreas.sandberg@arm.com 145012391Sjason@lowepower.com object operator()(typename vectorize_arg<Args>::type... args) { 145112391Sjason@lowepower.com return run(args..., 145212391Sjason@lowepower.com make_index_sequence<N>(), 145312391Sjason@lowepower.com select_indices<vectorize_arg<Args>::vectorize...>(), 145412391Sjason@lowepower.com make_index_sequence<NVectorized>()); 145511986Sandreas.sandberg@arm.com } 145611986Sandreas.sandberg@arm.com 145712391Sjason@lowepower.comprivate: 145812391Sjason@lowepower.com remove_reference_t<Func> f; 145912391Sjason@lowepower.com 146012391Sjason@lowepower.com template <size_t Index> using param_n_t = typename pack_element<Index, typename vectorize_arg<Args>::call_type...>::type; 146112391Sjason@lowepower.com 146212391Sjason@lowepower.com // Runs a vectorized function given arguments tuple and three index sequences: 146312391Sjason@lowepower.com // - Index is the full set of 0 ... (N-1) argument indices; 146412391Sjason@lowepower.com // - VIndex is the subset of argument indices with vectorized parameters, letting us access 146512391Sjason@lowepower.com // vectorized arguments (anything not in this sequence is passed through) 146612391Sjason@lowepower.com // - BIndex is a incremental sequence (beginning at 0) of the same size as VIndex, so that 146712391Sjason@lowepower.com // we can store vectorized buffer_infos in an array (argument VIndex has its buffer at 146812391Sjason@lowepower.com // index BIndex in the array). 146912391Sjason@lowepower.com template <size_t... Index, size_t... VIndex, size_t... BIndex> object run( 147012391Sjason@lowepower.com typename vectorize_arg<Args>::type &...args, 147112391Sjason@lowepower.com index_sequence<Index...> i_seq, index_sequence<VIndex...> vi_seq, index_sequence<BIndex...> bi_seq) { 147212391Sjason@lowepower.com 147312391Sjason@lowepower.com // Pointers to values the function was called with; the vectorized ones set here will start 147412391Sjason@lowepower.com // out as array_t<T> pointers, but they will be changed them to T pointers before we make 147512391Sjason@lowepower.com // call the wrapped function. Non-vectorized pointers are left as-is. 147612391Sjason@lowepower.com std::array<void *, N> params{{ &args... }}; 147712391Sjason@lowepower.com 147812391Sjason@lowepower.com // The array of `buffer_info`s of vectorized arguments: 147912391Sjason@lowepower.com std::array<buffer_info, NVectorized> buffers{{ reinterpret_cast<array *>(params[VIndex])->request()... }}; 148011986Sandreas.sandberg@arm.com 148111986Sandreas.sandberg@arm.com /* Determine dimensions parameters of output array */ 148212391Sjason@lowepower.com ssize_t nd = 0; 148312391Sjason@lowepower.com std::vector<ssize_t> shape(0); 148412391Sjason@lowepower.com auto trivial = broadcast(buffers, nd, shape); 148512391Sjason@lowepower.com size_t ndim = (size_t) nd; 148611986Sandreas.sandberg@arm.com 148712391Sjason@lowepower.com size_t size = std::accumulate(shape.begin(), shape.end(), (size_t) 1, std::multiplies<size_t>()); 148812391Sjason@lowepower.com 148912391Sjason@lowepower.com // If all arguments are 0-dimension arrays (i.e. single values) return a plain value (i.e. 149012391Sjason@lowepower.com // not wrapped in an array). 149112391Sjason@lowepower.com if (size == 1 && ndim == 0) { 149212391Sjason@lowepower.com PYBIND11_EXPAND_SIDE_EFFECTS(params[VIndex] = buffers[BIndex].ptr); 149312391Sjason@lowepower.com return cast(f(*reinterpret_cast<param_n_t<Index> *>(params[Index])...)); 149411986Sandreas.sandberg@arm.com } 149511986Sandreas.sandberg@arm.com 149612391Sjason@lowepower.com array_t<Return> result; 149712391Sjason@lowepower.com if (trivial == broadcast_trivial::f_trivial) result = array_t<Return, array::f_style>(shape); 149812391Sjason@lowepower.com else result = array_t<Return>(shape); 149911986Sandreas.sandberg@arm.com 150012391Sjason@lowepower.com if (size == 0) return result; 150111986Sandreas.sandberg@arm.com 150212037Sandreas.sandberg@arm.com /* Call the function */ 150312391Sjason@lowepower.com if (trivial == broadcast_trivial::non_trivial) 150412391Sjason@lowepower.com apply_broadcast(buffers, params, result, i_seq, vi_seq, bi_seq); 150512391Sjason@lowepower.com else 150612391Sjason@lowepower.com apply_trivial(buffers, params, result.mutable_data(), size, i_seq, vi_seq, bi_seq); 150711986Sandreas.sandberg@arm.com 150811986Sandreas.sandberg@arm.com return result; 150911986Sandreas.sandberg@arm.com } 151011986Sandreas.sandberg@arm.com 151112391Sjason@lowepower.com template <size_t... Index, size_t... VIndex, size_t... BIndex> 151212391Sjason@lowepower.com void apply_trivial(std::array<buffer_info, NVectorized> &buffers, 151312391Sjason@lowepower.com std::array<void *, N> ¶ms, 151412391Sjason@lowepower.com Return *out, 151512391Sjason@lowepower.com size_t size, 151612391Sjason@lowepower.com index_sequence<Index...>, index_sequence<VIndex...>, index_sequence<BIndex...>) { 151711986Sandreas.sandberg@arm.com 151812391Sjason@lowepower.com // Initialize an array of mutable byte references and sizes with references set to the 151912391Sjason@lowepower.com // appropriate pointer in `params`; as we iterate, we'll increment each pointer by its size 152012391Sjason@lowepower.com // (except for singletons, which get an increment of 0). 152112391Sjason@lowepower.com std::array<std::pair<unsigned char *&, const size_t>, NVectorized> vecparams{{ 152212391Sjason@lowepower.com std::pair<unsigned char *&, const size_t>( 152312391Sjason@lowepower.com reinterpret_cast<unsigned char *&>(params[VIndex] = buffers[BIndex].ptr), 152412391Sjason@lowepower.com buffers[BIndex].size == 1 ? 0 : sizeof(param_n_t<VIndex>) 152512391Sjason@lowepower.com )... 152612391Sjason@lowepower.com }}; 152711986Sandreas.sandberg@arm.com 152812391Sjason@lowepower.com for (size_t i = 0; i < size; ++i) { 152912391Sjason@lowepower.com out[i] = f(*reinterpret_cast<param_n_t<Index> *>(params[Index])...); 153012391Sjason@lowepower.com for (auto &x : vecparams) x.first += x.second; 153112391Sjason@lowepower.com } 153212391Sjason@lowepower.com } 153312391Sjason@lowepower.com 153412391Sjason@lowepower.com template <size_t... Index, size_t... VIndex, size_t... BIndex> 153512391Sjason@lowepower.com void apply_broadcast(std::array<buffer_info, NVectorized> &buffers, 153612391Sjason@lowepower.com std::array<void *, N> ¶ms, 153712391Sjason@lowepower.com array_t<Return> &output_array, 153812391Sjason@lowepower.com index_sequence<Index...>, index_sequence<VIndex...>, index_sequence<BIndex...>) { 153912391Sjason@lowepower.com 154012391Sjason@lowepower.com buffer_info output = output_array.request(); 154112391Sjason@lowepower.com multi_array_iterator<NVectorized> input_iter(buffers, output.shape); 154212391Sjason@lowepower.com 154312391Sjason@lowepower.com for (array_iterator<Return> iter = array_begin<Return>(output), end = array_end<Return>(output); 154412391Sjason@lowepower.com iter != end; 154512391Sjason@lowepower.com ++iter, ++input_iter) { 154612391Sjason@lowepower.com PYBIND11_EXPAND_SIDE_EFFECTS(( 154712391Sjason@lowepower.com params[VIndex] = input_iter.template data<BIndex>() 154812391Sjason@lowepower.com )); 154912391Sjason@lowepower.com *iter = f(*reinterpret_cast<param_n_t<Index> *>(std::get<Index>(params))...); 155011986Sandreas.sandberg@arm.com } 155111986Sandreas.sandberg@arm.com } 155211986Sandreas.sandberg@arm.com}; 155311986Sandreas.sandberg@arm.com 155412391Sjason@lowepower.comtemplate <typename Func, typename Return, typename... Args> 155512391Sjason@lowepower.comvectorize_helper<Func, Return, Args...> 155612391Sjason@lowepower.comvectorize_extractor(const Func &f, Return (*) (Args ...)) { 155712391Sjason@lowepower.com return detail::vectorize_helper<Func, Return, Args...>(f); 155812391Sjason@lowepower.com} 155912391Sjason@lowepower.com 156011986Sandreas.sandberg@arm.comtemplate <typename T, int Flags> struct handle_type_name<array_t<T, Flags>> { 156112037Sandreas.sandberg@arm.com static PYBIND11_DESCR name() { 156212037Sandreas.sandberg@arm.com return _("numpy.ndarray[") + npy_format_descriptor<T>::name() + _("]"); 156312037Sandreas.sandberg@arm.com } 156411986Sandreas.sandberg@arm.com}; 156511986Sandreas.sandberg@arm.com 156611986Sandreas.sandberg@arm.comNAMESPACE_END(detail) 156711986Sandreas.sandberg@arm.com 156812391Sjason@lowepower.com// Vanilla pointer vectorizer: 156912391Sjason@lowepower.comtemplate <typename Return, typename... Args> 157012391Sjason@lowepower.comdetail::vectorize_helper<Return (*)(Args...), Return, Args...> 157112391Sjason@lowepower.comvectorize(Return (*f) (Args ...)) { 157212391Sjason@lowepower.com return detail::vectorize_helper<Return (*)(Args...), Return, Args...>(f); 157311986Sandreas.sandberg@arm.com} 157411986Sandreas.sandberg@arm.com 157512391Sjason@lowepower.com// lambda vectorizer: 157612391Sjason@lowepower.comtemplate <typename Func, detail::enable_if_t<detail::is_lambda<Func>::value, int> = 0> 157712391Sjason@lowepower.comauto vectorize(Func &&f) -> decltype( 157812391Sjason@lowepower.com detail::vectorize_extractor(std::forward<Func>(f), (detail::function_signature_t<Func> *) nullptr)) { 157912391Sjason@lowepower.com return detail::vectorize_extractor(std::forward<Func>(f), (detail::function_signature_t<Func> *) nullptr); 158011986Sandreas.sandberg@arm.com} 158111986Sandreas.sandberg@arm.com 158212391Sjason@lowepower.com// Vectorize a class method (non-const): 158312391Sjason@lowepower.comtemplate <typename Return, typename Class, typename... Args, 158412391Sjason@lowepower.com typename Helper = detail::vectorize_helper<decltype(std::mem_fn(std::declval<Return (Class::*)(Args...)>())), Return, Class *, Args...>> 158512391Sjason@lowepower.comHelper vectorize(Return (Class::*f)(Args...)) { 158612391Sjason@lowepower.com return Helper(std::mem_fn(f)); 158711986Sandreas.sandberg@arm.com} 158811986Sandreas.sandberg@arm.com 158912391Sjason@lowepower.com// Vectorize a class method (non-const): 159012391Sjason@lowepower.comtemplate <typename Return, typename Class, typename... Args, 159112391Sjason@lowepower.com typename Helper = detail::vectorize_helper<decltype(std::mem_fn(std::declval<Return (Class::*)(Args...) const>())), Return, const Class *, Args...>> 159212391Sjason@lowepower.comHelper vectorize(Return (Class::*f)(Args...) const) { 159312391Sjason@lowepower.com return Helper(std::mem_fn(f)); 159412391Sjason@lowepower.com} 159512391Sjason@lowepower.com 159612391Sjason@lowepower.comNAMESPACE_END(PYBIND11_NAMESPACE) 159711986Sandreas.sandberg@arm.com 159811986Sandreas.sandberg@arm.com#if defined(_MSC_VER) 159911986Sandreas.sandberg@arm.com#pragma warning(pop) 160011986Sandreas.sandberg@arm.com#endif 1601