#include </builds/ipbus/ipbus-software/uhal/python/pybind11-python2/include/pybind11/numpy.h>

Inheritance diagram for dtype:

Collaboration diagram for dtype:

Public Member Functions
	PYBIND11_OBJECT_DEFAULT (dtype, object, detail::npy_api::get().PyArrayDescr_Check_)

	dtype (const buffer_info &info)

	dtype (const std::string &format)

	dtype (const char *format)

	dtype (list names, list formats, list offsets, ssize_t itemsize)

ssize_t	itemsize () const
	Size of the data type in bytes. More...

bool	has_fields () const
	Returns true for structured data types. More...

char	kind () const
	Single-character code for dtype's kind. More...

char	char_ () const
	Single-character for dtype's type. More...

	dtype (const buffer_info &info)

	dtype (const pybind11::str &format)

	dtype (const std::string &format)

	dtype (const char *format)

	dtype (list names, list formats, list offsets, ssize_t itemsize)

	dtype (int typenum)

ssize_t	itemsize () const
	Size of the data type in bytes. More...

bool	has_fields () const
	Returns true for structured data types. More...

char	kind () const
	Single-character code for dtype's kind. More...

char	char_ () const
	Single-character for dtype's type. More...

int	num () const
	type number of dtype. More...

char	byteorder () const
	Single character for byteorder. More...

int	alignment () const
	Alignment of the data type. More...

char	flags () const
	Flags for the array descriptor. More...

