1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
|
<?xml version="1.0" encoding="utf-8"?>
<!--
Copyright 2012 Eric Niebler
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)
-->
<header name="boost/proto/functional/std/utility.hpp">
<para>Defines Proto callables <computeroutput><classname>boost::proto::functional::make_pair</classname></computeroutput>,
<computeroutput><classname>boost::proto::functional::first</classname></computeroutput> and
<computeroutput><classname>boost::proto::functional::second</classname></computeroutput>.</para>
<namespace name="boost">
<namespace name="proto">
<namespace name="functional">
<!-- proto::functional::make_pair -->
<struct name="make_pair">
<purpose>A <conceptname>PolymorphicFunctionObject</conceptname> type that invokes
<computeroutput>std::make_pair()</computeroutput> on its arguments.</purpose>
<description>
<para>
A <conceptname>PolymorphicFunctionObject</conceptname> type that invokes
<computeroutput>std::make_pair()</computeroutput> on its arguments.</para>
</description>
<inherit>
<type><classname>proto::callable</classname></type>
</inherit>
<struct-specialization name="result">
<template>
<template-type-parameter name="This"/>
<template-type-parameter name="First"/>
<template-type-parameter name="Second"/>
</template>
<specialization>
<template-arg>This(First, Second)</template-arg>
</specialization>
<typedef name="type">
<type>std::pair<
typename boost::remove_const<typename boost::remove_reference<First>::type>::type
, typename boost::remove_const<typename boost::remove_reference<Second>::type>::type
></type>
</typedef>
</struct-specialization>
<method-group name="public member functions">
<method name="operator()" cv="const">
<type>typename std::pair< First, Second ></type>
<template>
<template-type-parameter name="First"/>
<template-type-parameter name="Second"/>
</template>
<parameter name="first">
<paramtype>First const &</paramtype>
</parameter>
<parameter name="second">
<paramtype>Second const &</paramtype>
</parameter>
<returns>
<para><computeroutput>std::make_pair(first, second)</computeroutput></para>
</returns>
</method>
</method-group>
</struct>
<!-- proto::functional::first -->
<struct name="first">
<purpose>
A <conceptname>PolymorphicFunctionObject</conceptname> type that returns
the first element of a <computeroutput>std::pair<></computeroutput>.
</purpose>
<description>
<para>
A <conceptname>PolymorphicFunctionObject</conceptname> type that returns
the first element of a <computeroutput>std::pair<></computeroutput>.</para>
</description>
<inherit><type><classname>proto::callable</classname></type>
</inherit>
<struct-specialization name="result">
<template>
<template-type-parameter name="This"/>
<template-type-parameter name="Pair"/>
</template>
<specialization>
<template-arg>This(Pair)</template-arg>
</specialization>
<typedef name="type">
<type>typename Pair::first_type</type>
</typedef>
</struct-specialization>
<struct-specialization name="result">
<template>
<template-type-parameter name="This"/>
<template-type-parameter name="Pair"/>
</template>
<specialization>
<template-arg>This(Pair &)</template-arg>
</specialization>
<typedef name="type">
<type>typename Pair::first_type &</type>
</typedef>
</struct-specialization>
<struct-specialization name="result">
<template>
<template-type-parameter name="This"/>
<template-type-parameter name="Pair"/>
</template>
<specialization>
<template-arg>This(Pair const &)</template-arg>
</specialization>
<typedef name="type">
<type>typename Pair::first_type const &</type>
</typedef>
</struct-specialization>
<method-group name="public member functions">
<method name="operator()" cv="const">
<type>typename Pair::first_type &</type>
<template>
<template-type-parameter name="Pair"/>
</template>
<parameter name="pair">
<paramtype>Pair &</paramtype>
</parameter>
<returns>
<para>
<computeroutput>pair.first</computeroutput>
</para>
</returns>
</method>
<method name="operator()" cv="const">
<type>typename Pair::first_type const &</type>
<template>
<template-type-parameter name="Pair"/>
</template>
<parameter name="pair">
<paramtype>Pair const &</paramtype>
</parameter>
<returns>
<para>
<computeroutput>pair.first</computeroutput>
</para>
</returns>
</method>
</method-group>
</struct>
<!-- proto::functional::second -->
<struct name="second">
<purpose>
A <conceptname>PolymorphicFunctionObject</conceptname> type that returns
the second element of a <computeroutput>std::pair<></computeroutput>.
</purpose>
<description>
<para>
A <conceptname>PolymorphicFunctionObject</conceptname> type that returns
the second element of a <computeroutput>std::pair<></computeroutput>.
</para>
</description>
<inherit><type><classname>proto::callable</classname></type></inherit>
<struct-specialization name="result">
<template>
<template-type-parameter name="This"/>
<template-type-parameter name="Pair"/>
</template>
<specialization>
<template-arg>This(Pair)</template-arg>
</specialization>
<typedef name="type">
<type>typename Pair::second_type</type>
</typedef>
</struct-specialization>
<struct-specialization name="result">
<template>
<template-type-parameter name="This"/>
<template-type-parameter name="Pair"/>
</template>
<specialization>
<template-arg>This(Pair &)</template-arg>
</specialization>
<typedef name="type">
<type>typename Pair::second_type &</type>
</typedef>
</struct-specialization>
<struct-specialization name="result">
<template>
<template-type-parameter name="This"/>
<template-type-parameter name="Pair"/>
</template>
<specialization>
<template-arg>This(Pair const &)</template-arg>
</specialization>
<typedef name="type">
<type>typename Pair::second_type const &</type>
</typedef>
</struct-specialization>
<method-group name="public member functions">
<method name="operator()" cv="const">
<type>typename Pair::second_type &</type>
<template>
<template-type-parameter name="Pair"/>
</template>
<parameter name="pair">
<paramtype>Pair &</paramtype>
</parameter>
<returns>
<para>
<computeroutput>pair.second</computeroutput>
</para>
</returns>
</method>
<method name="operator()" cv="const">
<type>typename Pair::second_type const &</type>
<template>
<template-type-parameter name="Pair"/>
</template>
<parameter name="pair">
<paramtype>Pair const &</paramtype>
</parameter>
<returns>
<para>
<computeroutput>pair.second</computeroutput>
</para>
</returns>
</method>
</method-group>
</struct>
</namespace>
</namespace>
</namespace>
</header>
|