94 lines
2.6 KiB
XML
94 lines
2.6 KiB
XML
<?xml version="1.0" ?>
|
|
<!--
|
|
Copyright 2008 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)
|
|
-->
|
|
<concept name="CallableTransform" category="utility">
|
|
<param name="Fn" role="polymorphic-function-object-type" />
|
|
<param name="Tn" role="transform-type" />
|
|
<param name="Expr" role="expression-type" />
|
|
<param name="State" role="state-type" />
|
|
<param name="Data" role="data-type" />
|
|
|
|
<models-sentence>
|
|
The type <arg num="1" /> must be a model of <conceptname name="PolymorphicFunctionObject"/>.
|
|
The type <arg num="2" /> must be a model of <conceptname name="Transform"/>.
|
|
</models-sentence>
|
|
|
|
<description>
|
|
<para>
|
|
A CallableTransform is a function type or a function
|
|
pointer type where the return type Fn is a
|
|
PolymorphicFunctionObject and the arguments are
|
|
Transforms. is_callable< Fn >::value
|
|
must be true. The CallableTransform, when applied,
|
|
has the effect of invoking the polymorphic function
|
|
object Fn, passing as arguments the result(s)
|
|
of applying transform(s) Tn.
|
|
</para>
|
|
</description>
|
|
|
|
<notation variables="fn">
|
|
<sample-value>
|
|
<type name="Fn" />
|
|
</sample-value>
|
|
</notation>
|
|
|
|
<notation variables="expr">
|
|
<sample-value>
|
|
<type name="Expr" />
|
|
</sample-value>
|
|
</notation>
|
|
|
|
<notation variables="state">
|
|
<sample-value>
|
|
<type name="State" />
|
|
</sample-value>
|
|
</notation>
|
|
|
|
<notation variables="data">
|
|
<sample-value>
|
|
<type name="Data" />
|
|
</sample-value>
|
|
</notation>
|
|
|
|
<associated-type name="result_type">
|
|
<get-member-type name="type">
|
|
<apply-template name="boost::result_of">
|
|
<type name="Fn(Transform<Tn, Expr, State, Data>::result_type...)"/>
|
|
</apply-template>
|
|
</get-member-type>
|
|
<description>
|
|
<simpara>The result of applying the CallableTransform.</simpara>
|
|
</description>
|
|
</associated-type>
|
|
|
|
<valid-expression name="Apply Transform">
|
|
<apply-function name="when< _, Fn(Tn...)>()">
|
|
<sample-value>
|
|
<type name="Expr" />
|
|
</sample-value>
|
|
<sample-value>
|
|
<type name="State" />
|
|
</sample-value>
|
|
<sample-value>
|
|
<type name="Data" />
|
|
</sample-value>
|
|
</apply-function>
|
|
<return-type>
|
|
<require-same-type testable="yes">
|
|
<type name="result_type"/>
|
|
</require-same-type>
|
|
</return-type>
|
|
<semantics>Applies the transform.</semantics>
|
|
</valid-expression>
|
|
|
|
<example-model>
|
|
<type name="boost::proto::_child(boost::proto::_left)" />
|
|
</example-model>
|
|
|
|
</concept>
|