Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Friends | List of all members
array Class Reference

#include <numpy.h>

Inheritance diagram for array:
Inheritance graph
[legend]

Public Types

enum  { c_style = detail::npy_api::NPY_ARRAY_C_CONTIGUOUS_, f_style = detail::npy_api::NPY_ARRAY_F_CONTIGUOUS_, forcecast = detail::npy_api::NPY_ARRAY_FORCECAST_ }
 
using ShapeContainer = detail::any_container< ssize_t >
 
using StridesContainer = detail::any_container< ssize_t >
 

Public Member Functions

 array ()
 
 array (const pybind11::dtype &dt, ShapeContainer shape, StridesContainer strides, const void *ptr=nullptr, handle base=handle())
 
 array (const pybind11::dtype &dt, ShapeContainer shape, const void *ptr=nullptr, handle base=handle())
 
template<typename T , typename = detail::enable_if_t<std::is_integral<T>::value && !std::is_same<bool, T>::value>>
 array (const pybind11::dtype &dt, T count, const void *ptr=nullptr, handle base=handle())
 
template<typename T >
 array (ShapeContainer shape, StridesContainer strides, const T *ptr, handle base=handle())
 
template<typename T >
 array (ShapeContainer shape, const T *ptr, handle base=handle())
 
template<typename T >
 array (ssize_t count, const T *ptr, handle base=handle())
 
 array (const buffer_info &info, handle base=handle())
 
object base () const
 Base object. More...
 
template<typename... Ix>
const void * data (Ix...index) const
 
pybind11::dtype dtype () const
 Array descriptor (dtype) More...
 
int flags () const
 Return the NumPy array flags. More...
 
template<typename... Ix>
ssize_t index_at (Ix...index) const
 
ssize_t itemsize () const
 Byte size of a single element. More...
 
template<typename... Ix>
void * mutable_data (Ix...index)
 
template<typename T , ssize_t Dims = -1>
detail::unchecked_mutable_reference< T, Dims > mutable_unchecked ()&
 
ssize_t nbytes () const
 Total number of bytes. More...
 
ssize_t ndim () const
 Number of dimensions. More...
 
template<typename... Ix>
ssize_t offset_at (Ix...index) const
 
ssize_t offset_at () const
 
bool owndata () const
 If set, the array owns the data (will be freed when the array is deleted) More...
 
void resize (ShapeContainer new_shape, bool refcheck=true)
 
const ssize_tshape () const
 Dimensions of the array. More...
 
ssize_t shape (ssize_t dim) const
 Dimension along a given axis. More...
 
ssize_t size () const
 Total number of elements. More...
 
array squeeze ()
 Return a new view with all of the dimensions of length 1 removed. More...
 
const ssize_tstrides () const
 Strides of the array. More...
 
ssize_t strides (ssize_t dim) const
 Stride along a given axis. More...
 
template<typename T , ssize_t Dims = -1>
detail::unchecked_reference< T, Dims > unchecked () const &
 
bool writeable () const
 If set, the array is writeable (otherwise the buffer is read-only) More...
 
- Public Member Functions inherited from buffer
buffer_info request (bool writable=false) const
 
- Public Member Functions inherited from object
template<typename T >
T cast () const &
 
template<typename T >
T cast ()&&
 
template<>
void cast () const &
 
template<>
void cast ()&&
 
 object ()=default
 
 object (const object &o)
 Copy constructor; always increases the reference count. More...
 
 object (object &&other) noexcept
 Move constructor; steals the object from other and preserves its reference count. More...
 
 object (handle h, borrowed_t)
 
 object (handle h, stolen_t)
 
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...
 
 handle (PyObject *ptr)
 Creates a handle from the given raw Python object pointer. More...
 
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 () const
 Return the underlying PyObject * pointer. More...
 
PyObject *& ptr ()
 

Static Public Member Functions

static array ensure (handle h, int ExtraFlags=0)
 

Protected Member Functions

template<typename... Ix>
ssize_t byte_offset (Ix...index) const
 
template<typename... Ix>
void check_dimensions (Ix...index) const
 
void check_dimensions_impl (ssize_t, const ssize_t *) const
 
template<typename... Ix>
void check_dimensions_impl (ssize_t axis, const ssize_t *shape, ssize_t i, Ix...index) const
 
