Protected Types | Protected Member Functions | Private Attributes | List of all members
dict_readonly Class Reference

Python's dictionary protocol permits this to be a forward iterator. More...

#include <pytypes.h>

Protected Types

using iterator_category = std::forward_iterator_tag
 
using pointer = arrow_proxy< const value_type >
 
using reference = const value_type
 
using value_type = std::pair< handle, handle >
 

Protected Member Functions

reference dereference () const
 
 dict_readonly ()=default
 
 dict_readonly (handle obj, ssize_t pos)
 
bool equal (const dict_readonly &b) const
 
void increment ()
 

Private Attributes

PyObject * key = nullptr
 
handle obj
 
ssize_t pos = -1
 
PyObject * value = nullptr
 

Detailed Description

Python's dictionary protocol permits this to be a forward iterator.

Definition at line 1298 of file pytypes.h.

Member Typedef Documentation

◆ iterator_category

using dict_readonly::iterator_category = std::forward_iterator_tag
protected

Definition at line 1300 of file pytypes.h.

◆ pointer

using dict_readonly::pointer = arrow_proxy<const value_type>
protected

Definition at line 1303 of file pytypes.h.

◆ reference

using dict_readonly::reference = const value_type
protected

Definition at line 1302 of file pytypes.h.

◆ value_type

using dict_readonly::value_type = std::pair<handle, handle>
protected

Definition at line 1301 of file pytypes.h.

Constructor & Destructor Documentation

◆ dict_readonly() [1/2]

dict_readonly::dict_readonly ( )
protecteddefault

◆ dict_readonly() [2/2]

dict_readonly::dict_readonly ( handle  obj,
ssize_t  pos 
)
inlineprotected

Definition at line 1306 of file pytypes.h.

Member Function Documentation

◆ dereference()

reference dict_readonly::dereference ( ) const
inlineprotected

Definition at line 1309 of file pytypes.h.

◆ equal()

bool dict_readonly::equal ( const dict_readonly b) const
inlineprotected

Definition at line 1315 of file pytypes.h.

◆ increment()

void dict_readonly::increment ( )
inlineprotected

Definition at line 1310 of file pytypes.h.

Member Data Documentation

◆ key

PyObject* dict_readonly::key = nullptr
private

Definition at line 1319 of file pytypes.h.

◆ obj

handle dict_readonly::obj
private

Definition at line 1318 of file pytypes.h.

◆ pos

ssize_t dict_readonly::pos = -1
private

Definition at line 1320 of file pytypes.h.

◆ value

PyObject * dict_readonly::value = nullptr
private

Definition at line 1319 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:01