Public Types | Static Public Member Functions | List of all members
eigenpy::StdVectorPythonVisitor< vector_type, NoProxy, EnableFromPythonListConverter, pickable > Struct Template Reference

Expose an std::vector from a type given as template argument. More...

#include <std-vector.hpp>

Public Types

typedef StdContainerFromPythonList< vector_type, NoProxy > FromPythonListConverter
 
typedef vector_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="")
 

Detailed Description

template<class vector_type, bool NoProxy = false, bool EnableFromPythonListConverter = true, bool pickable = true>
struct eigenpy::StdVectorPythonVisitor< vector_type, NoProxy, EnableFromPythonListConverter, pickable >

Expose an std::vector from a type given as template argument.

Template Parameters
vector_typestd::vector type to expose
NoProxyWhen set to false, the elements will be copied when returned to Python.
EnableFromPythonListConverterEnables the conversion from a Python list to a std::vector<T,Allocator>

Definition at line 424 of file std-vector.hpp.

Member Typedef Documentation

◆ FromPythonListConverter

template<class vector_type , bool NoProxy = false, bool EnableFromPythonListConverter = true, bool pickable = true>
typedef StdContainerFromPythonList<vector_type, NoProxy> eigenpy::StdVectorPythonVisitor< vector_type, NoProxy, EnableFromPythonListConverter, pickable >::FromPythonListConverter

Definition at line 427 of file std-vector.hpp.

◆ value_type

template<class vector_type , bool NoProxy = false, bool EnableFromPythonListConverter = true, bool pickable = true>
typedef vector_type::value_type eigenpy::StdVectorPythonVisitor< vector_type, NoProxy, EnableFromPythonListConverter, pickable >::value_type

Definition at line 425 of file std-vector.hpp.

Member Function Documentation

◆ expose() [1/3]

template<class vector_type , bool NoProxy = false, bool EnableFromPythonListConverter = true, bool pickable = true>
template<typename DerivedVisitor >
static void eigenpy::StdVectorPythonVisitor< vector_type, NoProxy, EnableFromPythonListConverter, pickable >::expose ( const std::string &  class_name,
const bp::def_visitor< DerivedVisitor > &  visitor 
)
inlinestatic

Definition at line 435 of file std-vector.hpp.

◆ expose() [2/3]

template<class vector_type , bool NoProxy = false, bool EnableFromPythonListConverter = true, bool pickable = true>
template<typename DerivedVisitor >
static void eigenpy::StdVectorPythonVisitor< vector_type, NoProxy, EnableFromPythonListConverter, pickable >::expose ( const std::string &  class_name,
const std::string &  doc_string,
const bp::def_visitor< DerivedVisitor > &  visitor 
)
inlinestatic

Definition at line 441 of file std-vector.hpp.

◆ expose() [3/3]

template<class vector_type , bool NoProxy = false, bool EnableFromPythonListConverter = true, bool pickable = true>
static void eigenpy::StdVectorPythonVisitor< vector_type, NoProxy, EnableFromPythonListConverter, pickable >::expose ( const std::string &  class_name,
const std::string &  doc_string = "" 
)
inlinestatic

Definition at line 429 of file std-vector.hpp.


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


eigenpy
Author(s): Justin Carpentier, Nicolas Mansard
autogenerated on Sat Nov 2 2024 02:14:45