Public Member Functions | List of all members
tuple Class Reference

#include <pytypes.h>

Inheritance diagram for tuple:
Inheritance graph
[legend]

Public Member Functions

detail::tuple_iterator begin () const
 
bool empty () const
 
detail::tuple_iterator end () const
 
detail::tuple_accessor operator[] (size_t index) const
 
template<typename T , detail::enable_if_t< detail::is_pyobject< T >::value, int > = 0>
detail::item_accessor operator[] (T &&o) const
 
size_t size () const
 
template<typename SzType = ssize_t, detail::enable_if_t< std::is_integral< SzType >::value, int > = 0>
 tuple (SzType size=0)
 
- Public Member Functions inherited from object
template<typename T >
T cast () &&
 
template<typename T >
T cast () const &
 
template<>
void cast () const &
 
 object ()=default
 
 object (const object &o)
 Copy constructor; always increases the reference count. More...
 
 object (handle h, borrowed_t)
 
 object (handle h, stolen_t)
 
 object (object &&other) noexcept
 Move constructor; steals the object from other and preserves its reference count. More...
 
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...
 
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...
 
template<typename T , detail::enable_if_t< detail::is_pyobj_ptr_or_nullptr_t< T >::value, int > = 0>
 handle (T ptr)
 
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 ()
 
PyObject * ptr () const
 Return the underlying PyObject * pointer. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from handle
static std::size_t inc_ref_counter ()
 
- 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 2077 of file pytypes.h.

Constructor & Destructor Documentation

◆ tuple()

template<typename SzType = ssize_t, detail::enable_if_t< std::is_integral< SzType >::value, int > = 0>
tuple::tuple ( SzType  size = 0)
inlineexplicit

Definition at line 2083 of file pytypes.h.

Member Function Documentation

◆ begin()

detail::tuple_iterator tuple::begin ( ) const
inline

Definition at line 2095 of file pytypes.h.

◆ empty()

bool tuple::empty ( ) const
inline

Definition at line 2089 of file pytypes.h.

◆ end()

detail::tuple_iterator tuple::end ( ) const
inline

Definition at line 2096 of file pytypes.h.

◆ operator[]() [1/2]

detail::tuple_accessor tuple::operator[] ( size_t  index) const
inline

Definition at line 2090 of file pytypes.h.

◆ operator[]() [2/2]

template<typename T , detail::enable_if_t< detail::is_pyobject< T >::value, int > = 0>
detail::item_accessor tuple::operator[] ( T &&  o) const
inline

Definition at line 2092 of file pytypes.h.

◆ size()

size_t tuple::size ( ) const
inline

Definition at line 2088 of file pytypes.h.


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


gtsam
Author(s):
autogenerated on Sat Nov 16 2024 04:10:09