blob: 540e18be41c74c3f0f9cd042993eb0c6bc533d5d [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>What is provided</title>
<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Phoenix 3.2.0">
<link rel="up" href="../lazy_list.html" title="Lazy List">
<link rel="prev" href="background.html" title="Background">
<link rel="next" href="tutorial_with_examples.html" title="Tutorial with examples">
</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="../../../../../../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="background.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lazy_list.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="tutorial_with_examples.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="phoenix.lazy_list.what_is_provided"></a><a class="link" href="what_is_provided.html" title="What is provided">What is provided</a>
</h3></div></div></div>
<p>
Functions are provided to build and manipulate objects of the list type
</p>
<pre class="programlisting"><span class="identifier">list</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span>
</pre>
<h3>
<a name="phoenix.lazy_list.what_is_provided.h0"></a>
<span class="phrase"><a name="phoenix.lazy_list.what_is_provided.namespace_and_header"></a></span><a class="link" href="what_is_provided.html#phoenix.lazy_list.what_is_provided.namespace_and_header">Namespace
and header</a>
</h3>
<p>
The functions are in the namespace
</p>
<pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">phoenix</span>
</pre>
<p>
defined by the header file
</p>
<pre class="programlisting"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">phoenix</span><span class="special">/</span><span class="identifier">function</span><span class="special">/</span><span class="identifier">lazy_prelude</span><span class="special">.</span><span class="identifier">hpp</span>
</pre>
<p>
which includes all other needed headers. It is not currently included in
</p>
<pre class="programlisting"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">phoenix</span><span class="special">/</span><span class="identifier">function</span><span class="special">.</span><span class="identifier">hpp</span>
</pre>
<p>
so it must be explicitly included to use these types and functions.
</p>
<h3>
<a name="phoenix.lazy_list.what_is_provided.h1"></a>
<span class="phrase"><a name="phoenix.lazy_list.what_is_provided.integration_with_boost_phoenix"></a></span><a class="link" href="what_is_provided.html#phoenix.lazy_list.what_is_provided.integration_with_boost_phoenix">Integration
with Boost Phoenix</a>
</h3>
<p>
The functions are defined by boost::phoenix::function which means that they
work with phoenix arguments such as 'arg1'. They have been defined in such
a way that when needed they can be passed as arguments to other functions.
</p>
<h2>
<a name="phoenix.lazy_list.what_is_provided.h2"></a>
<span class="phrase"><a name="phoenix.lazy_list.what_is_provided.lazy_list_type"></a></span><a class="link" href="what_is_provided.html#phoenix.lazy_list.what_is_provided.lazy_list_type">Lazy
List Type</a>
</h2>
<pre class="programlisting"><span class="identifier">list</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="special">(</span><span class="identifier">where</span> <span class="identifier">T</span> <span class="identifier">is</span> <span class="identifier">the</span> <span class="identifier">element</span> <span class="identifier">type</span><span class="special">)</span>
</pre>
<h2>
<a name="phoenix.lazy_list.what_is_provided.h3"></a>
<span class="phrase"><a name="phoenix.lazy_list.what_is_provided.functions"></a></span><a class="link" href="what_is_provided.html#phoenix.lazy_list.what_is_provided.functions">Functions</a>
</h2>
<p>
The functions are grouped as follows:
</p>
<h3>
<a name="phoenix.lazy_list.what_is_provided.h4"></a>
<span class="phrase"><a name="phoenix.lazy_list.what_is_provided.arithmetic_functions"></a></span><a class="link" href="what_is_provided.html#phoenix.lazy_list.what_is_provided.arithmetic_functions">Arithmetic
functions</a>
</h3>
<pre class="programlisting"><span class="identifier">plus</span>
<span class="identifier">minus</span>
<span class="identifier">multiplies</span>
<span class="identifier">divides</span>
<span class="identifier">modulus</span>
<span class="identifier">negate</span>
</pre>
<h3>
<a name="phoenix.lazy_list.what_is_provided.h5"></a>
<span class="phrase"><a name="phoenix.lazy_list.what_is_provided.boolean_functions"></a></span><a class="link" href="what_is_provided.html#phoenix.lazy_list.what_is_provided.boolean_functions">Boolean functions</a>
</h3>
<pre class="programlisting"><span class="identifier">equal</span>
<span class="identifier">not_equal</span>
<span class="identifier">greater</span>
<span class="identifier">less</span>
<span class="identifier">greater_equal</span>
<span class="identifier">less_equal</span>
</pre>
<h3>
<a name="phoenix.lazy_list.what_is_provided.h6"></a>
<span class="phrase"><a name="phoenix.lazy_list.what_is_provided.logical_functions"></a></span><a class="link" href="what_is_provided.html#phoenix.lazy_list.what_is_provided.logical_functions">Logical functions</a>
</h3>
<pre class="programlisting"><span class="identifier">logical_and</span>
<span class="identifier">logical_or</span>
<span class="identifier">logical_not</span>
</pre>
<h3>
<a name="phoenix.lazy_list.what_is_provided.h7"></a>
<span class="phrase"><a name="phoenix.lazy_list.what_is_provided.operational_functions"></a></span><a class="link" href="what_is_provided.html#phoenix.lazy_list.what_is_provided.operational_functions">Operational
functions</a>
</h3>
<pre class="programlisting"><span class="identifier">apply</span>
<span class="identifier">until</span>
<span class="identifier">until2</span>
<span class="identifier">max</span>
<span class="identifier">min</span>
<span class="identifier">inc</span>
<span class="identifier">dec</span>
<span class="identifier">make_pair</span>
</pre>
<h3>
<a name="phoenix.lazy_list.what_is_provided.h8"></a>
<span class="phrase"><a name="phoenix.lazy_list.what_is_provided.logical_predicates"></a></span><a class="link" href="what_is_provided.html#phoenix.lazy_list.what_is_provided.logical_predicates">Logical predicates</a>
</h3>
<pre class="programlisting"><span class="identifier">odd</span>
<span class="identifier">even</span>
</pre>
<h3>
<a name="phoenix.lazy_list.what_is_provided.h9"></a>
<span class="phrase"><a name="phoenix.lazy_list.what_is_provided.list_functions"></a></span><a class="link" href="what_is_provided.html#phoenix.lazy_list.what_is_provided.list_functions">List
Functions</a>
</h3>
<pre class="programlisting"><span class="identifier">cons</span>
<span class="identifier">cat</span>
<span class="identifier">take</span>
<span class="identifier">drop</span>
<span class="identifier">last</span>
<span class="identifier">all_but_last</span>
<span class="identifier">at</span>
<span class="identifier">length</span>
<span class="identifier">filter</span>
</pre>
<h4>
<a name="phoenix.lazy_list.what_is_provided.h10"></a>
<span class="phrase"><a name="phoenix.lazy_list.what_is_provided.list_generation_functions"></a></span><a class="link" href="what_is_provided.html#phoenix.lazy_list.what_is_provided.list_generation_functions">List
Generation Functions</a>
</h4>
<pre class="programlisting"><span class="identifier">enum_from</span>
<span class="identifier">enum_from_to</span>
<span class="identifier">list_with</span>
</pre>
<h3>
<a name="phoenix.lazy_list.what_is_provided.h11"></a>
<span class="phrase"><a name="phoenix.lazy_list.what_is_provided.futher_functions"></a></span><a class="link" href="what_is_provided.html#phoenix.lazy_list.what_is_provided.futher_functions">Futher
functions</a>
</h3>
<p>
Further functions are in development from the resources available in <a href="http://cgi.di.uoa.gr/~smaragd/fc++/" target="_top">FC++</a>.
</p>
</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 &#169; 2002-2005, 2010, 2014, 2015 Joel de Guzman, Dan Marsden, Thomas
Heller, John Fletcher<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="background.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../lazy_list.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="tutorial_with_examples.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>