numpy.h File Reference

#include "pybind11.h"
#include "detail/common.h"
#include "complex.h"
#include "gil_safe_call_once.h"
#include "pytypes.h"
#include <algorithm>
#include <array>
#include <cstdint>
#include <cstdlib>
#include <cstring>
#include <functional>
#include <numeric>
#include <sstream>
#include <string>
#include <type_traits>
#include <typeindex>
#include <utility>
#include <vector>

Include dependency graph for numpy.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	array
struct	array_info< T >
struct	array_info< char[N]>
struct	array_info< std::array< char, N > >
struct	array_info< std::array< T, N > >
struct	array_info< T[N]>
struct	array_info_scalar< T >
class	array_t< T, ExtraFlags >
class	common_iterator
struct	compare_buffer_info< T, detail::enable_if_t< detail::is_pod_struct< T >::value > >
class	dtype
struct	field_descriptor
struct	format_descriptor< char[N]>
struct	format_descriptor< std::array< char, N > >
struct	format_descriptor< T, detail::enable_if_t< detail::array_info< T >::is_array > >
struct	format_descriptor< T, detail::enable_if_t< detail::is_pod_struct< T >::value > >
struct	format_descriptor< T, detail::enable_if_t< std::is_enum< T >::value > >
struct	handle_type_name< array >
struct	handle_type_name< array_t< T, Flags > >
struct	handle_type_name< dtype >
struct	is_complex< T >
struct	is_complex< std::complex< T > >
struct	is_std_array< T >
struct	is_std_array< std::array< T, N > >
class	multi_array_iterator< N >
struct	npy_api
struct	npy_format_descriptor< T, SFINAE >
struct	npy_format_descriptor< T, SFINAE >
struct	npy_format_descriptor< char[N]>
struct	npy_format_descriptor< std::array< char, N > >
struct	npy_format_descriptor< T, enable_if_t< array_info< T >::is_array > >
struct	npy_format_descriptor< T, enable_if_t< is_same_ignoring_cvref< T, PyObject * >::value > >
struct	npy_format_descriptor< T, enable_if_t< satisfies_any_of< T, std::is_arithmetic, is_complex >::value > >
struct	npy_format_descriptor< T, enable_if_t< std::is_enum< T >::value > >
struct	npy_format_descriptor_name< T, typename >
struct	npy_format_descriptor_name< T, enable_if_t< is_complex< T >::value > >
struct	npy_format_descriptor_name< T, enable_if_t< std::is_floating_point< T >::value > >
struct	npy_format_descriptor_name< T, enable_if_t< std::is_integral< T >::value > >
struct	numpy_internals
struct	numpy_type_info
struct	array_t< T, ExtraFlags >::private_ctor
struct	npy_api::PyArray_Dims
struct	PyArray_Proxy
struct	PyArrayDescr1_Proxy
struct	PyArrayDescr2_Proxy
struct	PyArrayDescr_Proxy
struct	pyobject_caster< array_t< T, ExtraFlags > >
struct	PyVoidScalarObject_Proxy
struct	same_size< T >
struct	type_caster< unchecked_mutable_reference< T, Dim > >
struct	type_caster< unchecked_reference< T, Dim > >
class	unchecked_mutable_reference< T, Dims >
class	unchecked_reference< T, Dims >
struct	vectorize_arg< T >
struct	vectorize_helper< Func, Return, Args >
struct	vectorize_returned_array< Func, Return, Args >
struct	vectorize_returned_array< Func, void, Args... >

