BoB robotics
The Brains on Board robotics library
pybind11::memoryview Class Reference
Inheritance diagram for pybind11::memoryview:
pybind11::object pybind11::handle pybind11::detail::object_api< handle > pybind11::detail::pyobject_tag

Public Member Functions

 __attribute__ ((deprecated("Use reinterpret_borrow<""memoryview"">() or reinterpret_steal<""memoryview"">()"))) memoryview(handle h
 
- Public Member Functions inherited from pybind11::object
 __attribute__ ((deprecated("Use reinterpret_borrow<object>() or reinterpret_steal<object>()"))) object(handle h
 
 object (const object &o)
 Copy constructor; always increases the reference count.
 
 object (object &&other) noexcept
 Move constructor; steals the object from other and preserves its reference count.
 
 ~object ()
 Destructor; automatically calls handle::dec_ref()
 
handle release ()
 
objectoperator= (const object &other)
 
objectoperator= (object &&other) noexcept
 
template<typename T >
cast () const &
 
template<typename T >
cast () &&
 
 object (handle h, borrowed_t)
 
 object (handle h, stolen_t)
 
template<typename T >
cast () const &
 
template<typename T >
cast () &&
 
template<>
void cast () const &
 
template<>
void cast () &&
 
- Public Member Functions inherited from pybind11::handle
 handle ()=default
 The default constructor creates a handle with a nullptr-valued pointer.
 
 handle (PyObject *ptr)
 Creates a handle from the given raw Python object pointer.
 
PyObject * ptr () const
 Return the underlying PyObject * pointer.
 
PyObject *& ptr ()
 
const handleinc_ref () const &
 
const handledec_ref () const &
 
template<typename T >
cast () const
 
 operator bool () const
 Return true when the handle wraps a valid Python object.
 
 __attribute__ ((deprecated("Use obj1.is(obj2) instead"))) bool operator
 
template<>
void cast () const
 
- Public Member Functions inherited from pybind11::detail::object_api< handle >
iterator begin () const
 
iterator end () const
 Return a sentinel which ends iteration.
 
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)
 
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)
 
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.
 
object operator() (Args &&...args) const
 
 __attribute__ ((deprecated("call(...) was deprecated in favor of operator()(...)"))) object call(Args &&... args) const
 
bool is (object_api const &other) const
 Equivalent to obj is other in Python.
 
bool is_none () const
 Equivalent to obj is None in Python.
 
bool equal (object_api const &other) const
 Equivalent to obj == other in Python.
 
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
 
__attribute__((deprecated("Use py::str(obj) instead"))) pybind11 str_attr_accessor doc () const
 Get or set the object's docstring, i.e. obj.__doc__.
 
int ref_count () const
 Return the object's current reference count.
 
handle get_type () const
 

Static Public Member Functions

static memoryview from_buffer (const void *ptr, ssize_t itemsize, const char *format, detail::any_container< ssize_t > shape, detail::any_container< ssize_t > strides)
 
template<typename T >
static memoryview from_buffer (T *ptr, detail::any_container< ssize_t > shape, detail::any_container< ssize_t > strides, bool readonly=false)
 
template<typename T >
static memoryview from_buffer (const T *ptr, detail::any_container< ssize_t > shape, detail::any_container< ssize_t > strides)
 

Public Attributes

bool is_borrowed: object (is_borrowed ? object (h
 
bool borrowed_t
 
- Public Attributes inherited from pybind11::object
bool is_borrowed: handle(h) { if (is_borrowed) inc_ref()
 

Member Data Documentation

◆ borrowed_t

Initial value:
{}) : object (h, stolen_t{})) { } memoryview (handle h, borrowed_t) : object (h, borrowed_t{}) { } memoryview (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 && ( PyMemoryView_Check (m_ptr) != 0); } static bool check_(handle h) { return h.ptr() != nullptr && PyMemoryView_Check (h.ptr()); } template <typename Policy_> memoryview (const ::pybind11::detail::accessor<Policy_> &a) : memoryview (object(a)) { } memoryview (const object &o) : object (check_(o) ? o.inc_ref().ptr() : PyMemoryView_FromObject (o.ptr()), stolen_t{}) { if (!m_ptr) throw error_already_set(); } memoryview (object &&o) : object (check_(o) ? o.release().ptr() : PyMemoryView_FromObject (o.ptr()), stolen_t{}) { if (!m_ptr) throw error_already_set(); }
explicit memoryview(const buffer_info& info) {
if (!info.view())
pybind11_fail("Prohibited to create memoryview without Py_buffer");
m_ptr = (info.view()->obj) ?
PyMemoryView_FromObject(info.view()->obj) :
PyMemoryView_FromBuffer(info.view());
if (!m_ptr)
pybind11_fail("Unable to create memoryview from buffer descriptor");
}
static memoryview from_buffer(
void *ptr, ssize_t itemsize, const char *format,
detail::any_container<ssize_t> shape,
detail::any_container<ssize_t> strides, bool readonly = false)
handle()=default
The default constructor creates a handle with a nullptr-valued pointer.
const handle & inc_ref() const &
Definition: pytypes.h:197
PyObject * ptr() const
Return the underlying PyObject * pointer.
Definition: pytypes.h:189
handle release()
Definition: pytypes.h:254

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