mirror of
https://github.com/boostorg/function.git
synced 2025-07-22 17:07:14 +02:00
Import of BoostBook documentation for any, array, bind, function, ref, and
signals libraries. [SVN r17866]
This commit is contained in:
66
doc/function.xml
Normal file
66
doc/function.xml
Normal file
@ -0,0 +1,66 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
|
||||
"http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
|
||||
<library name="Function" dirname="function" id="function"
|
||||
last-revision="$Date$"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||
<libraryinfo>
|
||||
<author>
|
||||
<firstname>Douglas</firstname>
|
||||
<surname>Gregor</surname>
|
||||
<email>gregod@cs.rpi.edu</email>
|
||||
</author>
|
||||
|
||||
<copyright>
|
||||
<year>2001</year>
|
||||
<year>2002</year>
|
||||
<year>2003</year>
|
||||
<holder>Douglas Gregor</holder>
|
||||
</copyright>
|
||||
|
||||
<legalnotice>
|
||||
<para>Permission to copy, use, sell and distribute this software
|
||||
is granted provided this copyright notice appears in all copies.
|
||||
Permission to modify the code and to distribute modified code is
|
||||
granted provided this copyright notice appears in all copies, and
|
||||
a notice that the code was modified is included with the copyright
|
||||
notice. </para>
|
||||
|
||||
<para> This software is provided "as is" without express or
|
||||
implied warranty, and with no claim as to its suitability for any
|
||||
purpose. </para>
|
||||
</legalnotice>
|
||||
|
||||
<librarypurpose>Function object wrappers for deferred calls or callbacks</librarypurpose>
|
||||
<librarycategory name="category:higher-order"/>
|
||||
</libraryinfo>
|
||||
|
||||
<title>Boost.Function</title>
|
||||
|
||||
<section id="function.intro">
|
||||
<title>Introduction</title>
|
||||
<para>The Boost.Function library contains a family of class templates
|
||||
that are function object wrappers. The notion is similar to a
|
||||
generalized callback. It shares features with function pointers in
|
||||
that both define a call interface (e.g., a function taking two integer
|
||||
arguments and returning a floating-point value) through which some
|
||||
implementation can be called, and the implementation that is invoked
|
||||
may change throughout the course of the program.</para>
|
||||
|
||||
<para> Generally, any place in which a function pointer would be used
|
||||
to defer a call or make a callback, Boost.Function can be used instead
|
||||
to allow the user greater flexibility in the implementation of the
|
||||
target. Targets can be any 'compatible' function object (or function
|
||||
pointer), meaning that the arguments to the interface designated by
|
||||
Boost.Function can be converted to the arguments of the target
|
||||
function object.</para>
|
||||
</section>
|
||||
|
||||
<xi:include href="history.xml"/>
|
||||
<xi:include href="tutorial.xml"/>
|
||||
<xi:include href="reference.xml"/>
|
||||
<xi:include href="faq.xml"/>
|
||||
<xi:include href="misc.xml"/>
|
||||
<xi:include href="tests.xml"/>
|
||||
|
||||
</library>
|
Reference in New Issue
Block a user