Macros
#define	DECL_NPY_API(Func)   api.Func##_ = (decltype(api.Func##_)) api_ptr[API_##Func];
#define	PYBIND11_DECL_CHAR_FMT
#define	PYBIND11_EVAL(...)   PYBIND11_EVAL4(PYBIND11_EVAL4(PYBIND11_EVAL4(__VA_ARGS__)))
#define	PYBIND11_EVAL0(...)   __VA_ARGS__
#define	PYBIND11_EVAL1(...)   PYBIND11_EVAL0(PYBIND11_EVAL0(PYBIND11_EVAL0(__VA_ARGS__)))
#define	PYBIND11_EVAL2(...)   PYBIND11_EVAL1(PYBIND11_EVAL1(PYBIND11_EVAL1(__VA_ARGS__)))
#define	PYBIND11_EVAL3(...)   PYBIND11_EVAL2(PYBIND11_EVAL2(PYBIND11_EVAL2(__VA_ARGS__)))
#define	PYBIND11_EVAL4(...)   PYBIND11_EVAL3(PYBIND11_EVAL3(PYBIND11_EVAL3(__VA_ARGS__)))
#define	PYBIND11_FIELD_DESCRIPTOR(T, Field)   PYBIND11_FIELD_DESCRIPTOR_EX(T, Field, #Field)
#define	PYBIND11_FIELD_DESCRIPTOR_EX(T, Field, Name)
#define	PYBIND11_MAP2_LIST(f, t, ...)   PYBIND11_EVAL(PYBIND11_MAP2_LIST1(f, t, __VA_ARGS__, (), 0))
#define	PYBIND11_MAP2_LIST0(f, t, x1, x2, peek, ...)   f(t, x1, x2) PYBIND11_MAP2_LIST_NEXT(peek, PYBIND11_MAP2_LIST1)(f, t, peek, __VA_ARGS__)
#define	PYBIND11_MAP2_LIST1(f, t, x1, x2, peek, ...)   f(t, x1, x2) PYBIND11_MAP2_LIST_NEXT(peek, PYBIND11_MAP2_LIST0)(f, t, peek, __VA_ARGS__)
#define	PYBIND11_MAP2_LIST_NEXT(test, next)   PYBIND11_MAP2_LIST_NEXT1(PYBIND11_MAP_GET_END test, next)
#define	PYBIND11_MAP2_LIST_NEXT1(test, next)   PYBIND11_MAP_NEXT0(test, PYBIND11_MAP_COMMA next, 0)
#define	PYBIND11_MAP_COMMA   ,
#define	PYBIND11_MAP_END(...)
#define	PYBIND11_MAP_GET_END()   0, PYBIND11_MAP_END
#define	PYBIND11_MAP_LIST(f, t, ...)   PYBIND11_EVAL(PYBIND11_MAP_LIST1(f, t, __VA_ARGS__, (), 0))
#define	PYBIND11_MAP_LIST0(f, t, x, peek, ...)   f(t, x) PYBIND11_MAP_LIST_NEXT(peek, PYBIND11_MAP_LIST1)(f, t, peek, __VA_ARGS__)
#define	PYBIND11_MAP_LIST1(f, t, x, peek, ...)   f(t, x) PYBIND11_MAP_LIST_NEXT(peek, PYBIND11_MAP_LIST0)(f, t, peek, __VA_ARGS__)
#define	PYBIND11_MAP_LIST_NEXT(test, next)   PYBIND11_MAP_LIST_NEXT1(PYBIND11_MAP_GET_END test, next)
#define	PYBIND11_MAP_LIST_NEXT1(test, next)   PYBIND11_MAP_NEXT0(test, PYBIND11_MAP_COMMA next, 0)
#define	PYBIND11_MAP_NEXT(test, next)   PYBIND11_MAP_NEXT1(PYBIND11_MAP_GET_END test, next)
#define	PYBIND11_MAP_NEXT0(test, next, ...)   next PYBIND11_MAP_OUT
#define	PYBIND11_MAP_NEXT1(test, next)   PYBIND11_MAP_NEXT0(test, next, 0)
#define	PYBIND11_MAP_OUT
#define	PYBIND11_NUMPY_DTYPE(Type, ...)
#define	PYBIND11_NUMPY_DTYPE_EX(Type, ...)

Typedefs
template<typename T >
using	is_pod = all_of< std::is_standard_layout< T >, std::is_trivial< T > >
template<typename T >
using	is_pod_struct = all_of< std::is_standard_layout< T >, std::is_trivially_copyable< T >, satisfies_none_of< T, std::is_reference, std::is_array, is_std_array, std::is_arithmetic, is_complex, std::is_enum > >
template<typename T >
using	remove_all_extents_t = typename array_info< T >::type