void check_writeable () const
 
void fail_dim_check (ssize_t dim, const std::string &msg) const
 

Static Protected Member Functions

static std::vector< ssize_tc_strides (const std::vector< ssize_t > &shape, ssize_t itemsize)
 
static std::vector< ssize_tf_strides (const std::vector< ssize_t > &shape, ssize_t itemsize)
 
static PyObject * raw_array (PyObject *ptr, int ExtraFlags=0)
 Create array from any object – always returns a new reference. More...
 

Friends

template<typename , typename >
struct detail::npy_format_descriptor
 

Additional Inherited Members

- 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 543 of file numpy.h.

Member Typedef Documentation

using array::ShapeContainer = detail::any_container<ssize_t>

Definition at line 555 of file numpy.h.

using array::StridesContainer = detail::any_container<ssize_t>

Definition at line 556 of file numpy.h.

Member Enumeration Documentation

anonymous enum
Enumerator
c_style 
f_style 
forcecast 

Definition at line 547 of file numpy.h.

Constructor & Destructor Documentation

array::array ( )
inline

Definition at line 553 of file numpy.h.

array::array ( const pybind11::dtype &  dt,
ShapeContainer  shape,
StridesContainer  strides,
const void *  ptr = nullptr,
handle  base = handle() 
)
inline

Definition at line 559 of file numpy.h.

array::array ( const pybind11::dtype &  dt,
ShapeContainer  shape,
const void *  ptr = nullptr,
handle  base = handle() 
)
inline

Definition at line 596 of file numpy.h.

template<typename T , typename = detail::enable_if_t<std::is_integral<T>::value && !std::is_same<bool, T>::value>>
array::array ( const pybind11::dtype &  dt,
T  count,
const void *  ptr = nullptr,
handle  base = handle() 
)
inline

Definition at line 600 of file numpy.h.

template<typename T >
array::array ( ShapeContainer  shape,
StridesContainer  strides,
const T ptr,
handle  base = handle() 
)
inline

Definition at line 604 of file numpy.h.

template<typename T >
array::array ( ShapeContainer  shape,
const T ptr,
handle  base = handle() 
)
inline

Definition at line 608 of file numpy.h.

template<typename T >
array::array ( ssize_t  count,
const T ptr,
handle  base = handle() 
)
inlineexplicit

Definition at line 612 of file numpy.h.

array::array ( const buffer_info info,
handle  base = handle() 
)
inlineexplicit

Definition at line 614 of file numpy.h.

Member Function Documentation

object array::base ( ) const
inline

Base object.

Definition at line 643 of file numpy.h.

template<typename... Ix>
ssize_t array::byte_offset ( Ix...  index) const
inlineprotected

Definition at line 781 of file numpy.h.

static std::vector<ssize_t> array::c_strides ( const std::vector< ssize_t > &  shape,
ssize_t  itemsize 
)
inlinestaticprotected

Definition at line 792 of file numpy.h.

template<typename... Ix>
void array::check_dimensions ( Ix...  index) const
inlineprotected

Definition at line 810 of file numpy.h.

void array::check_dimensions_impl ( ssize_t  ,
const ssize_t  
) const
inlineprotected

Definition at line 814 of file numpy.h.

template<typename... Ix>
void array::check_dimensions_impl ( ssize_t  axis,
const ssize_t shape,
ssize_t  i,
Ix...  index 
) const
inlineprotected

Definition at line 816 of file numpy.h.

void array::check_writeable ( ) const
inlineprotected

Definition at line 786 of file numpy.h.

template<typename... Ix>
const void* array::data ( Ix...  index) const
inline

Pointer to the contained data. If index is not provided, points to the beginning of the buffer. May throw if the index would lead to out of bounds access.

Definition at line 688 of file numpy.h.

pybind11::dtype array::dtype ( ) const
inline

Array descriptor (dtype)

Definition at line 618 of file numpy.h.

static array array::ensure ( handle  h,
int  ExtraFlags = 0 
)
inlinestatic

Ensure that the argument is a NumPy array In case of an error, nullptr is returned and the Python error is cleared.

Definition at line 766 of file numpy.h.

