#include <numpy.h>

Inheritance diagram for array_t< T, ExtraFlags >:

[legend]

Classes
struct	private_ctor

Public Types
using	value_type = T

Public Types inherited from array
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_t ()

	array_t (const buffer_info &info, handle base=handle())

	array_t (const object &o)

	array_t (handle h, bool is_borrowed)

	array_t (handle h, borrowed_t)

	array_t (handle h, stolen_t)

	array_t (ShapeContainer shape, const T *ptr=nullptr, handle base=handle())

	array_t (ShapeContainer shape, StridesContainer strides, const T *ptr=nullptr, handle base=handle())

	array_t (ssize_t count, const T *ptr=nullptr, handle base=handle())

template<typename... Ix>
const T &	at (Ix... index) const

template<typename... Ix>
const T *	data (Ix... index) const

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

constexpr ssize_t	itemsize () const

template<typename... Ix>
T &	mutable_at (Ix... index)

template<typename... Ix>
T *	mutable_data (Ix... index)

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

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

Public Member Functions inherited from array
	array ()

	array (const buffer_info &info, handle base=handle())

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

	array (const pybind11::dtype &dt, ShapeContainer shape, StridesContainer strides, 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, const T *ptr, handle base=handle())

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

template<typename T >
	array (ssize_t count, const T *ptr, 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...

ssize_t	offset_at () const

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

bool	owndata () const
	If set, the array owns the data (will be freed when the array is deleted) More...

array	reshape (ShapeContainer new_shape)
	Optional `order` parameter omitted, to be added as needed. More...

void	resize (ShapeContainer new_shape, bool refcheck=true)

const ssize_t *	shape () 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_t *	strides () 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 &

array	view (const std::string &dtype)

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 () &&

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...

object &	operator= (const object &other)

object &	operator= (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 handle &	dec_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 handle &	inc_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...

Static Public Member Functions
static bool	check_ (handle h)

static array_t	ensure (handle h)

Static Public Member Functions inherited from array
static array	ensure (handle h, int ExtraFlags=0)

Static Public Member Functions inherited from handle
static std::size_t	inc_ref_counter ()

Static Protected Member Functions
static PyObject *	raw_array_t (PyObject *ptr)
	Create array from any object – always returns a new reference. More...

Static Protected Member Functions inherited from array
static PyObject *	raw_array (PyObject *ptr, int ExtraFlags=0)
	Create array from any object – always returns a new reference. More...

Private Member Functions
	array_t (private_ctor, ShapeContainer &&shape, StridesContainer &&strides, const T *ptr, handle base)

Additional Inherited Members
Public Attributes inherited from object
bool	is_borrowed: handle(h) { if (is_borrowed) { inc_ref()

Protected Member Functions inherited from array
template<typename... Ix>
ssize_t	byte_offset (Ix... index) const

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

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

void	check_dimensions_impl (ssize_t, const ssize_t *) const

void	check_writeable () const

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

Protected Attributes inherited from handle
PyObject *	m_ptr = nullptr

Detailed Description

template<typename T, int ExtraFlags = array::forcecast>
class array_t< T, ExtraFlags >

Definition at line 1155 of file numpy.h.

Member Typedef Documentation

◆ value_type

template<typename T , int ExtraFlags = array::forcecast>

using array_t< T, ExtraFlags >::value_type = T

Definition at line 1169 of file numpy.h.

Constructor & Destructor Documentation

◆ array_t() [1/10]

template<typename T , int ExtraFlags = array::forcecast>

array_t< T, ExtraFlags >::array_t	(	private_ctor	,
		ShapeContainer &&	shape,
		StridesContainer &&	strides,
		const T *	ptr,
		handle	base
	)

inlineprivate

Definition at line 1159 of file numpy.h.

◆ array_t() [2/10]

template<typename T , int ExtraFlags = array::forcecast>

array_t< T, ExtraFlags >::array_t ( )

inline

Definition at line 1171 of file numpy.h.

◆ array_t() [3/10]

template<typename T , int ExtraFlags = array::forcecast>

array_t< T, ExtraFlags >::array_t	(	handle	h,
		borrowed_t
	)

inline

Definition at line 1172 of file numpy.h.

◆ array_t() [4/10]

template<typename T , int ExtraFlags = array::forcecast>

array_t< T, ExtraFlags >::array_t	(	handle	h,
		stolen_t
	)

inline

Definition at line 1173 of file numpy.h.

◆ array_t() [5/10]

template<typename T , int ExtraFlags = array::forcecast>

array_t< T, ExtraFlags >::array_t	(	handle	h,
		bool	is_borrowed
	)

inline

Definition at line 1176 of file numpy.h.

◆ array_t() [6/10]

template<typename T , int ExtraFlags = array::forcecast>

array_t< T, ExtraFlags >::array_t ( const object & o )

inline

Definition at line 1186 of file numpy.h.

◆ array_t() [7/10]

template<typename T , int ExtraFlags = array::forcecast>

array_t< T, ExtraFlags >::array_t	(	const buffer_info &	info,
		handle	base = `handle()`
	)

inlineexplicit

Definition at line 1192 of file numpy.h.

◆ array_t() [8/10]

template<typename T , int ExtraFlags = array::forcecast>

array_t< T, ExtraFlags >::array_t	(	ShapeContainer	shape,
		StridesContainer	strides,
		const T *	ptr = `nullptr`,
		handle	base = `handle()`
	)

inline

Definition at line 1194 of file numpy.h.

◆ array_t() [9/10]

template<typename T , int ExtraFlags = array::forcecast>

array_t< T, ExtraFlags >::array_t	(	ShapeContainer	shape,
		const T *	ptr = `nullptr`,
		handle	base = `handle()`
	)

inlineexplicit

Definition at line 1200 of file numpy.h.

◆ array_t() [10/10]

template<typename T , int ExtraFlags = array::forcecast>

array_t< T, ExtraFlags >::array_t	(	ssize_t	count,
		const T *	ptr = `nullptr`,
		handle	base = `handle()`
	)

inlineexplicit

Definition at line 1208 of file numpy.h.

Member Function Documentation

◆ at()

template<typename T , int ExtraFlags = array::forcecast>

template<typename... Ix>

const T& array_t< T, ExtraFlags >::at ( Ix... index ) const

inline

Definition at line 1230 of file numpy.h.

◆ check_()

template<typename T , int ExtraFlags = array::forcecast>

static bool array_t< T, ExtraFlags >::check_ ( handle h )

inlinestatic

Definition at line 1281 of file numpy.h.

◆ data()

template<typename T , int ExtraFlags = array::forcecast>

template<typename... Ix>

const T* array_t< T, ExtraFlags >::data ( Ix... index ) const

inline

Definition at line 1219 of file numpy.h.

◆ ensure()

template<typename T , int ExtraFlags = array::forcecast>

static array_t array_t< T, ExtraFlags >::ensure ( handle h )

inlinestatic

Ensure that the argument is a NumPy array of the correct dtype (and if not, try to convert it). In case of an error, nullptr is returned and the Python error is cleared.

Definition at line 1273 of file numpy.h.

◆ index_at()

template<typename T , int ExtraFlags = array::forcecast>

template<typename... Ix>

ssize_t array_t< T, ExtraFlags >::index_at ( Ix... index ) const

inline

Definition at line 1214 of file numpy.h.

◆ itemsize()

template<typename T , int ExtraFlags = array::forcecast>

constexpr ssize_t array_t< T, ExtraFlags >::itemsize ( ) const

inlineconstexpr

Definition at line 1211 of file numpy.h.

◆ mutable_at()

template<typename T , int ExtraFlags = array::forcecast>

template<typename... Ix>

T& array_t< T, ExtraFlags >::mutable_at ( Ix... index )

inline

Definition at line 1240 of file numpy.h.

◆ mutable_data()

template<typename T , int ExtraFlags = array::forcecast>

template<typename... Ix>

T* array_t< T, ExtraFlags >::mutable_data ( Ix... index )

inline

Definition at line 1224 of file numpy.h.

◆ mutable_unchecked()

template<typename T , int ExtraFlags = array::forcecast>

template<ssize_t Dims = -1>

detail::unchecked_mutable_reference<T, Dims> array_t< T, ExtraFlags >::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 1255 of file numpy.h.

◆ raw_array_t()

template<typename T , int ExtraFlags = array::forcecast>

static PyObject* array_t< T, ExtraFlags >::raw_array_t ( PyObject * ptr )

inlinestaticprotected

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

Definition at line 1291 of file numpy.h.

◆ unchecked()

template<typename T , int ExtraFlags = array::forcecast>

template<ssize_t Dims = -1>

detail::unchecked_reference<T, Dims> array_t< T, ExtraFlags >::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 1267 of file numpy.h.

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

numpy.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

template<typename T, int ExtraFlags = array::forcecast> class array_t< T, ExtraFlags >

Member Typedef Documentation

◆ value_type

Constructor & Destructor Documentation

◆ array_t() [1/10]

◆ array_t() [2/10]

◆ array_t() [3/10]

◆ array_t() [4/10]

◆ array_t() [5/10]

◆ array_t() [6/10]

◆ array_t() [7/10]

◆ array_t() [8/10]

◆ array_t() [9/10]

◆ array_t() [10/10]

Member Function Documentation

◆ at()

◆ check_()

◆ data()

◆ ensure()

◆ index_at()

◆ itemsize()

◆ mutable_at()

◆ mutable_data()

◆ mutable_unchecked()

◆ raw_array_t()

◆ unchecked()

template<typename T, int ExtraFlags = array::forcecast>
class array_t< T, ExtraFlags >