Enumerations
enum	broadcast_trivial { broadcast_trivial::non_trivial, broadcast_trivial::c_trivial, broadcast_trivial::f_trivial }

Functions
const PyArrayDescr1_Proxy *	array_descriptor1_proxy (const PyObject *ptr)
const PyArrayDescr2_Proxy *	array_descriptor2_proxy (const PyObject *ptr)
const PyArrayDescr_Proxy *	array_descriptor_proxy (const PyObject *ptr)
PyArrayDescr_Proxy *	array_descriptor_proxy (PyObject *ptr)
const PyArray_Proxy *	array_proxy (const void *ptr)
PyArray_Proxy *	array_proxy (void *ptr)
template<size_t N>
broadcast_trivial	broadcast (const std::array< buffer_info, N > &buffers, ssize_t &ndim, std::vector< ssize_t > &shape)
template<ssize_t Dim = 0, typename Strides >
ssize_t	byte_offset_unsafe (const Strides &)
template<ssize_t Dim = 0, typename Strides , typename... Ix>
ssize_t	byte_offset_unsafe (const Strides &strides, ssize_t i, Ix... index)
bool	check_flags (const void *ptr, int flag)
numpy_internals &	get_numpy_internals ()
PYBIND11_NOINLINE module_	import_numpy_core_submodule (const char *submodule_name)
PYBIND11_NOINLINE void	load_numpy_internals (numpy_internals *&ptr)
template<typename Concrete >
constexpr int	platform_lookup ()
template<typename Concrete , typename T , typename... Ts, typename... Ints>
constexpr int	platform_lookup (int I, Ints... Is)
PYBIND11_NOINLINE void	register_structured_dtype (any_container< field_descriptor > fields, const std::type_info &tinfo, ssize_t itemsize, bool(*direct_converter)(PyObject *, void *&))
template<typename Func , detail::enable_if_t< detail::is_lambda< Func >::value, int > = 0>
auto	vectorize (Func &&f) -> decltype(detail::vectorize_extractor(std::forward< Func >(f),(detail::function_signature_t< Func > *) nullptr))
template<typename Return , typename... Args>
detail::vectorize_helper< Return(*)(Args...), Return, Args... >	vectorize (Return(*f)(Args...))
template<typename Return , typename Class , typename... Args, typename Helper = detail::vectorize_helper< decltype(std::mem_fn(std::declval<Return (Class::*)(Args...)>())), Return, Class *, Args...>>
Helper	vectorize (Return(Class::*f)(Args...))
template<typename Func , typename Return , typename... Args>
vectorize_helper< Func, Return, Args... >	vectorize_extractor (const Func &f, Return(*)(Args...))

Macro Definition Documentation

DECL_NPY_API

#define DECL_NPY_API

(

Func

)

api.Func##_ = (decltype(api.Func##_)) api_ptr[API_##Func];

PYBIND11_DECL_CHAR_FMT

#define PYBIND11_DECL_CHAR_FMT

Value:

    static constexpr auto name = const_name("S") + const_name<N>();                               \
    static pybind11::dtype dtype() {                                                              \
        return pybind11::dtype(std::string("S") + std::to_string(N));                             \
    }

Definition at line 1439 of file numpy.h.

PYBIND11_EVAL

#define PYBIND11_EVAL

(

...

)

PYBIND11_EVAL4(PYBIND11_EVAL4(PYBIND11_EVAL4(__VA_ARGS__)))

Definition at line 1630 of file numpy.h.

PYBIND11_EVAL0

#define PYBIND11_EVAL0

(

...

)

__VA_ARGS__

Definition at line 1625 of file numpy.h.

PYBIND11_EVAL1

#define PYBIND11_EVAL1

(

...

)

PYBIND11_EVAL0(PYBIND11_EVAL0(PYBIND11_EVAL0(__VA_ARGS__)))

Definition at line 1626 of file numpy.h.

PYBIND11_EVAL2

#define PYBIND11_EVAL2

