Public Member Functions | Private Types | Static Private Attributes | Friends | List of all members
unchecked_mutable_reference< T, Dims > Class Template Reference

#include <numpy.h>

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

Public Member Functions

template<typename... Ix>
Tmutable_data (Ix... ix)
 Mutable pointer access to the data at the given indices. More...
 
template<typename... Ix>
Toperator() (Ix... index)
 Mutable, unchecked access to data at the given indices. More...
 
template<ssize_t D = Dims, typename = enable_if_t<D == 1 || Dynamic>>
Toperator[] (ssize_t index)
 
- Public Member Functions inherited from unchecked_reference< T, Dims >
template<typename... Ix>
const Tdata (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 Toperator() (Ix... index) const
 
template<ssize_t D = Dims, typename = enable_if_t<D == 1 || Dynamic>>
const Toperator[] (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_tsize () const
 
template<bool Dyn = Dynamic>
enable_if_t< Dyn, ssize_tsize () const
 

Private Types

using ConstBase = unchecked_reference< T, Dims >
 

Static Private Attributes

static constexpr bool Dynamic
 

Friends

class pybind11::array
 

Additional Inherited Members

- Static Public Member Functions inherited from unchecked_reference< T, Dims >
constexpr static 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 > dims)
 
template<bool Dyn = Dynamic>
 unchecked_reference (const void *data, const ssize_t *shape, const ssize_t *strides, enable_if_t<!Dyn, ssize_t >)
 
- 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 590 of file numpy.h.

Member Typedef Documentation

◆ ConstBase

template<typename T , ssize_t Dims>
using unchecked_mutable_reference< T, Dims >::ConstBase = unchecked_reference<T, Dims>
private

Definition at line 592 of file numpy.h.

Member Function Documentation

◆ mutable_data()

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

◆ operator()()

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

◆ operator[]()

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

Member Data Documentation

◆ Dynamic

template<typename T , ssize_t Dims>
constexpr bool unchecked_reference< T, Dims >::Dynamic
staticconstexprprivate

Definition at line 505 of file numpy.h.


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


gtsam
Author(s):
autogenerated on Fri Nov 1 2024 03:43:49