Classes | Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | List of all members
cpp_function Class Reference

Wraps an arbitrary C++ function/method/lambda function/.. into a callable Python object. More...

#include <pybind11.h>

Inheritance diagram for cpp_function:
Inheritance graph
[legend]

Classes

struct  InitializingFunctionRecordDeleter
 
class  strdup_guard
 

Public Member Functions

 cpp_function ()=default
 
template<typename Func , typename... Extra, typename = detail::enable_if_t<detail::is_lambda<Func>::value>>
 cpp_function (Func &&f, const Extra &...extra)
 Construct a cpp_function from a lambda function (possibly with internal state) More...
 
template<typename Return , typename... Args, typename... Extra>
 cpp_function (Return(*f)(Args...), const Extra &...extra)
 Construct a cpp_function from a vanilla function pointer. More...
 
template<typename Return , typename Class , typename... Arg, typename... Extra>
 cpp_function (Return(Class::*f)(Arg...) &, const Extra &...extra)
 
template<typename Return , typename Class , typename... Arg, typename... Extra>
 cpp_function (Return(Class::*f)(Arg...) const &, const Extra &...extra)
 
template<typename Return , typename Class , typename... Arg, typename... Extra>
 cpp_function (Return(Class::*f)(Arg...) const, const Extra &...extra)
 Construct a cpp_function from a class method (const, no ref-qualifier) More...
 
template<typename Return , typename Class , typename... Arg, typename... Extra>
 cpp_function (Return(Class::*f)(Arg...), const Extra &...extra)
 Construct a cpp_function from a class method (non-const, no ref-qualifier) More...
 
 cpp_function (std::nullptr_t)
 
 cpp_function (std::nullptr_t, const is_setter &)
 
object name () const
 Return the function name. More...
 
- Public Member Functions inherited from function
handle cpp_function () const
 
bool is_cpp_function () const
 
- Public Member Functions inherited from object
template<typename T >
T cast () &&
 
template<typename T >
T cast () const &
 
template<>
void cast () const &
 
 object ()=default
 
 object (const object &o)
 Copy constructor; always increases the reference count. More...
 
 object (handle h, borrowed_t)
 
 object (handle h, stolen_t)
 
 object (object &&other) noexcept
 Move constructor; steals the object from other and preserves its reference count. More...
 
objectoperator= (const object &other)
 
