Public Member Functions | Static Public Member Functions | Private Member Functions | Static Private Member Functions | List of all members
dtype Class Reference

#include <numpy.h>

Inheritance diagram for dtype:
Inheritance graph
[legend]

Public Member Functions

 dtype (const buffer_info &info)
 
 dtype (const std::string &format)
 
 dtype (const char *format)
 
 dtype (list names, list formats, list offsets, ssize_t itemsize)
 
bool has_fields () const
 Returns true for structured data types. More...
 
ssize_t itemsize () const
 Size of the data type in bytes. More...
 
char kind () const
 Single-character type code. More...
 
 PYBIND11_OBJECT_DEFAULT (dtype, object, detail::npy_api::get().PyArrayDescr_Check_)
 
- Public Member Functions inherited from object
template<typename T >
T cast () const &
 
template<typename T >
T cast ()&&
 
template<>
void cast () const &
 
template<>
void cast ()&&
 
 object ()=default
 
 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 (handle h, borrowed_t)
 
 object (handle h, stolen_t)
 
objectoperator= (const object &other)
 
objectoperator= (object &&other) noexcept
 
 PYBIND11_DEPRECATED ("Use reinterpret_borrow<object>() or reinterpret_steal<object>()") object(handle h
 
handle release ()
 
 ~object ()
 Destructor; automatically calls handle::dec_ref() More...
 
- Public Member Functions inherited from handle
template<typename T >
T cast () const
 
template<>
void cast () const
 
bool check () const
 
const handledec_ref () const &
 
 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...
 
const handleinc_ref () 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
 
PyObject * ptr () const
 Return the underlying PyObject * pointer. More...
 
PyObject *& ptr ()
 

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

Private Member Functions

dtype strip_padding (ssize_t itemsize)
 

Static Private Member Functions

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

Constructor & Destructor Documentation

dtype::dtype ( const buffer_info info)
inlineexplicit

Definition at line 453 of file numpy.h.

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

Definition at line 459 of file numpy.h.

dtype::dtype ( const char *  format)
inline

Definition at line 463 of file numpy.h.

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

Definition at line 465 of file numpy.h.

Member Function Documentation

static object dtype::_dtype_from_pep3118 ( )
inlinestaticprivate

Definition at line 503 of file numpy.h.

static dtype dtype::from_args ( object  args)
inlinestatic

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

Definition at line 475 of file numpy.h.

bool dtype::has_fields ( ) const
inline

Returns true for structured data types.

Definition at line 493 of file numpy.h.

ssize_t dtype::itemsize ( ) const
inline

Size of the data type in bytes.

Definition at line 488 of file numpy.h.

char dtype::kind ( ) const
inline

Single-character type code.

Definition at line 498 of file numpy.h.

template<typename T >
static dtype dtype::of ( )
inlinestatic

Return dtype associated with a C++ type.

Definition at line 483 of file numpy.h.

dtype::PYBIND11_OBJECT_DEFAULT ( dtype  ,
object  ,
detail::npy_api::get().  PyArrayDescr_Check_ 
)
dtype dtype::strip_padding ( ssize_t  itemsize)
inlineprivate

Definition at line 509 of file numpy.h.


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


gtsam
Author(s):
autogenerated on Sat May 8 2021 02:51:47