(

...

)

PYBIND11_EVAL1(PYBIND11_EVAL1(PYBIND11_EVAL1(__VA_ARGS__)))

Definition at line 1627 of file numpy.h.

PYBIND11_EVAL3

#define PYBIND11_EVAL3

(

...

)

PYBIND11_EVAL2(PYBIND11_EVAL2(PYBIND11_EVAL2(__VA_ARGS__)))

Definition at line 1628 of file numpy.h.

PYBIND11_EVAL4

#define PYBIND11_EVAL4

(

...

)

PYBIND11_EVAL3(PYBIND11_EVAL3(PYBIND11_EVAL3(__VA_ARGS__)))

Definition at line 1629 of file numpy.h.

PYBIND11_FIELD_DESCRIPTOR

#define PYBIND11_FIELD_DESCRIPTOR	(		T,
			Field
	)		PYBIND11_FIELD_DESCRIPTOR_EX(T, Field, #Field)

Definition at line 1621 of file numpy.h.

PYBIND11_FIELD_DESCRIPTOR_EX

#define PYBIND11_FIELD_DESCRIPTOR_EX	(		T,
			Field,
			Name
	)

Value:

        ::pybind11::detail::field_descriptor {                                                    \
            Name, offsetof(T, Field), sizeof(decltype(std::declval<T>().Field)),                  \
                ::pybind11::format_descriptor<decltype(std::declval<T>().Field)>::format(),       \
                ::pybind11::detail::npy_format_descriptor<                                        \
                    decltype(std::declval<T>().Field)>::dtype()                                   \
        }

Definition at line 1612 of file numpy.h.

PYBIND11_MAP2_LIST

#define PYBIND11_MAP2_LIST	(		f,
			t,
			...
	)		PYBIND11_EVAL(PYBIND11_MAP2_LIST1(f, t, __VA_ARGS__, (), 0))

Definition at line 1675 of file numpy.h.

PYBIND11_MAP2_LIST0

#define PYBIND11_MAP2_LIST0	(		f,
			t,
			x1,
			x2,
			peek,
			...
	)		f(t, x1, x2) PYBIND11_MAP2_LIST_NEXT(peek, PYBIND11_MAP2_LIST1)(f, t, peek, __VA_ARGS__)

Definition at line 1670 of file numpy.h.

PYBIND11_MAP2_LIST1

#define PYBIND11_MAP2_LIST1	(		f,
			t,
			x1,
			x2,
			peek,
			...
	)		f(t, x1, x2) PYBIND11_MAP2_LIST_NEXT(peek, PYBIND11_MAP2_LIST0)(f, t, peek, __VA_ARGS__)

Definition at line 1672 of file numpy.h.

PYBIND11_MAP2_LIST_NEXT

#define PYBIND11_MAP2_LIST_NEXT	(		test,
			next
	)		PYBIND11_MAP2_LIST_NEXT1(PYBIND11_MAP_GET_END test, next)

Definition at line 1668 of file numpy.h.

PYBIND11_MAP2_LIST_NEXT1

#define PYBIND11_MAP2_LIST_NEXT1	(		test,
			next
	)		PYBIND11_MAP_NEXT0(test, PYBIND11_MAP_COMMA next, 0)

Definition at line 1665 of file numpy.h.

PYBIND11_MAP_COMMA

#define PYBIND11_MAP_COMMA   ,

Definition at line 1633 of file numpy.h.

PYBIND11_MAP_END

#define PYBIND11_MAP_END

(

...

)

Definition at line 1631 of file numpy.h.

PYBIND11_MAP_GET_END

#define PYBIND11_MAP_GET_END

(

)

0, PYBIND11_MAP_END

Definition at line 1634 of file numpy.h.

PYBIND11_MAP_LIST

#define PYBIND11_MAP_LIST	(		f,
			t,
			...
	)		PYBIND11_EVAL(PYBIND11_MAP_LIST1(f, t, __VA_ARGS__, (), 0))

Definition at line 1653 of file numpy.h.

PYBIND11_MAP_LIST0

