mirror of
https://github.com/boostorg/python.git
synced 2026-01-31 08:22:18 +00:00
101 lines
6.0 KiB
HTML
101 lines
6.0 KiB
HTML
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
<title>overloads.hpp</title>
|
|
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
|
|
<link rel="home" href="../index.html" title="Boost.Python Reference Manual">
|
|
<link rel="up" href="../function_invocation_and_creation.html" title="Chapter 4. Function Invocation and Creation">
|
|
<link rel="prev" href="make_function_hpp/example.html" title="Example">
|
|
<link rel="next" href="overloads_hpp/overloaddispatcher_concept.html" title="OverloadDispatcher Concept">
|
|
</head>
|
|
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
<table cellpadding="2" width="100%"><tr>
|
|
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../images/boost.png"></td>
|
|
<td align="center"><a href="../../../index.html">Home</a></td>
|
|
<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
|
|
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
|
|
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
|
|
<td align="center"><a href="../../../more/index.htm">More</a></td>
|
|
</tr></table>
|
|
<hr>
|
|
<div class="spirit-nav">
|
|
<a accesskey="p" href="make_function_hpp/example.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../function_invocation_and_creation.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="overloads_hpp/overloaddispatcher_concept.html"><img src="../../images/next.png" alt="Next"></a>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
|
|
<a name="function_invocation_and_creation.overloads_hpp"></a><a class="link" href="overloads_hpp.html" title="overloads.hpp">overloads.hpp</a>
|
|
</h2></div></div></div>
|
|
<div class="toc"><dl class="toc">
|
|
<dt><span class="section"><a href="overloads_hpp.html#function_invocation_and_creation.overloads_hpp.introduction">Introduction</a></span></dt>
|
|
<dd><dl><dt><span class="section"><a href="overloads_hpp.html#function_invocation_and_creation.overloads_hpp.introduction.overload_dispatch_expressions">overload-dispatch-expressions</a></span></dt></dl></dd>
|
|
<dt><span class="section"><a href="overloads_hpp/overloaddispatcher_concept.html">OverloadDispatcher
|
|
Concept</a></span></dt>
|
|
<dt><span class="section"><a href="overloads_hpp/macros.html">Macros</a></span></dt>
|
|
<dt><span class="section"><a href="overloads_hpp/example.html">Example</a></span></dt>
|
|
</dl></div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h3 class="title">
|
|
<a name="function_invocation_and_creation.overloads_hpp.introduction"></a><a class="link" href="overloads_hpp.html#function_invocation_and_creation.overloads_hpp.introduction" title="Introduction">Introduction</a>
|
|
</h3></div></div></div>
|
|
<div class="toc"><dl class="toc"><dt><span class="section"><a href="overloads_hpp.html#function_invocation_and_creation.overloads_hpp.introduction.overload_dispatch_expressions">overload-dispatch-expressions</a></span></dt></dl></div>
|
|
<p>
|
|
Defines facilities for generating families of overloaded Python functions
|
|
and extension class methods from C++ functions and member functions with
|
|
default arguments, or from similar families of C++ overloads
|
|
</p>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h4 class="title">
|
|
<a name="function_invocation_and_creation.overloads_hpp.introduction.overload_dispatch_expressions"></a><a class="link" href="overloads_hpp.html#function_invocation_and_creation.overloads_hpp.introduction.overload_dispatch_expressions" title="overload-dispatch-expressions">overload-dispatch-expressions</a>
|
|
</h4></div></div></div>
|
|
<p>
|
|
An overload-dispatch-expression is used to describe a family of overloaded
|
|
methods to be generated for an extension class. It has the following
|
|
properties:
|
|
</p>
|
|
<div class="variablelist">
|
|
<p class="title"><b></b></p>
|
|
<dl class="variablelist">
|
|
<dt><span class="term">docstring</span></dt>
|
|
<dd><p>
|
|
An ntbs whose value will bound to the methods' __doc__ attribute
|
|
</p></dd>
|
|
<dt><span class="term">keywords</span></dt>
|
|
<dd><p>
|
|
A keyword-expression which will be used to name (a trailing subsequence
|
|
of) the arguments to the generated methods.
|
|
</p></dd>
|
|
<dt><span class="term">call policies</span></dt>
|
|
<dd><p>
|
|
An instance of some type which models CallPolicies.
|
|
</p></dd>
|
|
<dt><span class="term">minimum arity</span></dt>
|
|
<dd><p>
|
|
The minimum number of arguments to be accepted by a generated method
|
|
overload.
|
|
</p></dd>
|
|
<dt><span class="term">maximum arity</span></dt>
|
|
<dd><p>
|
|
The maximum number of arguments to be accepted by a generated method
|
|
overload.
|
|
</p></dd>
|
|
</dl>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
|
|
<td align="left"></td>
|
|
<td align="right"><div class="copyright-footer">Copyright © 2002-2005, 2015 David Abrahams, Stefan Seefeld<p>
|
|
Distributed under the Boost Software License, Version 1.0. (See accompanying
|
|
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>
|
|
</p>
|
|
</div></td>
|
|
</tr></table>
|
|
<hr>
|
|
<div class="spirit-nav">
|
|
<a accesskey="p" href="make_function_hpp/example.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../function_invocation_and_creation.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="overloads_hpp/overloaddispatcher_concept.html"><img src="../../images/next.png" alt="Next"></a>
|
|
</div>
|
|
</body>
|
|
</html>
|