Scarab  v2.11.1
Project 8 C++ Utility Library
Classes | Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
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 ()
 
 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)
 
template<typename T >
 buffer_info (T *ptr, detail::any_container< ssize_t > shape_in, detail::any_container< ssize_t > strides_in)
 
 buffer_info (void *ptr, ssize_t itemsize, const std::string &format, ssize_t size)
 
template<typename T >
 buffer_info (T *ptr, ssize_t size)
 
 buffer_info (Py_buffer *view, bool ownview=true)
 
 buffer_info (const buffer_info &)=delete
 
buffer_infooperator= (const buffer_info &)=delete
 
 buffer_info (buffer_info &&other)
 
buffer_infooperator= (buffer_info &&rhs)
 
 ~buffer_info ()
 

Public Attributes

void * ptr = nullptr
 
ssize_t itemsize = 0
 
ssize_t size = 0
 
std::string format
 
ssize_t ndim = 0
 
std::vector< ssize_tshape
 
std::vector< ssize_tstrides
 

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)
 

Private Attributes

Py_buffer * view = nullptr
 
bool ownview = false
 

Detailed Description

Information record describing a Python buffer object.

Definition at line 17 of file buffer_info.h.

Constructor & Destructor Documentation

◆ buffer_info() [1/9]

buffer_info ( )
inline

Definition at line 26 of file buffer_info.h.

◆ buffer_info() [2/9]

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 
)
inline

Definition at line 28 of file buffer_info.h.

◆ buffer_info() [3/9]

buffer_info ( T *  ptr,
detail::any_container< ssize_t shape_in,
detail::any_container< ssize_t strides_in 
)
inline

Definition at line 39 of file buffer_info.h.

◆ buffer_info() [4/9]

buffer_info ( void *  ptr,
ssize_t  itemsize,
const std::string &  format,
ssize_t  size 
)
inline

Definition at line 42 of file buffer_info.h.

◆ buffer_info() [5/9]

buffer_info ( T *  ptr,
ssize_t  size 
)
inline

Definition at line 46 of file buffer_info.h.

◆ buffer_info() [6/9]

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

Definition at line 49 of file buffer_info.h.

◆ buffer_info() [7/9]

buffer_info ( const buffer_info )
delete

◆ buffer_info() [8/9]

buffer_info ( buffer_info &&  other)
inline

Definition at line 59 of file buffer_info.h.

◆ ~buffer_info()

~buffer_info ( )
inline

Definition at line 76 of file buffer_info.h.

◆ buffer_info() [9/9]

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 
)
inlineprivate

Definition at line 83 of file buffer_info.h.

Member Function Documentation

◆ operator=() [1/2]

buffer_info& operator= ( const buffer_info )
delete

◆ operator=() [2/2]

buffer_info& operator= ( buffer_info &&  rhs)
inline

Definition at line 63 of file buffer_info.h.

Member Data Documentation

◆ format

std::string format

Definition at line 21 of file buffer_info.h.

◆ itemsize

ssize_t itemsize = 0

Definition at line 19 of file buffer_info.h.

◆ ndim

ssize_t ndim = 0

Definition at line 22 of file buffer_info.h.

◆ ownview

bool ownview = false
private

Definition at line 88 of file buffer_info.h.

◆ ptr

void* ptr = nullptr

Definition at line 18 of file buffer_info.h.

◆ shape

std::vector<ssize_t> shape

Definition at line 23 of file buffer_info.h.

◆ size

ssize_t size = 0

Definition at line 20 of file buffer_info.h.

◆ strides

std::vector<ssize_t> strides

Definition at line 24 of file buffer_info.h.

◆ view

Py_buffer* view = nullptr
private

Definition at line 87 of file buffer_info.h.


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