#include <numpy.h>

Inheritance diagram for dtype:

Public Member Functions
	__attribute__ ((deprecated("Use reinterpret_borrow<""dtype"">() or reinterpret_steal<""dtype"">()"))) dtype(handle h

	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

	__attribute__ ((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...

	__attribute__ ((deprecated("Use obj1.is(obj2) instead"))) bool operator

template<>
void	cast () const

Public Member Functions inherited from object_api< handle >
iterator	begin () const

iterator	end () const
	Return a sentinel which ends iteration. More...

item_accessor	operator[] (handle key) const

item_accessor	operator[] (const char *key) const
	See above (the only difference is that they key is provided as a string literal) More...

obj_attr_accessor	attr (handle key) const

str_attr_accessor	attr (const char *key) const
	See above (the only difference is that they key is provided as a string literal) More...

args_proxy	operator* () const

object	operator* (object_api const &other) const

bool	contains (T &&item) const
	Check if the given item is contained within this object, i.e. `item in obj`. More...

object	operator() (Args &&...args) const

	__attribute__ ((deprecated("call(...) was deprecated in favor of operator()(...)"))) object call(Args &&... args) const
	Get or set the object's docstring, i.e. `obj.__doc__`. More...

bool	is (object_api const &other) const
	Equivalent to `obj is other` in Python. More...

bool	is_none () const
	Equivalent to `obj is None` in Python. More...

bool	equal (object_api const &other) const
	Equivalent to obj == other in Python. More...

bool	not_equal (object_api const &other) const

bool	operator< (object_api const &other) const

bool	operator<= (object_api const &other) const

bool	operator> (object_api const &other) const

bool	operator>= (object_api const &other) const

object	operator- () const

object	operator- (object_api const &other) const

object	operator~ () const

object	operator+ (object_api const &other) const

object	operator+= (object_api const &other) const

object	operator-= (object_api const &other) const

object	operator*= (object_api const &other) const

object	operator/ (object_api const &other) const

object	operator/= (object_api const &other) const

object	operator\| (object_api const &other) const

object	operator\|= (object_api const &other) const

object	operator& (object_api const &other) const

object	operator&= (object_api const &other) const

object	operator^ (object_api const &other) const

object	operator^= (object_api const &other) const

object	operator<< (object_api const &other) const

object	operator<<= (object_api const &other) const

object	operator>> (object_api const &other) const

object	operator>>= (object_api const &other) const

int	ref_count () const
	Return the object's current reference count. More...

handle	get_type () const
	Return a handle to the Python type object underlying the instance. More...

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...

Public Attributes
bool	is_borrowed: object (is_borrowed ? object (h

bool	borrowed_t {}) : object (h, stolen_t{})) { } dtype (handle h, borrowed_t) : object (h, borrowed_t{}) { } dtype (handle h, stolen_t) : object (h, stolen_t{}) { } PYBIND11_DEPRECATED("Use py::isinstance<py::python_type>(obj) instead") bool check() const { return m_ptr != nullptr && (bool) detail::npy_api::get().PyArrayDescr_Check_ (m_ptr); } static bool check_(handle h) { return h.ptr() != nullptr && detail::npy_api::get().PyArrayDescr_Check_ (h.ptr()); } dtype (const object &o) : object (o) { } dtype (object &&o) : object (std::move(o)) { } dtype () : object () { }

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

Private Member Functions
dtype	strip_padding (ssize_t itemsize)

Static Private Member Functions
static object	_dtype_from_pep3118 ()

Detailed Description

Definition at line 444 of file numpy.h.

Constructor & Destructor Documentation

◆ dtype() [1/4]

dtype ( const buffer_info & info )

inlineexplicit

Definition at line 448 of file numpy.h.

◆ dtype() [2/4]

dtype ( const std::string & format )

inlineexplicit

Definition at line 454 of file numpy.h.

◆ dtype() [3/4]

dtype ( const char * format )

inline

Definition at line 458 of file numpy.h.

◆ dtype() [4/4]

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

inline

Definition at line 460 of file numpy.h.

Member Function Documentation

◆ attribute()

__attribute__ ( (deprecated("Use reinterpret_borrow<""dtype"">() or reinterpret_steal<""dtype"">()")) )

◆ _dtype_from_pep3118()

static object _dtype_from_pep3118 ( )

inlinestaticprivate

Definition at line 498 of file numpy.h.

◆ from_args()

static dtype from_args ( object args )

inlinestatic

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

Definition at line 470 of file numpy.h.

◆ has_fields()

bool has_fields ( ) const

inline

Returns true for structured data types.

Definition at line 488 of file numpy.h.

◆ itemsize()

ssize_t itemsize ( ) const

inline

Size of the data type in bytes.

Definition at line 483 of file numpy.h.

◆ kind()

char kind ( ) const

inline

Single-character type code.

Definition at line 493 of file numpy.h.

◆ of()

static dtype of ( )

inlinestatic

Return dtype associated with a C++ type.

Definition at line 478 of file numpy.h.

◆ strip_padding()

dtype strip_padding ( ssize_t itemsize )

inlineprivate

Definition at line 504 of file numpy.h.

Member Data Documentation

◆ borrowed_t

bool borrowed_t {}) : object (h, stolen_t{})) { } dtype (handle h, borrowed_t) : object (h, borrowed_t{}) { } dtype (handle h, stolen_t) : object (h, stolen_t{}) { } PYBIND11_DEPRECATED("Use py::isinstance<py::python_type>(obj) instead") bool check() const { return m_ptr != nullptr && (bool) detail::npy_api::get().PyArrayDescr_Check_ (m_ptr); } static bool check_(handle h) { return h.ptr() != nullptr && detail::npy_api::get().PyArrayDescr_Check_ (h.ptr()); } dtype (const object &o) : object (o) { } dtype (object &&o) : object (std::move(o)) { } dtype () : object () { }

Definition at line 446 of file numpy.h.

◆ is_borrowed

bool is_borrowed

Definition at line 446 of file numpy.h.

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

numpy.h

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ dtype() [1/4]

◆ dtype() [2/4]

◆ dtype() [3/4]

◆ dtype() [4/4]

Member Function Documentation

◆ __attribute__()

◆ _dtype_from_pep3118()

◆ from_args()

◆ has_fields()

◆ itemsize()

◆ kind()

◆ of()

◆ strip_padding()

Member Data Documentation

◆ borrowed_t

◆ is_borrowed

◆ attribute()