buffer_info Struct Reference

Information record describing a Python buffer object. More...

#include <buffer_info.h>

Classes
struct	private_ctr_tag

Public Member Functions
	buffer_info ()=default
	buffer_info (buffer_info &&other) noexcept
	buffer_info (const buffer_info &)=delete
template<typename T >
	buffer_info (const T *ptr, ssize_t size, bool readonly=true)
	buffer_info (Py_buffer *view, bool ownview=true)
template<typename T >
	buffer_info (T *ptr, detail::any_container< ssize_t > shape_in, detail::any_container< ssize_t > strides_in, bool readonly=false)
template<typename T >
	buffer_info (T *ptr, ssize_t size, bool readonly=false)
	buffer_info (void *ptr, ssize_t itemsize, const std::string &format, ssize_t ndim, detail::any_container< ssize_t > shape_in, detail::any_container< ssize_t > strides_in, bool readonly=false)
	buffer_info (void *ptr, ssize_t itemsize, const std::string &format, ssize_t size, bool readonly=false)
template<typename T >
bool	item_type_is_equivalent_to () const
buffer_info &	operator= (buffer_info &&rhs) noexcept
buffer_info &	operator= (const buffer_info &)=delete
Py_buffer *&	view ()
Py_buffer *	view () const
	~buffer_info ()

Public Attributes
std::string	format
ssize_t	itemsize = 0
ssize_t	ndim = 0
void *	ptr = nullptr
bool	readonly = false
std::vector< ssize_t >	shape
ssize_t	size = 0
std::vector< ssize_t >	strides

Private Member Functions
	buffer_info (private_ctr_tag, void *ptr, ssize_t itemsize, const std::string &format, ssize_t ndim, detail::any_container< ssize_t > &&shape_in, detail::any_container< ssize_t > &&strides_in, bool readonly)

Private Attributes
Py_buffer *	m_view = nullptr
bool	ownview = false

Detailed Description

Information record describing a Python buffer object.

Definition at line 46 of file buffer_info.h.

Constructor & Destructor Documentation

buffer_info() [1/10]

buffer_info::buffer_info ( )

default

buffer_info() [2/10]

buffer_info::buffer_info ( void *  ptr, ssize_t  itemsize, const std::string &  format, ssize_t  ndim, detail::any_container< ssize_t >  shape_in, detail::any_container< ssize_t >  strides_in, bool  readonly = false  )

inline

Definition at line 60 of file buffer_info.h.

buffer_info() [3/10]

template<typename T >

buffer_info::buffer_info ( T *  ptr, detail::any_container< ssize_t >  shape_in, detail::any_container< ssize_t >  strides_in, bool  readonly = false  )

inline

Definition at line 78 of file buffer_info.h.

buffer_info() [4/10]

buffer_info::buffer_info ( void *  ptr, ssize_t  itemsize, const std::string &  format, ssize_t  size, bool  readonly = false  )

inline

Definition at line 91 of file buffer_info.h.

buffer_info() [5/10]

template<typename T >

buffer_info::buffer_info ( T *  ptr, ssize_t  size, bool  readonly = false  )

inline

Definition at line 99 of file buffer_info.h.

buffer_info() [6/10]

template<typename T >

buffer_info::buffer_info ( const T *  ptr, ssize_t  size, bool  readonly = true  )

inline

Definition at line 103 of file buffer_info.h.

buffer_info() [7/10]

buffer_info::buffer_info ( Py_buffer *  view, bool  ownview = true  )

inlineexplicit

Definition at line 107 of file buffer_info.h.

buffer_info() [8/10]

buffer_info::buffer_info ( const buffer_info &  )

delete

buffer_info() [9/10]

buffer_info::buffer_info ( buffer_info &&  other )

inlinenoexcept

Definition at line 130 of file buffer_info.h.

~buffer_info()

buffer_info::~buffer_info ( )

inline

Definition at line 146 of file buffer_info.h.

buffer_info() [10/10]

buffer_info::buffer_info ( private_ctr_tag  , void *  ptr, ssize_t  itemsize, const std::string &  format, ssize_t  ndim, detail::any_container< ssize_t > &&  shape_in, detail::any_container< ssize_t > &&  strides_in, bool  readonly  )

inlineprivate

Definition at line 170 of file buffer_info.h.

Member Function Documentation

item_type_is_equivalent_to()

template<typename T >

bool buffer_info::item_type_is_equivalent_to ( ) const

inline

Definition at line 163 of file buffer_info.h.

operator=() [1/2]

buffer_info& buffer_info::operator= ( buffer_info &&  rhs )

inlinenoexcept

Definition at line 132 of file buffer_info.h.

operator=() [2/2]

buffer_info& buffer_info::operator= ( const buffer_info &  )

delete

view() [1/2]

Py_buffer*& buffer_info::view ( )

inline

Definition at line 154 of file buffer_info.h.

view() [2/2]

Py_buffer* buffer_info::view ( ) const

inline

Definition at line 153 of file buffer_info.h.

Member Data Documentation

format

std::string buffer_info::format

Definition at line 50 of file buffer_info.h.

itemsize

ssize_t buffer_info::itemsize = 0

Definition at line 48 of file buffer_info.h.

m_view

Py_buffer* buffer_info::m_view = nullptr

private

Definition at line 181 of file buffer_info.h.

ndim

ssize_t buffer_info::ndim = 0

Definition at line 52 of file buffer_info.h.

ownview

bool buffer_info::ownview = false

private

Definition at line 182 of file buffer_info.h.

ptr

void* buffer_info::ptr = nullptr

Definition at line 47 of file buffer_info.h.

readonly

bool buffer_info::readonly = false

Definition at line 56 of file buffer_info.h.

shape

std::vector<ssize_t> buffer_info::shape

Definition at line 53 of file buffer_info.h.

size

ssize_t buffer_info::size = 0

Definition at line 49 of file buffer_info.h.

strides

std::vector<ssize_t> buffer_info::strides

Definition at line 54 of file buffer_info.h.

---

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

• buffer_info.h