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
|
<?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/eval.hpp">
<para>
Contains the
<computeroutput>
<functionname alt="boost::proto::eval">proto::eval()</functionname>
</computeroutput> expression evaluator.
</para>
<namespace name="boost">
<namespace name="proto">
<namespace name="functional">
<!-- proto::functional::eval-->
<struct name="eval">
<purpose>A <conceptname>PolymorphicFunctionObject</conceptname> type for evaluating a given Proto
expression with a given context.</purpose>
<inherit>
<type><classname>proto::callable</classname></type>
</inherit>
<struct-specialization name="result">
<template>
<template-type-parameter name="This"/>
<template-type-parameter name="Expr"/>
<template-type-parameter name="Context"/>
</template>
<specialization>
<template-arg>This(Expr, Context)</template-arg>
</specialization>
<inherit>
<type>
<classname>proto::result_of::eval</classname><
typename boost::remove_reference< Expr >::type,
typename boost::remove_reference< Context >::type
></type>
</inherit>
</struct-specialization>
<method-group name="public member functions">
<method name="operator()" cv="const">
<type>typename <classname>proto::result_of::eval</classname>< Expr, Context >::type</type>
<template>
<template-type-parameter name="Expr"/>
<template-type-parameter name="Context"/>
</template>
<parameter name="expr">
<paramtype>Expr &</paramtype>
<description>
<para>The Proto expression to evaluate.</para>
</description>
</parameter>
<parameter name="context">
<paramtype>Context &</paramtype>
<description>
<para>The context in which the expression should be evaluated. </para>
</description>
</parameter>
<purpose>Evaluate a given Proto expression with a given context. </purpose>
<returns>
<para>
<computeroutput>typename Context::template eval<Expr>()(expr, context)</computeroutput>
</para>
</returns>
</method>
<method name="operator()" cv="const">
<type>typename <classname>proto::result_of::eval</classname>< Expr, Context >::type</type>
<template>
<template-type-parameter name="Expr"/>
<template-type-parameter name="Context"/>
</template>
<parameter name="expr">
<paramtype>Expr &</paramtype>
</parameter>
<parameter name="context">
<paramtype>Context const &</paramtype>
</parameter>
<description>
<para>
This is an overloaded member function, provided for convenience. It differs from the above
function only in what argument(s) it accepts.
</para>
</description>
</method>
</method-group>
</struct>
</namespace>
<namespace name="result_of">
<!-- proto::result_of::eval -->
<struct name="eval">
<template>
<template-type-parameter name="Expr"/>
<template-type-parameter name="Context"/>
</template>
<purpose>A metafunction for calculating the return type of <computeroutput>
<functionname alt="proto::eval">proto::eval()</functionname></computeroutput> given a
certain <computeroutput>Expr</computeroutput> and <computeroutput>Context</computeroutput> types.</purpose>
<typedef name="type">
<type>typename Context::template eval< Expr >::result_type</type>
</typedef>
</struct>
</namespace>
<!-- proto::eval() -->
<overloaded-function name="eval">
<signature>
<type>typename <classname>proto::result_of::eval</classname>< Expr, Context >::type</type>
<template>
<template-type-parameter name="Expr"/>
<template-type-parameter name="Context"/>
</template>
<parameter name="expr">
<paramtype>Expr &</paramtype>
<description>
<para>The Proto expression to evaluate.</para>
</description>
</parameter>
<parameter name="context">
<paramtype>Context &</paramtype>
<description>
<para>The context in which the expression should be evaluated.</para>
</description>
</parameter>
</signature>
<signature>
<type>typename <classname>proto::result_of::eval</classname>< Expr, Context >::type</type>
<template>
<template-type-parameter name="Expr"/>
<template-type-parameter name="Context"/>
</template>
<parameter name="expr">
<paramtype>Expr &</paramtype>
</parameter>
<parameter name="context">
<paramtype>Context const &</paramtype>
</parameter>
</signature>
<purpose>Evaluate a given Proto expression with a given context. </purpose>
<returns>
<para>
<computeroutput>typename Context::template eval<Expr>()(expr, context)</computeroutput>
</para>
</returns>
</overloaded-function>
</namespace>
</namespace>
</header>
|