static std::vector<ssize_t> array::f_strides ( const std::vector< ssize_t > &  shape,
ssize_t  itemsize 
)
inlinestaticprotected

Definition at line 802 of file numpy.h.

void array::fail_dim_check ( ssize_t  dim,
const std::string &  msg 
) const
inlineprotected

Definition at line 776 of file numpy.h.

int array::flags ( ) const
inline

Return the NumPy array flags.

Definition at line 672 of file numpy.h.

template<typename... Ix>
ssize_t array::index_at ( Ix...  index) const
inline

Item count from beginning of the array to a given index (full or partial). May throw if the index would lead to out of bounds access.

Definition at line 712 of file numpy.h.

ssize_t array::itemsize ( ) const
inline

Byte size of a single element.

Definition at line 628 of file numpy.h.

template<typename... Ix>
void* array::mutable_data ( Ix...  index)
inline

Mutable pointer to the contained data. If index is not provided, points to the beginning of the buffer. May throw if the index would lead to out of bounds access. May throw if the array is not writeable.

Definition at line 695 of file numpy.h.

template<typename T , ssize_t Dims = -1>
detail::unchecked_mutable_reference<T, Dims> array::mutable_unchecked ( )
inline

Returns a proxy object that provides access to the array's data without bounds or dimensionality checking. Will throw if the array is missing the writeable flag. Use with care: the array must not be destroyed or reshaped for the duration of the returned object, and the caller must take care not to access invalid dimensions or dimension indices.

Definition at line 722 of file numpy.h.

ssize_t array::nbytes ( ) const
inline

Total number of bytes.

Definition at line 633 of file numpy.h.

ssize_t array::ndim ( ) const
inline

Number of dimensions.

Definition at line 638 of file numpy.h.

template<typename... Ix>
ssize_t array::offset_at ( Ix...  index) const
inline

Byte offset from beginning of the array to a given index (full or partial). May throw if the index would lead to out of bounds access.

Definition at line 702 of file numpy.h.

ssize_t array::offset_at ( ) const
inline

Definition at line 708 of file numpy.h.

bool array::owndata ( ) const
inline

If set, the array owns the data (will be freed when the array is deleted)

Definition at line 682 of file numpy.h.

static PyObject* array::raw_array ( PyObject *  ptr,
int  ExtraFlags = 0 
)
inlinestaticprotected

Create array from any object – always returns a new reference.

Definition at line 826 of file numpy.h.

void array::resize ( ShapeContainer  new_shape,
bool  refcheck = true 
)
inline

Resize array to given shape If refcheck is true and more that one reference exist to this array then resize will succeed only if it makes a reshape, i.e. original size doesn't change

Definition at line 752 of file numpy.h.

const ssize_t* array::shape ( ) const
inline

Dimensions of the array.

Definition at line 648 of file numpy.h.

ssize_t array::shape ( ssize_t  dim) const
inline

Dimension along a given axis.

Definition at line 653 of file numpy.h.

ssize_t array::size ( ) const
inline

Total number of elements.

Definition at line 623 of file numpy.h.

array array::squeeze ( )
inline

Return a new view with all of the dimensions of length 1 removed.

Definition at line 744 of file numpy.h.

const ssize_t* array::strides ( ) const
inline

Strides of the array.

Definition at line 660 of file numpy.h.

ssize_t array::strides ( ssize_t  dim) const
inline

Stride along a given axis.

Definition at line 665 of file numpy.h.

template<typename T , ssize_t Dims = -1>
detail::unchecked_reference<T, Dims> array::unchecked ( ) const
inline

Returns a proxy object that provides const access to the array's data without bounds or dimensionality checking. Unlike mutable_unchecked(), this does not require that the underlying array have the writable flag. Use with care: the array must not be destroyed or reshaped for the duration of the returned object, and the caller must take care not to access invalid dimensions or dimension indices.

Definition at line 736 of file numpy.h.

bool array::writeable ( ) const
inline

If set, the array is writeable (otherwise the buffer is read-only)

Definition at line 677 of file numpy.h.

Friends And Related Function Documentation

template<typename , typename >
friend struct detail::npy_format_descriptor
friend

Definition at line 774 of file numpy.h.


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


gtsam
Author(s):
autogenerated on Sat May 8 2021 02:51:44