Public Member Functions inherited from object
	object ()=default

	PYBIND11_DEPRECATED ("Use reinterpret_borrow<object>() or reinterpret_steal<object>()") object(handle h

	object (const object &o)
	Copy constructor; always increases the reference count. More...

	object (object &&other) noexcept
	Move constructor; steals the object from `other` and preserves its reference count. More...

	~object ()
	Destructor; automatically calls `handle::dec_ref()` More...

handle	release ()
	\rst Resets the internal pointer to `nullptr` without decreasing the object's reference count. More...

object &	operator= (const object &other)

object &	operator= (object &&other) noexcept

template<typename T >
T	cast () const &

template<typename T >
T	cast () &&

	object (handle h, borrowed_t)

	object (handle h, stolen_t)

	object ()=default

	PYBIND11_DEPRECATED ("Use reinterpret_borrow<object>() or reinterpret_steal<object>()") object(handle h

	object (const object &o)
	Copy constructor; always increases the reference count. More...

	object (object &&other) noexcept
	Move constructor; steals the object from `other` and preserves its reference count. More...

	~object ()
	Destructor; automatically calls `handle::dec_ref()` More...

handle	release ()
	\rst Resets the internal pointer to `nullptr` without decreasing the object's reference count. More...

object &	operator= (const object &other)

object &	operator= (object &&other) noexcept

template<typename T >
T	cast () const &

template<typename T >
T	cast () &&

	object (handle h, borrowed_t)

	object (handle h, stolen_t)

template<typename T >
T	cast () const &

template<typename T >
T	cast () &&

template<>
void	cast () const &

template<>
void	cast () &&

Public Member Functions inherited from handle
	handle ()=default
	The default constructor creates a handle with a `nullptr`-valued pointer. More...

	handle (PyObject *ptr)
	Creates a `handle` from the given raw Python object pointer. More...

PyObject *	ptr () const
	Return the underlying `PyObject *` pointer. More...

PyObject *&	ptr ()

const handle &	inc_ref () const &
	\rst Manually increase the reference count of the Python object. More...

const handle &	dec_ref () const &
	\rst Manually decrease the reference count of the Python object. More...

template<typename T >
T	cast () const
	\rst Attempt to cast the Python object into the given C++ type. More...

	operator bool () const
	Return `true` when the `handle` wraps a valid Python object. More...

bool	operator== (const handle &h) const
	\rst Deprecated: Check that the underlying pointers are the same. More...

bool	operator!= (const handle &h) const

bool	check () const

	handle ()=default
	The default constructor creates a handle with a `nullptr`-valued pointer. More...

template<typename T , detail::enable_if_t< detail::is_pyobj_ptr_or_nullptr_t< T >::value, int > = 0>
	handle (T ptr)
	Enable implicit conversion from `PyObject *` and `nullptr`. More...

template<typename T , detail::enable_if_t< detail::all_of< detail::none_of< std::is_base_of< handle, T >, detail::is_pyobj_ptr_or_nullptr_t< T > >, std::is_convertible< T, PyObject * > >::value, int > = 0>
	handle (T &obj)
	Enable implicit conversion through `T::operator PyObject *()`. More...

PyObject *	ptr () const
	Return the underlying `PyObject *` pointer. More...

PyObject *&	ptr ()

const handle &	inc_ref () const &
	\rst Manually increase the reference count of the Python object. More...

const handle &	dec_ref () const &
	\rst Manually decrease the reference count of the Python object. More...

template<typename T >
T	cast () const
	\rst Attempt to cast the Python object into the given C++ type. More...

	operator bool () const
	Return `true` when the `handle` wraps a valid Python object. More...

bool	operator== (const handle &h) const
	\rst Deprecated: Check that the underlying pointers are the same. More...

bool	operator!= (const handle &h) const

bool	check () const

template<>
void	cast () const

Static Public Member Functions
static dtype	from_args (object args)
	This is essentially the same as calling numpy.dtype(args) in Python. More...

template<typename T >
static dtype	of ()
	Return dtype associated with a C++ type. More...

static dtype	from_args (const object &args)
	This is essentially the same as calling numpy.dtype(args) in Python. More...

template<typename T >
static dtype	of ()
	Return dtype associated with a C++ type. More...

Static Public Member Functions inherited from handle
static std::size_t	inc_ref_counter ()

Private Member Functions
dtype	strip_padding (ssize_t itemsize)

dtype	strip_padding (ssize_t itemsize)

Static Private Member Functions
static object	_dtype_from_pep3118 ()

static object	_dtype_from_pep3118 ()

Additional Inherited Members
Public Attributes inherited from object
bool	is_borrowed: handle(h) { if (is_borrowed) { inc_ref()

Protected Attributes inherited from handle
PyObject *	m_ptr = nullptr

Detailed Description

Definition at line 542 of file numpy.h.

Constructor & Destructor Documentation

◆ dtype() [1/10]

dtype::dtype ( const buffer_info & info )

inlineexplicit

Definition at line 546 of file numpy.h.

References buffer_info::format, buffer_info::itemsize, and PYBIND11_STR_TYPE.

◆ dtype() [2/10]

dtype::dtype ( const std::string & format )

inlineexplicit

Definition at line 554 of file numpy.h.

◆ dtype() [3/10]

dtype::dtype ( const char * format )

inlineexplicit

Definition at line 558 of file numpy.h.

◆ dtype() [4/10]

dtype::dtype	(	list	names,
		list	formats,
		list	offsets,
		ssize_t	itemsize
	)

inline

Definition at line 560 of file numpy.h.

◆ dtype() [5/10]

dtype::dtype ( const buffer_info & info )

inlineexplicit

Definition at line 544 of file numpy.h.

References _dtype_from_pep3118(), and handle::m_ptr.

◆ dtype() [6/10]

dtype::dtype ( const pybind11::str & format )

inlineexplicit

Definition at line 552 of file numpy.h.

◆ dtype() [7/10]

dtype::dtype ( const std::string & format )

inlineexplicit

Definition at line 554 of file numpy.h.

◆ dtype() [8/10]

dtype::dtype ( const char * format )

inlineexplicit

Definition at line 556 of file numpy.h.

◆ dtype() [9/10]

dtype::dtype	(	list	names,
		list	formats,
		list	offsets,
		ssize_t	itemsize
	)

inline

Definition at line 558 of file numpy.h.

References from_args(), itemsize(), handle::m_ptr, handle::ptr(), and object::release().

◆ dtype() [10/10]

dtype::dtype ( int typenum )

inlineexplicit

Definition at line 567 of file numpy.h.

References handle::m_ptr.

Member Function Documentation

◆ _dtype_from_pep3118() [1/2]

static object dtype::_dtype_from_pep3118 ( )

inlinestaticprivate

Definition at line 604 of file numpy.h.

References object::cast(), and module_::import().

Referenced by dtype().

◆ _dtype_from_pep3118() [2/2]

static object dtype::_dtype_from_pep3118 ( )

inlinestaticprivate

Definition at line 626 of file numpy.h.

References object::cast(), module_::import(), handle::ptr(), and object::release().

◆ alignment()

int dtype::alignment ( ) const

inline

Alignment of the data type.

Definition at line 620 of file numpy.h.

References handle::m_ptr.

◆ byteorder()

char dtype::byteorder ( ) const

inline

Single character for byteorder.

Definition at line 617 of file numpy.h.

References handle::m_ptr.

◆ char_() [1/2]

char dtype::char_ ( ) const

inline

Single-character for dtype's type.

For example, float is 'f', double 'd', int 'i', and long 'l'.

Definition at line 596 of file numpy.h.

◆ char_() [2/2]

char dtype::char_ ( ) const

inline

Single-character for dtype's type.

For example, float is 'f', double 'd', int 'i', and long 'l'.

Definition at line 601 of file numpy.h.

References handle::m_ptr.

◆ flags()

char dtype::flags ( ) const

inline

Flags for the array descriptor.

Definition at line 623 of file numpy.h.

References handle::m_ptr.

◆ from_args() [1/2]

static dtype dtype::from_args ( const object & args )

inlinestatic

This is essentially the same as calling numpy.dtype(args) in Python.

Definition at line 575 of file numpy.h.

References handle::ptr().

◆ from_args() [2/2]

static dtype dtype::from_args ( object args )

inlinestatic

This is essentially the same as calling numpy.dtype(args) in Python.

Definition at line 570 of file numpy.h.

References handle::ptr().

Referenced by dtype(), and array::view().

◆ has_fields() [1/2]

bool dtype::has_fields ( ) const

inline

Returns true for structured data types.

Definition at line 588 of file numpy.h.

Referenced by strip_padding().

◆ has_fields() [2/2]

bool dtype::has_fields ( ) const

inline

Returns true for structured data types.

Definition at line 593 of file numpy.h.

References handle::m_ptr.

◆ itemsize() [1/2]

ssize_t dtype::itemsize ( ) const

inline

Size of the data type in bytes.

Definition at line 585 of file numpy.h.

Referenced by dtype(), and strip_padding().

◆ itemsize() [2/2]

ssize_t dtype::itemsize ( ) const

inline

Size of the data type in bytes.

Definition at line 590 of file numpy.h.

References handle::m_ptr.

◆ kind() [1/2]

char dtype::kind ( ) const

inline

Single-character code for dtype's kind.

For example, floating point types are 'f' and integral types are 'i'.

Definition at line 592 of file numpy.h.

◆ kind() [2/2]

char dtype::kind ( ) const

inline

Single-character code for dtype's kind.

For example, floating point types are 'f' and integral types are 'i'.

Definition at line 597 of file numpy.h.

References handle::m_ptr.

◆ num()

int dtype::num ( ) const

inline

type number of dtype.

Definition at line 609 of file numpy.h.

References handle::m_ptr.

◆ of() [1/2]

template<typename T >

static dtype dtype::of ( )

inlinestatic

Return dtype associated with a C++ type.

Definition at line 580 of file numpy.h.

◆ of() [2/2]

template<typename T >

static dtype dtype::of ( )

inlinestatic

Return dtype associated with a C++ type.

Definition at line 585 of file numpy.h.

◆ PYBIND11_OBJECT_DEFAULT()

dtype::PYBIND11_OBJECT_DEFAULT	(	dtype	,
		object	,
		detail::npy_api::get().	PyArrayDescr_Check_
	)

◆ strip_padding() [1/2]

dtype dtype::strip_padding ( ssize_t itemsize )

inlineprivate

Definition at line 613 of file numpy.h.

References list::append(), len(), and PYBIND11_STR_TYPE.

◆ strip_padding() [2/2]

dtype dtype::strip_padding ( ssize_t itemsize )

inlineprivate

Definition at line 635 of file numpy.h.

References list::append(), object::cast(), has_fields(), itemsize(), and len().

The documentation for this class was generated from the following files:

python/pybind11-python2/include/pybind11/numpy.h
python/pybind11/include/pybind11/numpy.h

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ dtype() [1/10]

◆ dtype() [2/10]

◆ dtype() [3/10]

◆ dtype() [4/10]

◆ dtype() [5/10]

◆ dtype() [6/10]

◆ dtype() [7/10]

◆ dtype() [8/10]

◆ dtype() [9/10]

◆ dtype() [10/10]

Member Function Documentation

◆ _dtype_from_pep3118() [1/2]

◆ _dtype_from_pep3118() [2/2]

◆ alignment()

◆ byteorder()

◆ char_() [1/2]

◆ char_() [2/2]

◆ flags()

◆ from_args() [1/2]

◆ from_args() [2/2]

◆ has_fields() [1/2]

◆ has_fields() [2/2]

◆ itemsize() [1/2]

◆ itemsize() [2/2]

◆ kind() [1/2]

◆ kind() [2/2]

◆ num()

◆ of() [1/2]

◆ of() [2/2]

◆ PYBIND11_OBJECT_DEFAULT()

◆ strip_padding() [1/2]

◆ strip_padding() [2/2]