<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <!-- Copyright David Abrahams 2006. Distributed under the Boost --> <!-- Software License, Version 1.0. (See accompanying --> <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) --> <html> <head> <meta name="generator" content= "HTML Tidy for Windows (vers 1st August 2002), see www.w3.org"> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <link rel="stylesheet" type="text/css" href="../boost.css"> <title>Boost.Python - <boost/python/tuple.hpp></title> </head> <body> <table border="0" cellpadding="7" cellspacing="0" width="100%" summary= "header"> <tr> <td valign="top" width="300"> <h3><a href="../../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../../boost.png" border="0"></a></h3> </td> <td valign="top"> <h1 align="center"><a href="../index.html">Boost.Python</a></h1> <h2 align="center">Header <boost/python/tuple.hpp></h2> </td> </tr> </table> <hr> <h2>Contents</h2> <dl class="page-index"> <dt><a href="#introduction">Introduction</a></dt> <dt><a href="#classes">Classes</a></dt> <dd> <dl class="page-index"> <dt><a href="#tuple-spec">Class <code>tuple</code></a></dt> <dd> <dl class="page-index"> <dt><a href="#tuple-spec-synopsis">Class <code>tuple</code> synopsis</a></dt> </dl> </dd> </dl> </dd> <dt><a href="#functions">Functions</a></dt> <dd> <dl class="page-index"> <dt><a href="#make_tuple-spec"><code>make_tuple</code></a></dt> </dl> </dd> <dt><a href="#examples">Example</a></dt> </dl> <hr> <h2><a name="introduction"></a>Introduction</h2> <p>Exposes a <a href= "ObjectWrapper.html#TypeWrapper-concept">TypeWrapper</a> for the Python <a href= "http://www.python.org/doc/current/tut/node7.html#SECTION007300000000000000000"> tuple</a> type.</p> <h2><a name="classes"></a>Classes</h2> <h3><a name="tuple-spec"></a>Class <code>tuple</code></h3> <p>Exposes the interface of Python's built-in <code>tuple</code> type. The semantics of the constructors and member functions defined below can be fully understood by reading the <a href= "ObjectWrapper.html#TypeWrapper-concept">TypeWrapper</a> concept definition. Since <code>tuple</code> is publicly derived from <code><a href="object.html#object-spec">object</a></code>, the public object interface applies to <code>tuple</code> instances as well.</p> <h4><a name="tuple-spec-synopsis"></a>Class <code>tuple</code> synopsis</h4> <pre> namespace boost { namespace python { class tuple : public object { // tuple() -> an empty tuple tuple(); // tuple(sequence) -> tuple initialized from sequence's items template <class T> explicit tuple(T const& sequence) }; }} </pre> <h2><a name="functions"></a>Functions</h2> <h3><a name="make_tuple-spec"></a><code>make_tuple</code></h3> <pre> namespace boost { namespace python { tuple make_tuple(); template <class A0> tuple make_tuple(A0 const& a0); template <class A0, class A1> tuple make_tuple(A0 const& a0, A1 const& a1); ... template <class A0, class A1,...class A<i>n</i>> tuple make_tuple(A0 const& a0, A1 const& a1,...A<i>n</i> const& a<i>n</i>); }} </pre> Constructs a new tuple object composed of <code>object(a0), object(a0),...object(a<i>n</i>)</code>. <h2><a name="examples"></a>Example</h2> <pre> using namespace boost::python; tuple head_and_tail(object sequence) { return make_tuple(sequence[0],sequence[-1]); } </pre> <p>Revised 03 October, 2002</p> <p><i>© Copyright <a href= "http://www.boost.org/people/dave_abrahams.htm">Dave Abrahams</a> 2002.</i></p> </body> </html>