unchecked_mutable_reference< T, Dims > Class Template Reference

#include <numpy.h>

Inheritance diagram for unchecked_mutable_reference< T, Dims >:

Public Member Functions
template<typename... Ix>
T *	mutable_data (Ix...ix)
	Mutable pointer access to the data at the given indices. More...
template<typename... Ix>
T &	operator() (Ix...index)
	Mutable, unchecked access to data at the given indices. More...
template<ssize_t D = Dims, typename = enable_if_t<D == 1 || Dynamic>>
T &	operator[] (ssize_t index)
Public Member Functions inherited from unchecked_reference< T, Dims >
template<typename... Ix>
const T *	data (Ix...ix) const
	Pointer access to the data at the given indices. More...
ssize_t	nbytes () const
ssize_t	ndim () const
	Returns the number of dimensions of the array. More...
template<typename... Ix>
const T &	operator() (Ix...index) const
template<ssize_t D = Dims, typename = enable_if_t<D == 1 || Dynamic>>
const T &	operator[] (ssize_t index) const
ssize_t	shape (ssize_t dim) const
	Returns the shape (i.e. size) of dimension dim More...
template<bool Dyn = Dynamic>
enable_if_t<!Dyn, ssize_t >	size () const
	Returns the total number of elements in the referenced array, i.e. the product of the shapes. More...
template<bool Dyn = Dynamic>
enable_if_t< Dyn, ssize_t >	size () const

Private Types
using	ConstBase = unchecked_reference< T, Dims >

Friends
class	pybind11::array

Additional Inherited Members
Static Public Member Functions inherited from unchecked_reference< T, Dims >
static constexpr ssize_t	itemsize ()
	Returns the item size, i.e. sizeof(T) More...
Protected Member Functions inherited from unchecked_reference< T, Dims >
template<bool Dyn = Dynamic>
	unchecked_reference (const void *data, const ssize_t *shape, const ssize_t *strides, enable_if_t<!Dyn, ssize_t >)
template<bool Dyn = Dynamic>
	unchecked_reference (const void *data, const ssize_t *shape, const ssize_t *strides, enable_if_t< Dyn, ssize_t > dims)
Protected Attributes inherited from unchecked_reference< T, Dims >
const unsigned char *	data_
const ssize_t	dims_
conditional_t< Dynamic, const ssize_t *, std::array< ssize_t,(size_t) Dims > >	shape_
conditional_t< Dynamic, const ssize_t *, std::array< ssize_t,(size_t) Dims > >	strides_
Static Protected Attributes inherited from unchecked_reference< T, Dims >
static constexpr bool	Dynamic = Dims < 0

Detailed Description

template<typename T, ssize_t Dims>
class unchecked_mutable_reference< T, Dims >

Definition at line 416 of file numpy.h.

Member Typedef Documentation

template<typename T , ssize_t Dims>

using unchecked_mutable_reference< T, Dims >::ConstBase = unchecked_reference<T, Dims>

private

Definition at line 418 of file numpy.h.

Member Function Documentation

template<typename T , ssize_t Dims>

template<typename... Ix>

T* unchecked_mutable_reference< T, Dims >::mutable_data ( Ix...  ix )

inline

Mutable pointer access to the data at the given indices.

Definition at line 437 of file numpy.h.

template<typename T , ssize_t Dims>

template<typename... Ix>

T& unchecked_mutable_reference< T, Dims >::operator() ( Ix...  index )

inline

Mutable, unchecked access to data at the given indices.

Definition at line 423 of file numpy.h.

template<typename T , ssize_t Dims>

template<ssize_t D = Dims, typename = enable_if_t<D == 1 || Dynamic>>

T& unchecked_mutable_reference< T, Dims >::operator[] ( ssize_t  index )

inline

Mutable, unchecked access data at the given index; this operator only participates if the reference is to a 1-dimensional array (or has runtime dimensions). When present, this is exactly equivalent to obj(index).

Definition at line 434 of file numpy.h.

Friends And Related Function Documentation

template<typename T , ssize_t Dims>

friend class pybind11::array

friend

Definition at line 417 of file numpy.h.

---

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

• numpy.h