#define PYBIND11_MAP_LIST0	(		f,
			t,
			x,
			peek,
			...
	)		f(t, x) PYBIND11_MAP_LIST_NEXT(peek, PYBIND11_MAP_LIST1)(f, t, peek, __VA_ARGS__)

Definition at line 1648 of file numpy.h.

PYBIND11_MAP_LIST1

#define PYBIND11_MAP_LIST1	(		f,
			t,
			x,
			peek,
			...
	)		f(t, x) PYBIND11_MAP_LIST_NEXT(peek, PYBIND11_MAP_LIST0)(f, t, peek, __VA_ARGS__)

Definition at line 1650 of file numpy.h.

PYBIND11_MAP_LIST_NEXT

#define PYBIND11_MAP_LIST_NEXT	(		test,
			next
	)		PYBIND11_MAP_LIST_NEXT1(PYBIND11_MAP_GET_END test, next)

Definition at line 1646 of file numpy.h.

PYBIND11_MAP_LIST_NEXT1

#define PYBIND11_MAP_LIST_NEXT1	(		test,
			next
	)		PYBIND11_MAP_NEXT0(test, PYBIND11_MAP_COMMA next, 0)

Definition at line 1643 of file numpy.h.

PYBIND11_MAP_NEXT

#define PYBIND11_MAP_NEXT	(		test,
			next
	)		PYBIND11_MAP_NEXT1(PYBIND11_MAP_GET_END test, next)

Definition at line 1637 of file numpy.h.

PYBIND11_MAP_NEXT0

#define PYBIND11_MAP_NEXT0	(		test,
			next,
			...
	)		next PYBIND11_MAP_OUT

Definition at line 1635 of file numpy.h.

PYBIND11_MAP_NEXT1

#define PYBIND11_MAP_NEXT1	(		test,
			next
	)		PYBIND11_MAP_NEXT0(test, next, 0)

Definition at line 1636 of file numpy.h.

PYBIND11_MAP_OUT

#define PYBIND11_MAP_OUT

Definition at line 1632 of file numpy.h.

PYBIND11_NUMPY_DTYPE

#define PYBIND11_NUMPY_DTYPE	(		Type,
			...
	)

Value:

        ::pybind11::detail::npy_format_descriptor<Type>::register_dtype(                          \
            ::std::vector<::pybind11::detail::field_descriptor>{                                  \
                PYBIND11_MAP_LIST(PYBIND11_FIELD_DESCRIPTOR, Type, __VA_ARGS__)})

Definition at line 1656 of file numpy.h.

PYBIND11_NUMPY_DTYPE_EX

#define PYBIND11_NUMPY_DTYPE_EX	(		Type,
			...
	)

Value:

        ::pybind11::detail::npy_format_descriptor<Type>::register_dtype(                          \
            ::std::vector<::pybind11::detail::field_descriptor>{                                  \
                PYBIND11_MAP2_LIST(PYBIND11_FIELD_DESCRIPTOR_EX, Type, __VA_ARGS__)})

Definition at line 1678 of file numpy.h.

Typedef Documentation

is_pod

template<typename T >

using is_pod = all_of<std::is_standard_layout<T>, std::is_trivial<T> >

Definition at line 486 of file numpy.h.

is_pod_struct

template<typename T >

using is_pod_struct = all_of<std::is_standard_layout<T>, std::is_trivially_copyable<T>, satisfies_none_of<T, std::is_reference, std::is_array, is_std_array, std::is_arithmetic, is_complex, std::is_enum> >

Definition at line 482 of file numpy.h.

remove_all_extents_t

template<typename T >

using remove_all_extents_t = typename array_info<T>::type

Definition at line 460 of file numpy.h.

Enumeration Type Documentation

broadcast_trivial

enum broadcast_trivial

strong

Enumerator
non_trivial
c_trivial
f_trivial

Definition at line 1788 of file numpy.h.

Function Documentation

array_descriptor1_proxy()

const PyArrayDescr1_Proxy* array_descriptor1_proxy ( const PyObject *  ptr )

inline

Definition at line 401 of file numpy.h.