objectoperator= (object &&other) noexcept
 
 PYBIND11_DEPRECATED ("Use reinterpret_borrow<object>() or reinterpret_steal<object>()") object(handle h
 
handle release ()
 
 ~object ()
 Destructor; automatically calls handle::dec_ref() More...
 
- Public Member Functions inherited from handle
template<typename T >
T cast () const
 
template<>
void cast () const
 
bool check () const
 
const handledec_ref () const &
 
 handle ()=default
 The default constructor creates a handle with a nullptr-valued pointer. More...
 
template<typename T , detail::enable_if_t< detail::all_of< detail::none_of< std::is_base_of< handle, T >, detail::is_pyobj_ptr_or_nullptr_t< T >>, std::is_convertible< T, PyObject * >>::value, int > = 0>
 handle (T &obj)
 Enable implicit conversion through T::operator PyObject *(). More...
 
template<typename T , detail::enable_if_t< detail::is_pyobj_ptr_or_nullptr_t< T >::value, int > = 0>
 handle (T ptr)
 
const handleinc_ref () const &
 
 operator bool () const
 Return true when the handle wraps a valid Python object. More...
 
bool operator!= (const handle &h) const
 
bool operator== (const handle &h) const
 
PyObject *& ptr ()
 
PyObject * ptr () const
 Return the underlying PyObject * pointer. More...
 

Protected Types

using unique_function_record = std::unique_ptr< detail::function_record, InitializingFunctionRecordDeleter >
 

Protected Member Functions

template<typename Func , typename Return , typename... Args, typename... Extra>
void initialize (Func &&f, Return(*)(Args...), const Extra &...extra)
 Special internal constructor for functors, lambda functions, etc. More...
 
void initialize_generic (unique_function_record &&unique_rec, const char *text, const std::type_info *const *types, size_t args)
 Register a function call with Python (generic non-templated code goes here) More...
 
PYBIND11_NOINLINE unique_function_record make_function_record ()
 Space optimization: don't inline this frequently instantiated fragment. More...
 

Static Protected Member Functions

static void destruct (detail::function_record *rec, bool free_strings=true)
 When a cpp_function is GCed, release any memory allocated by pybind11. More...
 
static PyObject * dispatcher (PyObject *self, PyObject *args_in, PyObject *kwargs_in)
 Main dispatch logic for calls to functions bound using pybind11. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from handle
static std::size_t inc_ref_counter ()
 
- Public Attributes inherited from object
bool is_borrowed: handle(h) { if (is_borrowed) { inc_ref()
 
- Protected Attributes inherited from handle
PyObject * m_ptr = nullptr
 

Detailed Description

Wraps an arbitrary C++ function/method/lambda function/.. into a callable Python object.

Definition at line 125 of file pybind11.h.

Member Typedef Documentation

◆ unique_function_record

using cpp_function::unique_function_record = std::unique_ptr<detail::function_record, InitializingFunctionRecordDeleter>
protected

Definition at line 203 of file pybind11.h.

Constructor & Destructor Documentation

◆ cpp_function() [1/9]

cpp_function::cpp_function ( )
default

◆ cpp_function() [2/9]

cpp_function::cpp_function ( std::nullptr_t  )
inline

Definition at line 129 of file pybind11.h.

◆ cpp_function() [3/9]

cpp_function::cpp_function ( std::nullptr_t  ,
const is_setter  
)
inline

Definition at line 130 of file pybind11.h.

◆ cpp_function() [4/9]

template<typename Return , typename... Args, typename... Extra>
cpp_function::cpp_function ( Return(*)(Args...)  f,
const Extra &...  extra 
)
inline

Construct a cpp_function from a vanilla function pointer.

Definition at line 135 of file pybind11.h.

◆ cpp_function() [5/9]

template<typename Func , typename... Extra, typename = detail::enable_if_t<detail::is_lambda<Func>::value>>
cpp_function::cpp_function ( Func &&  f,
const Extra &...  extra 
)
inline

Construct a cpp_function from a lambda function (possibly with internal state)

Definition at line 144 of file pybind11.h.

◆ cpp_function() [6/9]

template<typename Return , typename Class , typename... Arg, typename... Extra>
cpp_function::cpp_function ( Return(Class::*)(Arg...)  f,
const Extra &...  extra 
)
inline

Construct a cpp_function from a class method (non-const, no ref-qualifier)

Definition at line 152 of file pybind11.h.

◆ cpp_function() [7/9]

template<typename Return , typename Class , typename... Arg, typename... Extra>
cpp_function::cpp_function ( Return(Class::*)(Arg...) f ,
const Extra &...  extra 
)
inline

Construct a cpp_function from a class method (non-const, lvalue ref-qualifier) A copy of the overload for non-const functions without explicit ref-qualifier but with an added &.

Definition at line 164 of file pybind11.h.

◆ cpp_function() [8/9]

template<typename Return , typename Class , typename... Arg, typename... Extra>
cpp_function::cpp_function ( Return(Class::*)(Arg...) const  f,
const Extra &...  extra 
)
inline

Construct a cpp_function from a class method (const, no ref-qualifier)

Definition at line 174 of file pybind11.h.

◆ cpp_function() [9/9]

template<typename Return , typename Class , typename... Arg, typename... Extra>
cpp_function::cpp_function ( Return(Class::*)(Arg...) const f ,
const Extra &...  extra 
)
inline

Construct a cpp_function from a class method (const, lvalue ref-qualifier) A copy of the overload for const functions without explicit ref-qualifier but with an added &.

Definition at line 186 of file pybind11.h.

Member Function Documentation

◆ destruct()

static void cpp_function::destruct ( detail::function_record *  rec,
bool  free_strings = true 
)
inlinestaticprotected

When a cpp_function is GCed, release any memory allocated by pybind11.

Definition at line 671 of file pybind11.h.

◆ dispatcher()

static PyObject* cpp_function::dispatcher ( PyObject *  self,
PyObject *  args_in,
PyObject *  kwargs_in 
)
inlinestaticprotected

Main dispatch logic for calls to functions bound using pybind11.

Definition at line 717 of file pybind11.h.

◆ initialize()

template<typename Func , typename Return , typename... Args, typename... Extra>
void cpp_function::initialize ( Func &&  f,
Return(*)(Args...)  ,
const Extra &...  extra 
)
inlineprotected

Special internal constructor for functors, lambda functions, etc.

Definition at line 212 of file pybind11.h.

◆ initialize_generic()

void cpp_function::initialize_generic ( unique_function_record &&  unique_rec,
const char *  text,
const std::type_info *const *  types,
size_t  args 
)
inlineprotected

Register a function call with Python (generic non-templated code goes here)

Definition at line 385 of file pybind11.h.

◆ make_function_record()

PYBIND11_NOINLINE unique_function_record cpp_function::make_function_record ( )
inlineprotected

Space optimization: don't inline this frequently instantiated fragment.

Definition at line 206 of file pybind11.h.

◆ name()

object cpp_function::name ( ) const
inline

Return the function name.

Definition at line 194 of file pybind11.h.


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


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