dtype Class Reference

#include <numpy.h>

Inheritance 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 type code. 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 ()
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 &
const handle &	dec_ref () const &
template<typename T >
T	cast () const
	operator bool () const
	Return true when the handle wraps a valid Python object. More...
bool	operator== (const handle &h) const
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...

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 462 of file numpy.h.

Constructor & Destructor Documentation

dtype() [1/4]

dtype::dtype ( const buffer_info &  info )

inlineexplicit

Definition at line 466 of file numpy.h.

dtype() [2/4]

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

inlineexplicit

Definition at line 472 of file numpy.h.

dtype() [3/4]

dtype::dtype ( const char *  format )

inline

Definition at line 476 of file numpy.h.

dtype() [4/4]

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

inline

Definition at line 478 of file numpy.h.

Member Function Documentation

from_args()

static dtype dtype::from_args ( object  args )

inlinestatic

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

Definition at line 488 of file numpy.h.

has_fields()

bool dtype::has_fields ( ) const

inline

Returns true for structured data types.

Definition at line 506 of file numpy.h.

itemsize()

ssize_t dtype::itemsize ( ) const

inline

Size of the data type in bytes.

Definition at line 501 of file numpy.h.

kind()

char dtype::kind ( ) const

inline

Single-character type code.

Definition at line 511 of file numpy.h.

of()

template<typename T >

static dtype dtype::of ( )

inlinestatic

Return dtype associated with a C++ type.

Definition at line 496 of file numpy.h.

PYBIND11_OBJECT_DEFAULT()

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

---

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

• /Users/matin/Downloads/testProjs/CppyABM/examples/Cppy/build/_deps/pybind11-src/include/pybind11/numpy.h