array_descriptor2_proxy()

const PyArrayDescr2_Proxy* array_descriptor2_proxy ( const PyObject *  ptr )

inline

Definition at line 405 of file numpy.h.

array_descriptor_proxy() [1/2]

const PyArrayDescr_Proxy* array_descriptor_proxy ( const PyObject *  ptr )

inline

Definition at line 397 of file numpy.h.

array_descriptor_proxy() [2/2]

PyArrayDescr_Proxy* array_descriptor_proxy ( PyObject *  ptr )

inline

Definition at line 393 of file numpy.h.

array_proxy() [1/2]

const PyArray_Proxy* array_proxy ( const void *  ptr )

inline

Definition at line 389 of file numpy.h.

array_proxy() [2/2]

PyArray_Proxy* array_proxy ( void *  ptr )

inline

Definition at line 387 of file numpy.h.

broadcast()

template<size_t N>

broadcast_trivial broadcast	(	const std::array< buffer_info, N > &	buffers,
		ssize_t &	ndim,
		std::vector< ssize_t > &	shape
	)

Definition at line 1796 of file numpy.h.

byte_offset_unsafe() [1/2]

template<ssize_t Dim = 0, typename Strides >

ssize_t byte_offset_unsafe

(

const Strides &

)

Definition at line 489 of file numpy.h.

byte_offset_unsafe() [2/2]

template<ssize_t Dim = 0, typename Strides , typename... Ix>

ssize_t byte_offset_unsafe	(	const Strides &	strides,
		ssize_t	i,
		Ix...	index
	)

Definition at line 493 of file numpy.h.

check_flags()

bool check_flags ( const void *  ptr, int  flag  )

inline

Definition at line 409 of file numpy.h.

get_numpy_internals()

numpy_internals& get_numpy_internals ( )

inline

Definition at line 167 of file numpy.h.

import_numpy_core_submodule()

PYBIND11_NOINLINE module_ import_numpy_core_submodule

(

const char *

submodule_name

)

Definition at line 175 of file numpy.h.

load_numpy_internals()

PYBIND11_NOINLINE void load_numpy_internals

(

numpy_internals *&

ptr

)

Definition at line 163 of file numpy.h.

platform_lookup() [1/2]

template<typename Concrete >

constexpr int platform_lookup ( )

constexpr

Definition at line 204 of file numpy.h.

platform_lookup() [2/2]

template<typename Concrete , typename T , typename... Ts, typename... Ints>

constexpr int platform_lookup ( int  I, Ints...  Is  )

constexpr

Definition at line 210 of file numpy.h.

register_structured_dtype()

PYBIND11_NOINLINE void register_structured_dtype	(	any_container< field_descriptor >	fields,
		const std::type_info &	tinfo,
		ssize_t	itemsize,
		bool(*)(PyObject *, void *&)	direct_converter
	)

Definition at line 1490 of file numpy.h.

vectorize() [1/3]

template<typename Func , detail::enable_if_t< detail::is_lambda< Func >::value, int > = 0>

auto vectorize

(

Func &&

f

)

-> decltype(detail::vectorize_extractor(std::forward<Func>(f), (detail::function_signature_t<Func> *) nullptr))

Definition at line 2106 of file numpy.h.

vectorize() [2/3]

template<typename Return , typename... Args>

detail::vectorize_helper<Return (*)(Args...), Return, Args...> vectorize

(

Return(*)(Args...)

f

)

Definition at line 2100 of file numpy.h.

vectorize() [3/3]

template<typename Return , typename Class , typename... Args, typename Helper = detail::vectorize_helper< decltype(std::mem_fn(std::declval<Return (Class::*)(Args...)>())), Return, Class *, Args...>>

Helper vectorize

(

Return(Class::*)(Args...)

f

)

Definition at line 2122 of file numpy.h.

vectorize_extractor()

template<typename Func , typename Return , typename... Args>

vectorize_helper<Func, Return, Args...> vectorize_extractor	(	const Func &	f,
		Return(*)(Args...)
	)

Definition at line 2086 of file numpy.h.