eigenpy::StdArrayPythonVisitor< array_type, NoProxy, SliceAllocator > Struct Template Reference

Expose an std::array (a C++11 fixed-size array) from a given type. More...

#include <std-array.hpp>

Public Types
typedef array_type::value_type	value_type

Static Public Member Functions
template<typename DerivedVisitor >
static void	expose (const std::string &class_name, const bp::def_visitor< DerivedVisitor > &visitor)
template<typename DerivedVisitor >
static void	expose (const std::string &class_name, const std::string &doc_string, const bp::def_visitor< DerivedVisitor > &visitor)
static void	expose (const std::string &class_name, const std::string &doc_string="")
::boost::python::list	tolist (array_type &self, const bool deep_copy)

Detailed Description

template<typename array_type, bool NoProxy = false, class SliceAllocator = std::allocator<typename array_type::value_type>>
struct eigenpy::StdArrayPythonVisitor< array_type, NoProxy, SliceAllocator >

Expose an std::array (a C++11 fixed-size array) from a given type.

Template Parameters

array_type	std::array type to expose
NoProxy	When set to false, the elements will be copied when returned to Python.
SliceAllocator	Allocator type to use for slices of std::array type accessed using e.g. getitem[0:4] in Python. These slices are returned as std::vector (dynamic size).

Definition at line 112 of file std-array.hpp.

Member Typedef Documentation

value_type

template<typename array_type , bool NoProxy = false, class SliceAllocator = std::allocator<typename array_type::value_type>>

typedef array_type::value_type eigenpy::StdArrayPythonVisitor< array_type, NoProxy, SliceAllocator >::value_type

Definition at line 113 of file std-array.hpp.

Member Function Documentation

expose() [1/3]

template<typename array_type , bool NoProxy = false, class SliceAllocator = std::allocator<typename array_type::value_type>>

template<typename DerivedVisitor >

static void eigenpy::StdArrayPythonVisitor< array_type, NoProxy, SliceAllocator >::expose ( const std::string &  class_name, const bp::def_visitor< DerivedVisitor > &  visitor  )

inlinestatic

Definition at line 125 of file std-array.hpp.

expose() [2/3]

template<typename array_type , bool NoProxy = false, class SliceAllocator = std::allocator<typename array_type::value_type>>

template<typename DerivedVisitor >

static void eigenpy::StdArrayPythonVisitor< array_type, NoProxy, SliceAllocator >::expose ( const std::string &  class_name, const std::string &  doc_string, const bp::def_visitor< DerivedVisitor > &  visitor  )

inlinestatic

Definition at line 131 of file std-array.hpp.

expose() [3/3]

template<typename array_type , bool NoProxy = false, class SliceAllocator = std::allocator<typename array_type::value_type>>

static void eigenpy::StdArrayPythonVisitor< array_type, NoProxy, SliceAllocator >::expose ( const std::string &  class_name, const std::string &  doc_string = ""  )

inlinestatic

Definition at line 119 of file std-array.hpp.

tolist()

template<typename array_type , bool NoProxy = false, class SliceAllocator = std::allocator<typename array_type::value_type>>

::boost::python::list eigenpy::StdArrayPythonVisitor< array_type, NoProxy, SliceAllocator >::tolist ( array_type &  self, const bool  deep_copy  )

inlinestatic

Definition at line 115 of file std-array.hpp.

---

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

• std-array.hpp