Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | Friends | List of all members
unchecked_reference< T, Dims > Class Template Reference

#include <numpy.h>

Inheritance diagram for unchecked_reference< T, Dims >:
Inheritance graph
[legend]

Public Member Functions

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
 
template<bool Dyn = Dynamic>
enable_if_t< Dyn, ssize_t > size () const
 

Static Public Member Functions

static constexpr ssize_t itemsize ()
 Returns the item size, i.e. sizeof(T) More...
 

Protected Member Functions

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

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

static constexpr bool Dynamic = Dims < 0
 

Friends

class pybind11::array
 

Detailed Description

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

Proxy class providing unsafe, unchecked const access to array data. This is constructed through the unchecked<T, N>() method of array or the unchecked<N>() method of array_t<T>. Dims will be -1 for dimensions determined at runtime.

Definition at line 405 of file numpy.h.

Constructor & Destructor Documentation

◆ unchecked_reference() [1/2]

template<typename T , ssize_t Dims>
template<bool Dyn = Dynamic>
unchecked_reference< T, Dims >::unchecked_reference ( const void *  data,
const ssize_t *  shape,
const ssize_t *  strides,
enable_if_t<!Dyn, ssize_t >   
)
inlineprotected

Definition at line 417 of file numpy.h.

◆ unchecked_reference() [2/2]

template<typename T , ssize_t Dims>
template<bool Dyn = Dynamic>
unchecked_reference< T, Dims >::unchecked_reference ( const void *  data,
const ssize_t *  shape,
const ssize_t *  strides,
enable_if_t< Dyn, ssize_t >  dims 
)
inlineprotected

Definition at line 429 of file numpy.h.

Member Function Documentation

◆ data()

template<typename T , ssize_t Dims>
template<typename... Ix>
const T* unchecked_reference< T, Dims >::data ( Ix...  ix) const
inline

Pointer access to the data at the given indices.

Definition at line 460 of file numpy.h.

◆ itemsize()

template<typename T , ssize_t Dims>
static constexpr ssize_t unchecked_reference< T, Dims >::itemsize ( )
inlinestatic

Returns the item size, i.e. sizeof(T)

Definition at line 465 of file numpy.h.

◆ nbytes()

template<typename T , ssize_t Dims>
ssize_t unchecked_reference< T, Dims >::nbytes ( ) const
inline

Returns the total number of bytes used by the referenced data. Note that the actual span in memory may be larger if the referenced array has non-contiguous strides (e.g. for a slice).

Definition at line 488 of file numpy.h.

◆ ndim()

template<typename T , ssize_t Dims>
ssize_t unchecked_reference< T, Dims >::ndim ( ) const
inline

Returns the number of dimensions of the array.

Definition at line 471 of file numpy.h.

◆ operator()()

template<typename T , ssize_t Dims>
template<typename... Ix>
const T& unchecked_reference< T, Dims >::operator() ( Ix...  index) const
inline

Unchecked const reference access to data at the given indices. For a compile-time known number of dimensions, this requires the correct number of arguments; for run-time dimensionality, this is not checked (and so is up to the caller to use safely).

Definition at line 443 of file numpy.h.

◆ operator[]()

template<typename T , ssize_t Dims>
template<ssize_t D = Dims, typename = enable_if_t<D == 1 || Dynamic>>
const T& unchecked_reference< T, Dims >::operator[] ( ssize_t  index) const
inline

Unchecked const reference access to data; this operator only participates if the reference is to a 1-dimensional array. When present, this is exactly equivalent to obj(index).

Definition at line 454 of file numpy.h.

◆ shape()

template<typename T , ssize_t Dims>
ssize_t unchecked_reference< T, Dims >::shape ( ssize_t  dim) const
inline

Returns the shape (i.e. size) of dimension dim

Definition at line 468 of file numpy.h.

◆ size() [1/2]

template<typename T , ssize_t Dims>
template<bool Dyn = Dynamic>
enable_if_t<!Dyn, ssize_t> unchecked_reference< T, Dims >::size ( ) const
inline

Returns the total number of elements in the referenced array, i.e. the product of the shapes

Definition at line 476 of file numpy.h.

◆ size() [2/2]

template<typename T , ssize_t Dims>
template<bool Dyn = Dynamic>
enable_if_t<Dyn, ssize_t> unchecked_reference< T, Dims >::size ( ) const
inline

Definition at line 481 of file numpy.h.

Friends And Related Function Documentation

◆ pybind11::array

template<typename T , ssize_t Dims>
friend class pybind11::array
friend

Definition at line 414 of file numpy.h.

Member Data Documentation

◆ data_

template<typename T , ssize_t Dims>
const unsigned char* unchecked_reference< T, Dims >::data_
protected

Definition at line 408 of file numpy.h.

◆ dims_

template<typename T , ssize_t Dims>
const ssize_t unchecked_reference< T, Dims >::dims_
protected

Definition at line 412 of file numpy.h.

◆ Dynamic

template<typename T , ssize_t Dims>
constexpr bool unchecked_reference< T, Dims >::Dynamic = Dims < 0
staticprotected

Definition at line 407 of file numpy.h.

◆ shape_

template<typename T , ssize_t Dims>
conditional_t<Dynamic, const ssize_t *, std::array<ssize_t, (size_t) Dims> > unchecked_reference< T, Dims >::shape_
protected

Definition at line 411 of file numpy.h.

◆ strides_

template<typename T , ssize_t Dims>
conditional_t<Dynamic, const ssize_t *, std::array<ssize_t, (size_t) Dims> > unchecked_reference< T, Dims >::strides_
protected

Definition at line 411 of file numpy.h.

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

gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:41:10