diff options
Diffstat (limited to 'doc')
191 files changed, 9501 insertions, 0 deletions
diff --git a/doc/Jamfile.v2 b/doc/Jamfile.v2 new file mode 100644 index 0000000000..bbc09f416d --- /dev/null +++ b/doc/Jamfile.v2 @@ -0,0 +1,90 @@ +# Copyright (c) 2002 Douglas Gregor <doug.gregor -at- gmail.com> +# +# 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) +project boost/doc ; +import boostbook : boostbook ; + +alias asio : ../libs/asio/doc//asio/<xsl:param>boost.libraries=../../libs/libraries.htm ; + +boostbook doc + : + src/boost.xml + : + ## Build the various generated docs (Doxygen and QuickBook)... + + <dependency>../libs/accumulators/doc//accdoc.xml + <dependency>../libs/accumulators/doc//statsdoc.xml + <dependency>../libs/accumulators/doc//opdoc.xml + <dependency>../libs/accumulators/doc//accumulators + <dependency>../libs/program_options/doc//autodoc.xml + <dependency>../libs/algorithm/string/doc//autodoc.xml + <dependency>../libs/logic/doc//reference.xml + <dependency>../libs/functional/hash/doc//hash + #<dependency>../libs/type_traits/doc//type_traits + <dependency>../libs/static_assert/doc//static_assert + <dependency>../libs/tr1/doc//tr1 + <dependency>../libs/foreach/doc//foreach + <dependency>../libs/mpi/doc//mpi + <dependency>../libs/mpi/doc//mpi_autodoc.xml + <dependency>../libs/property_tree/doc//autodoc.xml + <dependency>../libs/property_tree/doc//property_tree + #<dependency>../libs/proto/doc//protodoc.xml + <dependency>../libs/proto/doc//proto + <dependency>../libs/typeof/doc//typeof + <dependency>../libs/xpressive/doc//autodoc.xml + <dependency>../libs/xpressive/doc//xpressive + <dependency>../libs/date_time/xmldoc//date_time_autodoc.xml + <dependency>../libs/date_time/xmldoc//gregorian_autodoc.xml + <dependency>../libs/date_time/xmldoc//posix_time_autodoc.xml + <dependency>../libs/date_time/xmldoc//local_time_autodoc.xml + <dependency>../tools/build/v2/doc//jam_docs + <dependency>../tools/quickbook/doc//quickbook + <dependency>../libs/interprocess/doc//autodoc.xml + <dependency>../libs/interprocess/doc//interprocess + <dependency>../libs/intrusive/doc//autodoc.xml + <dependency>../libs/intrusive/doc//intrusive + <dependency>../libs/units/doc//units + <dependency>../libs/unordered/doc//unordered + <dependency>../libs/thread/doc//thread + <dependency>../libs/signals2/doc//hello_world_def_code_snippet.xml + <dependency>../libs/random/doc//random + #<dependency>../libs/spirit/doc//spirit + + ## Add path references to the QuickBook generated docs... + + <implicit-dependency>../libs/accumulators/doc//accumulators + <implicit-dependency>../libs/functional/hash/doc//hash + #<implicit-dependency>../libs/type_traits/doc//type_traits + <implicit-dependency>../libs/static_assert/doc//static_assert + <implicit-dependency>../libs/tr1/doc//tr1 + <implicit-dependency>../libs/foreach/doc//foreach + <implicit-dependency>../libs/property_tree/doc//property_tree + <implicit-dependency>../libs/proto/doc//proto + <implicit-dependency>../libs/typeof/doc//typeof + <implicit-dependency>../libs/xpressive/doc//xpressive + <implicit-dependency>../tools/build/v2/doc//jam_docs + <implicit-dependency>../tools/quickbook/doc//quickbook + <implicit-dependency>../libs/mpi/doc//mpi + <implicit-dependency>../libs/interprocess/doc//interprocess + <implicit-dependency>../libs/intrusive/doc//intrusive + <implicit-dependency>../libs/units/doc//units + <implicit-dependency>../libs/unordered/doc//unordered + <implicit-dependency>../libs/thread/doc//thread + <implicit-dependency>../libs/signals2/doc//hello_world_def_code_snippet.xml + <implicit-dependency>../libs/random/doc//random + #<implicit-dependency>../libs/spirit/doc//spirit + + <xsl:param>boost.libraries=../../libs/libraries.htm + + <dependency>images + <dependency>callouts + ; + +install images : [ glob src/images/*.png ] : <location>html/images ; +explicit images ; +install callouts : [ glob src/images/callouts/*.png ] : <location>html/images/callouts ; +explicit callouts ; + + diff --git a/doc/html/Assignable.html b/doc/html/Assignable.html new file mode 100644 index 0000000000..d7a6f6829a --- /dev/null +++ b/doc/html/Assignable.html @@ -0,0 +1,16 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/Assignable.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/Assignable.html">http://boost-sandbox.sourceforge.net/doc/html/Assignable.html</a> + </body> +</html> diff --git a/doc/html/CopyConstructible.html b/doc/html/CopyConstructible.html new file mode 100644 index 0000000000..d88bf22c12 --- /dev/null +++ b/doc/html/CopyConstructible.html @@ -0,0 +1,16 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/CopyConstructible.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/CopyConstructible.html">http://boost-sandbox.sourceforge.net/doc/html/CopyConstructible.html</a> + </body> +</html> diff --git a/doc/html/accumulators.html b/doc/html/accumulators.html new file mode 100644 index 0000000000..c32c8ca35a --- /dev/null +++ b/doc/html/accumulators.html @@ -0,0 +1,16 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/accumulators.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/accumulators.html">http://boost-sandbox.sourceforge.net/doc/html/accumulators.html</a> + </body> +</html> diff --git a/doc/html/any.html b/doc/html/any.html new file mode 100644 index 0000000000..6b70582822 --- /dev/null +++ b/doc/html/any.html @@ -0,0 +1,16 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/any.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/any.html">http://boost-sandbox.sourceforge.net/doc/html/any.html</a> + </body> +</html> diff --git a/doc/html/array.html b/doc/html/array.html new file mode 100644 index 0000000000..03a39036cf --- /dev/null +++ b/doc/html/array.html @@ -0,0 +1,16 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/array.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/array.html">http://boost-sandbox.sourceforge.net/doc/html/array.html</a> + </body> +</html> diff --git a/doc/html/bbv2.html b/doc/html/bbv2.html new file mode 100644 index 0000000000..9fb97856a0 --- /dev/null +++ b/doc/html/bbv2.html @@ -0,0 +1,16 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/bbv2.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/bbv2.html">http://boost-sandbox.sourceforge.net/doc/html/bbv2.html</a> + </body> +</html> diff --git a/doc/html/bbv2/installation.html b/doc/html/bbv2/installation.html new file mode 100644 index 0000000000..ca0ff279f1 --- /dev/null +++ b/doc/html/bbv2/installation.html @@ -0,0 +1,18 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/bbv2/installation.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/bbv2/installation.html">http://boost-sandbox.sourceforge.net/doc/html/bbv2/installation.html</a> + </body> +</html> + + diff --git a/doc/html/boost_asio.html b/doc/html/boost_asio.html new file mode 100644 index 0000000000..10fefd4e67 --- /dev/null +++ b/doc/html/boost_asio.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/boost_asio.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/boost_asio.html">http://boost-sandbox.sourceforge.net/doc/html/boost_asio.html</a> + </body> +</html> + diff --git a/doc/html/boost_random.html b/doc/html/boost_random.html new file mode 100644 index 0000000000..abbf5bca48 --- /dev/null +++ b/doc/html/boost_random.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/boost_random.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/boost_random.html">http://boost-sandbox.sourceforge.net/doc/html/boost_random.html</a> + </body> +</html> + diff --git a/doc/html/boost_staticassert.html b/doc/html/boost_staticassert.html new file mode 100644 index 0000000000..1b1e042acd --- /dev/null +++ b/doc/html/boost_staticassert.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/boost_staticassert.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/boost_staticassert.html">http://boost-sandbox.sourceforge.net/doc/html/boost_staticassert.html</a> + </body> +</html> + diff --git a/doc/html/boost_tr1.html b/doc/html/boost_tr1.html new file mode 100644 index 0000000000..c682dc5cb9 --- /dev/null +++ b/doc/html/boost_tr1.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/boost_tr1.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/boost_tr1.html">http://boost-sandbox.sourceforge.net/doc/html/boost_tr1.html</a> + </body> +</html> + diff --git a/doc/html/boostbook.html b/doc/html/boostbook.html new file mode 100644 index 0000000000..89b866bfec --- /dev/null +++ b/doc/html/boostbook.html @@ -0,0 +1,16 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/boostbook.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/boostbook.html">http://boost-sandbox.sourceforge.net/doc/html/boostbook.html</a> + </body> +</html> diff --git a/doc/html/date_time.html b/doc/html/date_time.html new file mode 100644 index 0000000000..a8113c6654 --- /dev/null +++ b/doc/html/date_time.html @@ -0,0 +1,16 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/date_time.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/date_time.html">http://boost-sandbox.sourceforge.net/doc/html/date_time.html</a> + </body> +</html> diff --git a/doc/html/date_time/date_time_io.html b/doc/html/date_time/date_time_io.html new file mode 100644 index 0000000000..4a6304bb90 --- /dev/null +++ b/doc/html/date_time/date_time_io.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/date_time/date_time_io.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/date_time/date_time_io.html">http://boost-sandbox.sourceforge.net/doc/html/date_time/date_time_io.html</a> + </body> +</html> + diff --git a/doc/html/date_time/details.html b/doc/html/date_time/details.html new file mode 100644 index 0000000000..77b01b1628 --- /dev/null +++ b/doc/html/date_time/details.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/date_time/details.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/date_time/details.html">http://boost-sandbox.sourceforge.net/doc/html/date_time/details.html</a> + </body> +</html> + diff --git a/doc/html/date_time/local_time.html b/doc/html/date_time/local_time.html new file mode 100644 index 0000000000..23e64a44ef --- /dev/null +++ b/doc/html/date_time/local_time.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/date_time/local_time.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/date_time/local_time.html">http://boost-sandbox.sourceforge.net/doc/html/date_time/local_time.html</a> + </body> +</html> + diff --git a/doc/html/foreach.html b/doc/html/foreach.html new file mode 100644 index 0000000000..369fc453c1 --- /dev/null +++ b/doc/html/foreach.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/foreach.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/foreach.html">http://boost-sandbox.sourceforge.net/doc/html/foreach.html</a> + </body> +</html> + diff --git a/doc/html/function.html b/doc/html/function.html new file mode 100644 index 0000000000..d768e4c768 --- /dev/null +++ b/doc/html/function.html @@ -0,0 +1,16 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/function.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/function.html">http://boost-sandbox.sourceforge.net/doc/html/function.html</a> + </body> +</html> diff --git a/doc/html/hash.html b/doc/html/hash.html new file mode 100644 index 0000000000..5a860649b8 --- /dev/null +++ b/doc/html/hash.html @@ -0,0 +1,16 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/hash.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/hash.html">http://boost-sandbox.sourceforge.net/doc/html/hash.html</a> + </body> +</html> diff --git a/doc/html/hash/custom.html b/doc/html/hash/custom.html new file mode 100644 index 0000000000..f42ada1106 --- /dev/null +++ b/doc/html/hash/custom.html @@ -0,0 +1,16 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/hash/custom.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/hash/custom.html">http://boost-sandbox.sourceforge.net/doc/html/hash/custom.html</a> + </body> +</html> diff --git a/doc/html/images/blank.png b/doc/html/images/blank.png Binary files differnew file mode 100644 index 0000000000..764bf4f0c3 --- /dev/null +++ b/doc/html/images/blank.png diff --git a/doc/html/images/caution.png b/doc/html/images/caution.png Binary files differnew file mode 100644 index 0000000000..5b7809ca4a --- /dev/null +++ b/doc/html/images/caution.png diff --git a/doc/html/images/draft.png b/doc/html/images/draft.png Binary files differnew file mode 100644 index 0000000000..0084708c9b --- /dev/null +++ b/doc/html/images/draft.png diff --git a/doc/html/images/home.png b/doc/html/images/home.png Binary files differnew file mode 100644 index 0000000000..5584aacb09 --- /dev/null +++ b/doc/html/images/home.png diff --git a/doc/html/images/important.png b/doc/html/images/important.png Binary files differnew file mode 100644 index 0000000000..12c90f607a --- /dev/null +++ b/doc/html/images/important.png diff --git a/doc/html/images/next.png b/doc/html/images/next.png Binary files differnew file mode 100644 index 0000000000..59800b4e87 --- /dev/null +++ b/doc/html/images/next.png diff --git a/doc/html/images/next_disabled.png b/doc/html/images/next_disabled.png Binary files differnew file mode 100644 index 0000000000..10a8c59d7b --- /dev/null +++ b/doc/html/images/next_disabled.png diff --git a/doc/html/images/note.png b/doc/html/images/note.png Binary files differnew file mode 100644 index 0000000000..d0c3c645ab --- /dev/null +++ b/doc/html/images/note.png diff --git a/doc/html/images/prev.png b/doc/html/images/prev.png Binary files differnew file mode 100644 index 0000000000..d88a40f923 --- /dev/null +++ b/doc/html/images/prev.png diff --git a/doc/html/images/prev_disabled.png b/doc/html/images/prev_disabled.png Binary files differnew file mode 100644 index 0000000000..ab3c17e02d --- /dev/null +++ b/doc/html/images/prev_disabled.png diff --git a/doc/html/images/tip.png b/doc/html/images/tip.png Binary files differnew file mode 100644 index 0000000000..5c4aab3bb3 --- /dev/null +++ b/doc/html/images/tip.png diff --git a/doc/html/images/toc-blank.png b/doc/html/images/toc-blank.png Binary files differnew file mode 100644 index 0000000000..6ffad17a0c --- /dev/null +++ b/doc/html/images/toc-blank.png diff --git a/doc/html/images/toc-minus.png b/doc/html/images/toc-minus.png Binary files differnew file mode 100644 index 0000000000..abbb020c8e --- /dev/null +++ b/doc/html/images/toc-minus.png diff --git a/doc/html/images/toc-plus.png b/doc/html/images/toc-plus.png Binary files differnew file mode 100644 index 0000000000..941312ce0d --- /dev/null +++ b/doc/html/images/toc-plus.png diff --git a/doc/html/images/up.png b/doc/html/images/up.png Binary files differnew file mode 100644 index 0000000000..17d9c3ec49 --- /dev/null +++ b/doc/html/images/up.png diff --git a/doc/html/images/up_disabled.png b/doc/html/images/up_disabled.png Binary files differnew file mode 100644 index 0000000000..e22bc87121 --- /dev/null +++ b/doc/html/images/up_disabled.png diff --git a/doc/html/images/warning.png b/doc/html/images/warning.png Binary files differnew file mode 100644 index 0000000000..1c33db8f34 --- /dev/null +++ b/doc/html/images/warning.png diff --git a/doc/html/interprocess.html b/doc/html/interprocess.html new file mode 100644 index 0000000000..acb8310a6c --- /dev/null +++ b/doc/html/interprocess.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/interprocess.html"> + <title>Redirect to generated documentation</title> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/interprocess.html">http://boost-sandbox.sourceforge.net/doc/html/interprocess.html</a> + </body> +</html> + diff --git a/doc/html/intrusive.html b/doc/html/intrusive.html new file mode 100644 index 0000000000..4b83dd3329 --- /dev/null +++ b/doc/html/intrusive.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/intrusive.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/intrusive.html">http://boost-sandbox.sourceforge.net/doc/html/intrusive.html</a> + </body> +</html> + diff --git a/doc/html/jam.html b/doc/html/jam.html new file mode 100644 index 0000000000..d6a181b701 --- /dev/null +++ b/doc/html/jam.html @@ -0,0 +1,16 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/jam.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/jam.html">http://boost-sandbox.sourceforge.net/doc/html/jam.html</a> + </body> +</html> diff --git a/doc/html/jam/building.html b/doc/html/jam/building.html new file mode 100644 index 0000000000..31e2139e3f --- /dev/null +++ b/doc/html/jam/building.html @@ -0,0 +1,18 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/jam/building.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/jam/building.html">http://boost-sandbox.sourceforge.net/doc/html/jam/building.html</a> + </body> +</html> + + diff --git a/doc/html/lambda.html b/doc/html/lambda.html new file mode 100644 index 0000000000..9a771e2025 --- /dev/null +++ b/doc/html/lambda.html @@ -0,0 +1,16 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/lambda.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/lambda.html">http://boost-sandbox.sourceforge.net/doc/html/lambda.html</a> + </body> +</html> diff --git a/doc/html/mpi.html b/doc/html/mpi.html new file mode 100644 index 0000000000..5019c0b098 --- /dev/null +++ b/doc/html/mpi.html @@ -0,0 +1,16 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2007 Trustees of Indiana University + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/mpi.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/mpi.html">http://boost-sandbox.sourceforge.net/doc/html/mpi.html</a> + </body> +</html> diff --git a/doc/html/program_options.html b/doc/html/program_options.html new file mode 100644 index 0000000000..13f316a271 --- /dev/null +++ b/doc/html/program_options.html @@ -0,0 +1,16 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/program_options.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/program_options.html">http://boost-sandbox.sourceforge.net/doc/html/program_options.html</a> + </body> +</html> diff --git a/doc/html/property_tree.html b/doc/html/property_tree.html new file mode 100644 index 0000000000..8d0a4794b7 --- /dev/null +++ b/doc/html/property_tree.html @@ -0,0 +1,16 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/property_tree.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/property_tree.html">http://boost-sandbox.sourceforge.net/doc/html/property_tree.html</a> + </body> +</html> diff --git a/doc/html/proto.html b/doc/html/proto.html new file mode 100644 index 0000000000..98502e9610 --- /dev/null +++ b/doc/html/proto.html @@ -0,0 +1,16 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/proto.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/proto.html">http://boost-sandbox.sourceforge.net/doc/html/proto.html</a> + </body> +</html> diff --git a/doc/html/quickbook.html b/doc/html/quickbook.html new file mode 100644 index 0000000000..46372c9c0c --- /dev/null +++ b/doc/html/quickbook.html @@ -0,0 +1,16 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/quickbook.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/quickbook.html">http://boost-sandbox.sourceforge.net/doc/html/quickbook.html</a> + </body> +</html> diff --git a/doc/html/ref.html b/doc/html/ref.html new file mode 100644 index 0000000000..0457c760b1 --- /dev/null +++ b/doc/html/ref.html @@ -0,0 +1,16 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/ref.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/ref.html">http://boost-sandbox.sourceforge.net/doc/html/ref.html</a> + </body> +</html> diff --git a/doc/html/signals.html b/doc/html/signals.html new file mode 100644 index 0000000000..62b7a08138 --- /dev/null +++ b/doc/html/signals.html @@ -0,0 +1,16 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/signals.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/signals.html">http://boost-sandbox.sourceforge.net/doc/html/signals.html</a> + </body> +</html> diff --git a/doc/html/signals2.html b/doc/html/signals2.html new file mode 100644 index 0000000000..046b960630 --- /dev/null +++ b/doc/html/signals2.html @@ -0,0 +1,16 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/signals2.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/signals2.html">http://boost-sandbox.sourceforge.net/doc/html/signals2.html</a> + </body> +</html> diff --git a/doc/html/string_algo.html b/doc/html/string_algo.html new file mode 100644 index 0000000000..967db68481 --- /dev/null +++ b/doc/html/string_algo.html @@ -0,0 +1,16 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/string_algo.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/string_algo.html">http://boost-sandbox.sourceforge.net/doc/html/string_algo.html</a> + </body> +</html> diff --git a/doc/html/thread.html b/doc/html/thread.html new file mode 100644 index 0000000000..6b4379bc74 --- /dev/null +++ b/doc/html/thread.html @@ -0,0 +1,16 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/thread.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/thread.html">http://boost-sandbox.sourceforge.net/doc/html/thread.html</a> + </body> +</html> diff --git a/doc/html/tribool.html b/doc/html/tribool.html new file mode 100644 index 0000000000..79894ee550 --- /dev/null +++ b/doc/html/tribool.html @@ -0,0 +1,16 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/tribool.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/tribool.html">http://boost-sandbox.sourceforge.net/doc/html/tribool.html</a> + </body> +</html> diff --git a/doc/html/typeof.html b/doc/html/typeof.html new file mode 100644 index 0000000000..79c95b2d97 --- /dev/null +++ b/doc/html/typeof.html @@ -0,0 +1,16 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/typeof.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/typeof.html">http://boost-sandbox.sourceforge.net/doc/html/typeof.html</a> + </body> +</html> diff --git a/doc/html/unordered.html b/doc/html/unordered.html new file mode 100644 index 0000000000..a7418c38d5 --- /dev/null +++ b/doc/html/unordered.html @@ -0,0 +1,16 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/unordered.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/unordered.html">http://boost-sandbox.sourceforge.net/doc/html/unordered.html</a> + </body> +</html> diff --git a/doc/html/variant.html b/doc/html/variant.html new file mode 100644 index 0000000000..b67b72ddf7 --- /dev/null +++ b/doc/html/variant.html @@ -0,0 +1,16 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/variant.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/variant.html">http://boost-sandbox.sourceforge.net/doc/html/variant.html</a> + </body> +</html> diff --git a/doc/html/xpressive.html b/doc/html/xpressive.html new file mode 100644 index 0000000000..70931e88ab --- /dev/null +++ b/doc/html/xpressive.html @@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> + <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> + + 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) --> + <title>Redirect to generated documentation</title> + <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/xpressive.html"> + </head> + <body> + Automatic redirection failed, please go to + <a href="http://boost-sandbox.sourceforge.net/doc/html/xpressive.html">http://boost-sandbox.sourceforge.net/doc/html/xpressive.html</a> + </body> +</html> + diff --git a/doc/images/valid-html401.png b/doc/images/valid-html401.png Binary files differnew file mode 100644 index 0000000000..c0108424a5 --- /dev/null +++ b/doc/images/valid-html401.png diff --git a/doc/pdf/Jamfile.v2 b/doc/pdf/Jamfile.v2 new file mode 100644 index 0000000000..b3ab3a2ac4 --- /dev/null +++ b/doc/pdf/Jamfile.v2 @@ -0,0 +1,168 @@ +# Copyright (c) 2008 John Maddock +# +# 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) + +import boostbook ; +import os ; +import common ; +import doxygen ; +import quickbook ; + + +boostbook array_docs + : ../../libs/array/doc/array.xml + : + <format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/doc/html + <format>pdf + ; + +boostbook any_docs + : ../../libs/any/doc/any.xml + : + <format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/doc/html + <format>pdf + ; + +install pdf-install + : + array_docs + any_docs + ../../libs/accumulators/doc//standalone + ../../libs/algorithm/string/doc//string_algo + ../../libs/bimap/doc//standalone + ../../libs/bind/doc//ref-doc + ../../libs/concept_check/doc//concepts + ../../libs/config/doc//standalone + ../../libs/date_time/xmldoc//date_time + ../../libs/foreach/doc//standalone + ../../libs/function/doc//function-doc + ../../libs/functional/factory/doc//standalone + ../../libs/functional/forward/doc//standalone + ../../libs/functional/hash/doc//standalone + ../../libs/fusion/doc//quickbook + ../../libs/icl/doc//standalone + ../../libs/interprocess/doc//standalone + ../../libs/integer/doc//standalone + ../../libs/intrusive/doc//standalone + ../../libs/iterator/doc//standalone + ../../libs/lambda/doc//lambda-doc + ../../libs/logic/doc//tribool + ../../libs/math/doc/complex//standalone + ../../libs/math/doc/octonion//standalone + ../../libs/math/doc/quaternion//standalone + ../../libs/math/doc/gcd//standalone + ../../libs/math/doc/sf_and_dist//standalone + ../../libs/mpi/doc//standalone + ../../libs/numeric/conversion/doc//standalone + ../../libs/optional/doc//standalone + ../../libs/program_options/doc//program_option + ../../libs/property_tree/doc//standalone + ../../libs/proto/doc//standalone + # Invalid Jamfile, doesn't use Boostbook anyway?? + #../../libs/ptr_container/doc//standalone + ../../libs/regex/doc//standalone + ../../libs/scope_exit/doc//standalone + ../../libs/signals/doc//doc + ../../libs/spirit/doc//spirit2 + ../../libs/spirit/repository/doc//spirit2_repository + ../../libs/static_assert/doc//standalone + ../../libs/thread/doc//standalone + ../../libs/tr1/doc//standalone + ../../libs/type_traits/doc//standalone + ../../libs/typeof/doc//standalone + ../../libs/units/doc//standalone + ../../libs/unordered/doc//standalone + ../../libs/variant/doc//variant-doc + ../../libs/xpressive/doc//standalone + + ../../tools/boostbook/doc//boostbook + ../../tools/build/v2/doc//jam_docs + ../../tools/quickbook/doc//standalone + ../../tools/bcp/doc//standalone + : + <location>. + <install-type>PDF + <format>pdf + ; + + +install python-tutorial-install + : + ../../libs/python/doc/tutorial/doc//tutorial + : + <location>. + <install-type>PDF + <format>pdf + <name>python_tutorial.pdf + ; + +install asio-install + : + ../../libs/asio/doc//asio + : + <location>. + <install-type>PDF + <format>pdf + <name>asio.pdf + ; + +install phoenix-install + : + ../../libs/spirit/phoenix/doc//quickbook + : + <location>. + <install-type>PDF + <format>pdf + <name>phoenix.pdf + ; + +install boost-build-install + : + ../../tools/build/v2/doc//userman + : + <location>. + <install-type>PDF + <format>pdf + <name>boost_build.pdf + ; + +install signals2-install + : + ../../libs/signals2/doc//standalone + : + <location>. + <install-type>PDF + <format>pdf + <name>signals2.pdf + <dependency>../../libs/signals2/doc//hello_world_def_code_snippet.xml + ; + +install range-install + : + ../../libs/range/doc//quickbook + : + <location>. + <install-type>PDF + <format>pdf + <name>range.pdf + ; + +# Just copy the MSM PDF over: +install msm_install : ../../libs/msm/doc/pdf/msm.pdf : <location>. ; + + + + + + + + + + + + + + + diff --git a/doc/pdf/build b/doc/pdf/build new file mode 100644 index 0000000000..7e70426d5e --- /dev/null +++ b/doc/pdf/build @@ -0,0 +1,13 @@ +#!/bin/bash +boost_version=$(grep 'define.*BOOST_LIB_VERSION' ../../boost/version.hpp | sed 's/.*"\([^"]*\)".*/\1/') +echo Boost version tag = $boost_version +bjam -a --enable-index pdf xsl:param=fop1.extensions=0 xsl:param=xep.extensions=1 2>&1 | tee build.log +mkdir boost_${boost_version}_pdf +mv *.pdf boost_${boost_version}_pdf + + + + + + + diff --git a/doc/src/boost.xml b/doc/src/boost.xml new file mode 100644 index 0000000000..c59b593e24 --- /dev/null +++ b/doc/src/boost.xml @@ -0,0 +1,757 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE boostbook PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN" + "http://www.boost.org/tools/boostbook/dtd/boostbook.dtd"> +<boostbook id="boost" xmlns:xi="http://www.w3.org/2001/XInclude" + last-revision="$Date$"> + <title>The Boost C++ Libraries BoostBook Documentation Subset</title> + + <preface id="about"> + <title>What's Included in This Document</title> + + <para>This document represents only a subset of the full Boost + documentation: that part which is generated from BoostBook or + QuickBook sources. Eventually all Boost libraries may use these + formats, but in the meantime, much of Boost's documentation is not + available here. Please + see <ulink + url="http://www.boost.org/libs">http://www.boost.org/libs</ulink> + for complete documentation. + </para> + + <para> + Documentation for some of the libraries described in this document is + available in alternative formats: + <itemizedlist> + <listitem> + <simpara><link linkend="boost">HTML</link></simpara> + </listitem> + </itemizedlist> + <itemizedlist> + <listitem> + <simpara><ulink url="http://sourceforge.net/projects/boost/files/boost-docs/">PDF</ulink></simpara> + </listitem> + </itemizedlist> + </para> + + </preface> + + <part id="libraries"> + <title>The Boost C++ Libraries (BoostBook Subset)</title> + + <xi:include href="accumulators.xml"/> + + <xi:include href="../../libs/any/doc/any.xml"/> + <xi:include href="../../libs/array/doc/array.xml"/> + + <library name="Asio" dirname="asio" html-only="1"> + <libraryinfo> + <author> + <firstname>Christopher</firstname> + <surname>Kohlhoff</surname> + </author> + + <librarypurpose>Portable networking and other low-level I/O, including sockets, timers, hostname resolution, socket iostreams, serial ports, file descriptors and Windows HANDLEs</librarypurpose> + <librarycategory name="category:io"/> + </libraryinfo> + </library> + + <library name="Bind" dirname="bind" html-only="1"> + <libraryinfo> + <author> + <firstname>Peter</firstname> + <surname>Dimov</surname> + </author> + <librarypurpose>Generalized binders for function/object/pointers and member functions</librarypurpose> + <librarycategory name="category:higher-order"/> + </libraryinfo> + </library> + + <library name="Mem_fn" dirname="bind" html-only="1" + url="../../libs/bind/mem_fn.html"> + <libraryinfo> + <author> + <firstname>Peter</firstname> + <surname>Dimov</surname> + </author> + <librarypurpose>Generalized binders for member functions</librarypurpose> + <librarycategory name="category:higher-order"/> + </libraryinfo> + </library> + + <library name="Call Traits" dirname="call_traits" html-only="1" + url="../../libs/utility/call_traits.htm"> + <libraryinfo> + <author> + <firstname>John</firstname> + <surname>Maddock</surname> + </author> + <author> + <firstname>Howard</firstname> + <surname>Hinnant</surname> + </author> + <librarypurpose>Defines types for passing parameters</librarypurpose> + <librarycategory name="category:generic"/> + </libraryinfo> + </library> + + <library name="Circular Buffer" dirname="circular_buffer" html-only="1" + url="../../libs/circular_buffer/index.html"> + <libraryinfo> + <author> + <firstname>Jan</firstname> + <surname>Gaspar</surname> + </author> + <librarypurpose>A STL compliant container also known as ring or cyclic buffer</librarypurpose> + <librarycategory name="category:containers"/> + </libraryinfo> + </library> + + <library name="Compatibility" dirname="compatibility" html-only="1"> + <libraryinfo> + <author> + <firstname>Ralf</firstname> + <surname>Grosse-Kunstleve</surname> + </author> + <author> + <firstname>Jens</firstname> + <surname>Maurer</surname> + </author> + <librarypurpose>Help for non-conforming standard libraries</librarypurpose> + <librarycategory name="category:broken"/> + </libraryinfo> + </library> + + <library name="Compose" dirname="compose" html-only="1" + url="../../libs/compose/index.htm"> + <libraryinfo> + <author> + <firstname>Nicolai</firstname> + <surname>Josuttis</surname> + </author> + + <librarypurpose>Functional composition adapters for the STL</librarypurpose> + <librarycategory name="category:higher-order"/> + </libraryinfo> + </library> + + <library name="Compressed Pair" dirname="compressed_pair" html-only="1" + url="../../libs/utility/compressed_pair.htm"> + <libraryinfo> + <author> + <firstname>John</firstname> + <surname>Maddock</surname> + </author> + <author> + <firstname>Howard</firstname> + <surname>Hinnant</surname> + </author> + <librarypurpose>Empty member optimization</librarypurpose> + <librarycategory name="category:data-structures"/> + <librarycategory name="category:misc"/> + </libraryinfo> + </library> + + <library name="Concept Check" dirname="concept_check"> + <libraryinfo> + <author> + <firstname>Jeremy</firstname> + <surname>Siek</surname> + </author> + <librarypurpose>Tools for generic programming</librarypurpose> + <librarycategory name="category:generic"/> + <librarycategory name="category:testing"/> + </libraryinfo> + <title>Boost.Concept_Check</title> + <xi:include href="../../libs/concept_check/doc/reference/concepts.xml"/> + </library> + + <library name="Config" dirname="config" html-only="1"> + <libraryinfo> + <author> + <firstname>John</firstname> + <surname>Maddock</surname> + </author> + <author> + <firstname>Beman</firstname> + <surname>Dawes</surname> + </author> + <author> + <firstname>Vesa</firstname> + <surname>Karvonen</surname> + </author> + + <librarypurpose>Helps boost library developers adapt to compiler idiosyncrasies; not intended for library users</librarypurpose> + <librarycategory name="category:broken"/> + </libraryinfo> + </library> + + <library name="Conversion" dirname="conversion" html-only="1" + url="../../libs/conversion/index.html"> + <libraryinfo> + <author> + <firstname>Dave</firstname> + <surname>Abrahams</surname> + </author> + <author> + <firstname>Kevlin</firstname> + <surname>Henney</surname> + </author> + + <librarypurpose>Numeric, polymorphic, and lexical casts</librarypurpose> + <librarycategory name="category:misc"/> + </libraryinfo> + </library> + + <library name="CRC" dirname="crc" html-only="1"> + <libraryinfo> + <author> + <firstname>Daryle</firstname> + <surname>Walker</surname> + </author> + + <librarypurpose>Cyclic Redundancy Code</librarypurpose> + <librarycategory name="category:misc"/> + </libraryinfo> + </library> + + <xi:include href="../../libs/date_time/xmldoc/date_time.xml"/> + + <library name="Dynamic Bitset" dirname="dynamic_bitset" html-only="1"> + <libraryinfo> + <author> + <firstname>Jeremy</firstname> + <surname>Siek</surname> + </author> + <author> + <firstname>Chuck</firstname> + <surname>Allison</surname> + </author> + <librarypurpose>A runtime sized version of <code>std::bitset</code></librarypurpose> + <librarycategory name="category:containers"/> + </libraryinfo> + </library> + + <library name="Format" dirname="format" html-only="1" + url="../../libs/format/index.html"> + <libraryinfo> + <author> + <firstname>Samuel</firstname> + <surname>Krempp</surname> + </author> + + <librarypurpose>Type-safe 'printf-like' format operations</librarypurpose> + <librarycategory name="category:string-text"/> + <librarycategory name="category:io"/> + </libraryinfo> + </library> + + <library name="Filesystem" dirname="filesystem" html-only="1"> + <libraryinfo> + <author> + <firstname>Beman</firstname> + <surname>Dawes</surname> + </author> + + <librarypurpose>Portable paths, iteration over directories, and other useful filesystem operations</librarypurpose> + <librarycategory name="category:misc"/> + </libraryinfo> + </library> + + <xi:include href="foreach.xml"/> + + <xi:include href="../../libs/function/doc/function.xml"/> + + <library name="Functional" dirname="functional" html-only="1"> + <libraryinfo> + <author> + <firstname>Mark</firstname> + <surname>Rodgers</surname> + </author> + <librarypurpose>Enhanced function object adaptors</librarypurpose> + <librarycategory name="category:higher-order"/> + </libraryinfo> + </library> + + <xi:include href="hash.xml"/> + + <library name="Graph" dirname="graph" html-only="1"> + <libraryinfo> + <author> + <firstname>Jeremy</firstname> + <surname>Siek</surname> + </author> + <author> + <firstname>University of Notre Dame</firstname> + <surname>Team</surname> + </author> + <librarypurpose>Generic graph components and algorithms</librarypurpose> + <librarycategory name="category:containers"/> + <librarycategory name="category:iterators"/> + <librarycategory name="category:algorithms"/> + </libraryinfo> + </library> + + <library name="Integer" dirname="integer" html-only="1" + url="../../libs/integer/index.html"> + <libraryinfo> + <author> + <firstname>various</firstname> + <surname>authors</surname> + </author> + + <librarypurpose>Headers to ease dealing with integral types</librarypurpose> + <librarycategory name="category:math"/> + </libraryinfo> + </library> + + <xi:include href="interprocess.xml"/> + + <library name="Interval" dirname="numeric/interval" html-only="1" + url="../../libs/numeric/interval/doc/index.html"> + <libraryinfo> + <author> + <firstname>Guillaume</firstname> + <surname>Melquiond</surname> + </author> + <author> + <firstname>Hervé</firstname> + <surname>Brönnimann</surname> + </author> + <author> + <firstname>Sylvain</firstname> + <surname>Pion</surname> + </author> + + <librarypurpose>Extends the usual arithmetic functions to mathematical intervals</librarypurpose> + <librarycategory name="category:math"/> + </libraryinfo> + </library> + + <xi:include href="intrusive.xml"/> + + <library name="I/O State Savers" dirname="io" html-only="1"> + <libraryinfo> + <author> + <firstname>Daryle</firstname> + <surname>Walker</surname> + </author> + + <librarypurpose>Save I/O state to prevent jumbled data</librarypurpose> + <librarycategory name="category:io"/> + </libraryinfo> + </library> + + <library name="Iterator Adaptors" dirname="utility" html-only="1" + url="../../libs/utility/iterator_adaptors.htm"> + <libraryinfo> + <author> + <firstname>Dave</firstname> + <surname>Abrahams</surname> + </author> + <author> + <firstname>Jeremy</firstname> + <surname>Siek</surname> + </author> + <author> + <firstname>John</firstname> + <surname>Potter</surname> + </author> + + <librarypurpose>Adapt a base type into a standard conforming iterator</librarypurpose> + <librarycategory name="category:iterators"/> + </libraryinfo> + </library> + + <xi:include href="../../libs/lambda/doc/lambda.xml"/> + + <library name="Math" dirname="math" html-only="1"> + <libraryinfo> + <author> + <firstname>various</firstname> + <surname>authors</surname> + </author> + + <librarypurpose>Several contributions in the domain of mathematics</librarypurpose> + <librarycategory name="category:math"/> + </libraryinfo> + </library> + + <library name="Math/Common Factor" dirname="math/common_factor" html-only="1" + url="../../libs/math/doc/common_factor.html"> + <libraryinfo> + <author> + <firstname>Daryle</firstname> + <surname>Walker</surname> + </author> + + <librarypurpose>Greatest common divisor and least common multiple</librarypurpose> + <librarycategory name="category:math"/> + </libraryinfo> + </library> + + <library name="Math/Octonion" dirname="math/octonion" html-only="1"> + <libraryinfo> + <author> + <firstname>Hubert</firstname> + <surname>Holin</surname> + </author> + + <librarypurpose>Octonions</librarypurpose> + <librarycategory name="category:math"/> + </libraryinfo> + </library> + + <library name="Math/Quaternion" dirname="math/quaternion" html-only="1"> + <libraryinfo> + <author> + <firstname>Hubert</firstname> + <surname>Holin</surname> + </author> + + <librarypurpose>Quaternions</librarypurpose> + <librarycategory name="category:math"/> + </libraryinfo> + </library> + + <library name="Math/Special Functions" dirname="math/special_functions" html-only="1"> + <libraryinfo> + <author> + <firstname>Hubert</firstname> + <surname>Holin</surname> + </author> + + <librarypurpose>Mathematical special functions such as atanh, sinc, and sinhc</librarypurpose> + <librarycategory name="category:math"/> + </libraryinfo> + </library> + + <library name="MPL" dirname="mpl" html-only="1"> + <libraryinfo> + <author> + <firstname>Aleksey</firstname> + <surname>Gurtovoy</surname> + </author> + + <librarypurpose>Template metaprogramming framework of compile-time algorithms, sequences and metafunction classes</librarypurpose> + <librarycategory name="category:template"/> + </libraryinfo> + </library> + + <library name="Multi Array" dirname="multi_array" html-only="1"> + <libraryinfo> + <author> + <firstname>Ron</firstname> + <surname>Garcia</surname> + </author> + + <librarypurpose>Multidimensional containers and adaptors for arrays of contiguous data</librarypurpose> + <librarycategory name="category:math"/> + <librarycategory name="category:containers"/> + </libraryinfo> + </library> + + <library name="Operators" dirname="utility" html-only="1"> + <libraryinfo> + <author> + <firstname>Dave</firstname> + <surname>Abrahams</surname> + </author> + <author> + <firstname>Jeremy</firstname> + <surname>Siek</surname> + </author> + + <librarypurpose>Templates ease arithmetic classes and iterators</librarypurpose> + <librarycategory name="category:generic"/> + <librarycategory name="category:iterators"/> + <librarycategory name="category:math"/> + </libraryinfo> + </library> + + <library name="Optional" dirname="optional" html-only="1"> + <libraryinfo> + <author> + <firstname>Fernando</firstname> + <surname>Cacciola</surname> + </author> + + <librarypurpose>Discriminated-union wrapper for optional values</librarypurpose> + <librarycategory name="category:misc"/> + <librarycategory name="category:data-structures"/> + </libraryinfo> + </library> + + <xi:include href="mpi.xml"/> + + <library name="Pool" dirname="pool" html-only="1"> + <libraryinfo> + <author> + <firstname>Steve</firstname> + <surname>Cleary</surname> + </author> + + <librarypurpose>Memory pool management</librarypurpose> + <librarycategory name="category:memory"/> + </libraryinfo> + </library> + + <library name="Preprocessor" dirname="preprocessor" html-only="1"> + <libraryinfo> + <author> + <firstname>Vesa</firstname> + <surname>Karvonen</surname> + </author> + <author> + <firstname>Paul</firstname> + <surname>Mensonides</surname> + </author> + + <librarypurpose>Preprocessor metaprogramming tools including repetition and recursion</librarypurpose> + <librarycategory name="category:preprocessor"/> + </libraryinfo> + </library> + + <xi:include href="../../libs/program_options/doc/program_options.xml"/> + + <library name="Property Map" dirname="property_map" html-only="1"> + <libraryinfo> + <author> + <firstname>Jeremy</firstname> + <surname>Siek</surname> + </author> + <librarypurpose>Concepts defining interfaces which map key objects to value objects</librarypurpose> + <librarycategory name="category:containers"/> + <librarycategory name="category:generic"/> + </libraryinfo> + </library> + + <xi:include href="property_tree.xml"/> + + <xi:include href="proto.xml"/> + + <library name="Python" dirname="python" html-only="1"> + <libraryinfo> + <author> + <firstname>Dave</firstname> + <surname>Abrahams</surname> + </author> + <librarypurpose>Reflects C++ classes and functions into <ulink url="http://www.python.org">Python</ulink></librarypurpose> + <librarycategory name="category:lang"/> + </libraryinfo> + </library> + + <xi:include href="random.xml"/> + + <library name="Rational" dirname="rational" html-only="1"> + <libraryinfo> + <author> + <firstname>Paul</firstname> + <surname>Moore</surname> + </author> + <librarypurpose>A rational number class</librarypurpose> + <librarycategory name="category:math"/> + </libraryinfo> + </library> + + <xi:include href="../../libs/bind/doc/ref.xml"/> + + <library name="Regex" dirname="regex" html-only="1" + url="../../libs/regex/index.html"> + <libraryinfo> + <author> + <firstname>John</firstname> + <surname>Maddock</surname> + </author> + <librarypurpose>Regular expression library</librarypurpose> + <librarycategory name="category:string-text"/> + </libraryinfo> + </library> + + <library name="Serialization" dirname="serialization" html-only="1" + url="../../libs/serialization/index.html"> + <libraryinfo> + <author> + <firstname>Robert</firstname> + <surname>Ramey</surname> + </author> + <librarypurpose>Serialization of C++ objects for persistence and marshalling</librarypurpose> + <librarycategory name="category:io"/> + </libraryinfo> + </library> + + <xi:include href="../../libs/signals/doc/signals.xml"/> + + <xi:include href="../../libs/signals2/doc/signals.xml"/> + + <library name="Smart Pointer" dirname="smart_ptr" html-only="1" + url="../../libs/smart_ptr/index.html"> + <libraryinfo> + <author> + <firstname>Greg</firstname> + <surname>Colvin</surname> + </author> + <author> + <firstname>Beman</firstname> + <surname>Dawes</surname> + </author> + <author> + <firstname>Peter</firstname> + <surname>Dimov</surname> + </author> + <author> + <firstname>Darin</firstname> + <surname>Adler</surname> + </author> + <librarypurpose>Six smart pointer class templates</librarypurpose> + <librarycategory name="category:memory"/> + </libraryinfo> + </library> + + <library name="Spirit" dirname="spirit" html-only="1"> + <libraryinfo> + <author> + <firstname>Joel</firstname> + <surname>de Guzman</surname> + </author> + <author> + <firstname>team</firstname> + </author> + + <librarypurpose>LL parser framework represents parsers directly as EBNF grammars in inlined C++</librarypurpose> + <librarycategory name="category:text"/> + <librarycategory name="category:parsing"/> + </libraryinfo> + </library> + + <xi:include href="static_assert.xml"/> + + <xi:include href="../../libs/algorithm/string/doc/string_algo.xml"/> + + <library name="Test" dirname="test" html-only="1"> + <libraryinfo> + <author> + <firstname>Gennadiy</firstname> + <surname>Rozental</surname> + </author> + <librarypurpose>Support for simple program testing, full unit testing, and for program execution monitoring</librarypurpose> + <librarycategory name="category:testing"/> + </libraryinfo> + </library> + + <xi:include href="thread.xml"/> + + <library name="Timer" dirname="timer" html-only="1" + url="../../libs/timer/index.html"> + <libraryinfo> + <author> + <firstname>Beman</firstname> + <surname>Dawes</surname> + </author> + <librarypurpose>Event timer, progress timer, and progress display classes</librarypurpose> + <librarycategory name="category:misc"/> + </libraryinfo> + </library> + + <library name="Tokenizer" dirname="tokenizer" html-only="1" + url="../../libs/tokenizer/index.html"> + <libraryinfo> + <author> + <firstname>John</firstname> + <surname>Bandela</surname> + </author> + <librarypurpose>Break of a string or other character sequence into a series of tokens</librarypurpose> + <librarycategory name="category:string-text"/> + <librarycategory name="category:iterators"/> + </libraryinfo> + </library> + + <xi:include href="tr1.xml"/> + <xi:include href="../../libs/logic/doc/tribool.boostbook"/> + + <library name="Tuple" dirname="tuple" html-only="1"> + <libraryinfo> + <author> + <firstname>Jaakko</firstname> + <surname>Järvi</surname> + </author> + <librarypurpose>Ease definition of functions returning multiple values, and more</librarypurpose> + <librarycategory name="category:data-structures"/> + </libraryinfo> + </library> + + <library name="Type Traits" dirname="type_traits" html-only="1"> + <libraryinfo> + <author> + <firstname>John</firstname> + <surname>Maddock</surname> + </author> + <librarypurpose>Meta-programming support library.</librarypurpose> + <librarycategory name="category:generic"/> + </libraryinfo> + </library> + + <xi:include href="typeof.xml"/> + + <library name="uBLAS" dirname="numeric/ublas" html-only="1"> + <libraryinfo> + <author> + <firstname>Joerg</firstname> + <surname>Walter</surname> + </author> + <author> + <firstname>Mathias</firstname> + <surname>Koch</surname> + </author> + <librarypurpose>Basic linear algebra for dense, packed and sparse matrices</librarypurpose> + <librarycategory name="category:math"/> + </libraryinfo> + </library> + + <xi:include href="units.xml"/> + + <xi:include href="unordered.xml"/> + + <library name="Utility" dirname="utility" html-only="1"> + <libraryinfo> + <author> + <firstname>Dave</firstname> + <surname>Abrahams</surname> + </author> + <author> + <firstname>others</firstname> + </author> + + <librarypurpose>Class noncopyable plus <functionname>checked_delete</functionname>, <functionname>checked_array_delete</functionname>, <functionname>next</functionname>, <functionname>prior</functionname> function templates, plus base-from-member idiom</librarypurpose> + <librarycategory name="category:misc"/> + <librarycategory name="category:memory"/> + <librarycategory name="category:algorithms"/> + </libraryinfo> + </library> + <xi:include href="../../libs/variant/doc/variant.xml"/> + + <xi:include href="xpressive.xml"/> + + </part> + + <part id="tools"> + <title>Boost Tools</title> + <partintro> + <para> + Boost developers, testers, and maintainers have developed various programs to + help with the administration of the Boost Libraries. Like everything else about + Boost, these tools are available in source form, and are part of the regular + Boost distribution. + </para> + <para> + Users may find these tools useful when porting Boost libraries to a new platform, + or for use with their own applications. + </para> + </partintro> + <xi:include href="../../tools/boostbook/doc/boostbook.xml"/> + <xi:include href="quickbook.xml"/> + <xi:include href="jam_docs.xml"/> + <xi:include href="../../tools/build/v2/doc/src/userman.xml"/> + </part> +</boostbook> + + diff --git a/doc/src/boostbook.css b/doc/src/boostbook.css new file mode 100644 index 0000000000..c60e100318 --- /dev/null +++ b/doc/src/boostbook.css @@ -0,0 +1,601 @@ +/*============================================================================= + Copyright (c) 2004 Joel de Guzman + http://spirit.sourceforge.net/ + + Distributed under the Boost Software License, Version 1.0. (See accompany- + ing file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +=============================================================================*/ + +/*============================================================================= + Body defaults +=============================================================================*/ + + body + { + margin: 1em; + font-family: sans-serif; + } + +/*============================================================================= + Paragraphs +=============================================================================*/ + + p + { + text-align: left; + font-size: 10pt; + line-height: 1.15; + } + +/*============================================================================= + Program listings +=============================================================================*/ + + /* Code on paragraphs */ + p tt.computeroutput + { + font-size: 9pt; + } + + pre.synopsis + { + font-size: 9pt; + margin: 1pc 4% 0pc 4%; + padding: 0.5pc 0.5pc 0.5pc 0.5pc; + } + + .programlisting, + .screen + { + font-size: 9pt; + display: block; + margin: 1pc 4% 0pc 4%; + padding: 0.5pc 0.5pc 0.5pc 0.5pc; + } + + /* Program listings in tables don't get borders */ + td .programlisting, + td .screen + { + margin: 0pc 0pc 0pc 0pc; + padding: 0pc 0pc 0pc 0pc; + } + +/*============================================================================= + Headings +=============================================================================*/ + + h1, h2, h3, h4, h5, h6 + { + text-align: left; + margin: 1em 0em 0.5em 0em; + font-weight: bold; + } + + h1 { font: 140% } + h2 { font: bold 140% } + h3 { font: bold 130% } + h4 { font: bold 120% } + h5 { font: italic 110% } + h6 { font: italic 100% } + + /* Top page titles */ + title, + h1.title, + h2.title + h3.title, + h4.title, + h5.title, + h6.title, + .refentrytitle + { + font-weight: bold; + margin-bottom: 1pc; + } + + h1.title { font-size: 140% } + h2.title { font-size: 140% } + h3.title { font-size: 130% } + h4.title { font-size: 120% } + h5.title { font-size: 110% } + h6.title { font-size: 100% } + + .section h1 + { + margin: 0em 0em 0.5em 0em; + font-size: 140%; + } + + .section h2 { font-size: 140% } + .section h3 { font-size: 130% } + .section h4 { font-size: 120% } + .section h5 { font-size: 110% } + .section h6 { font-size: 100% } + + /* Code on titles */ + h1 tt.computeroutput { font-size: 140% } + h2 tt.computeroutput { font-size: 140% } + h3 tt.computeroutput { font-size: 130% } + h4 tt.computeroutput { font-size: 130% } + h5 tt.computeroutput { font-size: 130% } + h6 tt.computeroutput { font-size: 130% } + + +/*============================================================================= + Author +=============================================================================*/ + + h3.author + { + font-size: 100% + } + +/*============================================================================= + Lists +=============================================================================*/ + + li + { + font-size: 10pt; + line-height: 1.3; + } + + /* Unordered lists */ + ul + { + text-align: left; + } + + /* Ordered lists */ + ol + { + text-align: left; + } + +/*============================================================================= + Links +=============================================================================*/ + + a + { + text-decoration: none; /* no underline */ + } + + a:hover + { + text-decoration: underline; + } + +/*============================================================================= + Spirit style navigation +=============================================================================*/ + + .spirit-nav + { + text-align: right; + } + + .spirit-nav a + { + color: white; + padding-left: 0.5em; + } + + .spirit-nav img + { + border-width: 0px; + } + +/*============================================================================= + Copyright footer +=============================================================================*/ + .copyright-footer + { + text-align: right; + font-size: 70%; + } + + .copyright-footer p + { + text-align: right; + font-size: 80%; + } + +/*============================================================================= + Table of contents +=============================================================================*/ + + .toc + { + margin: 1pc 4% 0pc 4%; + padding: 0.1pc 1pc 0.1pc 1pc; + font-size: 80%; + line-height: 1.15; + } + + .boost-toc + { + float: right; + padding: 0.5pc; + } + + /* Code on toc */ + .toc .computeroutput { font-size: 120% } + +/*============================================================================= + Tables +=============================================================================*/ + + .table-title, + div.table p.title + { + margin-left: 4%; + padding-right: 0.5em; + padding-left: 0.5em; + } + + .informaltable table, + .table table + { + width: 92%; + margin-left: 4%; + margin-right: 4%; + } + + div.informaltable table, + div.table table + { + padding: 4px; + } + + /* Table Cells */ + div.informaltable table tr td, + div.table table tr td + { + padding: 0.5em; + text-align: left; + font-size: 9pt; + } + + div.informaltable table tr th, + div.table table tr th + { + padding: 0.5em 0.5em 0.5em 0.5em; + border: 1pt solid white; + font-size: 80%; + } + + table.simplelist + { + width: auto !important; + margin: 0em !important; + padding: 0em !important; + border: none !important; + } + table.simplelist td + { + margin: 0em !important; + padding: 0em !important; + text-align: left !important; + font-size: 9pt !important; + border: none !important; + } + +/*============================================================================= + Blurbs +=============================================================================*/ + + div.note, + div.tip, + div.important, + div.caution, + div.warning, + p.blurb + { + font-size: 9pt; /* A little bit smaller than the main text */ + line-height: 1.2; + display: block; + margin: 1pc 4% 0pc 4%; + padding: 0.5pc 0.5pc 0.5pc 0.5pc; + } + + p.blurb img + { + padding: 1pt; + } + +/*============================================================================= + Variable Lists +=============================================================================*/ + + div.variablelist + { + margin: 1em 0; + } + + /* Make the terms in definition lists bold */ + div.variablelist dl dt, + span.term + { + font-weight: bold; + font-size: 10pt; + } + + div.variablelist table tbody tr td + { + text-align: left; + vertical-align: top; + padding: 0em 2em 0em 0em; + font-size: 10pt; + margin: 0em 0em 0.5em 0em; + line-height: 1; + } + + div.variablelist dl dt + { + margin-bottom: 0.2em; + } + + div.variablelist dl dd + { + margin: 0em 0em 0.5em 2em; + font-size: 10pt; + } + + div.variablelist table tbody tr td p, + div.variablelist dl dd p + { + margin: 0em 0em 0.5em 0em; + line-height: 1; + } + +/*============================================================================= + Misc +=============================================================================*/ + + /* Title of books and articles in bibliographies */ + span.title + { + font-style: italic; + } + + span.underline + { + text-decoration: underline; + } + + span.strikethrough + { + text-decoration: line-through; + } + + /* Copyright, Legal Notice */ + div div.legalnotice p + { + text-align: left + } + +/*============================================================================= + Colors +=============================================================================*/ + + @media screen + { + body { + background-color: #FFFFFF; + color: #000000; + } + + /* Syntax Highlighting */ + .keyword { color: #0000AA; } + .identifier { color: #000000; } + .special { color: #707070; } + .preprocessor { color: #402080; } + .char { color: teal; } + .comment { color: #800000; } + .string { color: teal; } + .number { color: teal; } + .white_bkd { background-color: #FFFFFF; } + .dk_grey_bkd { background-color: #999999; } + + /* Links */ + a, a .keyword, a .identifier, a .special, a .preprocessor + a .char, a .comment, a .string, a .number + { + color: #005a9c; + } + + a:visited, a:visited .keyword, a:visited .identifier, + a:visited .special, a:visited .preprocessor a:visited .char, + a:visited .comment, a:visited .string, a:visited .number + { + color: #9c5a9c; + } + + h1 a, h2 a, h3 a, h4 a, h5 a, h6 a, + h1 a:hover, h2 a:hover, h3 a:hover, h4 a:hover, h5 a:hover, h6 a:hover, + h1 a:visited, h2 a:visited, h3 a:visited, h4 a:visited, h5 a:visited, h6 a:visited + { + text-decoration: none; /* no underline */ + color: #000000; + } + + /* Copyright, Legal Notice */ + .copyright + { + color: #666666; + font-size: small; + } + + div div.legalnotice p + { + color: #666666; + } + + /* Program listing */ + pre.synopsis + { + border: 1px solid #DCDCDC; + } + + .programlisting, + .screen + { + border: 1px solid #DCDCDC; + } + + td .programlisting, + td .screen + { + border: 0px solid #DCDCDC; + } + + /* Blurbs */ + div.note, + div.tip, + div.important, + div.caution, + div.warning, + p.blurb + { + border: 1px solid #DCDCDC; + } + + /* Table of contents */ + .toc + { + border: 1px solid #DCDCDC; + } + + /* Tables */ + div.informaltable table tr td, + div.table table tr td + { + border: 1px solid #DCDCDC; + } + + div.informaltable table tr th, + div.table table tr th + { + background-color: #F0F0F0; + border: 1px solid #DCDCDC; + } + + .copyright-footer + { + color: #8F8F8F; + } + + /* Misc */ + span.highlight + { + color: #00A000; + } + } + + @media print + { + /* Links */ + a + { + color: black; + } + + a:visited + { + color: black; + } + + .spirit-nav + { + display: none; + } + + /* Program listing */ + pre.synopsis + { + border: 1px solid gray; + } + + .programlisting, + .screen + { + border: 1px solid gray; + } + + td .programlisting, + td .screen + { + border: 0px solid #DCDCDC; + } + + /* Table of contents */ + .toc + { + border: 1px solid gray; + } + + .informaltable table, + .table table + { + border: 1px solid gray; + border-collapse: collapse; + } + + /* Tables */ + div.informaltable table tr td, + div.table table tr td + { + border: 1px solid gray; + } + + div.informaltable table tr th, + div.table table tr th + { + border: 1px solid gray; + } + + table.simplelist tr td + { + border: none !important; + } + + /* Misc */ + span.highlight + { + font-weight: bold; + } + } + +/*============================================================================= + Images +=============================================================================*/ + + span.inlinemediaobject img + { + vertical-align: middle; + } + +/*============================================================================== + Super and Subscript: style so that line spacing isn't effected, see + http://www.adobe.com/cfusion/communityengine/index.cfm?event=showdetails&productId=1&postId=5341 +==============================================================================*/ + +sup, +sub { + height: 0; + line-height: 1; + vertical-align: baseline; + _vertical-align: bottom; + position: relative; + +} + +sup { + bottom: 1ex; +} + +sub { + top: .5ex; +} + diff --git a/doc/src/docutils.css b/doc/src/docutils.css new file mode 100644 index 0000000000..620cf86102 --- /dev/null +++ b/doc/src/docutils.css @@ -0,0 +1,275 @@ +/* +:Author: David Goodger +:Contact: goodger@python.org +:Date: $Date$ +:Revision: $Revision$ +:Copyright: This stylesheet has been placed in the public domain. + +Default cascading style sheet for the HTML output of Docutils. + +See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to +customize this style sheet. +*/ + +/* used to remove borders from tables and images */ +.borderless, table.borderless td, table.borderless th { + border: 0 } + +table.borderless td, table.borderless th { + /* Override padding for "table.docutils td" with "! important". + The right padding separates the table cells. */ + padding: 0 0.5em 0 0 ! important } + +.first { + /* Override more specific margin styles with "! important". */ + margin-top: 0 ! important } + +.last, .with-subtitle { + margin-bottom: 0 ! important } + +.hidden { + display: none } + +a.toc-backref { + text-decoration: none ; + color: black } + +blockquote.epigraph { + margin: 2em 5em ; } + +dl.docutils dd { + margin-bottom: 0.5em } + +/* Uncomment (and remove this text!) to get bold-faced definition list terms +dl.docutils dt { + font-weight: bold } +*/ + +div.abstract { + margin: 2em 5em } + +div.abstract p.topic-title { + font-weight: bold ; + text-align: center } + +div.admonition, div.attention, div.caution, div.danger, div.error, +div.hint, div.important, div.note, div.tip, div.warning { + margin: 2em ; + border: medium outset ; + padding: 1em } + +div.admonition p.admonition-title, div.hint p.admonition-title, +div.important p.admonition-title, div.note p.admonition-title, +div.tip p.admonition-title { + font-weight: bold ; + font-family: sans-serif } + +div.attention p.admonition-title, div.caution p.admonition-title, +div.danger p.admonition-title, div.error p.admonition-title, +div.warning p.admonition-title { + color: red ; + font-weight: bold ; + font-family: sans-serif } + +/* Uncomment (and remove this text!) to get reduced vertical space in + compound paragraphs. +div.compound .compound-first, div.compound .compound-middle { + margin-bottom: 0.5em } + +div.compound .compound-last, div.compound .compound-middle { + margin-top: 0.5em } +*/ + +div.dedication { + margin: 2em 5em ; + text-align: center ; + font-style: italic } + +div.dedication p.topic-title { + font-weight: bold ; + font-style: normal } + +div.figure { + margin-left: 2em ; + margin-right: 2em } + +div.footer, div.header { + clear: both; + font-size: smaller } + +div.line-block { + display: block ; + margin-top: 1em ; + margin-bottom: 1em } + +div.line-block div.line-block { + margin-top: 0 ; + margin-bottom: 0 ; + margin-left: 1.5em } + +div.sidebar { + margin-left: 1em ; + border: medium outset ; + padding: 1em ; + background-color: #ffffee ; + width: 40% ; + float: right ; + clear: right } + +div.sidebar p.rubric { + font-family: sans-serif ; + font-size: medium } + +div.system-messages { + margin: 5em } + +div.system-messages h1 { + color: red } + +div.system-message { + border: medium outset ; + padding: 1em } + +div.system-message p.system-message-title { + color: red ; + font-weight: bold } + +div.topic { + margin: 2em } + +h1.section-subtitle, h2.section-subtitle, h3.section-subtitle, +h4.section-subtitle, h5.section-subtitle, h6.section-subtitle { + margin-top: 0.4em } + +h1.title { + text-align: center } + +h2.subtitle { + text-align: center } + +hr.docutils { + width: 75% } + +img.align-left { + clear: left } + +img.align-right { + clear: right } + +ol.simple, ul.simple { + margin-bottom: 1em } + +ol.arabic { + list-style: decimal } + +ol.loweralpha { + list-style: lower-alpha } + +ol.upperalpha { + list-style: upper-alpha } + +ol.lowerroman { + list-style: lower-roman } + +ol.upperroman { + list-style: upper-roman } + +p.attribution { + text-align: right ; + margin-left: 50% } + +p.caption { + font-style: italic } + +p.credits { + font-style: italic ; + font-size: smaller } + +p.label { + white-space: nowrap } + +p.rubric { + font-weight: bold ; + font-size: larger ; + color: maroon ; + text-align: center } + +p.sidebar-title { + font-family: sans-serif ; + font-weight: bold ; + font-size: larger } + +p.sidebar-subtitle { + font-family: sans-serif ; + font-weight: bold } + +p.topic-title { + font-weight: bold } + +pre.address { + margin-bottom: 0 ; + margin-top: 0 ; + font-family: serif ; + font-size: 100% } + +pre.literal-block, pre.doctest-block { + margin-left: 2em ; + margin-right: 2em } + +span.classifier { + font-family: sans-serif ; + font-style: oblique } + +span.classifier-delimiter { + font-family: sans-serif ; + font-weight: bold } + +span.interpreted { + font-family: sans-serif } + +span.option { + white-space: nowrap } + +span.pre { + white-space: pre } + +span.problematic { + color: red } + +span.section-subtitle { + /* font-size relative to parent (h1..h6 element) */ + font-size: 80% } + +table.citation { + border-left: solid 1px gray; + margin-left: 1px } + +table.docinfo { + margin: 2em 4em } + +table.docutils { + margin-top: 0.5em ; + margin-bottom: 0.5em } + +table.footnote { + border-left: solid 1px black; + margin-left: 1px } + +table.docutils td, table.docutils th, +table.docinfo td, table.docinfo th { + padding-left: 0.5em ; + padding-right: 0.5em ; + vertical-align: top } + +table.docutils th.field-name, table.docinfo th.docinfo-name { + font-weight: bold ; + text-align: left ; + white-space: nowrap ; + padding-left: 0 } + +h1 tt.docutils, h2 tt.docutils, h3 tt.docutils, +h4 tt.docutils, h5 tt.docutils, h6 tt.docutils { + font-size: 100% } + +ul.auto-toc { + list-style-type: none } diff --git a/doc/src/images/alert.png b/doc/src/images/alert.png Binary files differnew file mode 100644 index 0000000000..b4645bc7e7 --- /dev/null +++ b/doc/src/images/alert.png diff --git a/doc/src/images/blank.png b/doc/src/images/blank.png Binary files differnew file mode 100644 index 0000000000..764bf4f0c3 --- /dev/null +++ b/doc/src/images/blank.png diff --git a/doc/src/images/callouts/1.png b/doc/src/images/callouts/1.png Binary files differnew file mode 100644 index 0000000000..6003ad3af4 --- /dev/null +++ b/doc/src/images/callouts/1.png diff --git a/doc/src/images/callouts/1.svg b/doc/src/images/callouts/1.svg new file mode 100644 index 0000000000..e2e87dc526 --- /dev/null +++ b/doc/src/images/callouts/1.svg @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M10.428,10.411h0.56c3.78,0,4.788-1.96,4.872-3.444h3.22v19.88h-3.92V13.154h-4.732V10.411z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/10.png b/doc/src/images/callouts/10.png Binary files differnew file mode 100644 index 0000000000..0426f516a4 --- /dev/null +++ b/doc/src/images/callouts/10.png diff --git a/doc/src/images/callouts/10.svg b/doc/src/images/callouts/10.svg new file mode 100644 index 0000000000..4740f587bd --- /dev/null +++ b/doc/src/images/callouts/10.svg @@ -0,0 +1,18 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M3.815,10.758h0.48c3.24,0,4.104-1.681,4.176-2.952h2.76v17.04h-3.36V13.11H3.815V10.758z"/> + <path style="fill:#FFFFFF;" d="M22.175,7.806c4.009,0,5.904,2.76,5.904,8.736c0,5.975-1.896,8.76-5.904,8.76 + c-4.008,0-5.904-2.785-5.904-8.76C16.271,10.566,18.167,7.806,22.175,7.806z M22.175,22.613c1.921,0,2.448-1.68,2.448-6.071 + c0-4.393-0.527-6.049-2.448-6.049c-1.92,0-2.448,1.656-2.448,6.049C19.727,20.934,20.255,22.613,22.175,22.613z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/11.png b/doc/src/images/callouts/11.png Binary files differnew file mode 100644 index 0000000000..821afc4fa8 --- /dev/null +++ b/doc/src/images/callouts/11.png diff --git a/doc/src/images/callouts/11.svg b/doc/src/images/callouts/11.svg new file mode 100644 index 0000000000..09a0b2cf71 --- /dev/null +++ b/doc/src/images/callouts/11.svg @@ -0,0 +1,16 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M5.209,10.412h0.48c3.24,0,4.104-1.681,4.176-2.952h2.76V24.5h-3.36V12.764H5.209V10.412z"/> + <path style="fill:#FFFFFF;" d="M18.553,10.412h0.48c3.24,0,4.104-1.681,4.176-2.952h2.76V24.5h-3.359V12.764h-4.056V10.412z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/12.png b/doc/src/images/callouts/12.png Binary files differnew file mode 100644 index 0000000000..7cec72720f --- /dev/null +++ b/doc/src/images/callouts/12.png diff --git a/doc/src/images/callouts/12.svg b/doc/src/images/callouts/12.svg new file mode 100644 index 0000000000..9794044c71 --- /dev/null +++ b/doc/src/images/callouts/12.svg @@ -0,0 +1,18 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M4.813,10.412h0.48c3.24,0,4.104-1.681,4.176-2.952h2.76V24.5h-3.36V12.764H4.813V10.412z"/> + <path style="fill:#FFFFFF;" d="M17.316,13.484c0-5.545,4.056-6.024,5.568-6.024c3.265,0,5.856,1.92,5.856,5.376 + c0,2.928-1.896,4.416-3.553,5.544c-2.256,1.584-3.432,2.353-3.815,3.145h7.392V24.5h-11.64c0.12-1.992,0.264-4.08,3.96-6.768 + c3.072-2.232,4.296-3.097,4.296-5.017c0-1.128-0.72-2.424-2.353-2.424c-2.352,0-2.423,1.944-2.447,3.192H17.316z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/13.png b/doc/src/images/callouts/13.png Binary files differnew file mode 100644 index 0000000000..5b41e02a67 --- /dev/null +++ b/doc/src/images/callouts/13.png diff --git a/doc/src/images/callouts/13.svg b/doc/src/images/callouts/13.svg new file mode 100644 index 0000000000..64268bb4fa --- /dev/null +++ b/doc/src/images/callouts/13.svg @@ -0,0 +1,20 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M3.813,10.412h0.48c3.24,0,4.104-1.681,4.176-2.952h2.76V24.5h-3.36V12.764H3.813V10.412z"/> + <path style="fill:#FFFFFF;" d="M20.611,14.636h0.529c1.008,0,2.855-0.096,2.855-2.304c0-0.624-0.288-2.185-2.137-2.185 + c-2.303,0-2.303,2.185-2.303,2.784h-3.12c0-3.191,1.8-5.472,5.64-5.472c2.279,0,5.279,1.152,5.279,4.752 + c0,1.728-1.08,2.808-2.039,3.24V15.5c0.6,0.168,2.568,1.056,2.568,3.96c0,3.216-2.377,5.496-5.809,5.496 + c-1.607,0-5.928-0.36-5.928-5.688h3.288l-0.024,0.024c0,0.912,0.24,2.976,2.496,2.976c1.344,0,2.52-0.911,2.52-2.808 + c0-2.328-2.256-2.424-3.816-2.424V14.636z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/14.png b/doc/src/images/callouts/14.png Binary files differnew file mode 100644 index 0000000000..de5bdbd3eb --- /dev/null +++ b/doc/src/images/callouts/14.png diff --git a/doc/src/images/callouts/14.svg b/doc/src/images/callouts/14.svg new file mode 100644 index 0000000000..469aa97487 --- /dev/null +++ b/doc/src/images/callouts/14.svg @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M4.146,10.412h0.48c3.24,0,4.104-1.681,4.176-2.952h2.76V24.5h-3.36V12.764H4.146V10.412z"/> + <path style="fill:#FFFFFF;" d="M28.457,20.732h-1.896V24.5h-3.36v-3.768h-6.72v-2.904L22.746,7.46h3.815v10.656h1.896V20.732z + M23.201,18.116c0-4.128,0.072-6.792,0.072-7.32h-0.048l-4.272,7.32H23.201z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/15.png b/doc/src/images/callouts/15.png Binary files differnew file mode 100644 index 0000000000..3fd6ac3860 --- /dev/null +++ b/doc/src/images/callouts/15.png diff --git a/doc/src/images/callouts/15.svg b/doc/src/images/callouts/15.svg new file mode 100644 index 0000000000..8202233ef0 --- /dev/null +++ b/doc/src/images/callouts/15.svg @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M3.479,11.079h0.48c3.24,0,4.104-1.681,4.176-2.952h2.76v17.04h-3.36V13.43H3.479V11.079z"/> + <path style="fill:#FFFFFF;" d="M19.342,14.943c0.625-0.433,1.392-0.937,3.048-0.937c2.279,0,5.16,1.584,5.16,5.496 + c0,2.328-1.176,6.121-6.192,6.121c-2.664,0-5.376-1.584-5.544-5.016h3.36c0.144,1.391,0.888,2.326,2.376,2.326 + c1.607,0,2.544-1.367,2.544-3.191c0-1.512-0.72-3.047-2.496-3.047c-0.456,0-1.608,0.023-2.256,1.223l-3-0.143l1.176-9.361h9.36 + v2.832h-6.937L19.342,14.943z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/16.svg b/doc/src/images/callouts/16.svg new file mode 100644 index 0000000000..01d6bf8164 --- /dev/null +++ b/doc/src/images/callouts/16.svg @@ -0,0 +1,20 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M3.813,10.412h0.48c3.24,0,4.104-1.681,4.176-2.952h2.76V24.5h-3.36V12.764H3.813V10.412z"/> + <path style="fill:#FFFFFF;" d="M24.309,11.78c-0.097-0.96-0.721-1.633-1.969-1.633c-2.184,0-2.688,2.496-2.808,4.704L19.58,14.9 + c0.456-0.624,1.296-1.416,3.191-1.416c3.529,0,5.209,2.712,5.209,5.256c0,3.72-2.28,6.216-5.568,6.216 + c-5.16,0-6.168-4.32-6.168-8.568c0-3.24,0.432-8.928,6.336-8.928c0.695,0,2.641,0.264,3.48,1.104 + c0.936,0.912,1.271,1.416,1.584,3.217H24.309z M22.172,16.172c-1.271,0-2.568,0.792-2.568,2.928c0,1.849,1.056,3.168,2.664,3.168 + c1.225,0,2.353-0.936,2.353-3.239C24.62,16.868,23.229,16.172,22.172,16.172z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/17.svg b/doc/src/images/callouts/17.svg new file mode 100644 index 0000000000..0a04c5560e --- /dev/null +++ b/doc/src/images/callouts/17.svg @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M3.479,11.079h0.48c3.24,0,4.104-1.681,4.176-2.952h2.76v17.04h-3.36V13.43H3.479V11.079z"/> + <path style="fill:#FFFFFF;" d="M27.838,11.006c-1.631,1.776-5.807,6.816-6.215,14.16h-3.457c0.36-6.816,4.632-12.24,6.072-13.776 + h-8.472l0.072-2.976h12V11.006z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/18.svg b/doc/src/images/callouts/18.svg new file mode 100644 index 0000000000..1cb891b34d --- /dev/null +++ b/doc/src/images/callouts/18.svg @@ -0,0 +1,21 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M4.813,10.412h0.48c3.24,0,4.104-1.681,4.176-2.952h2.76V24.5h-3.36V12.764H4.813V10.412z"/> + <path style="fill:#FFFFFF;" d="M23.172,24.956c-4.392,0-5.904-2.856-5.904-5.185c0-0.863,0-3.119,2.592-4.319 + c-1.344-0.672-2.064-1.752-2.064-3.336c0-2.904,2.328-4.656,5.304-4.656c3.528,0,5.4,2.088,5.4,4.44 + c0,1.464-0.6,2.712-1.968,3.432c1.632,0.815,2.544,1.896,2.544,4.104C29.076,21.596,27.684,24.956,23.172,24.956z M23.124,16.916 + c-1.224,0-2.4,0.792-2.4,2.64c0,1.632,0.936,2.712,2.472,2.712c1.752,0,2.424-1.512,2.424-2.688 + C25.62,18.38,24.996,16.916,23.124,16.916z M25.284,12.26c0-1.296-0.888-2.112-1.968-2.112c-1.512,0-2.305,0.864-2.305,2.112 + c0,1.008,0.744,2.112,2.185,2.112C24.516,14.372,25.284,13.484,25.284,12.26z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/19.svg b/doc/src/images/callouts/19.svg new file mode 100644 index 0000000000..e6fbb179fc --- /dev/null +++ b/doc/src/images/callouts/19.svg @@ -0,0 +1,20 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M4.146,10.746h0.48c3.24,0,4.104-1.681,4.176-2.952h2.76v17.041h-3.36V13.097H4.146V10.746z"/> + <path style="fill:#FFFFFF;" d="M20.225,20.898v0.023c0.192,1.176,0.936,1.68,1.968,1.68c1.392,0,2.783-1.176,2.808-4.752 + l-0.048-0.049c-0.768,1.152-2.088,1.441-3.24,1.441c-3.264,0-5.16-2.473-5.16-5.329c0-4.176,2.472-6.12,5.808-6.12 + c5.904,0,6,6.36,6,8.76c0,6.601-3.12,8.736-6.192,8.736c-2.904,0-4.992-1.68-5.28-4.391H20.225z M22.434,16.553 + c1.176,0,2.472-0.84,2.472-2.855c0-1.944-0.841-3.145-2.568-3.145c-0.864,0-2.424,0.433-2.424,2.88 + C19.913,16.001,21.161,16.553,22.434,16.553z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/2.png b/doc/src/images/callouts/2.png Binary files differnew file mode 100644 index 0000000000..f7c1578846 --- /dev/null +++ b/doc/src/images/callouts/2.png diff --git a/doc/src/images/callouts/2.svg b/doc/src/images/callouts/2.svg new file mode 100644 index 0000000000..07d03395d0 --- /dev/null +++ b/doc/src/images/callouts/2.svg @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M9.668,12.328c0-6.469,4.732-7.028,6.496-7.028c3.808,0,6.833,2.24,6.833,6.271 + c0,3.416-2.213,5.152-4.145,6.469c-2.632,1.848-4.004,2.744-4.452,3.668h8.624v3.472H9.444c0.14-2.324,0.308-4.76,4.62-7.896 + c3.584-2.604,5.012-3.612,5.012-5.853c0-1.315-0.84-2.828-2.744-2.828c-2.744,0-2.828,2.269-2.856,3.725H9.668z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/20.svg b/doc/src/images/callouts/20.svg new file mode 100644 index 0000000000..ccbfd40319 --- /dev/null +++ b/doc/src/images/callouts/20.svg @@ -0,0 +1,20 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M3.972,13.484c0-5.545,4.056-6.024,5.568-6.024c3.264,0,5.856,1.92,5.856,5.376 + c0,2.928-1.896,4.416-3.552,5.544c-2.256,1.584-3.432,2.353-3.816,3.145h7.392V24.5H3.78c0.12-1.992,0.264-4.08,3.96-6.768 + c3.072-2.232,4.296-3.097,4.296-5.017c0-1.128-0.72-2.424-2.352-2.424c-2.352,0-2.424,1.944-2.448,3.192H3.972z"/> + <path style="fill:#FFFFFF;" d="M23.172,7.46c4.008,0,5.904,2.76,5.904,8.736c0,5.976-1.896,8.76-5.904,8.76 + s-5.904-2.784-5.904-8.76C17.268,10.22,19.164,7.46,23.172,7.46z M23.172,22.268c1.92,0,2.448-1.68,2.448-6.071 + c0-4.393-0.528-6.049-2.448-6.049s-2.448,1.656-2.448,6.049C20.724,20.588,21.252,22.268,23.172,22.268z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/21.svg b/doc/src/images/callouts/21.svg new file mode 100644 index 0000000000..93ec53fdd9 --- /dev/null +++ b/doc/src/images/callouts/21.svg @@ -0,0 +1,18 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M5.306,13.151c0-5.545,4.056-6.024,5.568-6.024c3.264,0,5.856,1.92,5.856,5.376 + c0,2.928-1.896,4.416-3.552,5.544c-2.256,1.584-3.432,2.353-3.816,3.145h7.392v2.976H5.114c0.12-1.992,0.264-4.08,3.96-6.768 + c3.072-2.232,4.296-3.097,4.296-5.017c0-1.128-0.72-2.424-2.352-2.424c-2.352,0-2.424,1.944-2.448,3.192H5.306z"/> + <path style="fill:#FFFFFF;" d="M19.49,10.079h0.48c3.239,0,4.104-1.681,4.176-2.952h2.761v17.04h-3.361V12.431H19.49V10.079z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/22.svg b/doc/src/images/callouts/22.svg new file mode 100644 index 0000000000..f48c5f3fd1 --- /dev/null +++ b/doc/src/images/callouts/22.svg @@ -0,0 +1,20 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M3.972,13.484c0-5.545,4.056-6.024,5.568-6.024c3.264,0,5.856,1.92,5.856,5.376 + c0,2.928-1.896,4.416-3.552,5.544c-2.256,1.584-3.432,2.353-3.816,3.145h7.392V24.5H3.78c0.12-1.992,0.264-4.08,3.96-6.768 + c3.072-2.232,4.296-3.097,4.296-5.017c0-1.128-0.72-2.424-2.352-2.424c-2.352,0-2.424,1.944-2.448,3.192H3.972z"/> + <path style="fill:#FFFFFF;" d="M17.316,13.484c0-5.545,4.056-6.024,5.568-6.024c3.265,0,5.856,1.92,5.856,5.376 + c0,2.928-1.896,4.416-3.553,5.544c-2.256,1.584-3.432,2.353-3.815,3.145h7.392V24.5h-11.64c0.12-1.992,0.264-4.08,3.96-6.768 + c3.072-2.232,4.296-3.097,4.296-5.017c0-1.128-0.72-2.424-2.353-2.424c-2.352,0-2.423,1.944-2.447,3.192H17.316z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/23.svg b/doc/src/images/callouts/23.svg new file mode 100644 index 0000000000..6624212957 --- /dev/null +++ b/doc/src/images/callouts/23.svg @@ -0,0 +1,22 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M3.972,13.484c0-5.545,4.056-6.024,5.568-6.024c3.264,0,5.856,1.92,5.856,5.376 + c0,2.928-1.896,4.416-3.552,5.544c-2.256,1.584-3.432,2.353-3.816,3.145h7.392V24.5H3.78c0.12-1.992,0.264-4.08,3.96-6.768 + c3.072-2.232,4.296-3.097,4.296-5.017c0-1.128-0.72-2.424-2.352-2.424c-2.352,0-2.424,1.944-2.448,3.192H3.972z"/> + <path style="fill:#FFFFFF;" d="M21.612,14.636h0.528c1.008,0,2.855-0.096,2.855-2.304c0-0.624-0.287-2.185-2.136-2.185 + c-2.304,0-2.304,2.185-2.304,2.784h-3.12c0-3.191,1.8-5.472,5.64-5.472c2.28,0,5.28,1.152,5.28,4.752 + c0,1.728-1.08,2.808-2.04,3.24V15.5c0.6,0.168,2.568,1.056,2.568,3.96c0,3.216-2.377,5.496-5.809,5.496 + c-1.607,0-5.928-0.36-5.928-5.688h3.288l-0.024,0.024c0,0.912,0.24,2.976,2.496,2.976c1.344,0,2.521-0.911,2.521-2.808 + c0-2.328-2.257-2.424-3.816-2.424V14.636z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/24.svg b/doc/src/images/callouts/24.svg new file mode 100644 index 0000000000..a3d552535f --- /dev/null +++ b/doc/src/images/callouts/24.svg @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M4.972,13.484c0-5.545,4.056-6.024,5.568-6.024c3.264,0,5.856,1.92,5.856,5.376 + c0,2.928-1.896,4.416-3.552,5.544c-2.256,1.584-3.432,2.353-3.816,3.145h7.392V24.5H4.78c0.12-1.992,0.264-4.08,3.96-6.768 + c3.072-2.232,4.296-3.097,4.296-5.017c0-1.128-0.72-2.424-2.352-2.424c-2.352,0-2.424,1.944-2.448,3.192H4.972z"/> + <path style="fill:#FFFFFF;" d="M30.124,20.732h-1.896V24.5h-3.36v-3.768h-6.72v-2.904L24.412,7.46h3.816v10.656h1.896V20.732z + M24.868,18.116c0-4.128,0.071-6.792,0.071-7.32h-0.047l-4.272,7.32H24.868z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/25.svg b/doc/src/images/callouts/25.svg new file mode 100644 index 0000000000..56614a979a --- /dev/null +++ b/doc/src/images/callouts/25.svg @@ -0,0 +1,21 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M3.972,13.484c0-5.545,4.056-6.024,5.568-6.024c3.264,0,5.856,1.92,5.856,5.376 + c0,2.928-1.896,4.416-3.552,5.544c-2.256,1.584-3.432,2.353-3.816,3.145h7.392V24.5H3.78c0.12-1.992,0.264-4.08,3.96-6.768 + c3.072-2.232,4.296-3.097,4.296-5.017c0-1.128-0.72-2.424-2.352-2.424c-2.352,0-2.424,1.944-2.448,3.192H3.972z"/> + <path style="fill:#FFFFFF;" d="M20.676,14.276c0.624-0.433,1.393-0.937,3.049-0.937c2.279,0,5.16,1.584,5.16,5.496 + c0,2.328-1.177,6.12-6.193,6.12c-2.664,0-5.375-1.584-5.543-5.016h3.36c0.144,1.392,0.889,2.327,2.376,2.327 + c1.608,0,2.544-1.367,2.544-3.191c0-1.513-0.72-3.048-2.496-3.048c-0.455,0-1.607,0.023-2.256,1.224l-3-0.144l1.176-9.36h9.36 + v2.832h-6.937L20.676,14.276z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/26.svg b/doc/src/images/callouts/26.svg new file mode 100644 index 0000000000..56faeaca30 --- /dev/null +++ b/doc/src/images/callouts/26.svg @@ -0,0 +1,22 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M3.972,13.484c0-5.545,4.056-6.024,5.568-6.024c3.264,0,5.856,1.92,5.856,5.376 + c0,2.928-1.896,4.416-3.552,5.544c-2.256,1.584-3.432,2.353-3.816,3.145h7.392V24.5H3.78c0.12-1.992,0.264-4.08,3.96-6.768 + c3.072-2.232,4.296-3.097,4.296-5.017c0-1.128-0.72-2.424-2.352-2.424c-2.352,0-2.424,1.944-2.448,3.192H3.972z"/> + <path style="fill:#FFFFFF;" d="M25.309,11.78c-0.097-0.96-0.721-1.633-1.969-1.633c-2.184,0-2.688,2.496-2.808,4.704L20.58,14.9 + c0.456-0.624,1.296-1.416,3.191-1.416c3.529,0,5.209,2.712,5.209,5.256c0,3.72-2.28,6.216-5.568,6.216 + c-5.16,0-6.168-4.32-6.168-8.568c0-3.24,0.432-8.928,6.336-8.928c0.695,0,2.641,0.264,3.48,1.104 + c0.936,0.912,1.271,1.416,1.584,3.217H25.309z M23.172,16.172c-1.271,0-2.568,0.792-2.568,2.928c0,1.849,1.056,3.168,2.664,3.168 + c1.225,0,2.353-0.936,2.353-3.239C25.62,16.868,24.229,16.172,23.172,16.172z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/27.svg b/doc/src/images/callouts/27.svg new file mode 100644 index 0000000000..a75c812159 --- /dev/null +++ b/doc/src/images/callouts/27.svg @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M3.972,13.484c0-5.545,4.056-6.024,5.568-6.024c3.264,0,5.856,1.92,5.856,5.376 + c0,2.928-1.896,4.416-3.552,5.544c-2.256,1.584-3.432,2.353-3.816,3.145h7.392V24.5H3.78c0.12-1.992,0.264-4.08,3.96-6.768 + c3.072-2.232,4.296-3.097,4.296-5.017c0-1.128-0.72-2.424-2.352-2.424c-2.352,0-2.424,1.944-2.448,3.192H3.972z"/> + <path style="fill:#FFFFFF;" d="M29.172,10.34c-1.632,1.776-5.808,6.816-6.216,14.16H19.5c0.36-6.816,4.632-12.24,6.072-13.776 + H17.1l0.072-2.976h12V10.34z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/28.svg b/doc/src/images/callouts/28.svg new file mode 100644 index 0000000000..7f8cf1a350 --- /dev/null +++ b/doc/src/images/callouts/28.svg @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M3.972,13.484c0-5.545,4.056-6.024,5.568-6.024c3.264,0,5.856,1.92,5.856,5.376 + c0,2.928-1.896,4.416-3.552,5.544c-2.256,1.584-3.432,2.353-3.816,3.145h7.392V24.5H3.78c0.12-1.992,0.264-4.08,3.96-6.768 + c3.072-2.232,4.296-3.097,4.296-5.017c0-1.128-0.72-2.424-2.352-2.424c-2.352,0-2.424,1.944-2.448,3.192H3.972z"/> + <path style="fill:#FFFFFF;" d="M23.172,24.956c-4.392,0-5.904-2.856-5.904-5.185c0-0.863,0-3.119,2.592-4.319 + c-1.344-0.672-2.064-1.752-2.064-3.336c0-2.904,2.328-4.656,5.304-4.656c3.528,0,5.4,2.088,5.4,4.44 + c0,1.464-0.6,2.712-1.968,3.432c1.632,0.815,2.544,1.896,2.544,4.104C29.076,21.596,27.684,24.956,23.172,24.956z M23.124,16.916 + c-1.224,0-2.4,0.792-2.4,2.64c0,1.632,0.936,2.712,2.472,2.712c1.752,0,2.424-1.512,2.424-2.688 + C25.62,18.38,24.996,16.916,23.124,16.916z M25.284,12.26c0-1.296-0.888-2.112-1.968-2.112c-1.512,0-2.305,0.864-2.305,2.112 + c0,1.008,0.744,2.112,2.185,2.112C24.516,14.372,25.284,13.484,25.284,12.26z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/29.svg b/doc/src/images/callouts/29.svg new file mode 100644 index 0000000000..cb63adf1fe --- /dev/null +++ b/doc/src/images/callouts/29.svg @@ -0,0 +1,22 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M3.972,13.484c0-5.545,4.056-6.024,5.568-6.024c3.264,0,5.856,1.92,5.856,5.376 + c0,2.928-1.896,4.416-3.552,5.544c-2.256,1.584-3.432,2.353-3.816,3.145h7.392V24.5H3.78c0.12-1.992,0.264-4.08,3.96-6.768 + c3.072-2.232,4.296-3.097,4.296-5.017c0-1.128-0.72-2.424-2.352-2.424c-2.352,0-2.424,1.944-2.448,3.192H3.972z"/> + <path style="fill:#FFFFFF;" d="M20.893,20.564v0.023c0.191,1.176,0.936,1.68,1.967,1.68c1.393,0,2.785-1.176,2.809-4.752 + l-0.048-0.048c-0.769,1.152-2.088,1.44-3.24,1.44c-3.264,0-5.16-2.473-5.16-5.328c0-4.176,2.472-6.12,5.807-6.12 + c5.904,0,6.001,6.36,6.001,8.76c0,6.601-3.12,8.736-6.192,8.736c-2.904,0-4.992-1.68-5.28-4.392H20.893z M23.1,16.22 + c1.176,0,2.473-0.84,2.473-2.855c0-1.944-0.84-3.145-2.568-3.145c-0.863,0-2.424,0.433-2.424,2.88 + C20.58,15.668,21.828,16.22,23.1,16.22z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/3.png b/doc/src/images/callouts/3.png Binary files differnew file mode 100644 index 0000000000..3ff0a93931 --- /dev/null +++ b/doc/src/images/callouts/3.png diff --git a/doc/src/images/callouts/3.svg b/doc/src/images/callouts/3.svg new file mode 100644 index 0000000000..918be806f4 --- /dev/null +++ b/doc/src/images/callouts/3.svg @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M15.127,14.005h0.616c1.176,0,3.332-0.112,3.332-2.688c0-0.728-0.336-2.548-2.492-2.548 + c-2.688,0-2.688,2.548-2.688,3.248h-3.64c0-3.724,2.1-6.384,6.58-6.384c2.66,0,6.16,1.344,6.16,5.544 + c0,2.016-1.261,3.276-2.38,3.78v0.056c0.699,0.196,2.996,1.232,2.996,4.62c0,3.752-2.772,6.412-6.776,6.412 + c-1.876,0-6.916-0.42-6.916-6.636h3.836l-0.028,0.027c0,1.064,0.28,3.473,2.912,3.473c1.568,0,2.94-1.064,2.94-3.276 + c0-2.716-2.632-2.828-4.452-2.828V14.005z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/30.svg b/doc/src/images/callouts/30.svg new file mode 100644 index 0000000000..dc43ba1e3c --- /dev/null +++ b/doc/src/images/callouts/30.svg @@ -0,0 +1,22 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M8.268,14.636h0.528c1.008,0,2.856-0.096,2.856-2.304c0-0.624-0.288-2.185-2.136-2.185 + c-2.304,0-2.304,2.185-2.304,2.784h-3.12c0-3.191,1.8-5.472,5.64-5.472c2.28,0,5.28,1.152,5.28,4.752 + c0,1.728-1.08,2.808-2.04,3.24V15.5c0.6,0.168,2.568,1.056,2.568,3.96c0,3.216-2.376,5.496-5.808,5.496 + c-1.608,0-5.928-0.36-5.928-5.688h3.288l-0.024,0.024c0,0.912,0.24,2.976,2.496,2.976c1.344,0,2.52-0.911,2.52-2.808 + c0-2.328-2.256-2.424-3.816-2.424V14.636z"/> + <path style="fill:#FFFFFF;" d="M23.172,7.46c4.008,0,5.904,2.76,5.904,8.736c0,5.976-1.896,8.76-5.904,8.76 + s-5.904-2.784-5.904-8.76C17.268,10.22,19.164,7.46,23.172,7.46z M23.172,22.268c1.92,0,2.448-1.68,2.448-6.071 + c0-4.393-0.528-6.049-2.448-6.049s-2.448,1.656-2.448,6.049C20.724,20.588,21.252,22.268,23.172,22.268z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/4.png b/doc/src/images/callouts/4.png Binary files differnew file mode 100644 index 0000000000..6aa29fc0b4 --- /dev/null +++ b/doc/src/images/callouts/4.png diff --git a/doc/src/images/callouts/4.svg b/doc/src/images/callouts/4.svg new file mode 100644 index 0000000000..8eb6a53b3b --- /dev/null +++ b/doc/src/images/callouts/4.svg @@ -0,0 +1,16 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M21.891,20.784h-2.212v4.396h-3.92v-4.396h-7.84v-3.389L15.227,5.3h4.452v12.432h2.212V20.784z + M15.759,17.731c0-4.815,0.084-7.924,0.084-8.54h-0.056l-4.984,8.54H15.759z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/5.png b/doc/src/images/callouts/5.png Binary files differnew file mode 100644 index 0000000000..36e785867a --- /dev/null +++ b/doc/src/images/callouts/5.png diff --git a/doc/src/images/callouts/5.svg b/doc/src/images/callouts/5.svg new file mode 100644 index 0000000000..ca7a9f22f6 --- /dev/null +++ b/doc/src/images/callouts/5.svg @@ -0,0 +1,18 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M14.035,14.252c0.728-0.504,1.624-1.092,3.556-1.092c2.66,0,6.02,1.848,6.02,6.411 + c0,2.717-1.372,7.141-7.224,7.141c-3.108,0-6.272-1.849-6.468-5.853h3.92c0.168,1.624,1.036,2.717,2.772,2.717 + c1.876,0,2.968-1.597,2.968-3.725c0-1.764-0.839-3.556-2.912-3.556c-0.532,0-1.876,0.028-2.632,1.428l-3.5-0.168l1.372-10.92 + h10.919v3.304h-8.092L14.035,14.252z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/6.png b/doc/src/images/callouts/6.png Binary files differnew file mode 100644 index 0000000000..c943676bea --- /dev/null +++ b/doc/src/images/callouts/6.png diff --git a/doc/src/images/callouts/6.svg b/doc/src/images/callouts/6.svg new file mode 100644 index 0000000000..783a0b9d77 --- /dev/null +++ b/doc/src/images/callouts/6.svg @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M19.106,10.673c-0.112-1.12-0.84-1.904-2.296-1.904c-2.548,0-3.136,2.912-3.276,5.488l0.056,0.056 + c0.532-0.728,1.512-1.651,3.724-1.651c4.116,0,6.077,3.164,6.077,6.131c0,4.34-2.66,7.252-6.497,7.252 + c-6.02,0-7.196-5.039-7.196-9.996c0-3.78,0.504-10.416,7.392-10.416c0.812,0,3.08,0.308,4.061,1.288 + c1.092,1.063,1.483,1.652,1.848,3.752H19.106z M16.614,15.797c-1.484,0-2.996,0.924-2.996,3.416c0,2.156,1.232,3.697,3.108,3.697 + c1.428,0,2.745-1.094,2.745-3.781C19.471,16.609,17.846,15.797,16.614,15.797z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/7.png b/doc/src/images/callouts/7.png Binary files differnew file mode 100644 index 0000000000..20940de30d --- /dev/null +++ b/doc/src/images/callouts/7.png diff --git a/doc/src/images/callouts/7.svg b/doc/src/images/callouts/7.svg new file mode 100644 index 0000000000..59b3714b56 --- /dev/null +++ b/doc/src/images/callouts/7.svg @@ -0,0 +1,16 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M24.28,9.66c-1.904,2.071-6.776,7.951-7.252,16.52h-4.032c0.42-7.952,5.404-14.28,7.084-16.072 + h-9.884l0.084-3.472h14V9.66z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/8.png b/doc/src/images/callouts/8.png Binary files differnew file mode 100644 index 0000000000..d8e34d4a09 --- /dev/null +++ b/doc/src/images/callouts/8.png diff --git a/doc/src/images/callouts/8.svg b/doc/src/images/callouts/8.svg new file mode 100644 index 0000000000..c1803a3c0d --- /dev/null +++ b/doc/src/images/callouts/8.svg @@ -0,0 +1,20 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M16.28,26.712c-5.124,0-6.888-3.332-6.888-6.048c0-1.009,0-3.641,3.024-5.04 + c-1.568-0.784-2.408-2.044-2.408-3.893c0-3.388,2.716-5.432,6.188-5.432c4.116,0,6.3,2.436,6.3,5.18 + c0,1.708-0.7,3.164-2.296,4.004c1.903,0.952,2.968,2.212,2.968,4.788C23.168,22.792,21.544,26.712,16.28,26.712z M16.224,17.332 + c-1.428,0-2.8,0.924-2.8,3.08c0,1.903,1.092,3.164,2.884,3.164c2.043,0,2.829-1.765,2.829-3.137 + C19.137,19.04,18.408,17.332,16.224,17.332z M18.744,11.899c0-1.512-1.036-2.464-2.296-2.464c-1.764,0-2.688,1.008-2.688,2.464 + c0,1.177,0.868,2.464,2.548,2.464C17.848,14.363,18.744,13.328,18.744,11.899z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/callouts/9.png b/doc/src/images/callouts/9.png Binary files differnew file mode 100644 index 0000000000..abe636072b --- /dev/null +++ b/doc/src/images/callouts/9.png diff --git a/doc/src/images/callouts/9.svg b/doc/src/images/callouts/9.svg new file mode 100644 index 0000000000..bc149d3cb2 --- /dev/null +++ b/doc/src/images/callouts/9.svg @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Generator: Adobe Illustrator 12.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --> +<!DOCTYPE svg [ + <!ENTITY ns_svg "http://www.w3.org/2000/svg"> + <!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> +]> +<svg version="1.0" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="33" height="33" viewBox="0 0 33 33" + style="overflow:visible;enable-background:new 0 0 33 33;" xml:space="preserve"> +<circle style="stroke:#000000;" cx="16.5" cy="16.5" r="16"/> +<g> + <g style="enable-background:new ;"> + <path style="fill:#FFFFFF;" d="M13.953,21.921v0.027c0.224,1.372,1.092,1.961,2.296,1.961c1.624,0,3.248-1.372,3.276-5.545 + l-0.057-0.056c-0.896,1.344-2.436,1.68-3.78,1.68c-3.808,0-6.02-2.884-6.02-6.216c0-4.872,2.884-7.14,6.776-7.14 + c6.888,0,7,7.42,7,10.22c0,7.7-3.641,10.192-7.224,10.192c-3.388,0-5.824-1.96-6.16-5.124H13.953z M16.529,16.853 + c1.372,0,2.884-0.979,2.884-3.332c0-2.268-0.98-3.668-2.996-3.668c-1.008,0-2.828,0.504-2.828,3.36 + C13.589,16.209,15.045,16.853,16.529,16.853z"/> + </g> +</g> +</svg> diff --git a/doc/src/images/caution.png b/doc/src/images/caution.png Binary files differnew file mode 100644 index 0000000000..5b7809ca4a --- /dev/null +++ b/doc/src/images/caution.png diff --git a/doc/src/images/caution.svg b/doc/src/images/caution.svg new file mode 100644 index 0000000000..4bd586a08e --- /dev/null +++ b/doc/src/images/caution.svg @@ -0,0 +1,68 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!-- Generator: Adobe Illustrator 12.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 51448) --><svg height="120.648" id="Layer_1" inkscape:version="0.42" sodipodi:docbase="F:\openclip\svg da inviare" sodipodi:docname="Attenzione.svg" sodipodi:version="0.32" space="preserve" style="overflow:visible;enable-background:new 0 0 133.878 120.648;" version="1.1" viewBox="0 0 133.878 120.648" width="133.878" xmlns="http://www.w3.org/2000/svg" xmlns:cc="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:sodipodi="http://inkscape.sourceforge.net/DTD/sodipodi-0.dtd" xmlns:svg="http://www.w3.org/2000/svg"> + <metadata> + <rdf:RDF xmlns:cc="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <cc:Work rdf:about=""> + <dc:title>Attenzione</dc:title> + <dc:description></dc:description> + <dc:subject> + <rdf:Bag> + <rdf:li>pulsante</rdf:li> + </rdf:Bag> + </dc:subject> + <dc:publisher> + <cc:Agent rdf:about="http://www.openclipart.org/"> + <dc:title>Open Clip Art Library</dc:title> + </cc:Agent> + </dc:publisher> + <dc:creator> + <cc:Agent> + <dc:title>Architetto Francesco Rollandin</dc:title> + </cc:Agent> + </dc:creator> + <dc:rights> + <cc:Agent> + <dc:title>Architetto Francesco Rollandin</dc:title> + </cc:Agent> + </dc:rights> + <dc:date></dc:date> + <dc:format>image/svg+xml</dc:format> + <dc:type rdf:resource="http://purl.org/dc/dcmitype/StillImage"/> + <cc:license rdf:resource="http://web.resource.org/cc/PublicDomain"/> + <dc:language>en</dc:language> + </cc:Work> + <cc:License rdf:about="http://web.resource.org/cc/PublicDomain"> + <cc:permits rdf:resource="http://web.resource.org/cc/Reproduction"/> + <cc:permits rdf:resource="http://web.resource.org/cc/Distribution"/> + <cc:permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/> + </cc:License> + </rdf:RDF> + </metadata> + <defs id="defs43"/> + <sodipodi:namedview bordercolor="#666666" borderopacity="1.0" id="base" inkscape:current-layer="Layer_1" inkscape:cx="66.939003" inkscape:cy="60.324001" inkscape:pageopacity="0.0" inkscape:pageshadow="2" inkscape:window-height="510" inkscape:window-width="787" inkscape:window-x="44" inkscape:window-y="58" inkscape:zoom="2.9838869" pagecolor="#ffffff"/> + <g id="g3"> + <linearGradient gradientTransform="matrix(56.9977 90.4964 90.4964 -56.9977 -27343.9609 47971.0547)" gradientUnits="userSpaceOnUse" id="XMLID_4_" x1="-244.5732" x2="-242.8169" y1="455.4199" y2="455.4199"> + <stop id="stop6" offset="0" style="stop-color:#FFFA5F"/> + <stop id="stop8" offset="1" style="stop-color:#9F3300"/> + </linearGradient> + <path d="M51.333,8.834C34.985,37.343,18.638,65.854,2.289,94.363 c-7.081,12.352,3.352,26.285,16.453,26.285c6.708,0,13.418,0,20.128,0c22.109,0,44.217,0,66.327,0c3.644,0,7.286,0,10.931,0 c13.293,0,20.963-14.273,16.452-26.031c-4.114-10.729-11.861-20.99-17.542-30.922c-8.81-15.403-17.618-30.809-26.429-46.212 c-1.813-3.167-3.622-6.333-5.434-9.5C76.601-3.516,57.616-2.03,51.333,8.834 M53.973,9.064" id="path10" style="fill:url(#XMLID_4_);"/> + <path d="M55.474,12.388c-8.247,14.279-16.492,28.559-24.739,42.839 c-5.526,9.567-11.05,19.137-16.577,28.707c-2.732,4.73-7.323,10.456-8.284,16c-3.799,21.9,34.927,15.743,46.734,15.743 c20.073,0,40.144,0,60.215,0c13.716,0,18.636-11.963,12.229-23.063c-6.462-11.195-12.927-22.388-19.389-33.582 c-7.249-12.557-14.499-25.113-21.75-37.671c-1.682-2.916-3.364-5.829-5.049-8.745C73.767,3.785,60.676,3.364,55.474,12.388" id="path12" style="fill-rule:evenodd;clip-rule:evenodd;fill:#FFF200;"/> + <path d="M55.474,12.388c-8.247,14.279-16.492,28.559-24.739,42.839c-5.526,9.567-11.05,19.137-16.577,28.707 c-2.732,4.73-7.323,10.456-8.284,16c-3.799,21.9,34.927,15.743,46.734,15.743c20.073,0,40.144,0,60.215,0 c13.716,0,18.636-11.963,12.229-23.063c-6.462-11.195-12.927-22.388-19.389-33.582c-7.249-12.557-14.499-25.113-21.75-37.671 c-1.682-2.916-3.364-5.829-5.049-8.745C73.767,3.785,60.676,3.364,55.474,12.388" id="path14" style="fill:#FFCE00;"/> + <path d="M126.731,95.522c-8.733-15.127-17.468-30.253-26.201-45.379 c-5.537-9.595-11.078-19.188-16.616-28.781c-3.938-6.821-7.459-15.689-16.813-15.689c1.013,0,5.901,10.225,6.469,11.196 c5.451,9.314,10.902,18.63,16.352,27.947c9.217,15.749,18.433,31.498,27.646,47.249c2.302,3.933,5.356,10.555,1.308,14.397 c-3.148,2.987-7.99,3.196-12.099,3.196c-7.225,0-14.448,0-21.674,0c-22.125,0-44.251,0-66.377,0c-3.598,0-7.197,0-10.794,0 c5.285,7.909,16.341,6.02,24.546,6.02c13.009,0,26.017,0,39.023,0c11.979,0,23.958,0,35.937,0c2.516,0,5.032,0,7.547,0 C125.136,115.678,131.878,104.435,126.731,95.522" id="path16" style="fill:#FFB600;"/> + <path d="M14.615,112.457c-4.483-7.751,1.908-16.103,5.793-22.834 c4.698-8.138,9.398-16.276,14.097-24.414C44.54,47.83,54.574,30.448,64.61,13.069c0.789-1.367,3.725-4.568,2.594-5.539 c-3.913-3.353-10.287,1.936-12.107,5.087c-3.129,5.417-6.258,10.835-9.386,16.252c-11.105,19.226-22.209,38.453-33.313,57.68 c-1.649,2.854-3.299,5.713-4.95,8.569c-4.771,8.265-0.075,19.162,9.658,20.446C16.124,114.65,15.294,113.615,14.615,112.457" id="path18" style="fill-rule:evenodd;clip-rule:evenodd;fill:#FFE600;"/> + <path d="M77.076,34.654c0,10.183-1.788,20.758-3.439,30.772 c-0.369,2.239-4.03,23.609-7.796,14.179c-4.247-10.632-4.832-23.419-5.958-34.696c-0.363-3.638-1.538-8.425-0.563-12.06 C61.667,24.099,77.076,25.199,77.076,34.654" id="path20" style="fill-rule:evenodd;clip-rule:evenodd;fill:#FFFFE1;"/> + <path d="M77.076,34.654c-2.018,0.995-1.521,8.717-1.797,11.395c-0.685,6.643-1.505,13.282-2.614,19.869 c-0.79,4.701-1.301,10.862-3.954,14.981c-1.642,2.567-3.405-5.958-3.634-6.932c-2.948-12.443-4.464-25.664-5.09-38.43 c-0.272-5.52,5.164-8.854,10.277-7.622c3.87,0.933,5.217,7.36,7.688,6.738c0.009-11.451-19.755-11.453-19.746,0 c0.017,11.956,2.087,24.599,4.423,36.294c0.501,2.507,1.642,12.376,5.449,12.376c4.059-0.021,5.285-11.432,5.79-14.137 c1.261-6.765,2.139-13.605,2.887-20.444C77.084,45.722,79.281,35.942,77.076,34.654" id="path22" style="fill:#FFFFFF;"/> + <linearGradient gradientTransform="matrix(68.2284 33.0019 33.0019 -68.2284 1613.9791 39385.6641)" gradientUnits="userSpaceOnUse" id="XMLID_5_" x1="-246.981" x2="-245.2275" y1="458.29" y2="458.29"> + <stop id="stop25" offset="0" style="stop-color:#FFFA5F"/> + <stop id="stop27" offset="1" style="stop-color:#9F3300"/> + </linearGradient> + <path d="M57.957,34.654c0,10.053,1.632,20.54,3.242,30.431 c0.479,2.936,4.912,26.502,9.99,15.164c4.987-11.134,5.351-25.201,6.386-37.184c0.273-3.169,1.153-7.045,0.421-10.221 C75.628,22.587,57.957,23.788,57.957,34.654 M60.207,34.654c0-8.061,13.138-9.015,15.459-1.792c1.156,3.597-0.13,8.748-0.508,12.38 c-1.135,10.904-2.052,22.602-5.501,33.069c-2.816,8.545-5.546-10.187-5.934-12.522C62.039,55.63,60.207,44.985,60.207,34.654" id="path29" style="fill-rule:evenodd;clip-rule:evenodd;fill:url(#XMLID_5_);"/> + <path d="M77.076,96.788c0,11.964-18.555,11.964-18.555,0 C58.521,84.822,77.076,84.822,77.076,96.788" id="path31" style="fill-rule:evenodd;clip-rule:evenodd;fill:#FFFFE1;"/> + <path d="M77.076,96.788c-2.605,1.661-2.157,6.757-7.044,8.101c-6.178,1.7-12.033-4.159-10.336-10.335 c1.439-5.23,7.657-7.767,12.341-5.021c2.91,1.704,3.164,7.913,5.915,7.256c0-14.267-22.698-12.238-20.143,1.826 c0.987,5.444,6.375,9.15,11.814,8.162C72.417,106.271,81.44,98.19,77.076,96.788" id="path33" style="fill:#FFFFFF;"/> + <linearGradient gradientTransform="matrix(68.2241 32.9998 32.9998 -68.2241 1604.682 39402.625)" gradientUnits="userSpaceOnUse" id="XMLID_6_" x1="-246.998" x2="-245.2348" y1="458.0625" y2="458.0625"> + <stop id="stop36" offset="0" style="stop-color:#FFFA5F"/> + <stop id="stop38" offset="1" style="stop-color:#9F3300"/> + </linearGradient> + <path d="M57.395,96.788c0,13.41,20.805,13.41,20.805,0 C78.2,83.376,57.395,83.375,57.395,96.788 M59.647,96.788c0-10.514,16.301-10.514,16.301,0 C75.948,107.3,59.647,107.3,59.647,96.788" id="path40" style="fill-rule:evenodd;clip-rule:evenodd;fill:url(#XMLID_6_);"/> + </g> +</svg> diff --git a/doc/src/images/draft.png b/doc/src/images/draft.png Binary files differnew file mode 100644 index 0000000000..0084708c9b --- /dev/null +++ b/doc/src/images/draft.png diff --git a/doc/src/images/home.png b/doc/src/images/home.png Binary files differnew file mode 100644 index 0000000000..5584aacb09 --- /dev/null +++ b/doc/src/images/home.png diff --git a/doc/src/images/home.svg b/doc/src/images/home.svg new file mode 100644 index 0000000000..e803a3178f --- /dev/null +++ b/doc/src/images/home.svg @@ -0,0 +1,26 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!-- Generator: Adobe Illustrator 9.0, SVG Export Plug-In --> +<!DOCTYPE svg [ + <!ENTITY st0 "fill-rule:nonzero;clip-rule:nonzero;fill:#FFFFFF;stroke:#000000;stroke-miterlimit:4;"> + <!ENTITY st1 "fill:none;stroke:none;"> + <!ENTITY st2 "fill:#000000;"> + <!ENTITY st3 "fill:none;stroke:#FFFFFF;stroke-width:6.3469;stroke-linejoin:round;"> + <!ENTITY st4 "fill-rule:evenodd;clip-rule:evenodd;stroke:none;"> + <!ENTITY st5 "fill-rule:nonzero;clip-rule:nonzero;stroke:#000000;stroke-miterlimit:4;"> +]> +<svg width="48pt" height="48pt" viewBox="0 0 48 48" xml:space="preserve" xmlns="http://www.w3.org/2000/svg"> + <g id="Layer_x0020_3" style="&st0;"> + <g style="&st4;"> + <path style="&st3;" d="M22.9,7.1L5.1,21.8l0,0c-0.3,0.3-0.5,0.8-0.5,1.2c0,0.2,0,0.4,0.1,0.6c0.3,0.6,0.9,1,1.6,1c0,0,1.1,0,2.2,0c0,2.4,0,14.2,0,14.2c0,1.1,0.8,1.9,1.8,1.9h27.4c1.1,0,1.9-0.9,1.9-2c0,0,0-11.8,0-14.2c1,0,2,0,2,0c0.8,0,1.4-0.5,1.7-1.2 + c0.1-0.2,0.1-0.4,0.1-0.6c0-0.5-0.2-1-0.7-1.4c0,0-3.6-3-4.5-3.7c0-1.2,0-6.9,0-6.9c0-1.2-0.8-2-2-2h-4.8c-1,0-1.7,0.6-1.9,1.5c-1.9-1.6-4.1-3.5-4.1-3.5l0.1,0.1c-0.7-0.7-1.8-0.8-2.7-0.1z"/> + <path style="&st2;" d="M22.9,7.1L5.1,21.8l0,0c-0.3,0.3-0.5,0.8-0.5,1.2c0,0.2,0,0.4,0.1,0.6c0.3,0.6,0.9,1,1.6,1c0,0,1.1,0,2.2,0c0,2.4,0,14.2,0,14.2c0,1.1,0.8,1.9,1.8,1.9h27.4c1.1,0,1.9-0.9,1.9-2c0,0,0-11.8,0-14.2c1,0,2,0,2,0c0.8,0,1.4-0.5,1.7-1.2 + c0.1-0.2,0.1-0.4,0.1-0.6c0-0.5-0.2-1-0.7-1.4c0,0-3.6-3-4.5-3.7c0-1.2,0-6.9,0-6.9c0-1.2-0.8-2-2-2h-4.8c-1,0-1.7,0.6-1.9,1.5c-1.9-1.6-4.1-3.5-4.1-3.5l0.1,0.1c-0.7-0.7-1.8-0.8-2.7-0.1z"/> + <path style="&st2;" d="M41.8,22.8l-5.1-4.2v-0.1L31,13.7v0l-6.5-5.5C24.2,8,24,8,23.8,8.2L6.2,22.9c-0.1,0.1-0.1,0.3,0.1,0.3h1.6H10h28.1h1.2h2.3c0.2,0,0.4-0.2,0.2-0.4z"/> + <path d="M35.8,16.8l0-5.1c0-0.2-0.1-0.4-0.3-0.4h-3.2c-0.2,0-0.3,0.1-0.3,0.3v2.2l3.9,2.9z"/> + <path d="M11.9,24.7V37c0,0.3,0.1,0.4,0.3,0.4h23.6c0.3,0,0.4-0.2,0.4-0.4V24.7H11.9z"/> + </g> + </g> + <g id="crop_x0020_marks" style="&st5;"> + <path style="&st1;" d="M48,48H0V0h48v48z"/> + </g> +</svg> diff --git a/doc/src/images/important.png b/doc/src/images/important.png Binary files differnew file mode 100644 index 0000000000..12c90f607a --- /dev/null +++ b/doc/src/images/important.png diff --git a/doc/src/images/important.svg b/doc/src/images/important.svg new file mode 100644 index 0000000000..dd84f3fe36 --- /dev/null +++ b/doc/src/images/important.svg @@ -0,0 +1,25 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!-- Generator: Adobe Illustrator 9.0, SVG Export Plug-In --> +<!DOCTYPE svg [ + <!ENTITY st0 "fill:#FFFFFF;stroke:none;"> + <!ENTITY st1 "fill:#FFFFFF;stroke-width:6.6112;stroke-linecap:round;stroke-linejoin:round;"> + <!ENTITY st2 "stroke:#FFFFFF;stroke-width:6.6112;"> + <!ENTITY st3 "fill:none;stroke:none;"> + <!ENTITY st4 "fill-rule:nonzero;clip-rule:nonzero;stroke:#000000;stroke-miterlimit:4;"> + <!ENTITY st5 "stroke:none;"> +]> +<svg width="48pt" height="48pt" viewBox="0 0 48 48" xml:space="preserve" xmlns="http://www.w3.org/2000/svg"> + <g id="Layer_x0020_3" style="&st4;"> + <g> + <path style="&st2;" d="M41.7,35.3L26.6,9.4c-0.6-1-1.7-1.7-2.9-1.6c-1.2,0-2.3,0.7-2.9,1.7L6.3,35.4c-0.6,1-0.6,2.3,0,3.3c0.6,1,1.7,1.6,2.9,1.6h29.6c1.2,0,2.3-0.6,2.9-1.7c0.6-1,0.6-2.3,0-3.3z"/> + <path style="&st1;" d="M23.7,11L9.2,37h29.6L23.7,11z"/> + <path style="&st0;" d="M23.7,11.9L10.3,36.1h27.5l-14-24.1z"/> + <g> + <path style="&st5;" d="M24.1,34c-1.1,0-1.8-0.8-1.8-1.8c0-1.1,0.7-1.8,1.8-1.8c1.1,0,1.8,0.7,1.8,1.8c0,1-0.7,1.8-1.8,1.8h0z M22.9,29.3l-0.4-9.1h3.2l-0.4,9.1h-2.3z"/> + </g> + </g> + </g> + <g id="crop_x0020_marks" style="&st4;"> + <path style="&st3;" d="M48,48H0V0h48v48z"/> + </g> +</svg> diff --git a/doc/src/images/next.png b/doc/src/images/next.png Binary files differnew file mode 100644 index 0000000000..59800b4e87 --- /dev/null +++ b/doc/src/images/next.png diff --git a/doc/src/images/next.svg b/doc/src/images/next.svg new file mode 100644 index 0000000000..75fa83ed8c --- /dev/null +++ b/doc/src/images/next.svg @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!-- Generator: Adobe Illustrator 9.0, SVG Export Plug-In --> +<!DOCTYPE svg [ + <!ENTITY st0 "fill:none;stroke:none;"> + <!ENTITY st1 "fill:#FFFFFF;stroke:#FFFFFF;stroke-width:7.5901;stroke-linejoin:round;"> + <!ENTITY st2 "fill-rule:nonzero;clip-rule:nonzero;stroke:#000000;stroke-miterlimit:4;"> + <!ENTITY st3 "stroke:none;"> +]> +<svg width="48pt" height="48pt" viewBox="0 0 48 48" xml:space="preserve" xmlns="http://www.w3.org/2000/svg"> + <g id="Layer_x0020_3" style="&st2;"> + <g> + <path style="&st1;" d="M22.4,41.1c0,0.3,0.3,0.3,0.5,0.2l16.6-16.9c0.5-0.5,0.4-0.7,0-1L22.9,6.7c-0.1-0.1-0.4-0.1-0.4,0.1v10H8.9c-0.3,0-0.5,0.2-0.5,0.4l0,13.3C8.4,30.9,8.6,31,9,31h13.5l-0.1,10.1z"/> + <path style="&st3;" d="M22.4,41.1c0,0.3,0.3,0.3,0.5,0.2l16.6-16.9c0.5-0.5,0.4-0.7,0-1L22.9,6.7c-0.1-0.1-0.4-0.1-0.4,0.1v10H8.9c-0.3,0-0.5,0.2-0.5,0.4l0,13.3C8.4,30.9,8.6,31,9,31h13.5l-0.1,10.1z"/> + </g> + </g> + <g id="crop_x0020_marks" style="&st2;"> + <path style="&st0;" d="M48,48H0V0h48v48z"/> + </g> +</svg> diff --git a/doc/src/images/next_disabled.png b/doc/src/images/next_disabled.png Binary files differnew file mode 100644 index 0000000000..10a8c59d7b --- /dev/null +++ b/doc/src/images/next_disabled.png diff --git a/doc/src/images/note.png b/doc/src/images/note.png Binary files differnew file mode 100644 index 0000000000..d0c3c645ab --- /dev/null +++ b/doc/src/images/note.png diff --git a/doc/src/images/note.svg b/doc/src/images/note.svg new file mode 100644 index 0000000000..648299d26f --- /dev/null +++ b/doc/src/images/note.svg @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!-- Generator: Adobe Illustrator 9.0, SVG Export Plug-In --> +<!DOCTYPE svg [ + <!ENTITY st0 "fill:none;stroke:#FFFFFF;stroke-width:12.1438;stroke-linejoin:round;"> + <!ENTITY st1 "fill:none;stroke-width:1.2429;"> + <!ENTITY st2 "fill:#FFFFFF;stroke:none;"> + <!ENTITY st3 "fill:none;stroke:#FFFFFF;stroke-width:12.7649;stroke-linejoin:round;"> + <!ENTITY st4 "fill:#FFFFFF;stroke-width:6.3824;stroke-linejoin:round;"> + <!ENTITY st5 "fill:none;stroke:none;"> + <!ENTITY st6 "fill-rule:nonzero;clip-rule:nonzero;stroke:#000000;stroke-miterlimit:4;"> + <!ENTITY st7 "fill:#FFFFFF;stroke:#FFFFFF;stroke-width:12.7649;stroke-linejoin:round;"> + <!ENTITY st8 "stroke:none;"> + <!ENTITY st9 "fill:none;stroke-width:4.9715;stroke-linejoin:round;"> +]> +<svg xmlns="http://www.w3.org/2000/svg" width="48pt" height="48pt" viewBox="0 0 48 48" xml:space="preserve"> + <g id="Layer_x0020_1" style="&st6;"> + <path style="&st0;" d="M35.7,19.8v18.9H11V8.8h13.9l10.8,11z"/> + <path style="&st3;" d="M38.7,30.4L25,16.7l-7.7-3l2.7,8.7l13.3,13.4l5.4-5.4z"/> + <path style="&st7;" d="M35.7,8.8H11v29.9h24.7V8.8z"/> + <path style="&st4;" d="M35.7,8.8H11v29.9h24.7V8.8z"/> + <path style="&st2;" d="M35.7,8.8H11v29.9h24.7V8.8z"/> + </g> + <g id="Layer_x0020_4" style="&st6;"> + <path style="&st9;" d="M38.7,30.4L25,16.7l-7.7-3l2.7,8.7l13.3,13.4l5.4-5.4z"/> + <path style="&st8;" d="M38.7,30.4L25,16.7l-7.7-3l2.7,8.7l13.3,13.4l5.4-5.4z"/> + <path style="&st8;" d="M20.6,14.7l-2.5,2.5L17,13.4l3.6,1.3z"/> + <path style="&st1;" d="M19.6,22.2l3-0.3l2.4-2.4l0.4-2.8"/> + <path style="&st2;" d="M20.4,14.9L18.3,17l1.6,5.2l2.7-0.3l2.4-2.4l0.3-2.4l-5-2.2z"/> + </g> + <g id="crop" style="&st6;"> + <path style="&st5;" d="M48,48H0V0h48v48z"/> + </g> +</svg> diff --git a/doc/src/images/prev.png b/doc/src/images/prev.png Binary files differnew file mode 100644 index 0000000000..d88a40f923 --- /dev/null +++ b/doc/src/images/prev.png diff --git a/doc/src/images/prev.svg b/doc/src/images/prev.svg new file mode 100644 index 0000000000..6d88ffdd0d --- /dev/null +++ b/doc/src/images/prev.svg @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!-- Generator: Adobe Illustrator 9.0, SVG Export Plug-In --> +<!DOCTYPE svg [ + <!ENTITY st0 "fill:none;stroke:none;"> + <!ENTITY st1 "fill:#FFFFFF;stroke:#FFFFFF;stroke-width:7.5901;stroke-linejoin:round;"> + <!ENTITY st2 "fill-rule:nonzero;clip-rule:nonzero;stroke:#000000;stroke-miterlimit:4;"> + <!ENTITY st3 "stroke:none;"> +]> +<svg width="48pt" height="48pt" viewBox="0 0 48 48" xml:space="preserve" xmlns="http://www.w3.org/2000/svg"> + <g id="Layer_x0020_3" style="&st2;"> + <g> + <path style="&st1;" d="M25.6,6.9c0-0.3-0.3-0.3-0.5-0.2L8.4,23.6c-0.5,0.5-0.4,0.7,0,1l16.6,16.6c0.1,0.1,0.4,0.1,0.4-0.1v-10h13.6c0.3,0,0.5-0.2,0.5-0.4l0-13.3c0-0.3-0.2-0.5-0.5-0.5H25.5l0.1-10.1z"/> + <path style="&st3;" d="M25.6,6.9c0-0.3-0.3-0.3-0.5-0.2L8.4,23.6c-0.5,0.5-0.4,0.7,0,1l16.6,16.6c0.1,0.1,0.4,0.1,0.4-0.1v-10h13.6c0.3,0,0.5-0.2,0.5-0.4l0-13.3c0-0.3-0.2-0.5-0.5-0.5H25.5l0.1-10.1z"/> + </g> + </g> + <g id="crop_x0020_marks" style="&st2;"> + <path style="&st0;" d="M48,48H0V0h48v48z"/> + </g> +</svg> diff --git a/doc/src/images/prev_disabled.png b/doc/src/images/prev_disabled.png Binary files differnew file mode 100644 index 0000000000..ab3c17e02d --- /dev/null +++ b/doc/src/images/prev_disabled.png diff --git a/doc/src/images/smiley.png b/doc/src/images/smiley.png Binary files differnew file mode 100644 index 0000000000..30a77f71ce --- /dev/null +++ b/doc/src/images/smiley.png diff --git a/doc/src/images/tip.png b/doc/src/images/tip.png Binary files differnew file mode 100644 index 0000000000..5c4aab3bb3 --- /dev/null +++ b/doc/src/images/tip.png diff --git a/doc/src/images/tip.svg b/doc/src/images/tip.svg new file mode 100644 index 0000000000..cd437a5e85 --- /dev/null +++ b/doc/src/images/tip.svg @@ -0,0 +1,84 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!-- Created with Inkscape (http://www.inkscape.org/) --><svg height="1052.3622047" id="svg2" inkscape:version="0.42.2" sodipodi:docbase="/home/sergio/tmp/downloads" sodipodi:docname="lamp.svg" sodipodi:version="0.32" width="744.09448819" xmlns="http://www.w3.org/2000/svg" xmlns:cc="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:sodipodi="http://inkscape.sourceforge.net/DTD/sodipodi-0.dtd" xmlns:svg="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"> + <metadata> + <rdf:RDF xmlns:cc="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> + <cc:Work rdf:about=""> + <dc:title>lamp</dc:title> + <dc:description></dc:description> + <dc:subject> + <rdf:Bag> + <rdf:li>office</rdf:li> + <rdf:li></rdf:li> + <rdf:li>lamp</rdf:li> + </rdf:Bag> + </dc:subject> + <dc:publisher> + <cc:Agent rdf:about="http://www.openclipart.org/"> + <dc:title>Open Clip Art Library</dc:title> + </cc:Agent> + </dc:publisher> + <dc:creator> + <cc:Agent> + <dc:title>Sergio Luiz Araujo Silva</dc:title> + </cc:Agent> + </dc:creator> + <dc:rights> + <cc:Agent> + <dc:title>Public Domain</dc:title> + </cc:Agent> + </dc:rights> + <dc:date>set 2005</dc:date> + <dc:format>image/svg+xml</dc:format> + <dc:type rdf:resource="http://purl.org/dc/dcmitype/StillImage"/> + <cc:license rdf:resource="http://web.resource.org/cc/PublicDomain"/> + <dc:language>en</dc:language> + </cc:Work> + <cc:License rdf:about="http://web.resource.org/cc/PublicDomain"> + <cc:permits rdf:resource="http://web.resource.org/cc/Reproduction"/> + <cc:permits rdf:resource="http://web.resource.org/cc/Distribution"/> + <cc:permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/> + </cc:License> + </rdf:RDF> + </metadata> + <defs id="defs4"> + <linearGradient id="linearGradient13125"> + <stop id="stop13127" offset="0.0000000" style="stop-color:#ffffff;stop-opacity:1.0000000;"/> + <stop id="stop13129" offset="1" style="stop-color:#fffeff;stop-opacity:0;"/> + </linearGradient> + <linearGradient id="linearGradient12389"> + <stop id="stop12391" offset="0.0000000" style="stop-color:#fefefe;stop-opacity:1.0000000;"/> + <stop id="stop12393" offset="1.0000000" style="stop-color:#fffefe;stop-opacity:1.0000000;"/> + </linearGradient> + <radialGradient cx="358.25909" cy="186.06468" fx="358.25909" fy="186.06468" gradientTransform="matrix(1.000001,-8.244061e-7,3.143917e-7,0.381356,-4.028738e-4,115.1081)" gradientUnits="userSpaceOnUse" id="radialGradient13131" inkscape:collect="always" r="27.486719" xlink:href="#linearGradient13125"/> + <radialGradient cx="358.25909" cy="186.06468" fx="358.25909" fy="186.06468" gradientTransform="matrix(1.000001,-8.244061e-7,3.143917e-7,0.381356,-4.028738e-4,115.1081)" gradientUnits="userSpaceOnUse" id="radialGradient14587" inkscape:collect="always" r="27.486719" xlink:href="#linearGradient13125"/> + <radialGradient cx="358.25909" cy="186.06468" fx="358.25909" fy="186.06468" gradientTransform="matrix(1.000001,-8.244061e-7,3.143917e-7,0.381356,-4.028738e-4,115.1081)" gradientUnits="userSpaceOnUse" id="radialGradient15390" inkscape:collect="always" r="27.486719" xlink:href="#linearGradient13125"/> + <radialGradient cx="358.25909" cy="186.06468" fx="358.25909" fy="186.06468" gradientTransform="matrix(1.000001,-8.244061e-7,3.143917e-7,0.381356,-4.028738e-4,115.1081)" gradientUnits="userSpaceOnUse" id="radialGradient16141" inkscape:collect="always" r="27.486719" xlink:href="#linearGradient13125"/> + </defs> + <sodipodi:namedview bordercolor="#666666" borderopacity="1.0" id="base" inkscape:current-layer="layer1" inkscape:cx="344.34505" inkscape:cy="795.78292" inkscape:document-units="px" inkscape:guide-bbox="true" inkscape:pageopacity="0.0" inkscape:pageshadow="2" inkscape:window-height="693" inkscape:window-width="1024" inkscape:window-x="0" inkscape:window-y="25" inkscape:zoom="0.72123084" pagecolor="#ffffff" showguides="true"/> + <g id="layer1" inkscape:groupmode="layer" inkscape:label="Layer 1"> + <path d="M 369.44028,121.86683 C 302.64703,119.68096 242.59223,184.30679 250.47188,250.87980 C 252.47522,280.21980 267.84094,306.49880 285.94332,328.82253 C 303.71281,358.65039 312.13900,393.24133 313.51068,427.73030 C 317.00419,446.97288 338.01608,454.57063 355.35334,455.26572 C 375.18456,456.91501 395.94281,455.09265 414.43470,447.69729 C 430.92724,435.70557 427.37713,413.20597 430.74488,395.55648 C 434.70351,361.57615 449.78002,329.76555 471.07843,303.26619 C 504.41026,252.31528 488.56419,176.76397 437.75400,143.26422 C 417.82956,129.49394 393.70573,121.69096 369.44028,121.86683 z " id="path1384" style="opacity:1.0000000;fill:#f3f2f3;fill-opacity:0.83333331;stroke:#000000;stroke-width:0.58960420;stroke-miterlimit:4.0000000;stroke-dasharray:none;stroke-dashoffset:0.0000000;stroke-opacity:1.0000000"/> + <path d="M 425.72698,154.07768 C 437.68158,164.87540 453.68534,182.03604 451.17873,203.82428 C 455.99913,200.54641 460.81954,197.26853 465.63995,193.99066 C 459.85546,170.27425 448.28648,162.75442 425.72698,154.07768 z " id="path2153" sodipodi:nodetypes="cccc" style="fill:#fefefe;fill-opacity:1.0000000;fill-rule:evenodd;stroke:none;stroke-width:1.0000000px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1.0000000"/> + <path d="M 506.99897 296.94009 A 37.120701 18.718985 0 1 1 432.75756,296.94009 A 37.120701 18.718985 0 1 1 506.99897 296.94009 z" id="path2881" sodipodi:cx="469.87827" sodipodi:cy="296.94009" sodipodi:rx="37.120701" sodipodi:ry="18.718985" sodipodi:type="arc" style="opacity:1.0000000;color:#000000;fill:#fefefe;fill-opacity:1.0000000;fill-rule:nonzero;stroke:none;stroke-width:0.64700001;stroke-linecap:butt;stroke-linejoin:miter;marker:none;marker-start:none;marker-mid:none;marker-end:none;stroke-miterlimit:4.0000000;stroke-dasharray:none;stroke-dashoffset:0.0000000;stroke-opacity:1.0000000;visibility:visible;display:inline;overflow:visible" transform="matrix(0.818103,0.000000,0.000000,0.896150,-13.89510,-26.68653)"/> + <path d="M 359.20536,314.30802 L 336.64585,244.31570 C 362.29042,230.62575 382.72895,234.28926 403.16748,243.15881 L 379.45107,315.46491 L 379.45107,315.46491" id="path3617" sodipodi:nodetypes="ccccc" style="fill:none;fill-opacity:0.75000000;fill-rule:evenodd;stroke:#8f9595;stroke-width:0.91160071px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1.0000000"/> + <path d="M 513.73605 514.32300 A 52.508934 11.885468 0 1 1 408.71818,514.32300 A 52.508934 11.885468 0 1 1 513.73605 514.32300 z" id="path4361" sodipodi:cx="461.22711" sodipodi:cy="514.32300" sodipodi:rx="52.508934" sodipodi:ry="11.885468" sodipodi:type="arc" style="opacity:1.0000000;color:#000000;fill:#a0a0a0;fill-opacity:1.0000000;fill-rule:nonzero;stroke:none;stroke-width:0.64700001;stroke-linecap:butt;stroke-linejoin:miter;marker:none;marker-start:none;marker-mid:none;marker-end:none;stroke-miterlimit:4.0000000;stroke-dasharray:none;stroke-dashoffset:0.0000000;stroke-opacity:1.0000000;visibility:visible;display:inline;overflow:visible" transform="matrix(0.982435,0.000000,0.000000,1.387810,-83.52495,-281.2705)"/> + <path d="M 315.87677,433.07959 C 319.14672,442.90428 329.03398,448.82383 338.76816,450.68840 C 362.00206,456.37952 386.74882,455.38004 409.63484,448.57985 C 414.28840,447.19363 419.18392,445.42184 422.06530,441.25295 C 423.42527,439.84003 425.68582,434.46169 424.07088,434.30126 C 411.81432,444.17256 395.75685,447.78808 380.34111,448.56322 C 362.85475,449.05661 344.64886,448.26521 328.51659,440.79114 C 324.02706,438.71576 319.76022,436.14612 315.87677,433.07959 z " id="path4363" style="fill:#d6dee6;fill-opacity:1.0000000;fill-rule:evenodd;stroke:none;stroke-width:1.0000000px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1.0000000"/> + <path d="M 400.47436,522.16227 C 396.48542,528.09177 392.49650,534.02126 388.50756,539.95076 C 383.93367,541.47295 366.98819,546.44954 353.57745,538.01018 C 350.34318,532.29631 347.10892,526.58244 343.87465,520.86856 C 364.35835,531.64946 396.48542,523.99502 400.47436,522.16227 z " id="path5094" sodipodi:nodetypes="ccccc" style="fill:#090a0c;fill-opacity:1.0000000;fill-rule:evenodd;stroke:#000000;stroke-width:0.91160071px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1.0000000"/> + <path d="M 419.65600,444.27781 C 419.97026,446.39906 420.28452,448.52031 420.59878,450.64156 C 421.46299,450.95582 422.32720,451.27008 423.19142,451.58434 C 423.19142,452.91994 423.19142,454.25554 423.19142,455.59114 C 422.32720,455.98397 421.46299,456.37678 420.59878,456.76961 C 420.36308,459.20512 420.12739,461.64063 419.89170,464.07614 C 420.52021,464.23327 421.14873,464.39039 421.77725,464.54753 C 421.69869,466.59021 421.62012,468.63289 421.54156,470.67558 C 420.83447,471.46123 420.12739,472.24688 419.42030,473.03253 C 419.57744,474.05387 419.73456,475.07522 419.89170,476.09656 C 420.91303,477.11790 421.93438,478.13925 422.95572,479.16058 C 422.87716,480.18193 422.79859,481.20328 422.72003,482.22461 C 422.01294,483.01026 421.30586,483.79591 420.59878,484.58156 C 420.36308,485.05294 420.12739,485.52433 419.89170,485.99572 C 419.57744,486.70280 419.26317,487.40989 418.94892,488.11697 C 419.10605,489.05975 419.26317,490.00253 419.42030,490.94531 C 419.89170,491.65239 420.36308,492.35947 420.83447,493.06655 C 420.67734,494.71641 420.52021,496.36627 420.36308,498.01614 C 415.02067,505.24410 409.67827,512.47206 404.33587,519.70003 C 403.15740,520.24998 401.97892,520.79994 400.80045,521.34989 C 397.81498,522.29266 394.82952,523.23544 391.84406,524.17822 C 386.34452,524.80674 380.84498,525.43525 375.34545,526.06378 C 371.96717,525.90664 368.58887,525.74952 365.21059,525.59238 C 362.46082,525.51382 359.71105,525.43525 356.96128,525.35669 C 353.42587,524.49247 349.89045,523.62827 346.35503,522.76405 C 345.17656,521.82128 343.99809,520.87850 342.81962,519.93572 C 339.75559,517.81447 336.69157,515.69322 333.62754,513.57197 C 328.75652,508.30813 323.88551,503.04429 319.01448,497.78044 C 319.01448,496.52341 319.01448,495.26636 319.01448,494.00933 C 319.87870,494.00933 320.74291,494.00933 321.60712,494.00933 C 321.13574,492.83086 320.66435,491.65239 320.19296,490.47392 C 319.09305,488.19554 317.99314,485.91716 316.89323,483.63878 C 316.89323,482.93170 316.89323,482.22461 316.89323,481.51753 C 318.38597,480.26049 319.87869,479.00345 321.37143,477.74642 C 320.03583,475.54660 318.70022,473.34679 317.36462,471.14697 C 317.28606,470.83271 317.20748,470.51845 317.12892,470.20419 C 318.46453,468.39720 319.80013,466.59021 321.13574,464.78322 C 320.74291,463.68331 320.35009,462.58341 319.95726,461.48350 C 319.09305,460.38359 318.22883,459.28369 317.36462,458.18378 C 317.12892,457.31956 316.89323,456.45536 316.65753,455.59114 C 317.75744,454.17697 318.85735,452.76281 319.95726,451.34864 C 319.87870,450.01304 319.80013,448.67744 319.72157,447.34184 C 319.32874,446.71332 318.93592,446.08480 318.54310,445.45628 C 318.62166,444.74920 318.70023,444.04212 318.77879,443.33503 C 319.48588,443.25647 320.19296,443.17790 320.90004,443.09934 C 324.04263,445.22059 327.18523,447.34184 330.32782,449.46309 C 348.08347,456.92674 391.76550,461.09068 419.65600,444.27781 z " id="path7284" sodipodi:nodetypes="ccccccccccccccccccccccccccccccccccccccccccccccc" style="fill:#fba246;fill-opacity:1.0000000;fill-rule:evenodd;stroke:#000000;stroke-width:0.91160071px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1.0000000"/> + <path d="M 389.86281,523.00744 C 389.46998,521.82897 391.23336,522.26765 390.84054,521.08918 C 383.37688,521.01061 375.91323,520.93205 368.44957,520.85348 C 368.44957,520.53923 368.44957,520.22496 368.44957,519.91070 C 374.10624,519.75357 379.76290,519.59645 385.41957,519.43932 C 388.24790,518.88937 391.07623,518.33941 393.90457,517.78946 C 395.39730,517.55377 396.89003,517.31807 398.38277,517.08237 C 401.44679,515.03969 404.51082,512.99701 407.57485,510.95432 C 407.49629,510.64006 407.41771,510.32580 407.33915,510.01153 C 401.36822,510.48292 395.39730,510.95432 389.42637,511.42571 C 387.30512,511.81853 385.18387,512.21135 383.06263,512.60418 C 379.13438,512.36849 375.20615,512.13279 371.27790,511.89710 C 369.78518,511.73997 368.29244,511.58284 366.79971,511.42571 C 364.44277,510.32580 362.08582,509.22589 359.72888,508.12598 C 376.54175,507.18320 396.89003,507.18320 415.11707,493.98432 C 391.31192,502.15506 371.27790,500.19093 355.01499,497.99112 C 375.91322,494.06288 396.57577,493.19867 417.00262,478.42849 C 387.38368,489.42756 366.24975,485.57788 349.35832,483.84946 C 371.51360,479.29269 403.56804,478.27136 414.40998,466.64376 C 383.06263,474.89306 355.95776,473.47890 338.75207,469.47210 C 352.81517,467.58654 366.87827,465.70098 380.94137,463.81543 C 374.10624,463.18691 367.27110,462.55840 360.43596,461.92988 C 373.32059,459.73006 386.20522,457.53024 399.08985,455.33043 C 381.88416,456.19465 346.53000,460.82997 319.89653,444.48849 C 323.66763,447.63108 328.61721,449.83090 331.20985,453.91627 C 327.28161,453.44487 323.35338,452.97349 319.42513,452.50210 C 319.66083,453.83770 319.89653,455.17330 320.13222,456.50890 C 324.13902,459.02298 328.14582,461.53704 332.15263,464.05112 C 327.43875,466.25093 322.72485,468.45075 318.01096,470.65057 C 323.90332,472.53612 329.79568,474.42169 335.68805,476.30724 C 330.03138,478.66418 322.48915,476.30724 318.71804,483.37807 C 325.55318,486.59923 335.21666,487.22774 339.22346,493.04154 C 333.33110,493.51293 326.73166,489.27043 321.54639,494.45571 C 327.67444,498.06968 333.80249,501.68367 339.93055,505.29765 C 336.55226,504.82626 333.17397,504.35487 329.79568,503.88348 C 334.58814,509.30445 341.26727,513.37780 346.05972,518.79877 C 362.00838,520.29150 373.91416,521.51471 389.86281,523.00744 z " id="path6556" sodipodi:nodetypes="ccccccccccccccccccccccccccccccccccccc" style="fill:#ffc080;fill-opacity:1.0000000;fill-rule:evenodd;stroke:none;stroke-width:1.0000000px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1.0000000"/> + <path d="M 410.63580,448.38806 C 375.91016,459.46570 347.07688,453.33765 330.49970,448.38806 C 332.54238,449.09515 334.58507,449.80223 336.62775,450.50931 C 365.30391,460.56561 396.80839,453.41621 407.80747,450.27362 C 408.75025,449.64510 409.69303,449.01658 410.63580,448.38806 z " id="path7286" sodipodi:nodetypes="ccccc" style="fill:#ffffff;fill-opacity:1.0000000;fill-rule:evenodd;stroke:none;stroke-width:1.0000000px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1.0000000"/> + <path d="M 431.22109,368.33927 C 427.74256,388.71364 424.26401,409.08801 420.78546,429.46237 C 416.60557,437.06563 407.94091,440.30372 400.07083,442.61238 C 391.48668,445.18530 382.40444,445.05799 373.54205,444.61656 C 371.08048,446.38986 364.99205,442.92177 370.06503,441.81235 C 377.17154,440.98795 384.60188,442.10538 391.38552,439.26558 C 401.04319,435.47671 410.26670,429.97354 417.05844,422.00834 C 421.19961,403.95301 425.34070,385.89766 429.48184,367.84233 C 430.06159,368.00798 430.64135,368.17360 431.22109,368.33927 z " id="path3629" style="fill:#ffffff;fill-opacity:0.64285713;fill-rule:evenodd;stroke:none;stroke-width:1.0000000px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1.0000000"/> + <path d="M 353.42087,428.84088 L 351.10708,419.00725 L 351.68553,378.22661 L 353.13164,373.45440 L 353.05576,339.28565 L 349.95018,336.28751 L 349.37173,316.04336 C 363.86558,304.49563 376.56238,306.21837 388.70625,316.23514 L 388.12780,336.28907 L 385.23556,339.18131 L 384.65711,373.58108 L 386.39245,378.21491 L 385.81401,427.68398 L 382.34331,429.99778 L 374.24503,428.84088 L 371.35278,425.37019 L 366.14675,425.37019 L 360.94071,429.41933 L 353.42087,428.84088 z " id="path3619" sodipodi:nodetypes="ccccccccccccccccccc" style="fill:#c1c1c1;fill-opacity:1.0000000;fill-rule:evenodd;stroke:#9b989f;stroke-width:0.91160071px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1.0000000"/> + <path d="M 358.25832,325.31572 L 358.25832,416.41507" id="path5096" style="fill:none;fill-opacity:0.75000000;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.91160071px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1.0000000"/> + <path d="M 380.15345,325.31572 L 380.15345,416.41507" id="path5824" style="fill:none;fill-opacity:0.75000000;fill-rule:evenodd;stroke:#ffffff;stroke-width:0.91160071px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1.0000000"/> + <path d="M 361.91098,325.31572 L 361.91098,416.41507" id="path5826" style="fill:none;fill-opacity:0.75000000;fill-rule:evenodd;stroke:#8f8f92;stroke-width:0.91160071px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1.0000000"/> + <path d="M 376.52161,325.31572 L 376.52161,416.41507" id="path6554" style="fill:none;fill-opacity:0.75000000;fill-rule:evenodd;stroke:#8f8f92;stroke-width:0.91160071px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1.0000000"/> + <g id="g9475" transform="matrix(0.911601,0.000000,0.000000,0.911601,328.5961,-156.2531)"> + <path d="M 86.864034,673.56687 L 79.199560,676.97330 L 77.155700,678.67652 L 75.793127,679.69845 L 65.573829,679.35780 L 65.403508,678.33587 L 70.683478,676.97330 C 70.683478,676.97330 74.430554,676.63266 75.111841,676.46234 C 75.793127,676.29201 78.688595,674.92944 78.688595,674.92944 L 84.649852,671.52301 L 87.034355,671.52301 L 86.864034,673.56687 z " id="path8741" style="fill:#ffffff;fill-opacity:1.0000000;fill-rule:evenodd;stroke:none;stroke-width:1.0000000px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1.0000000"/> + <path d="M 91.973683,686.34099 L 88.056285,686.17067 L 85.331139,687.53324 L 81.073098,689.23646 L 77.836987,691.45064 L 75.111841,692.30225 L 70.853800,692.64289 L 69.320905,693.15386 L 71.024122,693.83514 L 75.963449,693.83514 L 80.221490,694.51643 L 83.627923,693.83514 L 87.545320,690.42871 C 87.545320,690.42871 90.270466,689.23646 90.951753,688.89581 C 91.633039,688.55517 93.165934,687.87388 93.165934,687.87388 L 91.973683,686.34099 z " id="path8743" style="fill:#ffffff;fill-opacity:1.0000000;fill-rule:evenodd;stroke:none;stroke-width:1.0000000px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1.0000000"/> + <path d="M 94.017542,700.30736 L 89.078215,703.03251 L 85.842104,705.07637 L 83.457601,706.94991 L 77.836987,708.14216 L 75.622806,708.14216 L 81.584063,710.01570 L 86.353069,707.97184 L 91.292396,705.58733 L 92.825291,704.05444 L 94.017542,700.30736 z " id="path8745" style="fill:#ffffff;fill-opacity:1.0000000;fill-rule:evenodd;stroke:none;stroke-width:1.0000000px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1.0000000"/> + <path d="M 91.462718,717.85049 C 91.462718,717.85049 81.924706,721.59757 81.584063,722.27885 C 81.243420,722.96014 78.688595,723.98207 78.688595,723.98207 L 72.897660,724.66336 L 71.024122,725.68529 L 76.644736,726.36657 L 82.435671,724.49304 L 86.693712,724.32271 L 89.929823,722.10853 L 91.462718,720.40532 L 91.462718,717.85049 z " id="path8747" style="fill:#ffffff;fill-opacity:1.0000000;fill-rule:evenodd;stroke:none;stroke-width:1.0000000px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1.0000000"/> + </g> + <path d="M 378.14273,525.28637 C 377.57434,530.51553 378.00099,537.83204 377.43261,543.06120 C 372.27918,543.00443 367.82875,543.82657 360.97078,541.72320 C 359.43614,536.89190 356.80919,529.30796 355.27454,524.47667 C 356.26507,524.72572 356.68741,524.86790 357.82038,524.93742 C 358.95335,525.00694 360.79692,524.96593 361.90337,525.03791 C 363.00981,525.10990 364.25012,525.06768 365.31257,525.13480 C 366.37503,525.20191 367.41113,525.22689 368.41214,525.28180 C 369.41314,525.33669 370.37905,525.38365 371.30113,525.41898 C 372.22321,525.45432 374.35115,525.55378 375.17683,525.56221 C 376.00251,525.57065 375.56381,525.48806 376.27564,525.46225 C 376.98745,525.43643 377.56225,525.35378 378.14273,525.28637 z " id="path10207" sodipodi:nodetypes="ccccsssssssc" style="fill:#ffffff;fill-opacity:0.31547615;fill-rule:evenodd;stroke:none;stroke-width:1.0000000px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1.0000000"/> + <path d="M 467.06377,199.37552 L 453.69293,208.53364 L 451.86130,221.53816 L 468.71223,214.21167 L 467.06377,199.37552 z " id="path16869" style="fill:#fefefe;fill-opacity:1.0000000;fill-rule:evenodd;stroke:none;stroke-width:1.0000000px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1.0000000;opacity:1.0000000;color:#000000;marker:none;marker-start:none;marker-mid:none;marker-end:none;stroke-miterlimit:4.0000000;stroke-dasharray:none;stroke-dashoffset:0;visibility:visible;display:inline;overflow:visible"/> + </g> +</svg> diff --git a/doc/src/images/toc-blank.png b/doc/src/images/toc-blank.png Binary files differnew file mode 100644 index 0000000000..6ffad17a0c --- /dev/null +++ b/doc/src/images/toc-blank.png diff --git a/doc/src/images/toc-minus.png b/doc/src/images/toc-minus.png Binary files differnew file mode 100644 index 0000000000..abbb020c8e --- /dev/null +++ b/doc/src/images/toc-minus.png diff --git a/doc/src/images/toc-plus.png b/doc/src/images/toc-plus.png Binary files differnew file mode 100644 index 0000000000..941312ce0d --- /dev/null +++ b/doc/src/images/toc-plus.png diff --git a/doc/src/images/up.png b/doc/src/images/up.png Binary files differnew file mode 100644 index 0000000000..17d9c3ec49 --- /dev/null +++ b/doc/src/images/up.png diff --git a/doc/src/images/up.svg b/doc/src/images/up.svg new file mode 100644 index 0000000000..d31aa9c809 --- /dev/null +++ b/doc/src/images/up.svg @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!-- Generator: Adobe Illustrator 9.0, SVG Export Plug-In --> +<!DOCTYPE svg [ + <!ENTITY st0 "fill:none;stroke:none;"> + <!ENTITY st1 "fill:#FFFFFF;stroke:#FFFFFF;stroke-width:7.5901;stroke-linejoin:round;"> + <!ENTITY st2 "fill-rule:nonzero;clip-rule:nonzero;stroke:#000000;stroke-miterlimit:4;"> + <!ENTITY st3 "stroke:none;"> +]> +<svg width="48pt" height="48pt" viewBox="0 0 48 48" xml:space="preserve" xmlns="http://www.w3.org/2000/svg"> + <g id="Layer_x0020_3" style="&st2;"> + <g> + <path style="&st1;" d="M41.1,25.6c0.3,0,0.3-0.3,0.2-0.5L24.4,8.4c-0.5-0.5-0.7-0.4-1,0L6.7,25.1c-0.1,0.1-0.1,0.4,0.1,0.4h10v13.6c0,0.3,0.2,0.5,0.4,0.5l13.3,0c0.3,0,0.5-0.2,0.5-0.5V25.5l10.1,0.1z"/> + <path style="&st3;" d="M41.1,25.6c0.3,0,0.3-0.3,0.2-0.5L24.4,8.4c-0.5-0.5-0.7-0.4-1,0L6.7,25.1c-0.1,0.1-0.1,0.4,0.1,0.4h10v13.6c0,0.3,0.2,0.5,0.4,0.5l13.3,0c0.3,0,0.5-0.2,0.5-0.5V25.5l10.1,0.1z"/> + </g> + </g> + <g id="crop_x0020_marks" style="&st2;"> + <path style="&st0;" d="M48,48H0V0h48v48z"/> + </g> +</svg> diff --git a/doc/src/images/up_disabled.png b/doc/src/images/up_disabled.png Binary files differnew file mode 100644 index 0000000000..e22bc87121 --- /dev/null +++ b/doc/src/images/up_disabled.png diff --git a/doc/src/images/warning.png b/doc/src/images/warning.png Binary files differnew file mode 100644 index 0000000000..1c33db8f34 --- /dev/null +++ b/doc/src/images/warning.png diff --git a/doc/src/images/warning.svg b/doc/src/images/warning.svg new file mode 100644 index 0000000000..fc8d7484cb --- /dev/null +++ b/doc/src/images/warning.svg @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!-- Generator: Adobe Illustrator 9.0, SVG Export Plug-In --> +<!DOCTYPE svg [ + <!ENTITY st0 "fill:#000000;stroke:#FFFFFF;stroke-width:7.9139;stroke-linejoin:round;"> + <!ENTITY st1 "fill-rule:nonzero;clip-rule:nonzero;fill:#FFFFFF;stroke:#000000;stroke-miterlimit:4;"> + <!ENTITY st2 "fill:none;stroke:none;"> + <!ENTITY st3 "fill:#000000;"> + <!ENTITY st4 "fill-rule:evenodd;clip-rule:evenodd;stroke:none;"> + <!ENTITY st5 "fill-rule:nonzero;clip-rule:nonzero;stroke:#000000;stroke-miterlimit:4;"> +]> +<svg width="48pt" height="48pt" viewBox="0 0 48 48" xml:space="preserve" xmlns="http://www.w3.org/2000/svg"> + <g id="Layer_x0020_4" style="&st1;"> + <g style="&st4;"> + <path style="&st0;" d="M16.4,42.3L5.7,31.6V16.4L16.4,5.7h15.2l10.7,10.7v15.2L31.6,42.3H16.4z"/> + <path style="&st3;" d="M16.4,42.3L5.7,31.6V16.4L16.4,5.7h15.2l10.7,10.7v15.2L31.6,42.3H16.4z"/> + <path d="M11.7,17.7l18.7,18.7l5.9-5.9L17.6,11.7l-5.9,5.9z"/> + <path d="M11.7,30.5l5.9,5.9l18.7-18.7l-5.9-5.9L11.7,30.5z"/> + </g> + </g> + <g id="crop_x0020_marks" style="&st5;"> + <path style="&st2;" d="M48,48H0V0h48v48z"/> + </g> +</svg> diff --git a/doc/src/minimal.css b/doc/src/minimal.css new file mode 100644 index 0000000000..2e5812a9b8 --- /dev/null +++ b/doc/src/minimal.css @@ -0,0 +1,29 @@ +/* + + © Copyright Beman Dawes, 2007 + + Distributed under the Boost Software License, Version 1.0. + See www.boost.org/LICENSE_1_0.txt + +*/ + +/******************************************************************************* + Body +*******************************************************************************/ + +body { font-family: sans-serif; margin: 1em; } + +/******************************************************************************* + Table +*******************************************************************************/ + +table { margin: 0.5em; } + +/******************************************************************************* + Font sizes +*******************************************************************************/ + +p, td, li, blockquote { font-size: 10pt; } +pre { font-size: 9pt; } + +/*** end ***/
\ No newline at end of file diff --git a/doc/src/reference.css b/doc/src/reference.css new file mode 100644 index 0000000000..6826962afc --- /dev/null +++ b/doc/src/reference.css @@ -0,0 +1,11 @@ +/*============================================================================ + Copyright 2003-2004 Douglas Gregor + Distributed under the Boost Software License, Version 1.0. (See accompany- + ing file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +============================================================================*/ + +PRE.synopsis { + background-color: #e0ffff; + border: thin solid blue; + padding: 1em +}
\ No newline at end of file diff --git a/doc/test/HTML4_symbols.qbk b/doc/test/HTML4_symbols.qbk new file mode 100644 index 0000000000..2af7241ff2 --- /dev/null +++ b/doc/test/HTML4_symbols.qbk @@ -0,0 +1,253 @@ +[/ File Latin1_symbols.qbk +Copyright 2006-2007 Paul A. Bristow. +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). +] + + +[/ Symbols and Greek letters (about 120) from HTML4 ] +[/ File HTML4_symbols.qbk] +[/ See http://www.htmlhelp.com/reference/html40/entities/symbols.html] +[/ All (except 2 angle brackets) show OK on Firefox 2.0] + +[/ Also some miscellaneous math charaters added to this list - see the end.] + +[/ To use, enclose the template name in square brackets.] + +[template fnof[]'''ƒ'''] [/ � Latin small f with hook = function = florin] +[template Alpha[]'''Α'''] [/ ? Greek capital letter alpha] +[template Beta[]'''Β'''] [/ ? Greek capital letter beta] +[template Gamma[]'''Γ'''] [/ G Greek capital letter gamma] +[template Delta[]'''Δ'''] [/ ? Greek capital letter delta] +[template Epsilon[]'''Ε'''] [/ ? Greek capital letter epsilon] +[template Zeta[]'''Ζ'''] [/ ? Greek capital letter zeta] +[template Eta[]'''Η'''] [/ ? Greek capital letter eta] +[template Theta[]'''Θ'''] [/ T Greek capital letter theta] +[template Iota[]'''Ι'''] [/ ? Greek capital letter iota] +[template Kappa[]'''Κ'''] [/ ? Greek capital letter kappa] +[template Lambda[]'''Λ'''] [/ ? Greek capital letter lambda] +[template Mu[]'''Μ'''] [/ ? Greek capital letter mu] +[template Nu[]'''Ν'''] [/ ? Greek capital letter nu] +[template Xi[]'''Ξ'''] [/ ? Greek capital letter xi] +[template Omicron[]'''Ο'''] [/ ? Greek capital letter omicron] +[template Pi[]'''Π'''] [/ ? Greek capital letter pi] +[template Rho[]'''Ρ'''] [/ ? Greek capital letter rho] +[template Sigma[]'''Σ'''] [/ S Greek capital letter sigma] +[template Tau[]'''Τ'''] [/ ? Greek capital letter tau] +[template Upsilon[]'''Υ'''] [/ ? Greek capital letter upsilon] +[template Phi[]'''Φ'''] [/ F Greek capital letter phi] +[template Chi[]'''Χ'''] [/ ? Greek capital letter chi] +[template Psi[]'''Ψ'''] [/ ? Greek capital letter psi] +[template Omega[]'''Ω'''] [/ O Greek capital letter omega] +[template alpha[]'''α'''] [/ a Greek small letter alpha] +[template beta[]'''β'''] [/ � Greek small letter beta] +[template gamma[]'''γ'''] [/ ? Greek small letter gamma] +[template delta[]'''δ'''] [/ d Greek small letter delta] +[template epsilon[]'''ε'''] [/ e Greek small letter epsilon] +[template zeta[]'''ζ'''] [/ ? Greek small letter zeta] +[template eta[]'''η'''] [/ ? Greek small letter eta] +[template theta[]'''θ'''] [/ ? Greek small letter theta] +[template iota[]'''ι'''] [/ ? Greek small letter iota] +[template kappa[]'''κ'''] [/ ? Greek small letter kappa] +[template lambda[]'''λ'''] [/ ? Greek small letter lambda] +[template mu[]'''μ'''] [/ � Greek small letter mu] +[template nu[]'''ν'''] [/ ? Greek small letter nu] +[template xi[]'''ξ'''] [/ ? Greek small letter xi] +[template omicron[]'''ο'''] [/ ? Greek small letter omicron] +[template pi[]'''π'''] [/ p Greek small letter pi] +[template rho[]'''ρ'''] [/ ? Greek small letter rho] +[template sigmaf[]'''ς'''] [/ ? Greek small letter final sigma] +[template sigma[]'''σ'''] [/ s Greek small letter sigma] +[template tau[]'''τ'''] [/ t Greek small letter tau] +[template upsilon[]'''υ'''] [/ ? Greek small letter upsilon] +[template phi[]'''φ'''] [/ f Greek small letter phi] +[template chi[]'''χ'''] [/ ? Greek small letter chi] +[template psi[]'''ψ'''] [/ ? Greek small letter psi] +[template omega[]'''ω'''] [/ ? Greek small letter omega] +[template thetasym[]'''ϑ'''] [/ ? Greek small letter theta symbol] +[template upsih[]'''ϒ'''] [/ ? Greek upsilon with hook symbol] +[template piv[]'''ϖ'''] [/ ? Greek pi symbol] +[template bull[]'''•'''] [/ � bullet = black small circle] +[template hellip[]'''…'''] [/ � horizontal ellipsis = three dot leader] +[template prime[]'''′'''] [/ ' prime = minutes = feet] +[template Prime[]'''″'''] [/ ? double prime = seconds = inches] +[template oline[]'''‾'''] [/ ? overline = spacing overscore] +[template frasl[]'''⁄'''] [/ / fraction slash] +[template weierp[]'''℘'''] [/ P script capital P = power set = Weierstrass p] +[template image[]'''ℑ'''] [/ I blackletter capital I = imaginary part] +[template real[]'''ℜ'''] [/ R blackletter capital R = real part symbol] +[template trade[]'''™'''] [/ � trade mark sign] +[template alefsym[]'''ℵ'''] [/ ? alef symbol = first transfinite cardinal] +[template larr[]'''←'''] [/ ? leftwards arrow] +[template uarr[]'''↑'''] [/ ? upwards arrow] +[template rarr[]'''→'''] [/ ? rightwards arrow] +[template darr[]'''↓'''] [/ ? downwards arrow] +[template harr[]'''↔'''] [/ ? left right arrow] +[template crarr[]'''↵'''] [/ ? downwards arrow with corner leftwards = CR] +[template lArr[]'''⇐'''] [/ ? leftwards double arrow] +[template uArr[]'''⇑'''] [/ ? upwards double arrow] +[template rArr[]'''⇒'''] [/ ? rightwards double arrow] +[template dArr[]'''⇓'''] [/ ? downwards double arrow] +[template hArr[]'''⇔'''] [/ ? left right double arrow] +[template forall[]'''∀'''] [/ ? for all] +[template part[]'''∂'''] [/ ? partial differential] +[template exist[]'''∃'''] [/ ? there exists] +[template empty[]'''∅'''] [/ � empty set = null set = diameter] +[template nabla[]'''∇'''] [/ ? nabla = backward difference] +[template isin[]'''∈'''] [/ ? element of] +[template notin[]'''∉'''] [/ ? not an element of] +[template ni[]'''∋'''] [/ ? contains as member] +[template prod[]'''∏'''] [/ ? n-ary product = product sign] +[template sum[]'''∑'''] [/ ? n-ary sumation] +[template minus[]'''−'''] [/ - minus sign] +[template lowast[]'''∗'''] [/ * asterisk operator] +[template radic[]'''√'''] [/ v square root = radical sign] +[template prop[]'''∝'''] [/ ? proportional to] +[template infin[]'''∞'''] [/ 8 infinity] +[template ang[]'''∠'''] [/ ? angle] +[template and[]'''∧'''] [/ ? logical and = wedge] +[template or[]'''∨'''] [/ ? logical or = vee] +[template cap[]'''∩'''] [/ n intersection = cap] +[template cup[]'''∪'''] [/ ? union = cup] +[template int[]'''∫'''] [/ ? integral] +[template there4[]'''∴'''] [/ ? therefore] +[template sim[]'''∼'''] [/ ~ tilde operator = varies with = similar to] +[template cong[]'''≅'''] [/ ? approximately equal to] +[template asymp[]'''≈'''] [/ � almost equal to = asymptotic to] +[template ne[]'''≠'''] [/ ? not equal to] +[template equiv[]'''≡'''] [/ = identical to] +[template le[]'''≤'''] [/ = less-than or equal to] +[template ge[]'''≥'''] [/ = greater-than or equal to] +[template subset[]'''⊂'''] [/ ? subset of] +[template superset[]'''⊃'''] [/ ? superset of] +[template nsubset[]'''⊄'''] [/ ? not a subset of] +[template sube[]'''⊆'''] [/ ? subset of or equal to] +[template supe[]'''⊇'''] [/ ? superset of or equal to] +[template oplus[]'''⊕'''] [/ ? circled plus = direct sum] +[template otimes[]'''⊗'''] [/ ? circled times = vector product] +[template perp[]'''⊥'''] [/ ? up tack = orthogonal to = perpendicular] +[template sdot[]'''⋅'''] [/ � dot operator] +[template lceil[]'''⌈'''] [/ ? left ceiling = APL upstile] +[template rceil[]'''⌉'''] [/ ? right ceiling] +[template lfloor[]'''⌊'''] [/ ? left floor = APL downstile] +[template rfloor[]'''⌋'''] [/ ? right floor] +[template lang[]'''〈'''] [/ < left-pointing angle bracket = bra (Firefox shows ?)] +[template rang[]'''〉'''] [/ > right-pointing angle bracket = ket (Firefox shows ?)] +[template loz[]'''◊'''] [/ ? lozenge] +[template spades[]'''♠'''] [/ ? black spade suit] +[template clubs[]'''♣'''] [/ ? black club suit = shamrock] +[template hearts[]'''♥'''] [/ ? black heart suit = valentine] +[template diams[]'''♦'''] [/ ? black diamond suit] + +[/ Other symbols, not in the HTML4 list:] +[template space[]''' '''] +[template plusminus[]'''±'''] [/ ? plus or minus sign] + + +[/ Symbols and accented letters from Latin-1] +[/ File Latin1_symbols.qbk] +[/ http://www.htmlhelp.com/reference/html40/entities/latin1.html ] +[/ based on table Copyright </copyright.html> 1998-2006 Liam Quinn.] +[/ Glyphs <http://www.unicode.org/charts/> of the characters ] +[/ are available at the Unicode Consortium <http://www.unicode.org/>. ] + +[template nbsp[]''' '''] [/ no-break space = non-breaking space] +[template iexcl[]'''¡'''] [/ inverted exclamation mark ] +[template cent[]'''¢'''] [/ cent sign ] +[template pound[]'''£'''] [/ pound sign ] +[template curren[]'''¤'''] [/ currency sign ] +[template yen[]'''¥'''] [/ yen sign = yuan sign ] +[template brvbar[]'''¦'''] [/ broken vertical bar ] +[template sectsign[]'''§'''] [/ section sign ] +[template uml[]'''¨'''] [/ diaeresis ] +[template copy[]'''©'''] [/ copyright ] +[template ordf[]'''ª'''] [/ feminine ordinal indicator ] +[template laquo[]'''«'''] [/ left-pointing double angle quotation mark = left pointing guillemet ] +[template not[]'''¬'''] [/ not sign ] +[template shy[]'''­'''] [/ soft hyphen = discretionary hyphen ] +[template reg[]'''®'''] [/ registered sign = registered trade mark sign ] +[template macron[]'''¯'''] [/ macron = spacing macron = overline = APL overbar ] +[template deg[]'''°'''] [/ degree sign ] +[template plusmn[]'''±'''] [/ plus-minus sign = plus-or-minus sign ] +[template sup2[]'''²'''] [/ superscript two = superscript digit two = squared ] +[template cubed[]'''³'''] [/ superscript three = superscript digit three = cubed ] +[template acute[]'''´'''] [/ acute accent = spacing acute ] +[template micro[]'''µ'''] [/ micro sign ] +[template para[]'''¶'''] [/ pilcrow sign = paragraph sign ] +[template middot[]'''·'''] [/ middle dot = Georgian comma = Greek middle dot ] +[template cedil[]'''¸'''] [/ cedilla = spacing cedilla ] +[template sup1[]'''¹'''] [/ superscript one = superscript digit one ] +[template ordm[]'''º'''] [/ masculine ordinal indicator ] +[template raquo[]'''»'''] [/ right-pointing double angle quotation mark = right pointing guillemet ] +[template frac14[]'''¼'''] [/ vulgar fraction one quarter = fraction one quarter ] +[template frac12[]'''½'''] [/ vulgar fraction one half = fraction one half ] +[template frac34[]'''¾'''] [/vulgar fraction three quarters = fraction three quarters ] +[template iquest[]'''¿'''] [/ inverted question mark = turned question mark ] +[template Agrave[]'''À'''] [/ Latin capital letter A with grave = Latin capital letter A grave ] +[template Aacute[]'''Á'''] [/ Latin capital letter A with acute = Latin capital letter A acute ] +[template Acirc[]'''Â'''] [/ Latin capital letter A with circumflex ] +[template Atilde[]'''Ã'''] [/Latin capital letter A with tilde ] +[template Auml[]'''Ä'''] [/ Latin capital letter A with diaeresis ] +[template Aring[]'''Å'''] [/ Latin capital letter A with ring above = Latin capital letter A ring ] +[template AElig[]'''Æ'''] [/ Latin capital letter AE = Latin capital ligature AE ] +[template Ccedil[]'''Ç'''] [/ Latin capital letter C with cedilla ] +[template Egrave[]'''È'''] [/ Latin capital letter E with grave ] +[template Eacute[]'''É'''] [/ Latin capital letter E with acute ] +[template Ecirc[]'''Ê'''] [/ Latin capital letter E with circumflex ] +[template Euml[]'''Ë'''] [/ Latin capital letter E with diaeresis ] +[template Igrave[]'''Ì'''] [/ Latin capital letter I with grave ] +[template Iacute[]'''Í'''] [/ Latin capital letter I with acute ] +[template Icirc[]'''Î'''] [/ Latin capital letter I with circumflex ] +[template Iuml[]'''Ï'''] [/ Latin capital letter I with diaeresis ] +[template ETH[]'''Ð'''] [/ Latin capital letter ETH ] +[template Ntilde[]'''Ñ'''] [/ Latin capital letter N with tilde ] +[template Ograve[]'''Ò'''] [/ Latin capital letter O with grave] +[template Oacute[]'''Ó'''] [/ Latin capital letter O with acute ] +[template Ocirc[]'''Ô'''] [/ Latin capital letter O with circumflex ] +[template Otilde[]'''Õ'''] [/ Latin capital letter O with tilde ] +[template Ouml[]'''Ö'''] [/ Latin capital letter O with diaeresis ] +[template times[]'''×'''] [/ multiplication sign ] +[template Oslash[]'''Ø'''] [/ Latin capital letter O with stroke = Latin capital letter O slash ] +[template Ugrave[]'''Ù'''] [/ Latin capital letter U with grave ] +[template Uacute[]'''Ú'''] [/ Latin capital letter U with acute ] +[template Ucirc[]'''Û'''] [/ Latin capital letter U with circumflex ] +[template Uuml[]'''Ü'''] [/ Latin capital letter U with diaeresis ] +[template Yacute[]'''Ý'''] [/ Latin capital letter Y with acute ] +[template THORN[]'''Þ'''] [/ Latin capital letter THORN ] +[template szlig[]'''ß'''] [/ Latin small letter sharp s = ess-zed ] +[template agrave[]'''à'''] [/ Latin small letter a with grave = Latin small letter a grave ] +[template aacute[]'''á'''] [/ Latin small letter a with acute ] +[template acirc[]'''â'''] [/ Latin small letter a with circumflex ] +[template atilde[]'''ã'''] [/ Latin small letter a with tilde ] +[template auml[]'''ä'''] [/ Latin small letter a with diaeresis ] +[template aring[]'''å'''] [/ Latin small letter a with ring above = Latin small letter a ring ] +[template aelig[]'''æ'''] [/ Latin small letter ae = Latin small ligature ae ] +[template ccedil[]'''ç'''] [/ Latin small letter c with cedilla ] +[template egrave[]'''è'''] [/ Latin small letter e with grave ] +[template eacute[]'''é'''] [/ Latin small letter e with acute ] +[template ecirc[]'''ê'''] [/ Latin small letter e with circumflex ] +[template euml[]'''ë'''] [/ Latin small letter e with diaeresis ] +[template igrave[]'''ì'''] [/ Latin small letter i with grave ] +[template iacute[]'''í'''] [/ Latin small letter i with acute ] +[template icirc[]'''î'''] [/ Latin small letter i with circumflex ] +[template iuml[]'''ï'''] [/ Latin small letter i with diaeresis ] +[template eth[]'''ð'''] [/ Latin small letter eth ] +[template ntilde[]'''ñ'''] [/ Latin small letter n with tilde ] +[template ograve[]'''ò'''] [/Latin small letter o with grave ] +[template oacute[]'''ó'''] [/ Latin small letter o with acute ] +[template ocirc[]'''ô'''] [/ Latin small letter o with circumflex ] +[template otilde[]'''õ'''] [/ Latin small letter o with tilde ] +[template ouml[]'''ö'''] [/ Latin small letter o with diaeresis ] +[template divide[]'''÷'''] [/ division sign ] +[template oslash[]'''ø'''] [/ Latin small letter o with stroke = Latin small letter o slash ] +[template ugrave[]'''ù'''] [/ Latin small letter u with grave ] +[template uacute[]'''ú'''] [/ Latin small letter u with acute ] +[template ucirc[]'''û'''] [/ Latin small letter u with circumflex ] +[template uuml[]'''ü'''] [/ Latin small letter u with diaeresis ] +[template yacute[]'''ý'''] [/ Latin small letter y with acute ] +[template thorn[]'''þ'''] [/ Latin small letter thorn ] +[template yuml[]'''ÿ'''] [/ Latin small letter y with diaeresis ] + + + diff --git a/doc/test/Jamfile.v2 b/doc/test/Jamfile.v2 new file mode 100644 index 0000000000..7d55b74e49 --- /dev/null +++ b/doc/test/Jamfile.v2 @@ -0,0 +1,207 @@ +# Copyright John Maddock 2008. Use, modification, and distribution are +# subject to 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) + +import os ; +import common ; +import doxygen ; +using quickbook ; +import modules ; + +path-constant images_location : html ; + +# +# Accumulators docs are dependent upon +# latex dvips and ps being in your PATH. +# This is true for most Unix installs, but +# not on Win32, where you will need to install +# MkTex and Ghostscript and add these tools +# to your path. +# +make latex.check : : @check-latex ; +actions check-latex +{ + latex -version > latex.version +} + +make dvips.check : : @check-dvips ; +actions check-dvips +{ + dvips -version > dvips.version +} + +make gs.check : : @check-gs ; + +import os ; + +if [ os.name ] = "NT" +{ + actions check-gs + { + gswin32c -version > gs.version + } +} +else +{ + actions check-gs + { + gs -version > gs.version + } +} + + +# Use Doxygen to emit a tagfile with the definition of depends_on<>. That +# tagfile will be used by Doxygen below when generating the Statistics Library +# Reference. This is all so that the Doxygen-generated documentation for the +# features shows the dependency relationships between them. +doxygen tagfile + : + ../../boost/accumulators/framework/depends_on.hpp + ../../boost/accumulators/framework/extractor.hpp + : + <doxygen:param>MACRO_EXPANSION=YES + <doxygen:param>EXPAND_ONLY_PREDEF=YES + <doxygen:param>GENERATE_TAGFILE=accumulators.tag + <doxygen:param>"PREDEFINED=\"BOOST_ACCUMULATORS_DOXYGEN_INVOKED=1\" \\ + \"BOOST_PP_REPEAT_FROM_TO(a,b,c,d)=\" \\ + \"BOOST_PP_ENUM_PARAMS(a,b)=b ## 1, b ## 2, ...\"" + <dependency>latex.check + <dependency>dvips.check + <dependency>gs.check + ; + +# Generate the HTML form of the stats documentation, as this causes Doxygen to +# generate .png images for the LaTeX formulas embedded in the doc comments. +doxygen statsdoc.html + : + weighted_tail_quantile.hpp + : + <dependency>latex.check + <dependency>dvips.check + <dependency>gs.check + ; + +if [ os.name ] = NT +{ + CP = copy /y ; + MKDIR = mkdir ; + FROM = \\..\\..\\..\\html\\statsdoc\\*.png ; + TOHTML = .\\html\\images\\accumulators ; + TOPDF = \\images\\accumulators ; +} +else +{ + CP = cp ; + MKDIR = mkdir -p ; + FROM = /../../html/statsdoc/*.png ; + TOHTML = ./html/images/accumulators ; + TOPDF = /images/accumulators ; +} + +actions copy-latex-pngs +{ + $(MKDIR) $(TOHTML) + $(MKDIR) $(<:D)$(TOPDF) + $(CP) $(<:D)$(FROM) $(TOHTML) + $(CP) $(<:D)$(FROM) $(<:D)$(TOPDF) + echo "Stamped" > "$(<)" +} + +# This causes the png files built above to be copied into the +# html/images/accumulators directory. +make statsdoclatex.tag + : statsdoc.html + : @copy-latex-pngs + ; + +doxygen statsdoc + : + weighted_tail_quantile.hpp + : + <doxygen:param>EXTRACT_ALL=YES + <doxygen:param>"PREDEFINED=\"BOOST_ACCUMULATORS_DOXYGEN_INVOKED=1\" \\ + \"BOOST_PP_REPEAT_FROM_TO(a,b,c,d)=\" \\ + \"BOOST_PP_REPEAT(a,b,c)=\" \\ + \"BOOST_PARAMETER_KEYWORD(a,b)=\\ + namespace a { struct b {}; } \\ + boost::parameter::keyword<a::b> const b;\" \\ + \"BOOST_PP_ENUM_PARAMS(a,b)=b ## 1, b ## 2, ...\"" + <doxygen:param>HIDE_UNDOC_MEMBERS=NO + <doxygen:param>EXTRACT_PRIVATE=NO + <doxygen:param>ENABLE_PREPROCESSING=YES + <doxygen:param>MACRO_EXPANSION=YES + <doxygen:param>EXPAND_ONLY_PREDEF=YES + <doxygen:param>SEARCH_INCLUDES=NO + <doxygen:param>TAGFILES=accumulators.tag + <xsl:param>boost.doxygen.header.prefix=doc + <xsl:param>boost.doxygen.formuladir=images/accumulators/ + <reftitle>"Statistics Library Reference" + <dependency>tagfile + <dependency>statsdoclatex.tag + <dependency>latex.check + <dependency>dvips.check + <dependency>gs.check + ; + +if htmlhelp in [ modules.peek : ARGV ] +{ + # + # Start with a rule to convert htmlhelp project into + # compiled help file: + # + make htmlhelp/htmlhelp.chm : standalone : @hhc ; + actions ignore hhc + { + hhc htmlhelp/htmlhelp.hhp + } + # + # These install rules copy our images into a subdirectory of the created + # htmlhelp project directory: unfortunately hhc.exe will only embed + # images in a subdirectory of the project root. + # + install htmlhelp1 : [ glob html/images/*.png ] : <location>htmlhelp/images ; + install htmlhelp1a : [ glob html/images/*.svg ] : <location>htmlhelp/images ; + install htmlhelp2 : [ glob html/images/accumulators/*.png ] : <dependency>statsdoc <location>htmlhelp/images/accumulators ; + install htmlhelp3 : [ glob ../src/images/*.png ] : <dependency>statsdoc <location>htmlhelp/images ; + install htmlhelp4 : [ glob ../src/images/callouts/*.png ] : <dependency>statsdoc <location>htmlhelp/images/callouts ; +} + +xml test : test.qbk ; +boostbook standalone + : + test + : + <dependency>statsdoc + <format>htmlhelp:<dependency>htmlhelp1 + <format>htmlhelp:<dependency>htmlhelp1a + <format>htmlhelp:<dependency>htmlhelp2 + <format>htmlhelp:<dependency>htmlhelp3 + <format>htmlhelp:<dependency>htmlhelp4 + + # HTML options first: + #====================================================================== + + <xsl:param>toc.max.depth=2 + <xsl:param>toc.section.depth=2 + <xsl:param>chunk.section.depth=1 + <xsl:param>boost.root=../../.. + <xsl:param>navig.graphics=1 + + + # PDF Options: + #====================================================================== + <format>pdf:<xsl:param>img.src.path=$(images_location)/ + <format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/doc/test/html + + # HTML Help Options: + #====================================================================== + #<format>htmlhelp:<xsl:param>img.src.path=../html + <format>htmlhelp:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/doc/test/html + <format>htmlhelp:<xsl:param>htmlhelp.chm=test.chm + ; + + +install pdf-install : standalone : <location>. <install-type>PDF ; + + + diff --git a/doc/test/array.xml b/doc/test/array.xml new file mode 100644 index 0000000000..ce3f57e029 --- /dev/null +++ b/doc/test/array.xml @@ -0,0 +1,64 @@ +<section id="array.intro"> + <title>Introduction</title> + + <using-namespace name="boost"/> + <using-class name="array"/> + + <para>The C++ Standard Template Library STL as part of the C++ + Standard Library provides a framework for processing algorithms on + different kind of containers. However, ordinary arrays don't + provide the interface of STL containers (although, they provide + the iterator interface of STL containers).</para> + + <para>As replacement for ordinary arrays, the STL provides class + <code><classname>std::vector</classname></code>. However, + <code><classname>std::vector<></classname></code> provides + the semantics of dynamic arrays. Thus, it manages data to be able + to change the number of elements. This results in some overhead in + case only arrays with static size are needed.</para> + + <para>In his book, <emphasis>Generic Programming and the + STL</emphasis>, Matthew H. Austern introduces a useful wrapper + class for ordinary arrays with static size, called + <code>block</code>. It is safer and has no worse performance than + ordinary arrays. In <emphasis>The C++ Programming + Language</emphasis>, 3rd edition, Bjarne Stroustrup introduces a + similar class, called <code>c_array</code>, which I (<ulink + url="http://www.josuttis.com">Nicolai Josuttis</ulink>) present + slightly modified in my book <emphasis>The C++ Standard Library - + A Tutorial and Reference</emphasis>, called + <code>carray</code>. This is the essence of these approaches + spiced with many feedback from <ulink + url="http://www.boost.org">boost</ulink>.</para> + + <para>After considering different names, we decided to name this + class simply <code><classname>array</classname></code>.</para> + + <para>Note that this class is suggested to be part of the next + Technical Report, which will extend the C++ Standard (see + <ulink url="http://std.dkuug.dk/jtc1/sc22/wg21/docs/papers/2003/n1548.htm">http://std.dkuug.dk/jtc1/sc22/wg21/docs/papers/2003/n1548.htm</ulink>).</para> + + <para>Class <code><classname>array</classname></code> fulfills most + but not all of the requirements of "reversible containers" (see + Section 23.1, [lib.container.requirements] of the C++ + Standard). The reasons array is not an reversible STL container is + because: + <itemizedlist spacing="compact"> + <listitem><simpara>No constructors are provided.</simpara></listitem> + <listitem><simpara>Elements may have an undetermined initial value (see <xref linkend="array.rationale"/>).</simpara></listitem> + <listitem><simpara><functionname>swap</functionname>() has no constant complexity.</simpara></listitem> + <listitem><simpara><methodname>size</methodname>() is always constant, based on the second template argument of the type.</simpara></listitem> + <listitem><simpara>The container provides no allocator support.</simpara></listitem> + </itemizedlist> + </para> + + <para>It doesn't fulfill the requirements of a "sequence" (see Section 23.1.1, [lib.sequence.reqmts] of the C++ Standard), except that: + <itemizedlist spacing="compact"> + <listitem><simpara><methodname>front</methodname>() and <methodname>back</methodname>() are provided.</simpara></listitem> + <listitem><simpara><methodname>operator[]</methodname> and <methodname>at</methodname>() are provided.</simpara></listitem> + </itemizedlist> + </para> + </section> + + + diff --git a/doc/test/array1.xml b/doc/test/array1.xml new file mode 100644 index 0000000000..253938bcff --- /dev/null +++ b/doc/test/array1.xml @@ -0,0 +1,511 @@ +<library-reference> + <header name="boost/array.hpp"> + <namespace name="boost"> + <class name="array"> + <template> + <template-type-parameter name="T"/> + <template-nontype-parameter name="N"> + <type>std::size_t</type> + </template-nontype-parameter> + </template> + + <purpose> + <para>STL compliant container wrapper for arrays of constant size</para> + </purpose> + <typedef name="value_type"> + <type>T</type> + </typedef> + <typedef name="iterator"> + <type>T*</type> + </typedef> + <typedef name="const_iterator"> + <type>const T*</type> + </typedef> + <typedef name="reverse_iterator"> + <type> + <classname>std::reverse_iterator</classname><iterator> + </type> + </typedef> + <typedef name="const_reverse_iterator"> + <type> + <classname>std::reverse_iterator</classname><const_iterator> + </type> + </typedef> + <typedef name="reference"> + <type>T&</type> + </typedef> + <typedef name="const_reference"> + <type>const T&</type> + </typedef> + <typedef name="size_type"> + <type>std::size_t</type> + </typedef> + <typedef name="difference_type"> + <type>std::ptrdiff_t</type> + </typedef> + + <static-constant name="static_size"> + <type>size_type</type> + <default>N</default> + </static-constant> + + <copy-assignment> + <template> + <template-type-parameter name="U"/> + </template> + <parameter name="other"> + <paramtype>const <classname>array</classname><U, N>&</paramtype> + </parameter> + <effects> + <simpara> + <code> + std::copy(rhs.<methodname>begin</methodname>(),rhs.<methodname>end</methodname>(), <methodname>begin</methodname>()) + </code> + </simpara> + </effects> + </copy-assignment> + + <method-group name="iterator support"> + <overloaded-method name="begin"> + <signature> + <type>iterator</type> + </signature> + <signature cv="const"> + <type>const_iterator</type> + </signature> + + <returns> + <simpara>iterator for the first element</simpara> + </returns> + <throws> + <simpara>will not throw</simpara> + </throws> + </overloaded-method> + + <overloaded-method name="end"> + <signature> + <type>iterator</type> + </signature> + <signature cv="const"> + <type>const_iterator</type> + </signature> + + <returns> + <simpara>iterator for position after the last element</simpara> + </returns> + <throws> + <simpara>will not throw</simpara> + </throws> + </overloaded-method> + </method-group> + + <method-group name="reverse iterator support"> + <overloaded-method name="rbegin"> + <signature> + <type>reverse_iterator</type> + </signature> + <signature cv="const"> + <type>const_reverse_iterator</type> + </signature> + + <returns> + <simpara>reverse iterator for the first element of reverse iteration</simpara> + </returns> + </overloaded-method> + + <overloaded-method name="rend"> + <signature> + <type>reverse_iterator</type> + </signature> + <signature cv="const"> + <type>const_reverse_iterator</type> + </signature> + + <returns> + <simpara>reverse iterator for position after the last element in reverse iteration</simpara> + </returns> + </overloaded-method> + </method-group> + + <method-group name="capacity"> + <method name="size"> + <type>size_type</type> + <returns> + <simpara> + <code>N</code> + </simpara> + </returns> + </method> + <method name="empty"> + <type>bool</type> + <returns> + <simpara> + <code>N==0</code> + </simpara> + </returns> + <throws> + <simpara>will not throw</simpara> + </throws> + </method> + <method name="max_size"> + <type>size_type</type> + <returns> + <simpara> + <code>N</code> + </simpara> + </returns> + <throws> + <simpara>will not throw</simpara> + </throws> + </method> + </method-group> + + <method-group name="element access"> + <overloaded-method name="operator[]"> + <signature> + <type>reference</type> + <parameter name="i"> + <paramtype>size_type</paramtype> + </parameter> + </signature> + + <signature cv="const"> + <type>const_reference</type> + <parameter name="i"> + <paramtype>size_type</paramtype> + </parameter> + </signature> + + <requires> + <simpara> + <code>i < N</code> + </simpara> + </requires> + <returns> + <simpara> + element with index <code>i</code> + </simpara> + </returns> + <throws> + <simpara>will not throw.</simpara> + </throws> + </overloaded-method> + + <overloaded-method name="at"> + <signature> + <type>reference</type> + <parameter name="i"> + <paramtype>size_type</paramtype> + </parameter> + </signature> + + <signature cv="const"> + <type>const_reference</type> + <parameter name="i"> + <paramtype>size_type</paramtype> + </parameter> + </signature> + + <returns> + <simpara> + element with index <code>i</code> + </simpara> + </returns> + <throws> + <simpara> + <code> + <classname>std::range_error</classname> + </code> if <code>i >= N</code> + </simpara> + </throws> + </overloaded-method> + + <overloaded-method name="front"> + <signature> + <type>reference</type> + </signature> + <signature cv="const"> + <type>const_reference</type> + </signature> + <requires> + <simpara> + <code>N > 0</code> + </simpara> + </requires> + <returns> + <simpara>the first element</simpara> + </returns> + <throws> + <simpara>will not throw</simpara> + </throws> + </overloaded-method> + + <overloaded-method name="back"> + <signature> + <type>reference</type> + </signature> + <signature cv="const"> + <type>const_reference</type> + </signature> + <requires> + <simpara> + <code>N > 0</code> + </simpara> + </requires> + <returns> + <simpara>the last element</simpara> + </returns> + <throws> + <simpara>will not throw</simpara> + </throws> + </overloaded-method> + + <method name="data" cv="const"> + <type>const T*</type> + <returns> + <simpara> + <code>elems</code> + </simpara> + </returns> + <throws> + <simpara>will not throw</simpara> + </throws> + </method> + + <method name="c_array"> + <type>T*</type> + <returns> + <simpara> + <code>elems</code> + </simpara> + </returns> + <throws> + <simpara>will not throw</simpara> + </throws> + </method> + </method-group> + + <method-group name="modifiers"> + <method name="swap"> + <type>void</type> + <parameter name="other"> + <paramtype><classname>array</classname><T, N>&</paramtype> + </parameter> + <effects> + <simpara> + <code> + std::swap_ranges(<methodname>begin</methodname>(), <methodname>end</methodname>(), other.<methodname>begin</methodname>()) + </code> + </simpara> + </effects> + <complexity> + <simpara> + linear in <code>N</code> + </simpara> + </complexity> + </method> + <method name="assign"> + <type>void</type> + <parameter name="value"> + <paramtype>const T&</paramtype> + </parameter> + <effects> + <simpara> + <code> + std::fill_n(<methodname>begin</methodname>(), N, value) + </code> + </simpara> + </effects> + </method> + </method-group> + + <data-member name="elems[N]"> + <!-- HACK --> + <type>T</type> + </data-member> + + <free-function-group name="specialized algorithms"> + <function name="swap"> + <template> + <template-type-parameter name="T"/> + <template-nontype-parameter name="N"> + <type>std::size_t</type> + </template-nontype-parameter> + </template> + + <type>void</type> + + <parameter name="x"> + <paramtype><classname>array</classname><T, N>&</paramtype> + </parameter> + <parameter name="y"> + <paramtype><classname>array</classname><T, N>&</paramtype> + </parameter> + + <effects> + <simpara> + <code> + x.<methodname>swap</methodname>(y) + </code> + </simpara> + </effects> + <throws> + <simpara>will not throw.</simpara> + </throws> + </function> + </free-function-group> + + <free-function-group name="comparisons"> + <function name="operator=="> + <template> + <template-type-parameter name="T"/> + <template-nontype-parameter name="N"> + <type>std::size_t</type> + </template-nontype-parameter> + </template> + + <type>bool</type> + + <parameter name="x"> + <paramtype>const <classname>array</classname><T, N>&</paramtype> + </parameter> + <parameter name="y"> + <paramtype>const <classname>array</classname><T, N>&</paramtype> + </parameter> + + <returns> + <simpara> + <code> + std::equal(x.<methodname>begin</methodname>(), x.<methodname>end</methodname>(), y.<methodname>begin</methodname>()) + </code> + </simpara> + </returns> + </function> + + <function name="operator!="> + <template> + <template-type-parameter name="T"/> + <template-nontype-parameter name="N"> + <type>std::size_t</type> + </template-nontype-parameter> + </template> + + <type>bool</type> + + <parameter name="x"> + <paramtype>const <classname>array</classname><T, N>&</paramtype> + </parameter> + <parameter name="y"> + <paramtype>const <classname>array</classname><T, N>&</paramtype> + </parameter> + + <returns> + <simpara> + <code>!(x == y)</code> + </simpara> + </returns> + </function> + + <function name="operator<"> + <template> + <template-type-parameter name="T"/> + <template-nontype-parameter name="N"> + <type>std::size_t</type> + </template-nontype-parameter> + </template> + + <type>bool</type> + + <parameter name="x"> + <paramtype>const <classname>array</classname><T, N>&</paramtype> + </parameter> + <parameter name="y"> + <paramtype>const <classname>array</classname><T, N>&</paramtype> + </parameter> + + <returns> + <simpara> + <code> + std::lexicographical_compare(x.<methodname>begin</methodname>(), x.<methodname>end</methodname>(), y.<methodname>begin</methodname>(), y.<methodname>end</methodname>()) + </code> + </simpara> + </returns> + </function> + + <function name="operator>"> + <template> + <template-type-parameter name="T"/> + <template-nontype-parameter name="N"> + <type>std::size_t</type> + </template-nontype-parameter> + </template> + + <type>bool</type> + + <parameter name="x"> + <paramtype>const <classname>array</classname><T, N>&</paramtype> + </parameter> + <parameter name="y"> + <paramtype>const <classname>array</classname><T, N>&</paramtype> + </parameter> + + <returns> + <simpara> + <code>y < x</code> + </simpara> + </returns> + </function> + + <function name="operator<="> + <template> + <template-type-parameter name="T"/> + <template-nontype-parameter name="N"> + <type>std::size_t</type> + </template-nontype-parameter> + </template> + + <type>bool</type> + + <parameter name="x"> + <paramtype>const <classname>array</classname><T, N>&</paramtype> + </parameter> + <parameter name="y"> + <paramtype>const <classname>array</classname><T, N>&</paramtype> + </parameter> + + <returns> + <simpara> + <code>!(y < x)</code> + </simpara> + </returns> + </function> + + <function name="operator>="> + <template> + <template-type-parameter name="T"/> + <template-nontype-parameter name="N"> + <type>std::size_t</type> + </template-nontype-parameter> + </template> + + <type>bool</type> + + <parameter name="x"> + <paramtype>const <classname>array</classname><T, N>&</paramtype> + </parameter> + <parameter name="y"> + <paramtype>const <classname>array</classname><T, N>&</paramtype> + </parameter> + + <returns> + <simpara> + <code>!(x < y)</code> + </simpara> + </returns> + </function> + </free-function-group> + </class> + </namespace> + </header> +</library-reference> + diff --git a/doc/test/array2.xml b/doc/test/array2.xml new file mode 100644 index 0000000000..e2a90174c4 --- /dev/null +++ b/doc/test/array2.xml @@ -0,0 +1,82 @@ +<section id="array.rationale"> + <title>Design Rationale</title> + + <para> + There was an important design tradeoff regarding the + constructors: We could implement array as an "aggregate" (see + Section 8.5.1, [dcl.init.aggr], of the C++ Standard). This would + mean: + <itemizedlist> + <listitem> + <simpara> + An array can be initialized with a + brace-enclosing, comma-separated list of initializers for the + elements of the container, written in increasing subscript + order: + </simpara> + + <programlisting> + <classname>boost::array</classname><int,4> a = { { 1, 2, 3 } }; + </programlisting> + + <simpara> + Note that if there are fewer elements in the + initializer list, then each remaining element gets + default-initialized (thus, it has a defined value). + </simpara> + </listitem> + </itemizedlist> + </para> + + <para> + However, this approach has its drawbacks: <emphasis + role="bold"> + passing no initializer list means that the elements + have an indetermined initial value + </emphasis>, because the rule says + that aggregates may have: + <itemizedlist> + <listitem> + <simpara>No user-declared constructors.</simpara> + </listitem> + <listitem> + <simpara>No private or protected non-static data members.</simpara> + </listitem> + <listitem> + <simpara>No base classes.</simpara> + </listitem> + <listitem> + <simpara>No virtual functions.</simpara> + </listitem> + </itemizedlist> + </para> + + <para>Nevertheless, The current implementation uses this approach.</para> + + <para> + Note that for standard conforming compilers it is possible to + use fewer braces (according to 8.5.1 (11) of the Standard). That is, + you can initialize an array as follows: + </para> + + <programlisting> + <classname>boost::array</classname><int,4> a = { 1, 2, 3 }; + </programlisting> + + <para> + I'd appreciate any constructive feedback. <emphasis + role="bold"> + Please note: I don't have time to read all boost + mails. Thus, to make sure that feedback arrives to me, please send + me a copy of each mail regarding this class. + </emphasis> + </para> + + <para> + The code is provided "as is" without expressed or implied + warranty. + </para> + +</section> + + diff --git a/doc/test/array3.xml b/doc/test/array3.xml new file mode 100644 index 0000000000..1f370a0b68 --- /dev/null +++ b/doc/test/array3.xml @@ -0,0 +1,22 @@ +<section id="array.more.info"> + <title>For more information...</title> + <para> + To find more details about using ordinary arrays in C++ and + the framework of the STL, see e.g. + + <literallayout> + The C++ Standard Library - A Tutorial and Reference + by Nicolai M. Josuttis + Addison Wesley Longman, 1999 + ISBN 0-201-37926-0 + </literallayout> + </para> + + <para> + <ulink url="http://www.josuttis.com/"> + Home Page of Nicolai + Josuttis + </ulink> + </para> +</section> + diff --git a/doc/test/array4.xml b/doc/test/array4.xml new file mode 100644 index 0000000000..f382e37ed0 --- /dev/null +++ b/doc/test/array4.xml @@ -0,0 +1,5 @@ +<section id="array.ack"> + <title>Acknowledgements</title> + + <para>Doug Gregor ported the documentation to the BoostBook format.</para> +</section> diff --git a/doc/test/gold/boost/accumulators/extract/weighted_tail_quantile.html b/doc/test/gold/boost/accumulators/extract/weighted_tail_quantile.html new file mode 100644 index 0000000000..94c4c42d1c --- /dev/null +++ b/doc/test/gold/boost/accumulators/extract/weighted_tail_quantile.html @@ -0,0 +1,50 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Global weighted_tail_quantile</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../index.html" title="Document To Test Formatting"> +<link rel="up" href="../../../document_to_test_formatting/accumulators.html#header.doc.test.weighted_tail_quantile_hpp" title="Header <doc/test/weighted_tail_quantile.hpp>"> +<link rel="prev" href="../../../document_to_test_formatting/accumulators.html" title="Accumulators Example Doxygen Documentation"> +<link rel="next" href="../impl/weighted_tail_quantile__id330053.html" title="Struct template weighted_tail_quantile_impl"> +</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="../../../document_to_test_formatting/accumulators.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../document_to_test_formatting/accumulators.html#header.doc.test.weighted_tail_quantile_hpp"><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="../impl/weighted_tail_quantile__id330053.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.accumulators.extract.weighted_tail_quantile"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global weighted_tail_quantile</span></h2> +<p>boost::accumulators::extract::weighted_tail_quantile</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../document_to_test_formatting/accumulators.html#header.doc.test.weighted_tail_quantile_hpp" title="Header <doc/test/weighted_tail_quantile.hpp>">doc/test/weighted_tail_quantile.hpp</a>> + +</span>extractor<span class="special"><</span> <span class="identifier">tag</span><span class="special">::</span><span class="identifier">quantile</span> <span class="special">></span> <span class="keyword">const</span> weighted_tail_quantile<span class="special">;</span></pre></div> +</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 © 2007 John Maddock, Joel de Guzman, Eric Niebler and Matias + Capeletto<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="../../../document_to_test_formatting/accumulators.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../document_to_test_formatting/accumulators.html#header.doc.test.weighted_tail_quantile_hpp"><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="../impl/weighted_tail_quantile__id330053.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/test/gold/boost/accumulators/impl/weighted_tail_quantile__id330053.html b/doc/test/gold/boost/accumulators/impl/weighted_tail_quantile__id330053.html new file mode 100644 index 0000000000..755abcb8eb --- /dev/null +++ b/doc/test/gold/boost/accumulators/impl/weighted_tail_quantile__id330053.html @@ -0,0 +1,91 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Struct template weighted_tail_quantile_impl</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../index.html" title="Document To Test Formatting"> +<link rel="up" href="../../../document_to_test_formatting/accumulators.html#header.doc.test.weighted_tail_quantile_hpp" title="Header <doc/test/weighted_tail_quantile.hpp>"> +<link rel="prev" href="../extract/weighted_tail_quantile.html" title="Global weighted_tail_quantile"> +<link rel="next" href="../tag/weighted_tail_quantile.html" title="Struct template weighted_tail_quantile"> +</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="../extract/weighted_tail_quantile.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../document_to_test_formatting/accumulators.html#header.doc.test.weighted_tail_quantile_hpp"><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="../tag/weighted_tail_quantile.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.accumulators.impl.weighted_tail_quantile__id330053"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template weighted_tail_quantile_impl</span></h2> +<p>boost::accumulators::impl::weighted_tail_quantile_impl — Tail quantile estimation based on order statistics of weighted samples (for both left and right tails). </p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../document_to_test_formatting/accumulators.html#header.doc.test.weighted_tail_quantile_hpp" title="Header <doc/test/weighted_tail_quantile.hpp>">doc/test/weighted_tail_quantile.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Sample<span class="special">,</span> <span class="keyword">typename</span> Weight<span class="special">,</span> <span class="keyword">typename</span> LeftRight<span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="weighted_tail_quantile__id330053.html" title="Struct template weighted_tail_quantile_impl">weighted_tail_quantile_impl</a> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <span class="identifier">numeric</span><span class="special">::</span><span class="identifier">functional</span><span class="special">::</span><span class="identifier">average</span><span class="special"><</span> <span class="identifier">Weight</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">></span><span class="special">::</span><span class="identifier">result_type</span> <a name="boost.accumulators.impl.weighted_tail_quantile__id330053.float_type"></a><span class="identifier">float_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">Sample</span> <a name="boost.accumulators.impl.weighted_tail_quantile__id330053.result_type"></a><span class="identifier">result_type</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="weighted_tail_quantile__id330053.html#boost.accumulators.impl.weighted_tail_quantile__id330053construct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="weighted_tail_quantile__id330053.html#id330297-bb"><span class="identifier">weighted_tail_quantile_impl</span></a><span class="special">(</span><span class="identifier">dont_care</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="weighted_tail_quantile__id330053.html#id330273-bb">public member functions</a></span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Args<span class="special">></span> <span class="identifier">result_type</span> <a class="link" href="weighted_tail_quantile__id330053.html#id330277-bb"><span class="identifier">result</span></a><span class="special">(</span><span class="identifier">Args</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id779890"></a><h2>Description</h2> +<p>An estimator <span class="inlinemediaobject"><img src="../../../images/accumulators/form_0.png"></span> of tail quantiles with level <span class="inlinemediaobject"><img src="../../../images/accumulators/form_1.png"></span> based on order statistics <span class="inlinemediaobject"><img src="../../../images/accumulators/form_2.png"></span> of weighted samples are given by <span class="inlinemediaobject"><img src="../../../images/accumulators/form_3.png"></span> (left tail) and <span class="inlinemediaobject"><img src="../../../images/accumulators/form_4.png"></span> (right tail), where</p> +<div class="equation"> +<a name="id779998"></a><p class="title"><b>Equation 1. </b></p> +<div class="equation-contents"><div class="mediaobject" align="center"><img src="../../../images/accumulators/form_5.png" align="middle"></div></div> +</div> +<p><br class="equation-break"></p> +<p>and</p> +<div class="equation"> +<a name="id780026"></a><p class="title"><b>Equation 2. </b></p> +<div class="equation-contents"><div class="mediaobject" align="center"><img src="../../../images/accumulators/form_6.png" align="middle"></div></div> +</div> +<p><br class="equation-break"></p> +<p><span class="inlinemediaobject"><img src="../../../images/accumulators/form_7.png"></span> being the number of samples and <span class="inlinemediaobject"><img src="../../../images/accumulators/form_8.png"></span> the sum of all weights.</p> +<p> +</p> +<div class="refsect2"> +<a name="id780095"></a><h3> +<a name="boost.accumulators.impl.weighted_tail_quantile__id330053construct-copy-destruct"></a><code class="computeroutput">weighted_tail_quantile_impl</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="id330297-bb"></a><span class="identifier">weighted_tail_quantile_impl</span><span class="special">(</span><span class="identifier">dont_care</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> +</div> +<div class="refsect2"> +<a name="id780149"></a><h3> +<a name="id330273-bb"></a><code class="computeroutput">weighted_tail_quantile_impl</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Args<span class="special">></span> <span class="identifier">result_type</span> <a name="id330277-bb"></a><span class="identifier">result</span><span class="special">(</span><span class="identifier">Args</span> <span class="keyword">const</span> <span class="special">&</span> args<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li></ol></div> +</div> +</div> +</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 © 2007 John Maddock, Joel de Guzman, Eric Niebler and Matias + Capeletto<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="../extract/weighted_tail_quantile.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../document_to_test_formatting/accumulators.html#header.doc.test.weighted_tail_quantile_hpp"><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="../tag/weighted_tail_quantile.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/test/gold/boost/accumulators/tag/weighted_tail_quantile.html b/doc/test/gold/boost/accumulators/tag/weighted_tail_quantile.html new file mode 100644 index 0000000000..07d6e6a75e --- /dev/null +++ b/doc/test/gold/boost/accumulators/tag/weighted_tail_quantile.html @@ -0,0 +1,52 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Struct template weighted_tail_quantile</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../../../index.html" title="Document To Test Formatting"> +<link rel="up" href="../../../document_to_test_formatting/accumulators.html#header.doc.test.weighted_tail_quantile_hpp" title="Header <doc/test/weighted_tail_quantile.hpp>"> +<link rel="prev" href="../impl/weighted_tail_quantile__id330053.html" title="Struct template weighted_tail_quantile_impl"> +</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="../impl/weighted_tail_quantile__id330053.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../document_to_test_formatting/accumulators.html#header.doc.test.weighted_tail_quantile_hpp"><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> +</div> +<div class="refentry"> +<a name="boost.accumulators.tag.weighted_tail_quantile"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template weighted_tail_quantile</span></h2> +<p>boost::accumulators::tag::weighted_tail_quantile</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../document_to_test_formatting/accumulators.html#header.doc.test.weighted_tail_quantile_hpp" title="Header <doc/test/weighted_tail_quantile.hpp>">doc/test/weighted_tail_quantile.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> LeftRight<span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="weighted_tail_quantile.html" title="Struct template weighted_tail_quantile">weighted_tail_quantile</a> <span class="special">:</span> <span class="keyword">public</span> boost::accumulators::depends_on< sum_of_weights, tail_weights< LeftRight > > +<span class="special">{</span> +<span class="special">}</span><span class="special">;</span></pre></div> +</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 © 2007 John Maddock, Joel de Guzman, Eric Niebler and Matias + Capeletto<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="../impl/weighted_tail_quantile__id330053.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../document_to_test_formatting/accumulators.html#header.doc.test.weighted_tail_quantile_hpp"><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> +</div> +</body> +</html> diff --git a/doc/test/gold/boost/array.html b/doc/test/gold/boost/array.html new file mode 100644 index 0000000000..2e54887fb0 --- /dev/null +++ b/doc/test/gold/boost/array.html @@ -0,0 +1,559 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Class template array</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../index.html" title="Document To Test Formatting"> +<link rel="up" href="../document_to_test_formatting/array.html#header.boost.array_hpp" title="Header <boost/array.hpp>"> +<link rel="prev" href="../document_to_test_formatting/array.html" title="Array Example Boostbook XML Documentation"> +<link rel="next" href="../document_to_test_formatting/accumulators.html" title="Accumulators Example Doxygen Documentation"> +</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="../document_to_test_formatting/array.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../document_to_test_formatting/array.html#header.boost.array_hpp"><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="../document_to_test_formatting/accumulators.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.array"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class template array</span></h2> +<p>boost::array — STL compliant container wrapper for arrays of constant size</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../document_to_test_formatting/array.html#header.boost.array_hpp" title="Header <boost/array.hpp>">boost/array.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> +<span class="keyword">class</span> <a class="link" href="array.html" title="Class template array">array</a> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <span class="identifier">T</span> <a name="boost.array.value_type"></a><span class="identifier">value_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">T</span><span class="special">*</span> <a name="boost.array.iterator"></a><span class="identifier">iterator</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">*</span> <a name="boost.array.const_iterator"></a><span class="identifier">const_iterator</span><span class="special">;</span> + <span class="keyword">typedef</span> + std::reverse_iterator<span class="special"><</span><span class="identifier">iterator</span><span class="special">></span> + <a name="boost.array.reverse_iterator"></a><span class="identifier">reverse_iterator</span><span class="special">;</span> + <span class="keyword">typedef</span> + std::reverse_iterator<span class="special"><</span><span class="identifier">const_iterator</span><span class="special">></span> + <a name="boost.array.const_reverse_iterator"></a><span class="identifier">const_reverse_iterator</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">T</span><span class="special">&</span> <a name="boost.array.reference"></a><span class="identifier">reference</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="keyword">const</span> <span class="identifier">T</span><span class="special">&</span> <a name="boost.array.const_reference"></a><span class="identifier">const_reference</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="boost.array.size_type"></a><span class="identifier">size_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ptrdiff_t</span> <a name="boost.array.difference_type"></a><span class="identifier">difference_type</span><span class="special">;</span> + + <span class="comment">// static constants</span> + <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">size_type</span> <span class="identifier">static_size</span> = <span class="identifier">N</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="array.html#boost.arrayconstruct-copy-destruct">construct/copy/destruct</a></span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> U<span class="special">></span> array& <a class="link" href="array.html#id330673-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">U</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="array.html#id330714-bb">iterator support</a></span> + <span class="identifier">iterator</span> <a class="link" href="array.html#id330722-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_iterator</span> <a class="link" href="array.html#id330729-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">iterator</span> <a class="link" href="array.html#id330755-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_iterator</span> <a class="link" href="array.html#id330761-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="array.html#id330785-bb">reverse iterator support</a></span> + <span class="identifier">reverse_iterator</span> <a class="link" href="array.html#id330793-bb"><span class="identifier">rbegin</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_reverse_iterator</span> <a class="link" href="array.html#id330800-bb"><span class="identifier">rbegin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">reverse_iterator</span> <a class="link" href="array.html#id330821-bb"><span class="identifier">rend</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_reverse_iterator</span> <a class="link" href="array.html#id330827-bb"><span class="identifier">rend</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="array.html#id330844-bb">capacity</a></span> + <span class="identifier">size_type</span> <a class="link" href="array.html#id330848-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="array.html#id330866-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">size_type</span> <a class="link" href="array.html#id330890-bb"><span class="identifier">max_size</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="array.html#id330915-bb">element access</a></span> + <span class="identifier">reference</span> <a class="link" href="array.html#id330923-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_reference</span> <a class="link" href="array.html#id330938-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">reference</span> <a class="link" href="array.html#id330986-bb"><span class="identifier">at</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_reference</span> <a class="link" href="array.html#id331001-bb"><span class="identifier">at</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">reference</span> <a class="link" href="array.html#id331061-bb"><span class="identifier">front</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_reference</span> <a class="link" href="array.html#id331069-bb"><span class="identifier">front</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">reference</span> <a class="link" href="array.html#id331115-bb"><span class="identifier">back</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_reference</span> <a class="link" href="array.html#id331123-bb"><span class="identifier">back</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">T</span><span class="special">*</span> <a class="link" href="array.html#id331165-bb"><span class="identifier">data</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">T</span><span class="special">*</span> <a class="link" href="array.html#id331198-bb"><span class="identifier">c_array</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="array.html#id331230-bb">modifiers</a></span> + <span class="keyword">void</span> <a class="link" href="array.html#id331235-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="array.html#id331296-bb"><span class="identifier">assign</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">T</span> elems[N]<span class="special">;</span> +<span class="special">}</span><span class="special">;</span> + +<span class="comment">// <a class="link" href="array.html#id331348-bb">specialized algorithms</a></span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> <span class="keyword">void</span> <a class="link" href="array.html#boost.array.swap"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">,</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> + +<span class="comment">// <a class="link" href="array.html#id331434-bb">comparisons</a></span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="array.html#boost.array.operator=="><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="array.html#boost.array.operator!="><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="array.html#boost.array.operator_id331592"><span class="keyword">operator</span><span class="special"><</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="array.html#boost.array.operator_id331679"><span class="keyword">operator</span><span class="special">></span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="array.html#boost.array.operator_=_id331750"><span class="keyword">operator</span><span class="special"><=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="array.html#boost.array.operator_=_id332091"><span class="keyword">operator</span><span class="special">>=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id776025"></a><h2>Description</h2> +<div class="refsect2"> +<a name="id776028"></a><h3> +<a name="boost.arrayconstruct-copy-destruct"></a><code class="computeroutput">array</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> U<span class="special">></span> array& <a name="id330673-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">U</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Effects:</span></p></td> +<td> + <code class="computeroutput"> + std::copy(rhs.<a class="link" href="array.html#id330718-bb">begin</a>(),rhs.<a class="link" href="array.html#id330751-bb">end</a>(), <a class="link" href="array.html#id330718-bb">begin</a>()) + </code> + </td> +</tr></tbody> +</table></div> +</li></ol></div> +</div> +<div class="refsect2"> +<a name="id776182"></a><h3> +<a name="id330714-bb"></a><code class="computeroutput">array</code> iterator support</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a name="id330718-bb"></a><span class="identifier">iterator</span> <a name="id330722-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> +<span class="identifier">const_iterator</span> <a name="id330729-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td>iterator for the first element</td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>will not throw</td> +</tr> +</tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="id330751-bb"></a><span class="identifier">iterator</span> <a name="id330755-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> +<span class="identifier">const_iterator</span> <a name="id330761-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td>iterator for position after the last element</td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>will not throw</td> +</tr> +</tbody> +</table></div> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="id776385"></a><h3> +<a name="id330785-bb"></a><code class="computeroutput">array</code> reverse iterator support</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a name="id330789-bb"></a><span class="identifier">reverse_iterator</span> <a name="id330793-bb"></a><span class="identifier">rbegin</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> +<span class="identifier">const_reverse_iterator</span> <a name="id330800-bb"></a><span class="identifier">rbegin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Returns:</span></p></td> +<td>reverse iterator for the first element of reverse iteration</td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="id330817-bb"></a><span class="identifier">reverse_iterator</span> <a name="id330821-bb"></a><span class="identifier">rend</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> +<span class="identifier">const_reverse_iterator</span> <a name="id330827-bb"></a><span class="identifier">rend</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Returns:</span></p></td> +<td>reverse iterator for position after the last element in reverse iteration</td> +</tr></tbody> +</table></div> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="id776574"></a><h3> +<a name="id330844-bb"></a><code class="computeroutput">array</code> capacity</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="id330848-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Returns:</span></p></td> +<td> + <code class="computeroutput">N</code> + </td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">bool</span> <a name="id330866-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td> + <code class="computeroutput">N==0</code> + </td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>will not throw</td> +</tr> +</tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="id330890-bb"></a><span class="identifier">max_size</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td> + <code class="computeroutput">N</code> + </td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>will not throw</td> +</tr> +</tbody> +</table></div> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="id776761"></a><h3> +<a name="id330915-bb"></a><code class="computeroutput">array</code> element access</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a name="id330919-bb"></a><span class="identifier">reference</span> <a name="id330923-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">size_type</span> i<span class="special">)</span><span class="special">;</span> +<span class="identifier">const_reference</span> <a name="id330938-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">size_type</span> i<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Requires:</span></p></td> +<td> + <code class="computeroutput">i < N</code> + </td> +</tr> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td> + element with index <code class="computeroutput">i</code> + </td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>will not throw.</td> +</tr> +</tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="id330982-bb"></a><span class="identifier">reference</span> <a name="id330986-bb"></a><span class="identifier">at</span><span class="special">(</span><span class="identifier">size_type</span> i<span class="special">)</span><span class="special">;</span> +<span class="identifier">const_reference</span> <a name="id331001-bb"></a><span class="identifier">at</span><span class="special">(</span><span class="identifier">size_type</span> i<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td> + element with index <code class="computeroutput">i</code> + </td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td> + <code class="computeroutput"> + std::range_error + </code> if <code class="computeroutput">i >= N</code> + </td> +</tr> +</tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="id331056-bb"></a><span class="identifier">reference</span> <a name="id331061-bb"></a><span class="identifier">front</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> +<span class="identifier">const_reference</span> <a name="id331069-bb"></a><span class="identifier">front</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Requires:</span></p></td> +<td> + <code class="computeroutput">N > 0</code> + </td> +</tr> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td>the first element</td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>will not throw</td> +</tr> +</tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="id331110-bb"></a><span class="identifier">reference</span> <a name="id331115-bb"></a><span class="identifier">back</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> +<span class="identifier">const_reference</span> <a name="id331123-bb"></a><span class="identifier">back</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Requires:</span></p></td> +<td> + <code class="computeroutput">N > 0</code> + </td> +</tr> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td>the last element</td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>will not throw</td> +</tr> +</tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">T</span><span class="special">*</span> <a name="id331165-bb"></a><span class="identifier">data</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td> + <code class="computeroutput">elems</code> + </td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>will not throw</td> +</tr> +</tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">T</span><span class="special">*</span> <a name="id331198-bb"></a><span class="identifier">c_array</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td> + <code class="computeroutput">elems</code> + </td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>will not throw</td> +</tr> +</tbody> +</table></div> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="id777380"></a><h3> +<a name="id331230-bb"></a><code class="computeroutput">array</code> modifiers</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="id331235-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Effects:</span></p></td> +<td> + <code class="computeroutput"> + std::swap_ranges(<a class="link" href="array.html#id330718-bb">begin</a>(), <a class="link" href="array.html#id330751-bb">end</a>(), other.<a class="link" href="array.html#id330718-bb">begin</a>()) + </code> + </td> +</tr> +<tr> +<td><p><span class="term">Complexity:</span></p></td> +<td> + linear in <code class="computeroutput">N</code> + </td> +</tr> +</tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="id331296-bb"></a><span class="identifier">assign</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Effects:</span></p></td> +<td> + <code class="computeroutput"> + std::fill_n(<a class="link" href="array.html#id330718-bb">begin</a>(), N, value) + </code> + </td> +</tr></tbody> +</table></div> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="id777592"></a><h3> +<a name="id331348-bb"></a><code class="computeroutput">array</code> specialized algorithms</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> <span class="keyword">void</span> <a name="boost.array.swap"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> x<span class="special">,</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> y<span class="special">)</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Effects:</span></p></td> +<td> + <code class="computeroutput"> + x.<a class="link" href="array.html#id331235-bb">swap</a>(y) + </code> + </td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td>will not throw.</td> +</tr> +</tbody> +</table></div> +</li></ol></div> +</div> +<div class="refsect2"> +<a name="id777791"></a><h3> +<a name="id331434-bb"></a><code class="computeroutput">array</code> comparisons</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a name="boost.array.operator=="></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> x<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> y<span class="special">)</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Returns:</span></p></td> +<td> + <code class="computeroutput"> + std::equal(x.<a class="link" href="array.html#id330718-bb">begin</a>(), x.<a class="link" href="array.html#id330751-bb">end</a>(), y.<a class="link" href="array.html#id330718-bb">begin</a>()) + </code> + </td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a name="boost.array.operator!="></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> x<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> y<span class="special">)</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Returns:</span></p></td> +<td> + <code class="computeroutput">!(x == y)</code> + </td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a name="boost.array.operator_id331592"></a><span class="keyword">operator</span><span class="special"><</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> x<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> y<span class="special">)</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Returns:</span></p></td> +<td> + <code class="computeroutput"> + std::lexicographical_compare(x.<a class="link" href="array.html#id330718-bb">begin</a>(), x.<a class="link" href="array.html#id330751-bb">end</a>(), y.<a class="link" href="array.html#id330718-bb">begin</a>(), y.<a class="link" href="array.html#id330751-bb">end</a>()) + </code> + </td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a name="boost.array.operator_id331679"></a><span class="keyword">operator</span><span class="special">></span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> x<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> y<span class="special">)</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Returns:</span></p></td> +<td> + <code class="computeroutput">y < x</code> + </td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a name="boost.array.operator_=_id331750"></a><span class="keyword">operator</span><span class="special"><=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> x<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> y<span class="special">)</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Returns:</span></p></td> +<td> + <code class="computeroutput">!(y < x)</code> + </td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a name="boost.array.operator_=_id332091"></a><span class="keyword">operator</span><span class="special">>=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> x<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span> y<span class="special">)</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Returns:</span></p></td> +<td> + <code class="computeroutput">!(x < y)</code> + </td> +</tr></tbody> +</table></div> +</li> +</ol></div> +</div> +</div> +</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 © 2007 John Maddock, Joel de Guzman, Eric Niebler and Matias + Capeletto<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="../document_to_test_formatting/array.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../document_to_test_formatting/array.html#header.boost.array_hpp"><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="../document_to_test_formatting/accumulators.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/test/gold/document_to_test_formatting/accumulators.html b/doc/test/gold/document_to_test_formatting/accumulators.html new file mode 100644 index 0000000000..b05c11bfec --- /dev/null +++ b/doc/test/gold/document_to_test_formatting/accumulators.html @@ -0,0 +1,69 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Accumulators Example Doxygen Documentation</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../index.html" title="Document To Test Formatting"> +<link rel="up" href="../index.html" title="Document To Test Formatting"> +<link rel="prev" href="../boost/array.html" title="Class template array"> +<link rel="next" href="../boost/accumulators/extract/weighted_tail_quantile.html" title="Global weighted_tail_quantile"> +</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="../boost/array.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="../boost/accumulators/extract/weighted_tail_quantile.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="document_to_test_formatting.accumulators"></a><a class="link" href="accumulators.html" title="Accumulators Example Doxygen Documentation"> Accumulators + Example Doxygen Documentation</a> +</h2></div></div></div> +<div class="toc"><dl><dt><span class="section"><a href="accumulators.html#statistics_library_reference">Statistics Library Reference</a></span></dt></dl></div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="statistics_library_reference"></a>Statistics Library Reference</h3></div></div></div> +<div class="toc"><dl><dt><span class="section"><a href="accumulators.html#header.doc.test.weighted_tail_quantile_hpp">Header <doc/test/weighted_tail_quantile.hpp></a></span></dt></dl></div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="header.doc.test.weighted_tail_quantile_hpp"></a>Header <<a href="../../../../doc/test/weighted_tail_quantile.hpp" target="_top">doc/test/weighted_tail_quantile.hpp</a>></h4></div></div></div> +<pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> + <span class="keyword">namespace</span> <span class="identifier">accumulators</span> <span class="special">{</span> + <span class="keyword">namespace</span> <span class="identifier">extract</span> <span class="special">{</span> + extractor<span class="special"><</span> <span class="identifier">tag</span><span class="special">::</span><span class="identifier">quantile</span> <span class="special">></span> <span class="keyword">const</span> <a class="link" href="../boost/accumulators/extract/weighted_tail_quantile.html" title="Global weighted_tail_quantile">weighted_tail_quantile</a><span class="special">;</span> + <span class="special">}</span> + <span class="keyword">namespace</span> <span class="identifier">impl</span> <span class="special">{</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Sample<span class="special">,</span> <span class="keyword">typename</span> Weight<span class="special">,</span> <span class="keyword">typename</span> LeftRight<span class="special">></span> + <span class="keyword">struct</span> <a class="link" href="../boost/accumulators/impl/weighted_tail_quantile__id330053.html" title="Struct template weighted_tail_quantile_impl">weighted_tail_quantile_impl</a><span class="special">;</span> + <span class="special">}</span> + <span class="keyword">namespace</span> <span class="identifier">tag</span> <span class="special">{</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> LeftRight<span class="special">></span> <span class="keyword">struct</span> <a class="link" href="../boost/accumulators/tag/weighted_tail_quantile.html" title="Struct template weighted_tail_quantile">weighted_tail_quantile</a><span class="special">;</span> + <span class="special">}</span> + <span class="special">}</span> +<span class="special">}</span></pre> +</div> +</div> +</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 © 2007 John Maddock, Joel de Guzman, Eric Niebler and Matias + Capeletto<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="../boost/array.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="../boost/accumulators/extract/weighted_tail_quantile.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/test/gold/document_to_test_formatting/array.html b/doc/test/gold/document_to_test_formatting/array.html new file mode 100644 index 0000000000..b49a79825f --- /dev/null +++ b/doc/test/gold/document_to_test_formatting/array.html @@ -0,0 +1,226 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Array Example Boostbook XML Documentation</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../index.html" title="Document To Test Formatting"> +<link rel="up" href="../index.html" title="Document To Test Formatting"> +<link rel="prev" href="remez.html" title="Sample Article (The Remez Method)"> +<link rel="next" href="../boost/array.html" title="Class template array"> +</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="remez.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="../boost/array.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="document_to_test_formatting.array"></a><a class="link" href="array.html" title="Array Example Boostbook XML Documentation"> Array Example Boostbook + XML Documentation</a> +</h2></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="array.html#array.intro">Introduction</a></span></dt> +<dt><span class="section"><a href="array.html#id772287">Reference</a></span></dt> +<dt><span class="section"><a href="array.html#array.rationale">Design Rationale</a></span></dt> +<dt><span class="section"><a href="array.html#array.more.info">For more information...</a></span></dt> +<dt><span class="section"><a href="array.html#array.ack">Acknowledgements</a></span></dt> +</dl></div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="array.intro"></a>Introduction</h3></div></div></div> +<p>The C++ Standard Template Library STL as part of the C++ + Standard Library provides a framework for processing algorithms on + different kind of containers. However, ordinary arrays don't + provide the interface of STL containers (although, they provide + the iterator interface of STL containers).</p> +<p>As replacement for ordinary arrays, the STL provides class + <code class="computeroutput">std::vector</code>. However, + <code class="computeroutput">std::vector<></code> provides + the semantics of dynamic arrays. Thus, it manages data to be able + to change the number of elements. This results in some overhead in + case only arrays with static size are needed.</p> +<p>In his book, <span class="emphasis"><em>Generic Programming and the + STL</em></span>, Matthew H. Austern introduces a useful wrapper + class for ordinary arrays with static size, called + <code class="computeroutput">block</code>. It is safer and has no worse performance than + ordinary arrays. In <span class="emphasis"><em>The C++ Programming + Language</em></span>, 3rd edition, Bjarne Stroustrup introduces a + similar class, called <code class="computeroutput">c_array</code>, which I (<a href="http://www.josuttis.com" target="_top">Nicolai Josuttis</a>) present + slightly modified in my book <span class="emphasis"><em>The C++ Standard Library - + A Tutorial and Reference</em></span>, called + <code class="computeroutput">carray</code>. This is the essence of these approaches + spiced with many feedback from <a href="http://www.boost.org" target="_top">boost</a>.</p> +<p>After considering different names, we decided to name this + class simply <code class="computeroutput"><a class="link" href="../boost/array.html" title="Class template array">array</a></code>.</p> +<p>Note that this class is suggested to be part of the next + Technical Report, which will extend the C++ Standard (see + <a href="http://std.dkuug.dk/jtc1/sc22/wg21/docs/papers/2003/n1548.htm" target="_top">http://std.dkuug.dk/jtc1/sc22/wg21/docs/papers/2003/n1548.htm</a>).</p> +<p>Class <code class="computeroutput"><a class="link" href="../boost/array.html" title="Class template array">array</a></code> fulfills most + but not all of the requirements of "reversible containers" (see + Section 23.1, [lib.container.requirements] of the C++ + Standard). The reasons array is not an reversible STL container is + because: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc" compact> +<li class="listitem">No constructors are provided.</li> +<li class="listitem">Elements may have an undetermined initial value (see <a class="xref" href="array.html#array.rationale" title="Design Rationale">the section called “Design Rationale”</a>).</li> +<li class="listitem"> +<code class="computeroutput"><a class="link" href="../boost/array.html#boost.array.swap">swap</a></code>() has no constant complexity.</li> +<li class="listitem"> +<code class="computeroutput"><a class="link" href="../boost/array.html#id330848-bb">size</a></code>() is always constant, based on the second template argument of the type.</li> +<li class="listitem">The container provides no allocator support.</li> +</ul></div> +<p> + </p> +<p>It doesn't fulfill the requirements of a "sequence" (see Section 23.1.1, [lib.sequence.reqmts] of the C++ Standard), except that: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc" compact> +<li class="listitem"> +<code class="computeroutput"><a class="link" href="../boost/array.html#id331056-bb">front</a></code>() and <code class="computeroutput"><a class="link" href="../boost/array.html#id331110-bb">back</a></code>() are provided.</li> +<li class="listitem"> +<code class="computeroutput"><a class="link" href="../boost/array.html#id330919-bb">operator[]</a></code> and <code class="computeroutput"><a class="link" href="../boost/array.html#id330982-bb">at</a></code>() are provided.</li> +</ul></div> +<p> + </p> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="id772287"></a>Reference</h3></div></div></div> +<div class="toc"><dl><dt><span class="section"><a href="array.html#header.boost.array_hpp">Header <boost/array.hpp></a></span></dt></dl></div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="header.boost.array_hpp"></a>Header <<a href="../../../../boost/array.hpp" target="_top">boost/array.hpp</a>></h4></div></div></div> +<pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> <span class="keyword">class</span> <a class="link" href="../boost/array.html" title="Class template array">array</a><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> <span class="keyword">void</span> <a class="link" href="../boost/array.html#boost.array.swap"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="../boost/array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">,</span> <a class="link" href="../boost/array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="../boost/array.html#boost.array.operator=="><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="../boost/array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="../boost/array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="../boost/array.html#boost.array.operator!="><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="../boost/array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="../boost/array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="../boost/array.html#boost.array.operator_id331592"><span class="keyword">operator</span><span class="special"><</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="../boost/array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="../boost/array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="../boost/array.html#boost.array.operator_id331679"><span class="keyword">operator</span><span class="special">></span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="../boost/array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="../boost/array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="../boost/array.html#boost.array.operator_=_id331750"><span class="keyword">operator</span><span class="special"><=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="../boost/array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="../boost/array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="../boost/array.html#boost.array.operator_=_id332091"><span class="keyword">operator</span><span class="special">>=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="../boost/array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="../boost/array.html" title="Class template array">array</a><span class="special"><</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span></pre> +</div> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="array.rationale"></a>Design Rationale</h3></div></div></div> +<p> + There was an important design tradeoff regarding the + constructors: We could implement array as an "aggregate" (see + Section 8.5.1, [dcl.init.aggr], of the C++ Standard). This would + mean: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"> +<p class="simpara"> + An array can be initialized with a + brace-enclosing, comma-separated list of initializers for the + elements of the container, written in increasing subscript + order: + </p> +<pre class="programlisting"> + <code class="computeroutput"><a class="link" href="../boost/array.html" title="Class template array">boost::array</a></code><int,4> a = { { 1, 2, 3 } }; + </pre> +<p class="simpara"> + Note that if there are fewer elements in the + initializer list, then each remaining element gets + default-initialized (thus, it has a defined value). + </p> +</li></ul></div> +<p> + </p> +<p> + However, this approach has its drawbacks: <span class="bold"><strong> + passing no initializer list means that the elements + have an indetermined initial value + </strong></span>, because the rule says + that aggregates may have: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem">No user-declared constructors.</li> +<li class="listitem">No private or protected non-static data members.</li> +<li class="listitem">No base classes.</li> +<li class="listitem">No virtual functions.</li> +</ul></div> +<p> + </p> +<p>Nevertheless, The current implementation uses this approach.</p> +<p> + Note that for standard conforming compilers it is possible to + use fewer braces (according to 8.5.1 (11) of the Standard). That is, + you can initialize an array as follows: + </p> +<pre class="programlisting"> + <code class="computeroutput"><a class="link" href="../boost/array.html" title="Class template array">boost::array</a></code><int,4> a = { 1, 2, 3 }; + </pre> +<p> + I'd appreciate any constructive feedback. <span class="bold"><strong> + Please note: I don't have time to read all boost + mails. Thus, to make sure that feedback arrives to me, please send + me a copy of each mail regarding this class. + </strong></span> + </p> +<p> + The code is provided "as is" without expressed or implied + warranty. + </p> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="array.more.info"></a>For more information...</h3></div></div></div> +<p> + To find more details about using ordinary arrays in C++ and + the framework of the STL, see e.g. + + </p> +<div class="literallayout"><p><br> +         The C++ Standard Library - A Tutorial and Reference<br> +         by Nicolai M. Josuttis<br> +         Addison Wesley Longman, 1999<br> +         ISBN 0-201-37926-0<br> +      </p></div> +<p> + </p> +<p> + <a href="http://www.josuttis.com/" target="_top"> + Home Page of Nicolai + Josuttis + </a> + </p> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="array.ack"></a>Acknowledgements</h3></div></div></div> +<p>Doug Gregor ported the documentation to the BoostBook format.</p> +</div> +</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 © 2007 John Maddock, Joel de Guzman, Eric Niebler and Matias + Capeletto<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="remez.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="../boost/array.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/test/gold/document_to_test_formatting/basic_formatting.html b/doc/test/gold/document_to_test_formatting/basic_formatting.html new file mode 100644 index 0000000000..2b2c74c976 --- /dev/null +++ b/doc/test/gold/document_to_test_formatting/basic_formatting.html @@ -0,0 +1,208 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Basic Formatting</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../index.html" title="Document To Test Formatting"> +<link rel="up" href="../index.html" title="Document To Test Formatting"> +<link rel="prev" href="code_blocks.html" title="Code Blocks"> +<link rel="next" href="blurbs.html" title="Blurbs"> +</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="code_blocks.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="blurbs.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="document_to_test_formatting.basic_formatting"></a><a class="link" href="basic_formatting.html" title="Basic Formatting">Basic Formatting</a> +</h2></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="basic_formatting.html#document_to_test_formatting.basic_formatting.font_styles">Font + Styles</a></span></dt> +<dt><span class="section"><a href="basic_formatting.html#document_to_test_formatting.basic_formatting.replaceable_text">Replaceable + Text</a></span></dt> +<dt><span class="section"><a href="basic_formatting.html#document_to_test_formatting.basic_formatting.quotations">Quotations</a></span></dt> +<dt><span class="section"><a href="basic_formatting.html#document_to_test_formatting.basic_formatting.inline_code">Inline + Code</a></span></dt> +<dt><span class="section"><a href="basic_formatting.html#document_to_test_formatting.basic_formatting.links">Links</a></span></dt> +<dt><span class="section"><a href="basic_formatting.html#document_to_test_formatting.basic_formatting.footnotes">Footnotes</a></span></dt> +<dt><span class="section"><a href="basic_formatting.html#document_to_test_formatting.basic_formatting.blockquote">Blockquote</a></span></dt> +<dt><span class="section"><a href="basic_formatting.html#document_to_test_formatting.basic_formatting.headings">Headings</a></span></dt> +</dl></div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="document_to_test_formatting.basic_formatting.font_styles"></a><a class="link" href="basic_formatting.html#document_to_test_formatting.basic_formatting.font_styles" title="Font Styles">Font + Styles</a> +</h3></div></div></div> +<p> + Here we go with some inline formatting: <span class="emphasis"><em>italic</em></span>, <span class="bold"><strong>bold</strong></span>, <span class="underline">underline</span>, + <code class="literal">teletype</code>, <span class="strikethrough">strikethrough</span>, + we can combine styles as well: <span class="emphasis"><em><span class="bold"><strong>bold italic</strong></span></em></span>, + <span class="underline"><code class="literal">teletype with underline</code></span>. + </p> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="document_to_test_formatting.basic_formatting.replaceable_text"></a><a class="link" href="basic_formatting.html#document_to_test_formatting.basic_formatting.replaceable_text" title="Replaceable Text">Replaceable + Text</a> +</h3></div></div></div> +<p> + Text that is intended to be user-replaceable is <em class="replaceable"><code>rendered like + this</code></em>. + </p> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="document_to_test_formatting.basic_formatting.quotations"></a><a class="link" href="basic_formatting.html#document_to_test_formatting.basic_formatting.quotations" title="Quotations">Quotations</a> +</h3></div></div></div> +<p> + Here we go: <span class="quote">“<span class="quote">A question that sometimes drives me hazy: am I or are + the others crazy?</span>”</span>--Einstein + </p> +<p> + Note the proper left and right quote marks. Also, while you can simply use + ordinary quote marks like "quoted", our quotation, above, will + generate correct DocBook quotations (e.g. <quote>quoted</quote>). + </p> +<p> + Like all phrase elements, quotations may be nested. Example: + </p> +<p> + <span class="quote">“<span class="quote">Here's the rule for bargains: <span class="quote">‘<span class="quote">Do other men, for they would + do you.</span>’</span> That's the true business precept.</span>”</span> + </p> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="document_to_test_formatting.basic_formatting.inline_code"></a><a class="link" href="basic_formatting.html#document_to_test_formatting.basic_formatting.inline_code" title="Inline Code">Inline + Code</a> +</h3></div></div></div> +<p> + This text has inlined code <code class="computeroutput"><span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span> <span class="special">{</span> <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span> <span class="special">}</span></code> + in it. The code should be syntax highlighted. + </p> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="document_to_test_formatting.basic_formatting.links"></a><a class="link" href="basic_formatting.html#document_to_test_formatting.basic_formatting.links" title="Links">Links</a> +</h3></div></div></div> +<p> + Try this: <a href="http://www.boost.org" target="_top">this is <span class="bold"><strong>boost's</strong></span> + website....</a> it should be visible as a link. + </p> +<p> + This is <a href="../../../../boost/math/distributions.hpp" target="_top">a link to a header + file (boost/math/distributions.hpp)</a>, it should be rewritable and + point to the website when built as a PDF. + </p> +<p> + This is <a href="../../../../libs/regex/index.html" target="_top">a link to another library's + documentation (Boost.Regex)</a>, using the boost: protocol, it should + be rewritten to point to the website when building a PDF. + </p> +<p> + This is <a href="../../../../libs/regex/index.html" target="_top">a link to another library's + documentation (Boost.Regex)</a>, using the boost:/ protocol, it should + be rewritten to point to the website when building a PDF. + </p> +<p> + This is <a href="../../weighted_tail_quantile.hpp" target="_top">a relative link to a header + file within the test source</a>, it should be rewritten to point to the + website when building a PDF. Although it might be on the website yet. + </p> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="document_to_test_formatting.basic_formatting.footnotes"></a><a class="link" href="basic_formatting.html#document_to_test_formatting.basic_formatting.footnotes" title="Footnotes">Footnotes</a> +</h3></div></div></div> +<p> + Here's one <sup>[<a name="id769038" href="#ftn.id769038" class="footnote">1</a>]</sup>. + </p> +<p> + And here's another <sup>[<a name="id769049" href="#ftn.id769049" class="footnote">2</a>]</sup>. + </p> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="document_to_test_formatting.basic_formatting.blockquote"></a><a class="link" href="basic_formatting.html#document_to_test_formatting.basic_formatting.blockquote" title="Blockquote">Blockquote</a> +</h3></div></div></div> +<p> + Lets indent the next paragraph: + </p> +<div class="blockquote"><blockquote class="blockquote"><p> + Here we go!!! + </p></blockquote></div> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="document_to_test_formatting.basic_formatting.headings"></a><a class="link" href="basic_formatting.html#document_to_test_formatting.basic_formatting.headings" title="Headings">Headings</a> +</h3></div></div></div> +<p> + Now try rendering some heading styles: + </p> +<a name="document_to_test_formatting.basic_formatting.headings.heading_1"></a><h2> +<a name="id769109"></a> + <a class="link" href="basic_formatting.html#document_to_test_formatting.basic_formatting.headings.heading_1">Heading + 1</a> + </h2> +<a name="document_to_test_formatting.basic_formatting.headings.heading_2"></a><h3> +<a name="id769128"></a> + <a class="link" href="basic_formatting.html#document_to_test_formatting.basic_formatting.headings.heading_2">Heading + 2</a> + </h3> +<a name="document_to_test_formatting.basic_formatting.headings.heading_3"></a><h4> +<a name="id769146"></a> + <a class="link" href="basic_formatting.html#document_to_test_formatting.basic_formatting.headings.heading_3">Heading + 3</a> + </h4> +<a name="document_to_test_formatting.basic_formatting.headings.heading_4"></a><h5> +<a name="id769165"></a> + <a class="link" href="basic_formatting.html#document_to_test_formatting.basic_formatting.headings.heading_4">Heading + 4</a> + </h5> +<a name="document_to_test_formatting.basic_formatting.headings.heading_5"></a><h6> +<a name="id769183"></a> + <a class="link" href="basic_formatting.html#document_to_test_formatting.basic_formatting.headings.heading_5">Heading + 5</a> + </h6> +<a name="document_to_test_formatting.basic_formatting.headings.heading_6"></a><h4> +<a name="id769201"></a> + <a class="link" href="basic_formatting.html#document_to_test_formatting.basic_formatting.headings.heading_6">Heading + 6</a> + </h4> +</div> +<div class="footnotes"> +<br><hr width="100" align="left"> +<div class="footnote"><p><sup>[<a name="ftn.id769038" href="#id769038" class="para">1</a>] </sup> + A sample footnote + </p></div> +<div class="footnote"><p><sup>[<a name="ftn.id769049" href="#id769049" class="para">2</a>] </sup> + Another sample footnote + </p></div> +</div> +</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 © 2007 John Maddock, Joel de Guzman, Eric Niebler and Matias + Capeletto<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="code_blocks.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="blurbs.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/test/gold/document_to_test_formatting/blurbs.html b/doc/test/gold/document_to_test_formatting/blurbs.html new file mode 100644 index 0000000000..44843dc40c --- /dev/null +++ b/doc/test/gold/document_to_test_formatting/blurbs.html @@ -0,0 +1,160 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Blurbs</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../index.html" title="Document To Test Formatting"> +<link rel="up" href="../index.html" title="Document To Test Formatting"> +<link rel="prev" href="basic_formatting.html" title="Basic Formatting"> +<link rel="next" href="lists_and_tables.html" title="Lists and Tables"> +</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="basic_formatting.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="lists_and_tables.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="document_to_test_formatting.blurbs"></a><a class="link" href="blurbs.html" title="Blurbs">Blurbs</a> +</h2></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="blurbs.html#document_to_test_formatting.blurbs.preformatted_text">Preformatted + text</a></span></dt> +<dt><span class="section"><a href="blurbs.html#document_to_test_formatting.blurbs.admonishments">Admonishments</a></span></dt> +<dt><span class="section"><a href="blurbs.html#document_to_test_formatting.blurbs.blurbs">Blurbs</a></span></dt> +</dl></div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="document_to_test_formatting.blurbs.preformatted_text"></a><a class="link" href="blurbs.html#document_to_test_formatting.blurbs.preformatted_text" title="Preformatted text">Preformatted + text</a> +</h3></div></div></div> +<p> + Here's some sample program output: + </p> +<pre class="programlisting">F test for equal standard deviations +____________________________________ + +Sample 1: +Number of Observations = 240 +Sample Standard Deviation = 65.549 + +Sample 2: +Number of Observations = 240 +Sample Standard Deviation = 61.854 + +Test Statistic = 1.123 + +CDF of test statistic: = 8.148e-001 +Upper Critical Value at alpha: = 1.238e+000 +Upper Critical Value at alpha/2: = 1.289e+000 +Lower Critical Value at alpha: = 8.080e-001 +Lower Critical Value at alpha/2: = 7.756e-001 + +Results for Alternative Hypothesis and alpha = 0.0500 + +Alternative Hypothesis Conclusion +Standard deviations are unequal (two sided test) REJECTED +Standard deviation 1 is less than standard deviation 2 REJECTED +Standard deviation 1 is greater than standard deviation 2 REJECTED +</pre> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="document_to_test_formatting.blurbs.admonishments"></a><a class="link" href="blurbs.html#document_to_test_formatting.blurbs.admonishments" title="Admonishments">Admonishments</a> +</h3></div></div></div> +<p> + There are four admonishments supported by Docbook XML: + </p> +<div class="note"><table border="0" summary="Note"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td> +<th align="left">Note</th> +</tr> +<tr><td align="left" valign="top"><p> + This is a note + </p></td></tr> +</table></div> +<div class="tip"><table border="0" summary="Tip"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="../../../../doc/src/images/tip.png"></td> +<th align="left">Tip</th> +</tr> +<tr><td align="left" valign="top"><p> + This is a tip + </p></td></tr> +</table></div> +<div class="important"><table border="0" summary="Important"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="../../../../doc/src/images/important.png"></td> +<th align="left">Important</th> +</tr> +<tr><td align="left" valign="top"><p> + This is important + </p></td></tr> +</table></div> +<div class="caution"><table border="0" summary="Caution"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="../../../../doc/src/images/caution.png"></td> +<th align="left">Caution</th> +</tr> +<tr><td align="left" valign="top"><p> + This is a caution + </p></td></tr> +</table></div> +<div class="warning"><table border="0" summary="Warning"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../doc/src/images/warning.png"></td> +<th align="left">Warning</th> +</tr> +<tr><td align="left" valign="top"> +<p> + This is a warning + </p> +<p> + They can contain more than one paragraph. + </p> +</td></tr> +</table></div> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="document_to_test_formatting.blurbs.blurbs"></a><a class="link" href="blurbs.html#document_to_test_formatting.blurbs.blurbs" title="Blurbs">Blurbs</a> +</h3></div></div></div> +<div class="sidebar"> +<p class="title"><b></b></p> +<p> + <span class="bold"><strong>An eye catching advertisement or note...</strong></span> + </p> +<p> + These should be rendered in a manner similar to admonishments. + </p> +<p> + They can contain more than one paragraph. + </p> +</div> +</div> +</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 © 2007 John Maddock, Joel de Guzman, Eric Niebler and Matias + Capeletto<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="basic_formatting.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="lists_and_tables.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/test/gold/document_to_test_formatting/code_blocks.html b/doc/test/gold/document_to_test_formatting/code_blocks.html new file mode 100644 index 0000000000..fefa9e089e --- /dev/null +++ b/doc/test/gold/document_to_test_formatting/code_blocks.html @@ -0,0 +1,426 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Code Blocks</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../index.html" title="Document To Test Formatting"> +<link rel="up" href="../index.html" title="Document To Test Formatting"> +<link rel="prev" href="../index.html" title="Document To Test Formatting"> +<link rel="next" href="basic_formatting.html" title="Basic Formatting"> +</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="../index.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="basic_formatting.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="document_to_test_formatting.code_blocks"></a><a class="link" href="code_blocks.html" title="Code Blocks">Code Blocks</a> +</h2></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="code_blocks.html#document_to_test_formatting.code_blocks.embedded_code">Embedded + code</a></span></dt> +<dt><span class="section"><a href="code_blocks.html#document_to_test_formatting.code_blocks.code_with_a_very_long_line">Code + With a Very Long Line</a></span></dt> +<dt><span class="section"><a href="code_blocks.html#document_to_test_formatting.code_blocks.imported_code_and_callouts">Imported + code and callouts</a></span></dt> +<dt><span class="section"><a href="code_blocks.html#document_to_test_formatting.code_blocks.larger_example">Larger + example</a></span></dt> +</dl></div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="document_to_test_formatting.code_blocks.embedded_code"></a><a class="link" href="code_blocks.html#document_to_test_formatting.code_blocks.embedded_code" title="Embedded code">Embedded + code</a> +</h3></div></div></div> +<p> + These should be syntax highlighted: + </p> +<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span> + +<span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span> +<span class="special">{</span> + <span class="comment">// Sample code +</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="string">"Hello, World\n"</span><span class="special">;</span> + <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span> +<span class="special">}</span> +</pre> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="document_to_test_formatting.code_blocks.code_with_a_very_long_line"></a><a class="link" href="code_blocks.html#document_to_test_formatting.code_blocks.code_with_a_very_long_line" title="Code With a Very Long Line">Code + With a Very Long Line</a> +</h3></div></div></div> +<pre class="programlisting"><span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">RealType</span><span class="special">></span> <span class="identifier">RealType</span> <span class="keyword">inline</span> <span class="identifier">foo</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RealType</span><span class="special">&</span> <span class="identifier">a</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">RealType</span><span class="special">&</span> <span class="identifier">b</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">RealType</span><span class="special">&</span> <span class="identifier">c</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">RealType</span><span class="special">&</span> <span class="identifier">d</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">RealType</span><span class="special">&</span> <span class="identifier">e</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">RealType</span><span class="special">&</span> <span class="identifier">f</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">RealType</span><span class="special">&</span> <span class="identifier">g</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">RealType</span><span class="special">&</span> <span class="identifier">h</span><span class="special">){</span> <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span> <span class="special">}</span> +</pre> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="document_to_test_formatting.code_blocks.imported_code_and_callouts"></a><a class="link" href="code_blocks.html#document_to_test_formatting.code_blocks.imported_code_and_callouts" title="Imported code and callouts">Imported + code and callouts</a> +</h3></div></div></div> +<p> + Here's some code with left-placed callouts: + </p> +<p> + +</p> +<pre class="programlisting"><span class="keyword">class</span> <span class="identifier">x</span> +<span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + + <a class="co" name="document_to_test_formatting0co" href="code_blocks.html#document_to_test_formatting0"><img src="../../../../doc/src/images/callouts/1.png" alt="1" border="0"></a><span class="identifier">x</span><span class="special">()</span> <span class="special">:</span> <span class="identifier">n</span><span class="special">(</span><span class="number">0</span><span class="special">)</span> + <span class="special">{</span> + <span class="special">}</span> + + <a class="co" name="document_to_test_formatting1co" href="code_blocks.html#document_to_test_formatting1"><img src="../../../../doc/src/images/callouts/2.png" alt="2" border="0"></a><span class="special">~</span><span class="identifier">x</span><span class="special">()</span> + <span class="special">{</span> + <span class="special">}</span> + + <a class="co" name="document_to_test_formatting2co" href="code_blocks.html#document_to_test_formatting2"><img src="../../../../doc/src/images/callouts/3.png" alt="3" border="0"></a><span class="keyword">int</span> <span class="identifier">get</span><span class="special">()</span> <span class="keyword">const</span> + <span class="special">{</span> + <span class="keyword">return</span> <span class="identifier">n</span><span class="special">;</span> + <span class="special">}</span> + + <a class="co" name="document_to_test_formatting3co" href="code_blocks.html#document_to_test_formatting3"><img src="../../../../doc/src/images/callouts/4.png" alt="4" border="0"></a><span class="keyword">void</span> <span class="identifier">set</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">n_</span><span class="special">)</span> + <span class="special">{</span> + <span class="identifier">n</span> <span class="special">=</span> <span class="identifier">n_</span><span class="special">;</span> + <span class="special">}</span> +<span class="special">};</span> +</pre> +<p> + </p> +<p> + </p> +<div class="calloutlist"><table border="0" summary="Callout list"> +<tr> +<td width="5%" valign="top" align="left"><p><a name="document_to_test_formatting0"></a><a href="#document_to_test_formatting0co"><img src="../../../../doc/src/images/callouts/1.png" alt="1" border="0"></a> </p></td> +<td valign="top" align="left"><p> Constructor </p></td> +</tr> +<tr> +<td width="5%" valign="top" align="left"><p><a name="document_to_test_formatting1"></a><a href="#document_to_test_formatting1co"><img src="../../../../doc/src/images/callouts/2.png" alt="2" border="0"></a> </p></td> +<td valign="top" align="left"><p> Destructor </p></td> +</tr> +<tr> +<td width="5%" valign="top" align="left"><p><a name="document_to_test_formatting2"></a><a href="#document_to_test_formatting2co"><img src="../../../../doc/src/images/callouts/3.png" alt="3" border="0"></a> </p></td> +<td valign="top" align="left"><p> Get the <code class="computeroutput"><span class="identifier">n</span></code> + member variable </p></td> +</tr> +<tr> +<td width="5%" valign="top" align="left"><p><a name="document_to_test_formatting3"></a><a href="#document_to_test_formatting3co"><img src="../../../../doc/src/images/callouts/4.png" alt="4" border="0"></a> </p></td> +<td valign="top" align="left"><p> Set the <code class="computeroutput"><span class="identifier">n</span></code> + member variable </p></td> +</tr> +</table></div> +<p> + </p> +<p> + And again with callouts placed exactly where we put them: + </p> +<p> + +</p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="identifier">foo_bar</span><span class="special">()</span> <a class="co" name="document_to_test_formatting4co" href="code_blocks.html#document_to_test_formatting4"><img src="../../../../doc/src/images/callouts/1.png" alt="1" border="0"></a> +<span class="special">{</span> + <span class="keyword">return</span> <span class="string">"foo-bar"</span><span class="special">;</span> <a class="co" name="document_to_test_formatting5co" href="code_blocks.html#document_to_test_formatting5"><img src="../../../../doc/src/images/callouts/2.png" alt="2" border="0"></a> +<span class="special">}</span> +</pre> +<p> + </p> +<p> + </p> +<div class="calloutlist"><table border="0" summary="Callout list"> +<tr> +<td width="5%" valign="top" align="left"><p><a name="document_to_test_formatting4"></a><a href="#document_to_test_formatting4co"><img src="../../../../doc/src/images/callouts/1.png" alt="1" border="0"></a> </p></td> +<td valign="top" align="left"><p> The <span class="emphasis"><em>Mythical</em></span> FooBar. See <a href="http://en.wikipedia.org/wiki/Foobar" target="_top">Foobar + for details</a> </p></td> +</tr> +<tr> +<td width="5%" valign="top" align="left"><p><a name="document_to_test_formatting5"></a><a href="#document_to_test_formatting5co"><img src="../../../../doc/src/images/callouts/2.png" alt="2" border="0"></a> </p></td> +<td valign="top" align="left"><p> return 'em, foo-bar man! </p></td> +</tr> +</table></div> +<p> + </p> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="document_to_test_formatting.code_blocks.larger_example"></a><a class="link" href="code_blocks.html#document_to_test_formatting.code_blocks.larger_example" title="Larger example">Larger + example</a> +</h3></div></div></div> +<p> + Now let's include a larger example, this may span several pages and should + not be chopped off half way through... some FO processors get this wrong! + </p> +<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">{</span> + +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">class</span> <span class="identifier">sub_match</span><span class="special">;</span> + +<span class="keyword">typedef</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="keyword">const</span> <span class="keyword">char</span><span class="special">*></span> <span class="identifier">csub_match</span><span class="special">;</span> +<span class="keyword">typedef</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="keyword">const</span> <span class="keyword">wchar_t</span><span class="special">*></span> <span class="identifier">wcsub_match</span><span class="special">;</span> +<span class="keyword">typedef</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">::</span><span class="identifier">const_iterator</span><span class="special">></span> <span class="identifier">ssub_match</span><span class="special">;</span> +<span class="keyword">typedef</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">wstring</span><span class="special">::</span><span class="identifier">const_iterator</span><span class="special">></span> <span class="identifier">wssub_match</span><span class="special">;</span> + +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">class</span> <span class="identifier">sub_match</span> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">,</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="keyword">typedef</span> <span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="identifier">value_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">difference_type</span> <span class="identifier">difference_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">BidirectionalIterator</span> <span class="identifier">iterator</span><span class="special">;</span> + + <span class="keyword">bool</span> <span class="identifier">matched</span><span class="special">;</span> + + <span class="identifier">difference_type</span> <span class="identifier">length</span><span class="special">()</span><span class="keyword">const</span><span class="special">;</span> + <span class="keyword">operator</span> <span class="identifier">basic_string</span><span class="special"><</span><span class="identifier">value_type</span><span class="special">>()</span><span class="keyword">const</span><span class="special">;</span> + <span class="identifier">basic_string</span><span class="special"><</span><span class="identifier">value_type</span><span class="special">></span> <span class="identifier">str</span><span class="special">()</span><span class="keyword">const</span><span class="special">;</span> + + <span class="keyword">int</span> <span class="identifier">compare</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special">&</span> <span class="identifier">s</span><span class="special">)</span><span class="keyword">const</span><span class="special">;</span> + <span class="keyword">int</span> <span class="identifier">compare</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">basic_string</span><span class="special"><</span><span class="identifier">value_type</span><span class="special">>&</span> <span class="identifier">s</span><span class="special">)</span><span class="keyword">const</span><span class="special">;</span> + <span class="keyword">int</span> <span class="identifier">compare</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">value_type</span><span class="special">*</span> <span class="identifier">s</span><span class="special">)</span><span class="keyword">const</span><span class="special">;</span> +<span class="preprocessor">#ifdef</span> <span class="identifier">BOOST_REGEX_MATCH_EXTRA</span> + <span class="keyword">typedef</span> <span class="identifier">implementation</span><span class="special">-</span><span class="keyword">private</span> <span class="identifier">capture_sequence_type</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">capture_sequence_type</span><span class="special">&</span> <span class="identifier">captures</span><span class="special">()</span><span class="keyword">const</span><span class="special">;</span> +<span class="preprocessor">#endif</span> +<span class="special">};</span> +<span class="comment">// +</span><span class="comment">// comparisons to another sub_match: +</span><span class="comment">// +</span><span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special">==</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special">!=</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special"><</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special"><=</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special">>=</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special">></span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> + + +<span class="comment">// +</span><span class="comment">// comparisons to a basic_string: +</span><span class="comment">// +</span><span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">traits</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Allocator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special">==</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span><span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span><span class="special">,</span> + <span class="identifier">traits</span><span class="special">,</span> + <span class="identifier">Allocator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">traits</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Allocator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special">!=</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span><span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span><span class="special">,</span> + <span class="identifier">traits</span><span class="special">,</span> + <span class="identifier">Allocator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">traits</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Allocator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special"><</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span><span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span><span class="special">,</span> + <span class="identifier">traits</span><span class="special">,</span> + <span class="identifier">Allocator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">traits</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Allocator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special">></span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span><span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span><span class="special">,</span> + <span class="identifier">traits</span><span class="special">,</span> + <span class="identifier">Allocator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">traits</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Allocator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special">>=</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span><span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span><span class="special">,</span> + <span class="identifier">traits</span><span class="special">,</span> + <span class="identifier">Allocator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">traits</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Allocator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special"><=</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span><span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span><span class="special">,</span> + <span class="identifier">traits</span><span class="special">,</span> + <span class="identifier">Allocator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> + +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">traits</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Allocator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special">==</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span><span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span><span class="special">,</span> + <span class="identifier">traits</span><span class="special">,</span> + <span class="identifier">Allocator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">traits</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Allocator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special">!=</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span><span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span><span class="special">,</span> + <span class="identifier">traits</span><span class="special">,</span> + <span class="identifier">Allocator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">traits</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Allocator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special"><</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span><span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span><span class="special">,</span> + <span class="identifier">traits</span><span class="special">,</span> + <span class="identifier">Allocator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">traits</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Allocator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special">></span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span><span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span><span class="special">,</span> + <span class="identifier">traits</span><span class="special">,</span> + <span class="identifier">Allocator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">traits</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Allocator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special">>=</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span><span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span><span class="special">,</span> + <span class="identifier">traits</span><span class="special">,</span> + <span class="identifier">Allocator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">traits</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Allocator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special"><=</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span><span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span><span class="special">,</span> + <span class="identifier">traits</span><span class="special">,</span> + <span class="identifier">Allocator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> + +<span class="comment">// +</span><span class="comment">// comparisons to a pointer to a character array: +</span><span class="comment">// +</span><span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special">==</span> <span class="special">(</span><span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special">!=</span> <span class="special">(</span><span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special"><</span> <span class="special">(</span><span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special">></span> <span class="special">(</span><span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special">>=</span> <span class="special">(</span><span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special"><=</span> <span class="special">(</span><span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> + +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special">==</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special">!=</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special"><</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special">></span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special">>=</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special"><=</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">rhs</span><span class="special">);</span> + +<span class="comment">// +</span><span class="comment">// comparisons to a single character: +</span><span class="comment">// +</span><span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special">==</span> <span class="special">(</span><span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special">!=</span> <span class="special">(</span><span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special"><</span> <span class="special">(</span><span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special">></span> <span class="special">(</span><span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special">>=</span> <span class="special">(</span><span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special"><=</span> <span class="special">(</span><span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">rhs</span><span class="special">);</span> + +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special">==</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special">!=</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special"><</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special">></span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special">>=</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="keyword">bool</span> <span class="keyword">operator</span> <span class="special"><=</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">lhs</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">rhs</span><span class="special">);</span> +<span class="comment">// +</span><span class="comment">// addition operators: +</span><span class="comment">// +</span><span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">traits</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Allocator</span><span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span><span class="special">,</span> <span class="identifier">traits</span><span class="special">,</span> <span class="identifier">Allocator</span><span class="special">></span> + <span class="keyword">operator</span> <span class="special">+</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span><span class="special">,</span> + <span class="identifier">traits</span><span class="special">,</span> + <span class="identifier">Allocator</span><span class="special">>&</span> <span class="identifier">s</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">m</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">traits</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Allocator</span><span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span><span class="special">,</span> <span class="identifier">traits</span><span class="special">,</span> <span class="identifier">Allocator</span><span class="special">></span> + <span class="keyword">operator</span> <span class="special">+</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">m</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span><span class="special">,</span> + <span class="identifier">traits</span><span class="special">,</span> + <span class="identifier">Allocator</span><span class="special">>&</span> <span class="identifier">s</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span><span class="special">></span> + <span class="keyword">operator</span> <span class="special">+</span> <span class="special">(</span><span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">s</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">m</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span><span class="special">></span> + <span class="keyword">operator</span> <span class="special">+</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">m</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">*</span> <span class="identifier">s</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span><span class="special">></span> + <span class="keyword">operator</span> <span class="special">+</span> <span class="special">(</span><span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">s</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">m</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span><span class="special">></span> + <span class="keyword">operator</span> <span class="special">+</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">m</span><span class="special">,</span> + <span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">s</span><span class="special">);</span> +<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">iterator_traits</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>::</span><span class="identifier">value_type</span><span class="special">></span> + <span class="keyword">operator</span> <span class="special">+</span> <span class="special">(</span><span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">m1</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">m2</span><span class="special">);</span> + +<span class="comment">// +</span><span class="comment">// stream inserter: +</span><span class="comment">// +</span><span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">charT</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">traits</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BidirectionalIterator</span><span class="special">></span> +<span class="identifier">basic_ostream</span><span class="special"><</span><span class="identifier">charT</span><span class="special">,</span> <span class="identifier">traits</span><span class="special">>&</span> + <span class="keyword">operator</span> <span class="special"><<</span> <span class="special">(</span><span class="identifier">basic_ostream</span><span class="special"><</span><span class="identifier">charT</span><span class="special">,</span> <span class="identifier">traits</span><span class="special">>&</span> <span class="identifier">os</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">sub_match</span><span class="special"><</span><span class="identifier">BidirectionalIterator</span><span class="special">>&</span> <span class="identifier">m</span><span class="special">);</span> + +<span class="special">}</span> <span class="comment">// namespace boost +</span></pre> +</div> +</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 © 2007 John Maddock, Joel de Guzman, Eric Niebler and Matias + Capeletto<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="../index.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="basic_formatting.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/test/gold/document_to_test_formatting/images.html b/doc/test/gold/document_to_test_formatting/images.html new file mode 100644 index 0000000000..8303d68f60 --- /dev/null +++ b/doc/test/gold/document_to_test_formatting/images.html @@ -0,0 +1,60 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Images</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../index.html" title="Document To Test Formatting"> +<link rel="up" href="../index.html" title="Document To Test Formatting"> +<link rel="prev" href="lists_and_tables.html" title="Lists and Tables"> +<link rel="next" href="test.html" title="test HTML4 symbols"> +</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="lists_and_tables.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="test.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="document_to_test_formatting.images"></a><a class="link" href="images.html" title="Images">Images</a> +</h2></div></div></div> +<p> + These are tricky enough that they warrent their own section. + </p> +<p> + Let's start with a PNG file that's set to 120dpi, it should render at a sensible + size in both html and PDF forms. It should print OK too! + </p> +<p> + <span class="inlinemediaobject"><img src="../images/digamma3.png" alt="digamma3"></span> + </p> +<p> + Now try again with a sample SVG image: + </p> +<p> + <span class="inlinemediaobject"><object type="image/svg+xml" data="../images/open_clipart_library_logo.svg" width="745.60706" height="513.2569"></object></span> + </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 © 2007 John Maddock, Joel de Guzman, Eric Niebler and Matias + Capeletto<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="lists_and_tables.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="test.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/test/gold/document_to_test_formatting/lists_and_tables.html b/doc/test/gold/document_to_test_formatting/lists_and_tables.html new file mode 100644 index 0000000000..b372e4f430 --- /dev/null +++ b/doc/test/gold/document_to_test_formatting/lists_and_tables.html @@ -0,0 +1,459 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Lists and Tables</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../index.html" title="Document To Test Formatting"> +<link rel="up" href="../index.html" title="Document To Test Formatting"> +<link rel="prev" href="blurbs.html" title="Blurbs"> +<link rel="next" href="images.html" title="Images"> +</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="blurbs.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="images.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="document_to_test_formatting.lists_and_tables"></a><a class="link" href="lists_and_tables.html" title="Lists and Tables">Lists and + Tables</a> +</h2></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="lists_and_tables.html#document_to_test_formatting.lists_and_tables.lists">Lists</a></span></dt> +<dt><span class="section"><a href="lists_and_tables.html#document_to_test_formatting.lists_and_tables.variable_lists">Variable + Lists</a></span></dt> +<dt><span class="section"><a href="lists_and_tables.html#document_to_test_formatting.lists_and_tables.tables">Tables</a></span></dt> +</dl></div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="document_to_test_formatting.lists_and_tables.lists"></a><a class="link" href="lists_and_tables.html#document_to_test_formatting.lists_and_tables.lists" title="Lists">Lists</a> +</h3></div></div></div> +<p> + A numbered list: + </p> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + One + </li> +<li class="listitem"> + Two + </li> +<li class="listitem"> + Three + <div class="orderedlist"><ol class="orderedlist" type="a"> +<li class="listitem"> + Three.a + </li> +<li class="listitem"> + Three.b + </li> +<li class="listitem"> + Three.c + </li> +</ol></div> + </li> +<li class="listitem"> + Four + <div class="orderedlist"><ol class="orderedlist" type="a"><li class="listitem"> + Four.a + <div class="orderedlist"><ol class="orderedlist" type="i"> +<li class="listitem"> + Four.a.i + </li> +<li class="listitem"> + Four.a.ii + </li> +</ol></div> + </li></ol></div> + </li> +<li class="listitem"> + Five + </li> +</ol></div> +<p> + An unordered list: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + First + </li> +<li class="listitem"> + Second + </li> +<li class="listitem"> + Third + </li> +</ul></div> +<p> + A mixture of the two: + </p> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> + 1 + <div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + 1.a + <div class="orderedlist"><ol class="orderedlist" type="a"> +<li class="listitem"> + 1.a.1 + </li> +<li class="listitem"> + 1.a.2 + </li> +</ol></div> + </li> +<li class="listitem"> + 1.b + </li> +</ul></div> + </li> +<li class="listitem"> + 2 + <div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + 2.a + </li> +<li class="listitem"> + 2.b + <div class="orderedlist"><ol class="orderedlist" type="a"> +<li class="listitem"> + 2.b.1 + </li> +<li class="listitem"> + 2.b.2 + <div class="itemizedlist"><ul class="itemizedlist" type="circle"> +<li class="listitem"> + 2.b.2.a + </li> +<li class="listitem"> + 2.b.2.b + </li> +</ul></div> + </li> +</ol></div> + </li> +</ul></div> + </li> +</ol></div> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="document_to_test_formatting.lists_and_tables.variable_lists"></a><a class="link" href="lists_and_tables.html#document_to_test_formatting.lists_and_tables.variable_lists" title="Variable Lists">Variable + Lists</a> +</h3></div></div></div> +<div class="variablelist"> +<p class="title"><b>A Variable List</b></p> +<dl> +<dt><span class="term">term 1</span></dt> +<dd><p> + The definition of term 1 + </p></dd> +<dt><span class="term">term 2</span></dt> +<dd><p> + The definition of term 2 + </p></dd> +<dt><span class="term">term 3</span></dt> +<dd><p> + The definition of term 3 + </p></dd> +</dl> +</div> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="document_to_test_formatting.lists_and_tables.tables"></a><a class="link" href="lists_and_tables.html#document_to_test_formatting.lists_and_tables.tables" title="Tables">Tables</a> +</h3></div></div></div> +<p> + Here's a big table with code and other tricky things: + </p> +<div class="table"> +<a name="id769721"></a><p class="title"><b>Table 1. Notes on the Implementation of the Beta Distribution</b></p> +<div class="table-contents"><table class="table" summary="Notes on the Implementation of the Beta Distribution"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th> + <p> + Function + </p> + </th> +<th> + <p> + Implementation Notes + </p> + </th> +</tr></thead> +<tbody> +<tr> +<td> + <p> + pdf + </p> + </td> +<td> + <p> + f(x;α,β) = x<sup>α - 1</sup> (1 - x)<sup>β -1</sup> / B(α, β) + </p> + <p> + Implemented using ibeta_derivative(a, b, x). + </p> + </td> +</tr> +<tr> +<td> + <p> + cdf + </p> + </td> +<td> + <p> + Using the incomplete beta function ibeta(a, b, x) + </p> + </td> +</tr> +<tr> +<td> + <p> + cdf complement + </p> + </td> +<td> + <p> + ibetac(a, b, x) + </p> + </td> +</tr> +<tr> +<td> + <p> + quantile + </p> + </td> +<td> + <p> + Using the inverse incomplete beta function ibeta_inv(a, b, p) + </p> + </td> +</tr> +<tr> +<td> + <p> + quantile from the complement + </p> + </td> +<td> + <p> + ibetac_inv(a, b, q) + </p> + </td> +</tr> +<tr> +<td> + <p> + mean + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">a</span><span class="special">/(</span><span class="identifier">a</span><span class="special">+</span><span class="identifier">b</span><span class="special">)</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + variance + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">a</span> <span class="special">*</span> + <span class="identifier">b</span> <span class="special">/</span> + <span class="special">(</span><span class="identifier">a</span><span class="special">+</span><span class="identifier">b</span><span class="special">)^</span><span class="number">2</span> <span class="special">*</span> <span class="special">(</span><span class="identifier">a</span> <span class="special">+</span> + <span class="identifier">b</span> <span class="special">+</span> + <span class="number">1</span><span class="special">)</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + mode + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="special">(</span><span class="identifier">a</span><span class="special">-</span><span class="number">1</span><span class="special">)</span> <span class="special">/</span> <span class="special">(</span><span class="identifier">a</span> + <span class="special">+</span> <span class="identifier">b</span> + <span class="special">+</span> <span class="number">2</span><span class="special">)</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + skewness + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="number">2</span> <span class="special">(</span><span class="identifier">b</span><span class="special">-</span><span class="identifier">a</span><span class="special">)</span> + <span class="identifier">sqrt</span><span class="special">(</span><span class="identifier">a</span><span class="special">+</span><span class="identifier">b</span><span class="special">+</span><span class="number">1</span><span class="special">)/(</span><span class="identifier">a</span><span class="special">+</span><span class="identifier">b</span><span class="special">+</span><span class="number">2</span><span class="special">)</span> <span class="special">*</span> <span class="identifier">sqrt</span><span class="special">(</span><span class="identifier">a</span> + <span class="special">*</span> <span class="identifier">b</span><span class="special">)</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + kurtosis excess + </p> + </td> +<td> + <p> + <span class="inlinemediaobject"><img src="../images/beta_dist_kurtosis.png" alt="beta_dist_kurtosis"></span> + </p> + </td> +</tr> +<tr> +<td> + <p> + kurtosis + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">kurtosis</span> <span class="special">+</span> + <span class="number">3</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + parameter estimation + </p> + </td> +<td> + </td> +</tr> +<tr> +<td> + <p> + alpha + </p> + <p> + from mean and variance + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">mean</span> <span class="special">*</span> + <span class="special">((</span> <span class="special">(</span><span class="identifier">mean</span> <span class="special">*</span> + <span class="special">(</span><span class="number">1</span> + <span class="special">-</span> <span class="identifier">mean</span><span class="special">))</span> <span class="special">/</span> <span class="identifier">variance</span><span class="special">)-</span> + <span class="number">1</span><span class="special">)</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + beta + </p> + <p> + from mean and variance + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="special">(</span><span class="number">1</span> + <span class="special">-</span> <span class="identifier">mean</span><span class="special">)</span> <span class="special">*</span> <span class="special">(((</span><span class="identifier">mean</span> + <span class="special">*</span> <span class="special">(</span><span class="number">1</span> <span class="special">-</span> <span class="identifier">mean</span><span class="special">))</span> + <span class="special">/</span><span class="identifier">variance</span><span class="special">)-</span><span class="number">1</span><span class="special">)</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + The member functions <code class="computeroutput"><span class="identifier">estimate_alpha</span></code> + and <code class="computeroutput"><span class="identifier">estimate_beta</span></code> + </p> + <p> + from cdf and probability x + </p> + <p> + and <span class="bold"><strong>either</strong></span> <code class="computeroutput"><span class="identifier">alpha</span></code> + or <code class="computeroutput"><span class="identifier">beta</span></code> + </p> + </td> +<td> + <p> + Implemented in terms of the inverse incomplete beta functions + </p> + <p> + ibeta_inva, and ibeta_invb respectively. + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">estimate_alpha</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">ibeta_inva</span><span class="special">(</span><span class="identifier">beta</span><span class="special">,</span> + <span class="identifier">x</span><span class="special">,</span> + <span class="identifier">probability</span><span class="special">)</span></code> + </p> + </td> +</tr> +<tr> +<td> + <p> + <code class="computeroutput"><span class="identifier">estimate_beta</span></code> + </p> + </td> +<td> + <p> + <code class="computeroutput"><span class="identifier">ibeta_invb</span><span class="special">(</span><span class="identifier">alpha</span><span class="special">,</span> + <span class="identifier">x</span><span class="special">,</span> + <span class="identifier">probability</span><span class="special">)</span></code> + </p> + </td> +</tr> +</tbody> +</table></div> +</div> +<br class="table-break"> +</div> +</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 © 2007 John Maddock, Joel de Guzman, Eric Niebler and Matias + Capeletto<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="blurbs.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="images.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/test/gold/document_to_test_formatting/remez.html b/doc/test/gold/document_to_test_formatting/remez.html new file mode 100644 index 0000000000..e8b89f1969 --- /dev/null +++ b/doc/test/gold/document_to_test_formatting/remez.html @@ -0,0 +1,535 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Sample Article (The Remez Method)</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../index.html" title="Document To Test Formatting"> +<link rel="up" href="../index.html" title="Document To Test Formatting"> +<link rel="prev" href="test.html" title="test HTML4 symbols"> +<link rel="next" href="array.html" title="Array Example Boostbook XML Documentation"> +</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="test.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="array.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="document_to_test_formatting.remez"></a><a class="link" href="remez.html" title="Sample Article (The Remez Method)"> Sample Article (The + Remez Method)</a> +</h2></div></div></div> +<p> + The <a href="http://en.wikipedia.org/wiki/Remez_algorithm" target="_top">Remez algorithm</a> + is a methodology for locating the minimax rational approximation to a function. + This short article gives a brief overview of the method, but it should not + be regarded as a thorough theoretical treatment, for that you should consult + your favorite textbook. + </p> +<p> + Imagine that you want to approximate some function f(x) by way of a rational + function R(x), where R(x) may be either a polynomial P(x) or a ratio of two + polynomials P(x)/Q(x) (a rational function). Initially we'll concentrate on + the polynomial case, as it's by far the easier to deal with, later we'll extend + to the full rational function case. + </p> +<p> + We want to find the "best" rational approximation, where "best" + is defined to be the approximation that has the least deviation from f(x). + We can measure the deviation by way of an error function: + </p> +<p> + E<sub>abs</sub>(x) = f(x) - R(x) + </p> +<p> + which is expressed in terms of absolute error, but we can equally use relative + error: + </p> +<p> + E<sub>rel</sub>(x) = (f(x) - R(x)) / |f(x)| + </p> +<p> + And indeed in general we can scale the error function in any way we want, it + makes no difference to the maths, although the two forms above cover almost + every practical case that you're likely to encounter. + </p> +<p> + The minimax rational function R(x) is then defined to be the function that + yields the smallest maximal value of the error function. Chebyshev showed that + there is a unique minimax solution for R(x) that has the following properties: + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + If R(x) is a polynomial of degree N, then there are N+2 unknowns: the N+1 + coefficients of the polynomial, and maximal value of the error function. + </li> +<li class="listitem"> + The error function has N+1 roots, and N+2 extrema (minima and maxima). + </li> +<li class="listitem"> + The extrema alternate in sign, and all have the same magnitude. + </li> +</ul></div> +<p> + That means that if we know the location of the extrema of the error function + then we can write N+2 simultaneous equations: + </p> +<p> + R(x<sub>i</sub>) + (-1)<sup>i</sup>E = f(x<sub>i</sub>) + </p> +<p> + where E is the maximal error term, and x<sub>i</sub> are the abscissa values of the N+2 + extrema of the error function. It is then trivial to solve the simultaneous + equations to obtain the polynomial coefficients and the error term. + </p> +<p> + <span class="emphasis"><em>Unfortunately we don't know where the extrema of the error function + are located!</em></span> + </p> +<a name="document_to_test_formatting.remez.the_remez_method"></a><h5> +<a name="id771060"></a> + <a class="link" href="remez.html#document_to_test_formatting.remez.the_remez_method">The Remez + Method</a> + </h5> +<p> + The Remez method is an iterative technique which, given a broad range of assumptions, + will converge on the extrema of the error function, and therefore the minimax + solution. + </p> +<p> + In the following discussion we'll use a concrete example to illustrate the + Remez method: an approximation to the function e<sup>x</sup> over the range [-1, 1]. + </p> +<p> + Before we can begin the Remez method, we must obtain an initial value for the + location of the extrema of the error function. We could "guess" these, + but a much closer first approximation can be obtained by first constructing + an interpolated polynomial approximation to f(x). + </p> +<p> + In order to obtain the N+1 coefficients of the interpolated polynomial we need + N+1 points (x<sub>0</sub>...x<sub>N</sub>): with our interpolated form passing through each of those + points that yields N+1 simultaneous equations: + </p> +<p> + f(x<sub>i</sub>) = P(x<sub>i</sub>) = c<sub>0</sub> + c<sub>1</sub>x<sub>i</sub> ... + c<sub>N</sub>x<sub>i</sub><sup>N</sup> + </p> +<p> + Which can be solved for the coefficients c<sub>0</sub>...c<sub>N</sub> in P(x). + </p> +<p> + Obviously this is not a minimax solution, indeed our only guarantee is that + f(x) and P(x) touch at N+1 locations, away from those points the error may + be arbitrarily large. However, we would clearly like this initial approximation + to be as close to f(x) as possible, and it turns out that using the zeros of + an orthogonal polynomial as the initial interpolation points is a good choice. + In our example we'll use the zeros of a Chebyshev polynomial as these are particularly + easy to calculate, interpolating for a polynomial of degree 4, and measuring + <span class="emphasis"><em>relative error</em></span> we get the following error function: + </p> +<p> + <span class="inlinemediaobject"><img src="../images/remez-2.png" alt="remez-2"></span> + </p> +<p> + Which has a peak relative error of 1.2x10<sup>-3</sup>. + </p> +<p> + While this is a pretty good approximation already, judging by the shape of + the error function we can clearly do better. Before starting on the Remez method + propper, we have one more step to perform: locate all the extrema of the error + function, and store these locations as our initial <span class="emphasis"><em>Chebyshev control + points</em></span>. + </p> +<div class="note"><table border="0" summary="Note"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td> +<th align="left">Note</th> +</tr> +<tr><td align="left" valign="top"> +<p> + In the simple case of a polynomial approximation, by interpolating through + the roots of a Chebyshev polynomial we have in fact created a <span class="emphasis"><em>Chebyshev + approximation</em></span> to the function: in terms of <span class="emphasis"><em>absolute + error</em></span> this is the best a priori choice for the interpolated form + we can achieve, and typically is very close to the minimax solution. + </p> +<p> + However, if we want to optimise for <span class="emphasis"><em>relative error</em></span>, + or if the approximation is a rational function, then the initial Chebyshev + solution can be quite far from the ideal minimax solution. + </p> +<p> + A more technical discussion of the theory involved can be found in this + <a href="http://math.fullerton.edu/mathews/n2003/ChebyshevPolyMod.html" target="_top">online + course</a>. + </p> +</td></tr> +</table></div> +<a name="document_to_test_formatting.remez.remez_step_1"></a><h5> +<a name="id771248"></a> + <a class="link" href="remez.html#document_to_test_formatting.remez.remez_step_1">Remez Step 1</a> + </h5> +<p> + The first step in the Remez method, given our current set of N+2 Chebyshev + control points x<sub>i</sub>, is to solve the N+2 simultaneous equations: + </p> +<p> + P(x<sub>i</sub>) + (-1)<sup>i</sup>E = f(x<sub>i</sub>) + </p> +<p> + To obtain the error term E, and the coefficients of the polynomial P(x). + </p> +<p> + This gives us a new approximation to f(x) that has the same error <span class="emphasis"><em>E</em></span> + at each of the control points, and whose error function <span class="emphasis"><em>alternates + in sign</em></span> at the control points. This is still not necessarily the + minimax solution though: since the control points may not be at the extrema + of the error function. After this first step here's what our approximation's + error function looks like: + </p> +<p> + <span class="inlinemediaobject"><img src="../images/remez-3.png" alt="remez-3"></span> + </p> +<p> + Clearly this is still not the minimax solution since the control points are + not located at the extrema, but the maximum relative error has now dropped + to 5.6x10<sup>-4</sup>. + </p> +<a name="document_to_test_formatting.remez.remez_step_2"></a><h5> +<a name="id771342"></a> + <a class="link" href="remez.html#document_to_test_formatting.remez.remez_step_2">Remez Step 2</a> + </h5> +<p> + The second step is to locate the extrema of the new approximation, which we + do in two stages: first, since the error function changes sign at each control + point, we must have N+1 roots of the error function located between each pair + of N+2 control points. Once these roots are found by standard root finding + techniques, we know that N extrema are bracketed between each pair of roots, + plus two more between the endpoints of the range and the first and last roots. + The N+2 extrema can then be found using standard function minimisation techniques. + </p> +<p> + We now have a choice: multi-point exchange, or single point exchange. + </p> +<p> + In single point exchange, we move the control point nearest to the largest + extrema to the absissa value of the extrema. + </p> +<p> + In multi-point exchange we swap all the current control points, for the locations + of the extrema. + </p> +<p> + In our example we perform multi-point exchange. + </p> +<a name="document_to_test_formatting.remez.iteration"></a><h5> +<a name="id771387"></a> + <a class="link" href="remez.html#document_to_test_formatting.remez.iteration">Iteration</a> + </h5> +<p> + The Remez method then performs steps 1 and 2 above iteratively until the control + points are located at the extrema of the error function: this is then the minimax + solution. + </p> +<p> + For our current example, two more iterations converges on a minimax solution + with a peak relative error of 5x10<sup>-4</sup> and an error function that looks like: + </p> +<p> + <span class="inlinemediaobject"><img src="../images/remez-4.png" alt="remez-4"></span> + </p> +<a name="document_to_test_formatting.remez.rational_approximations"></a><h5> +<a name="id771441"></a> + <a class="link" href="remez.html#document_to_test_formatting.remez.rational_approximations">Rational + Approximations</a> + </h5> +<p> + If we wish to extend the Remez method to a rational approximation of the form + </p> +<p> + f(x) = R(x) = P(x) / Q(x) + </p> +<p> + where P(x) and Q(x) are polynomials, then we proceed as before, except that + now we have N+M+2 unknowns if P(x) is of order N and Q(x) is of order M. This + assumes that Q(x) is normalised so that it's leading coefficient is 1, giving + N+M+1 polynomial coefficients in total, plus the error term E. + </p> +<p> + The simultaneous equations to be solved are now: + </p> +<p> + P(x<sub>i</sub>) / Q(x<sub>i</sub>) + (-1)<sup>i</sup>E = f(x<sub>i</sub>) + </p> +<p> + Evaluated at the N+M+2 control points x<sub>i</sub>. + </p> +<p> + Unfortunately these equations are non-linear in the error term E: we can only + solve them if we know E, and yet E is one of the unknowns! + </p> +<p> + The method usually adopted to solve these equations is an iterative one: we + guess the value of E, solve the equations to obtain a new value for E (as well + as the polynomial coefficients), then use the new value of E as the next guess. + The method is repeated until E converges on a stable value. + </p> +<p> + These complications extend the running time required for the development of + rational approximations quite considerably. It is often desirable to obtain + a rational rather than polynomial approximation none the less: rational approximations + will often match more difficult to approximate functions, to greater accuracy, + and with greater efficiency, than their polynomial alternatives. For example, + if we takes our previous example of an approximation to e<sup>x</sup>, we obtained 5x10<sup>-4</sup> accuracy + with an order 4 polynomial. If we move two of the unknowns into the denominator + to give a pair of order 2 polynomials, and re-minimise, then the peak relative + error drops to 8.7x10<sup>-5</sup>. That's a 5 fold increase in accuracy, for the same + number of terms overall. + </p> +<a name="document_to_test_formatting.remez.practical_considerations"></a><h5> +<a name="id771550"></a> + <a class="link" href="remez.html#document_to_test_formatting.remez.practical_considerations">Practical + Considerations</a> + </h5> +<p> + Most treatises on approximation theory stop at this point. However, from a + practical point of view, most of the work involves finding the right approximating + form, and then persuading the Remez method to converge on a solution. + </p> +<p> + So far we have used a direct approximation: + </p> +<p> + f(x) = R(x) + </p> +<p> + But this will converge to a useful approximation only if f(x) is smooth. In + addition round-off errors when evaluating the rational form mean that this + will never get closer than within a few epsilon of machine precision. Therefore + this form of direct approximation is often reserved for situations where we + want efficiency, rather than accuracy. + </p> +<p> + The first step in improving the situation is generally to split f(x) into a + dominant part that we can compute accurately by another method, and a slowly + changing remainder which can be approximated by a rational approximation. We + might be tempted to write: + </p> +<p> + f(x) = g(x) + R(x) + </p> +<p> + where g(x) is the dominant part of f(x), but if f(x)/g(x) is approximately + constant over the interval of interest then: + </p> +<p> + f(x) = g(x)(c + R(x)) + </p> +<p> + Will yield a much better solution: here <span class="emphasis"><em>c</em></span> is a constant + that is the approximate value of f(x)/g(x) and R(x) is typically tiny compared + to <span class="emphasis"><em>c</em></span>. In this situation if R(x) is optimised for absolute + error, then as long as its error is small compared to the constant <span class="emphasis"><em>c</em></span>, + that error will effectively get wiped out when R(x) is added to <span class="emphasis"><em>c</em></span>. + </p> +<p> + The difficult part is obviously finding the right g(x) to extract from your + function: often the asymptotic behaviour of the function will give a clue, + so for example the function __erfc becomes proportional to e<sup>-x<sup>2</sup></sup>/x as x becomes + large. Therefore using: + </p> +<p> + erfc(z) = (C + R(x)) e<sup>-x<sup>2</sup></sup>/x + </p> +<p> + as the approximating form seems like an obvious thing to try, and does indeed + yield a useful approximation. + </p> +<p> + However, the difficulty then becomes one of converging the minimax solution. + Unfortunately, it is known that for some functions the Remez method can lead + to divergent behaviour, even when the initial starting approximation is quite + good. Furthermore, it is not uncommon for the solution obtained in the first + Remez step above to be a bad one: the equations to be solved are generally + "stiff", often very close to being singular, and assuming a solution + is found at all, round-off errors and a rapidly changing error function, can + lead to a situation where the error function does not in fact change sign at + each control point as required. If this occurs, it is fatal to the Remez method. + It is also possible to obtain solutions that are perfectly valid mathematically, + but which are quite useless computationally: either because there is an unavoidable + amount of roundoff error in the computation of the rational function, or because + the denominator has one or more roots over the interval of the approximation. + In the latter case while the approximation may have the correct limiting value + at the roots, the approximation is nonetheless useless. + </p> +<p> + Assuming that the approximation does not have any fatal errors, and that the + only issue is converging adequately on the minimax solution, the aim is to + get as close as possible to the minimax solution before beginning the Remez + method. Using the zeros of a Chebyshev polynomial for the initial interpolation + is a good start, but may not be ideal when dealing with relative errors and/or + rational (rather than polynomial) approximations. One approach is to skew the + initial interpolation points to one end: for example if we raise the roots + of the Chebyshev polynomial to a positive power greater than 1 then the roots + will be skewed towards the middle of the [-1,1] interval, while a positive + power less than one will skew them towards either end. More usefully, if we + initially rescale the points over [0,1] and then raise to a positive power, + we can skew them to the left or right. Returning to our example of e<sup>x</sup> over [-1,1], + the initial interpolated form was some way from the minimax solution: + </p> +<p> + <span class="inlinemediaobject"><img src="../images/remez-2.png" alt="remez-2"></span> + </p> +<p> + However, if we first skew the interpolation points to the left (rescale them + to [0, 1], raise to the power 1.3, and then rescale back to [-1,1]) we reduce + the error from 1.3x10<sup>-3</sup>to 6x10<sup>-4</sup>: + </p> +<p> + <span class="inlinemediaobject"><img src="../images/remez-5.png" alt="remez-5"></span> + </p> +<p> + It's clearly still not ideal, but it is only a few percent away from our desired + minimax solution (5x10<sup>-4</sup>). + </p> +<a name="document_to_test_formatting.remez.remez_method_checklist"></a><h5> +<a name="id771737"></a> + <a class="link" href="remez.html#document_to_test_formatting.remez.remez_method_checklist">Remez + Method Checklist</a> + </h5> +<p> + The following lists some of the things to check if the Remez method goes wrong, + it is by no means an exhaustive list, but is provided in the hopes that it + will prove useful. + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> + Is the function smooth enough? Can it be better separated into a rapidly + changing part, and an asymptotic part? + </li> +<li class="listitem"> + Does the function being approximated have any "blips" in it? + Check for problems as the function changes computation method, or if a + root, or an infinity has been divided out. The telltale sign is if there + is a narrow region where the Remez method will not converge. + </li> +<li class="listitem"> + Check you have enough accuracy in your calculations: remember that the + Remez method works on the difference between the approximation and the + function being approximated: so you must have more digits of precision + available than the precision of the approximation being constructed. So + for example at double precision, you shouldn't expect to be able to get + better than a float precision approximation. + </li> +<li class="listitem"> + Try skewing the initial interpolated approximation to minimise the error + before you begin the Remez steps. + </li> +<li class="listitem"> + If the approximation won't converge or is ill-conditioned from one starting + location, try starting from a different location. + </li> +<li class="listitem"> + If a rational function won't converge, one can minimise a polynomial (which + presents no problems), then rotate one term from the numerator to the denominator + and minimise again. In theory one can continue moving terms one at a time + from numerator to denominator, and then re-minimising, retaining the last + set of control points at each stage. + </li> +<li class="listitem"> + Try using a smaller interval. It may also be possible to optimise over + one (small) interval, rescale the control points over a larger interval, + and then re-minimise. + </li> +<li class="listitem"> + Keep absissa values small: use a change of variable to keep the abscissa + over, say [0, b], for some smallish value <span class="emphasis"><em>b</em></span>. + </li> +</ul></div> +<a name="document_to_test_formatting.remez.references"></a><h5> +<a name="id771857"></a> + <a class="link" href="remez.html#document_to_test_formatting.remez.references">References</a> + </h5> +<p> + The original references for the Remez Method and it's extension to rational + functions are unfortunately in Russian: + </p> +<p> + Remez, E.Ya., <span class="emphasis"><em>Fundamentals of numerical methods for Chebyshev approximations</em></span>, + "Naukova Dumka", Kiev, 1969. + </p> +<p> + Remez, E.Ya., Gavrilyuk, V.T., <span class="emphasis"><em>Computer development of certain approaches + to the approximate construction of solutions of Chebyshev problems nonlinearly + depending on parameters</em></span>, Ukr. Mat. Zh. 12 (1960), 324-338. + </p> +<p> + Gavrilyuk, V.T., <span class="emphasis"><em>Generalization of the first polynomial algorithm + of E.Ya.Remez for the problem of constructing rational-fractional Chebyshev + approximations</em></span>, Ukr. Mat. Zh. 16 (1961), 575-585. + </p> +<p> + Some English language sources include: + </p> +<p> + Fraser, W., Hart, J.F., <span class="emphasis"><em>On the computation of rational approximations + to continuous functions</em></span>, Comm. of the ACM 5 (1962), 401-403, 414. + </p> +<p> + Ralston, A., <span class="emphasis"><em>Rational Chebyshev approximation by Remes' algorithms</em></span>, + Numer.Math. 7 (1965), no. 4, 322-330. + </p> +<p> + A. Ralston, <span class="emphasis"><em>Rational Chebyshev approximation, Mathematical Methods + for Digital Computers v. 2</em></span> (Ralston A., Wilf H., eds.), Wiley, New + York, 1967, pp. 264-284. + </p> +<p> + Hart, J.F. e.a., <span class="emphasis"><em>Computer approximations</em></span>, Wiley, New York + a.o., 1968. + </p> +<p> + Cody, W.J., Fraser, W., Hart, J.F., <span class="emphasis"><em>Rational Chebyshev approximation + using linear equations</em></span>, Numer.Math. 12 (1968), 242-251. + </p> +<p> + Cody, W.J., <span class="emphasis"><em>A survey of practical rational and polynomial approximation + of functions</em></span>, SIAM Review 12 (1970), no. 3, 400-423. + </p> +<p> + Barrar, R.B., Loeb, H.J., <span class="emphasis"><em>On the Remez algorithm for non-linear families</em></span>, + Numer.Math. 15 (1970), 382-391. + </p> +<p> + Dunham, Ch.B., <span class="emphasis"><em>Convergence of the Fraser-Hart algorithm for rational + Chebyshev approximation</em></span>, Math. Comp. 29 (1975), no. 132, 1078-1082. + </p> +<p> + G. L. Litvinov, <span class="emphasis"><em>Approximate construction of rational approximations + and the effect of error autocorrection</em></span>, Russian Journal of Mathematical + Physics, vol.1, No. 3, 1994. + </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 © 2007 John Maddock, Joel de Guzman, Eric Niebler and Matias + Capeletto<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="test.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="array.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/test/gold/document_to_test_formatting/test.html b/doc/test/gold/document_to_test_formatting/test.html new file mode 100644 index 0000000000..beb278dd1b --- /dev/null +++ b/doc/test/gold/document_to_test_formatting/test.html @@ -0,0 +1,73 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>test HTML4 symbols</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="../index.html" title="Document To Test Formatting"> +<link rel="up" href="../index.html" title="Document To Test Formatting"> +<link rel="prev" href="images.html" title="Images"> +<link rel="next" href="remez.html" title="Sample Article (The Remez Method)"> +</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="images.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="remez.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="document_to_test_formatting.test"></a><a class="link" href="test.html" title="test HTML4 symbols"> test HTML4 symbols</a> +</h2></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="test.html#document_to_test_formatting.test.test_greek_and_math_symbols">test + Greek and Math symbols</a></span></dt> +<dt><span class="section"><a href="test.html#document_to_test_formatting.test.test_latin1_symbols">test + Latin1 symbols</a></span></dt> +</dl></div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="document_to_test_formatting.test.test_greek_and_math_symbols"></a><a class="link" href="test.html#document_to_test_formatting.test.test_greek_and_math_symbols" title="test Greek and Math symbols">test + Greek and Math symbols</a> +</h3></div></div></div> +<p> + ƒ, Α, Β, Γ, Δ, Ε, Ζ, Η, Θ, Ι, Κ, Λ, Μ, Ν, Ξ, Ο, Π, Ρ, Σ, Τ, Υ, Φ, Χ, Ψ, Ω, α, β, γ, δ, ε, ζ, η, θ, ι, κ, λ, μ, + ν, ξ, ο, π, ρ, ς, σ, τ, υ, φ, χ, ψ, ω, ϑ, ϒ, ϖ, •, …, ′, ″, ‾, ⁄, ℘, ℑ, ℜ, ™, ℵ, ←, ↑, →, ↓, ↔, ↵, ⇐, ⇑, ⇒, ⇓, + ⇔, ∀, ∂, ∃, ∅, ∇, ∈, ∉, ∋, ∏, ∑, −, ∗, √, ∝, ∞, ∠, ∧, ∨, ∩, ∪, ∫, ∴, ∼, ≅, ≈, ≠, ≡, ≤, ≥, ⊂, ⊃, ⊄, ⊆, ⊇, ⊕, ⊗, + ⊥, ⋅, ⌈, ⌉, ⌊, ⌋, 〈, 〉, ◊, ♠, ♣, ♥, ♦ + </p> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="document_to_test_formatting.test.test_latin1_symbols"></a><a class="link" href="test.html#document_to_test_formatting.test.test_latin1_symbols" title="test Latin1 symbols">test + Latin1 symbols</a> +</h3></div></div></div> +<p> +  , ¡, ¢, £, ¤, ¥, ¦, §, ¨, ©, ª, «, ¬, ­, ®, ¯, °, ±, ², ³, ´, µ, ¶, ·, ¸, ¹, º, », ¼, ½, ¾, ¿, À, Á, Â, Ã, Ä, + Å, Æ, Ç, È, É, Ê, Ë, Ì, Í, Î, Ï, Ð, Ñ, Ò, Ó, Ô, Õ, Ö, ×, Ø, Ù, Ú, Û, Ü, Ý, Þ, ß, à, á, â, ã, ä, å, æ, ç, è, é, + ê, ë, ì, í, î, ï, ð, ñ, ò, ó, ô, õ, ö, ÷, ø, ù, ú, û, ü, ý, þ, ÿ, + </p> +</div> +</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 © 2007 John Maddock, Joel de Guzman, Eric Niebler and Matias + Capeletto<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="images.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="remez.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/test/gold/images/accumulators/doxygen.png b/doc/test/gold/images/accumulators/doxygen.png Binary files differnew file mode 100644 index 0000000000..f0a274bbaf --- /dev/null +++ b/doc/test/gold/images/accumulators/doxygen.png diff --git a/doc/test/gold/images/accumulators/form_0.png b/doc/test/gold/images/accumulators/form_0.png Binary files differnew file mode 100644 index 0000000000..9fb5ce8b77 --- /dev/null +++ b/doc/test/gold/images/accumulators/form_0.png diff --git a/doc/test/gold/images/accumulators/form_1.png b/doc/test/gold/images/accumulators/form_1.png Binary files differnew file mode 100644 index 0000000000..e3a10bb862 --- /dev/null +++ b/doc/test/gold/images/accumulators/form_1.png diff --git a/doc/test/gold/images/accumulators/form_2.png b/doc/test/gold/images/accumulators/form_2.png Binary files differnew file mode 100644 index 0000000000..c81c9a4f9f --- /dev/null +++ b/doc/test/gold/images/accumulators/form_2.png diff --git a/doc/test/gold/images/accumulators/form_3.png b/doc/test/gold/images/accumulators/form_3.png Binary files differnew file mode 100644 index 0000000000..fa15c98119 --- /dev/null +++ b/doc/test/gold/images/accumulators/form_3.png diff --git a/doc/test/gold/images/accumulators/form_4.png b/doc/test/gold/images/accumulators/form_4.png Binary files differnew file mode 100644 index 0000000000..a2ee808368 --- /dev/null +++ b/doc/test/gold/images/accumulators/form_4.png diff --git a/doc/test/gold/images/accumulators/form_5.png b/doc/test/gold/images/accumulators/form_5.png Binary files differnew file mode 100644 index 0000000000..d7481e0616 --- /dev/null +++ b/doc/test/gold/images/accumulators/form_5.png diff --git a/doc/test/gold/images/accumulators/form_6.png b/doc/test/gold/images/accumulators/form_6.png Binary files differnew file mode 100644 index 0000000000..dcfd30cb6c --- /dev/null +++ b/doc/test/gold/images/accumulators/form_6.png diff --git a/doc/test/gold/images/accumulators/form_7.png b/doc/test/gold/images/accumulators/form_7.png Binary files differnew file mode 100644 index 0000000000..66d2cf8779 --- /dev/null +++ b/doc/test/gold/images/accumulators/form_7.png diff --git a/doc/test/gold/images/accumulators/form_8.png b/doc/test/gold/images/accumulators/form_8.png Binary files differnew file mode 100644 index 0000000000..2564f5224d --- /dev/null +++ b/doc/test/gold/images/accumulators/form_8.png diff --git a/doc/test/gold/images/beta_dist_kurtosis.png b/doc/test/gold/images/beta_dist_kurtosis.png Binary files differnew file mode 100644 index 0000000000..1be258bfde --- /dev/null +++ b/doc/test/gold/images/beta_dist_kurtosis.png diff --git a/doc/test/gold/images/digamma3.png b/doc/test/gold/images/digamma3.png Binary files differnew file mode 100644 index 0000000000..bf4b81f607 --- /dev/null +++ b/doc/test/gold/images/digamma3.png diff --git a/doc/test/gold/images/doctest.png b/doc/test/gold/images/doctest.png Binary files differnew file mode 100644 index 0000000000..6d58193b31 --- /dev/null +++ b/doc/test/gold/images/doctest.png diff --git a/doc/test/gold/images/open_clipart_library_logo.svg b/doc/test/gold/images/open_clipart_library_logo.svg new file mode 100644 index 0000000000..9a4521f3a5 --- /dev/null +++ b/doc/test/gold/images/open_clipart_library_logo.svg @@ -0,0 +1,143 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!-- Created with Inkscape (http://www.inkscape.org/) --> +<svg + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:cc="http://web.resource.org/cc/" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns="http://www.w3.org/2000/svg" + xmlns:sodipodi="http://inkscape.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + version="1.0" + x="0.00000000" + y="0.00000000" + id="svg6221" + width="745.60706" + height="513.25690" + sodipodi:version="0.32" + inkscape:version="0.42" + sodipodi:docname="Open_Clipart_Library_logo.svg"> + <sodipodi:namedview + inkscape:cy="893.36713" + inkscape:cx="305.25953" + inkscape:zoom="0.86831670" + inkscape:window-height="913" + inkscape:window-width="1272" + inkscape:pageshadow="2" + inkscape:pageopacity="0.0" + borderopacity="1.0" + bordercolor="#666666" + pagecolor="#ffffff" + id="base" + inkscape:window-x="0" + inkscape:window-y="30" + inkscape:current-layer="svg6221" /> + <metadata + id="metadata4"> + <rdf:RDF> + <cc:Work + rdf:about=""> + <dc:format>image/svg+xml</dc:format> + <dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> + <dc:title>Open Clip Art Logo</dc:title> + <dc:date>10-01-2004</dc:date> + <dc:creator> + <cc:Agent> + <dc:title>Andreas Nilsson</dc:title> + </cc:Agent> + </dc:creator> + <cc:license + rdf:resource="http://web.resource.org/cc/PublicDomain" /> + <dc:contributor> + <cc:Agent> + <dc:title>Jon Phillips, Tobias Jakobs</dc:title> + </cc:Agent> + </dc:contributor> + <dc:description>This is one version of the official Open Clip Art Library logo.</dc:description> + <dc:subject>logo, open clip art library logo, logotype</dc:subject> + </cc:Work> + <cc:License + rdf:about="http://web.resource.org/cc/PublicDomain"> + <cc:permits + rdf:resource="http://web.resource.org/cc/Reproduction" /> + <cc:permits + rdf:resource="http://web.resource.org/cc/Distribution" /> + <cc:permits + rdf:resource="http://web.resource.org/cc/DerivativeWorks" /> + </cc:License> + </rdf:RDF> + </metadata> + <defs + id="defs3" /> + <path + d="M 405.82430,48.494855 C 396.10958,45.870336 386.13966,51.583653 383.51514,61.298370 L 298.15838,376.92441 C 295.53385,386.63914 301.24717,396.41506 310.96188,399.03957 L 626.58791,484.39635 C 636.30255,487.02086 646.27253,481.30755 648.89705,471.59283 L 734.25375,155.96679 C 735.49097,151.38725 734.71475,146.85751 732.70181,142.96928 L 732.70181,142.77528 L 732.50782,142.38730 L 732.50782,142.19331 C 732.46276,142.11490 732.36008,142.07704 732.31383,141.99931 L 717.76438,111.93045 L 651.80695,114.84034 L 405.82430,48.494855 z " + style="fill:#000000;fill-opacity:0.20000000;fill-rule:evenodd;stroke:none;stroke-width:1.6789947;stroke-miterlimit:4.0000000;stroke-opacity:0.20000000" + id="rect6080" /> + <rect + width="363.28452" + height="363.28452" + rx="2.9260478" + ry="2.9260478" + x="363.42282" + y="-78.837021" + transform="matrix(0.965391,0.260807,-0.260807,0.965391,0.000000,0.000000)" + style="fill:#ffffff;fill-rule:evenodd;stroke:#ffffff;stroke-width:7.7597070;stroke-miterlimit:4.0000000;stroke-opacity:1.0000000" + id="rect911" /> + <rect + width="288.49521" + height="288.49521" + rx="2.3236644" + ry="2.3236644" + x="398.72931" + y="-39.355053" + transform="matrix(0.965391,0.260807,-0.260807,0.965391,0.000000,0.000000)" + style="fill:#f3e533;fill-opacity:1.0000000;fill-rule:evenodd;stroke-width:0.79413080pt" + id="rect912" /> + <path + d="M 552.48969,32.227283 L 486.13725,53.566475 L 486.71922,53.760468 L 235.30476,53.760468 C 225.24184,53.760468 217.26344,61.738811 217.26344,71.801785 L 217.26344,398.87339 C 217.26344,408.93643 225.24178,416.91471 235.30476,416.91471 L 562.37636,416.91471 C 572.43940,416.91471 580.41768,408.93637 580.41768,398.87339 L 580.41768,71.801785 C 580.41768,66.612962 578.25806,62.108236 574.79189,58.804276 L 552.48969,32.227283 z " + style="fill:#000000;fill-opacity:0.20000000;fill-rule:evenodd;stroke:none;stroke-width:1.6789950;stroke-miterlimit:4.0000000;stroke-opacity:1.0000000" + id="rect6079" /> + <rect + width="363.28418" + height="363.28418" + rx="2.9260466" + ry="2.9260466" + x="192.47523" + y="30.531385" + style="fill:#ffffff;fill-rule:evenodd;stroke:#ffffff;stroke-width:7.7597060;stroke-miterlimit:4.0000000;stroke-opacity:1.0000000" + id="rect913" /> + <rect + width="288.49512" + height="288.49512" + rx="2.3236635" + ry="2.3236635" + x="227.78207" + y="70.013809" + style="fill:#ff7f00;fill-rule:evenodd;stroke-width:0.79413080pt" + id="rect914" /> + <path + d="M 348.20848,28.541423 L 291.17463,66.563983 L 305.14211,68.115925 L 55.667554,157.15854 C 46.188236,160.53570 41.232826,170.76437 44.609974,180.24367 L 138.89040,445.04365 L 132.29465,444.84966 L 128.02682,485.39411 L 163.52746,498.58561 L 163.91546,498.58561 C 168.05181,500.44490 172.88654,501.00342 177.49494,499.36159 L 485.55528,389.56176 C 495.03452,386.18460 499.79600,375.76200 496.41886,366.28264 L 386.81301,58.416291 C 385.25785,54.051177 382.02384,50.975478 378.27734,48.910652 L 348.20848,28.541423 z " + style="fill:#000000;fill-opacity:0.20000000;fill-rule:evenodd;stroke:none;stroke-width:1.2500002;stroke-miterlimit:4.0000000;stroke-opacity:1.0000000" + id="rect6078" /> + <rect + width="363.28326" + height="363.28326" + rx="2.9260383" + ry="2.9260383" + x="-41.716114" + y="142.20343" + transform="matrix(0.942003,-0.335604,0.335604,0.942003,0.000000,0.000000)" + style="fill:#ffffff;fill-rule:evenodd;stroke:#ffffff;stroke-width:7.7596951;stroke-miterlimit:4.0000000;stroke-opacity:1.0000000" + id="rect915" /> + <rect + width="288.49469" + height="288.49469" + rx="2.3236592" + ry="2.3236592" + x="-6.4090877" + y="181.68738" + transform="matrix(0.942003,-0.335604,0.335604,0.942003,0.000000,0.000000)" + style="fill:#bf0000;fill-rule:evenodd;stroke-width:0.79413080pt" + id="rect916" /> +</svg> diff --git a/doc/test/gold/images/remez-2.png b/doc/test/gold/images/remez-2.png Binary files differnew file mode 100644 index 0000000000..e9bfbd9108 --- /dev/null +++ b/doc/test/gold/images/remez-2.png diff --git a/doc/test/gold/images/remez-3.png b/doc/test/gold/images/remez-3.png Binary files differnew file mode 100644 index 0000000000..6493527d56 --- /dev/null +++ b/doc/test/gold/images/remez-3.png diff --git a/doc/test/gold/images/remez-4.png b/doc/test/gold/images/remez-4.png Binary files differnew file mode 100644 index 0000000000..6733bac9b9 --- /dev/null +++ b/doc/test/gold/images/remez-4.png diff --git a/doc/test/gold/images/remez-5.png b/doc/test/gold/images/remez-5.png Binary files differnew file mode 100644 index 0000000000..80727614f8 --- /dev/null +++ b/doc/test/gold/images/remez-5.png diff --git a/doc/test/gold/index.html b/doc/test/gold/index.html new file mode 100644 index 0000000000..19d2738ad9 --- /dev/null +++ b/doc/test/gold/index.html @@ -0,0 +1,151 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Document To Test Formatting</title> +<link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="Document To Test Formatting"> +<link rel="next" href="document_to_test_formatting/code_blocks.html" title="Code Blocks"> +</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="n" href="document_to_test_formatting/code_blocks.html"><img src="../../../doc/src/images/next.png" alt="Next"></a></div> +<div class="article"> +<div class="titlepage"> +<div> +<div><h2 class="title"> +<a name="document_to_test_formatting"></a>Document To Test Formatting</h2></div> +<div><div class="authorgroup"> +<div class="author"><h3 class="author"> +<span class="firstname">John</span> <span class="surname">Maddock</span> +</h3></div> +<div class="author"><h3 class="author"> +<span class="firstname">Joel</span> <span class="surname">de Guzman</span> +</h3></div> +<div class="author"><h3 class="author"> +<span class="firstname">Eric</span> <span class="surname">Niebler</span> +</h3></div> +<div class="author"><h3 class="author"> +<span class="firstname">Matias</span> <span class="surname">Capeletto</span> +</h3></div> +</div></div> +<div><p class="copyright">Copyright © 2007 John Maddock, Joel de Guzman, Eric Niebler and Matias + Capeletto</p></div> +<div><div class="legalnotice"> +<a name="id759728"></a><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></div> +</div> +<hr> +</div> +<div class="toc"> +<p><b>Table of Contents</b></p> +<dl> +<dt><span class="section"><a href="index.html#document_to_test_formatting.introduction">Introduction</a></span></dt> +<dt><span class="section"><a href="document_to_test_formatting/code_blocks.html">Code Blocks</a></span></dt> +<dd><dl> +<dt><span class="section"><a href="document_to_test_formatting/code_blocks.html#document_to_test_formatting.code_blocks.embedded_code">Embedded + code</a></span></dt> +<dt><span class="section"><a href="document_to_test_formatting/code_blocks.html#document_to_test_formatting.code_blocks.code_with_a_very_long_line">Code + With a Very Long Line</a></span></dt> +<dt><span class="section"><a href="document_to_test_formatting/code_blocks.html#document_to_test_formatting.code_blocks.imported_code_and_callouts">Imported + code and callouts</a></span></dt> +<dt><span class="section"><a href="document_to_test_formatting/code_blocks.html#document_to_test_formatting.code_blocks.larger_example">Larger + example</a></span></dt> +</dl></dd> +<dt><span class="section"><a href="document_to_test_formatting/basic_formatting.html">Basic Formatting</a></span></dt> +<dd><dl> +<dt><span class="section"><a href="document_to_test_formatting/basic_formatting.html#document_to_test_formatting.basic_formatting.font_styles">Font + Styles</a></span></dt> +<dt><span class="section"><a href="document_to_test_formatting/basic_formatting.html#document_to_test_formatting.basic_formatting.replaceable_text">Replaceable + Text</a></span></dt> +<dt><span class="section"><a href="document_to_test_formatting/basic_formatting.html#document_to_test_formatting.basic_formatting.quotations">Quotations</a></span></dt> +<dt><span class="section"><a href="document_to_test_formatting/basic_formatting.html#document_to_test_formatting.basic_formatting.inline_code">Inline + Code</a></span></dt> +<dt><span class="section"><a href="document_to_test_formatting/basic_formatting.html#document_to_test_formatting.basic_formatting.links">Links</a></span></dt> +<dt><span class="section"><a href="document_to_test_formatting/basic_formatting.html#document_to_test_formatting.basic_formatting.footnotes">Footnotes</a></span></dt> +<dt><span class="section"><a href="document_to_test_formatting/basic_formatting.html#document_to_test_formatting.basic_formatting.blockquote">Blockquote</a></span></dt> +<dt><span class="section"><a href="document_to_test_formatting/basic_formatting.html#document_to_test_formatting.basic_formatting.headings">Headings</a></span></dt> +</dl></dd> +<dt><span class="section"><a href="document_to_test_formatting/blurbs.html">Blurbs</a></span></dt> +<dd><dl> +<dt><span class="section"><a href="document_to_test_formatting/blurbs.html#document_to_test_formatting.blurbs.preformatted_text">Preformatted + text</a></span></dt> +<dt><span class="section"><a href="document_to_test_formatting/blurbs.html#document_to_test_formatting.blurbs.admonishments">Admonishments</a></span></dt> +<dt><span class="section"><a href="document_to_test_formatting/blurbs.html#document_to_test_formatting.blurbs.blurbs">Blurbs</a></span></dt> +</dl></dd> +<dt><span class="section"><a href="document_to_test_formatting/lists_and_tables.html">Lists and + Tables</a></span></dt> +<dd><dl> +<dt><span class="section"><a href="document_to_test_formatting/lists_and_tables.html#document_to_test_formatting.lists_and_tables.lists">Lists</a></span></dt> +<dt><span class="section"><a href="document_to_test_formatting/lists_and_tables.html#document_to_test_formatting.lists_and_tables.variable_lists">Variable + Lists</a></span></dt> +<dt><span class="section"><a href="document_to_test_formatting/lists_and_tables.html#document_to_test_formatting.lists_and_tables.tables">Tables</a></span></dt> +</dl></dd> +<dt><span class="section"><a href="document_to_test_formatting/images.html">Images</a></span></dt> +<dt><span class="section"><a href="document_to_test_formatting/test.html"> test HTML4 symbols</a></span></dt> +<dd><dl> +<dt><span class="section"><a href="document_to_test_formatting/test.html#document_to_test_formatting.test.test_greek_and_math_symbols">test + Greek and Math symbols</a></span></dt> +<dt><span class="section"><a href="document_to_test_formatting/test.html#document_to_test_formatting.test.test_latin1_symbols">test + Latin1 symbols</a></span></dt> +</dl></dd> +<dt><span class="section"><a href="document_to_test_formatting/remez.html"> Sample Article (The + Remez Method)</a></span></dt> +<dt><span class="section"><a href="document_to_test_formatting/array.html"> Array Example Boostbook + XML Documentation</a></span></dt> +<dd><dl> +<dt><span class="section"><a href="document_to_test_formatting/array.html#array.intro">Introduction</a></span></dt> +<dt><span class="section"><a href="document_to_test_formatting/array.html#id772287">Reference</a></span></dt> +<dt><span class="section"><a href="document_to_test_formatting/array.html#array.rationale">Design Rationale</a></span></dt> +<dt><span class="section"><a href="document_to_test_formatting/array.html#array.more.info">For more information...</a></span></dt> +<dt><span class="section"><a href="document_to_test_formatting/array.html#array.ack">Acknowledgements</a></span></dt> +</dl></dd> +<dt><span class="section"><a href="document_to_test_formatting/accumulators.html"> Accumulators + Example Doxygen Documentation</a></span></dt> +<dd><dl><dt><span class="section"><a href="document_to_test_formatting/accumulators.html#statistics_library_reference">Statistics Library Reference</a></span></dt></dl></dd> +</dl> +</div> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="document_to_test_formatting.introduction"></a><a class="link" href="index.html#document_to_test_formatting.introduction" title="Introduction">Introduction</a> +</h2></div></div></div> +<p> + This document is purely a test case to test out HTML and PDF generation and + style. + </p> +<p> + This is some body text. + </p> +<pre class="programlisting"><span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span> +<span class="special">{</span> + <span class="keyword">double</span> <span class="identifier">d</span> <span class="special">=</span> <span class="number">2.345</span><span class="special">;</span> + <span class="keyword">return</span> <span class="identifier">d</span><span class="special">;</span> +<span class="special">}</span> +</pre> +<p> + We can count in Greek too: α, β, γ. + </p> +<p> + Try some superscrips and subscripts: x<sup>2</sup>, x<sub>i</sub><sup>3</sup>, α<sup>2</sup>, β<sup>α</sup>, ⌊x⌋, ⌊α⌋, ⌈a⌉. + </p> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"><p><small>Last revised: July 22, 2010 at 21:58:58 GMT</small></p></td> +<td align="right"><div class="copyright-footer"></div></td> +</tr></table> +<hr> +<div class="spirit-nav"><a accesskey="n" href="document_to_test_formatting/code_blocks.html"><img src="../../../doc/src/images/next.png" alt="Next"></a></div> +</body> +</html> diff --git a/doc/test/html/images/beta_dist_kurtosis.png b/doc/test/html/images/beta_dist_kurtosis.png Binary files differnew file mode 100644 index 0000000000..1be258bfde --- /dev/null +++ b/doc/test/html/images/beta_dist_kurtosis.png diff --git a/doc/test/html/images/digamma3.png b/doc/test/html/images/digamma3.png Binary files differnew file mode 100644 index 0000000000..bf4b81f607 --- /dev/null +++ b/doc/test/html/images/digamma3.png diff --git a/doc/test/html/images/doctest.png b/doc/test/html/images/doctest.png Binary files differnew file mode 100644 index 0000000000..6d58193b31 --- /dev/null +++ b/doc/test/html/images/doctest.png diff --git a/doc/test/html/images/open_clipart_library_logo.svg b/doc/test/html/images/open_clipart_library_logo.svg new file mode 100644 index 0000000000..9a4521f3a5 --- /dev/null +++ b/doc/test/html/images/open_clipart_library_logo.svg @@ -0,0 +1,143 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!-- Created with Inkscape (http://www.inkscape.org/) --> +<svg + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:cc="http://web.resource.org/cc/" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns="http://www.w3.org/2000/svg" + xmlns:sodipodi="http://inkscape.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + version="1.0" + x="0.00000000" + y="0.00000000" + id="svg6221" + width="745.60706" + height="513.25690" + sodipodi:version="0.32" + inkscape:version="0.42" + sodipodi:docname="Open_Clipart_Library_logo.svg"> + <sodipodi:namedview + inkscape:cy="893.36713" + inkscape:cx="305.25953" + inkscape:zoom="0.86831670" + inkscape:window-height="913" + inkscape:window-width="1272" + inkscape:pageshadow="2" + inkscape:pageopacity="0.0" + borderopacity="1.0" + bordercolor="#666666" + pagecolor="#ffffff" + id="base" + inkscape:window-x="0" + inkscape:window-y="30" + inkscape:current-layer="svg6221" /> + <metadata + id="metadata4"> + <rdf:RDF> + <cc:Work + rdf:about=""> + <dc:format>image/svg+xml</dc:format> + <dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> + <dc:title>Open Clip Art Logo</dc:title> + <dc:date>10-01-2004</dc:date> + <dc:creator> + <cc:Agent> + <dc:title>Andreas Nilsson</dc:title> + </cc:Agent> + </dc:creator> + <cc:license + rdf:resource="http://web.resource.org/cc/PublicDomain" /> + <dc:contributor> + <cc:Agent> + <dc:title>Jon Phillips, Tobias Jakobs</dc:title> + </cc:Agent> + </dc:contributor> + <dc:description>This is one version of the official Open Clip Art Library logo.</dc:description> + <dc:subject>logo, open clip art library logo, logotype</dc:subject> + </cc:Work> + <cc:License + rdf:about="http://web.resource.org/cc/PublicDomain"> + <cc:permits + rdf:resource="http://web.resource.org/cc/Reproduction" /> + <cc:permits + rdf:resource="http://web.resource.org/cc/Distribution" /> + <cc:permits + rdf:resource="http://web.resource.org/cc/DerivativeWorks" /> + </cc:License> + </rdf:RDF> + </metadata> + <defs + id="defs3" /> + <path + d="M 405.82430,48.494855 C 396.10958,45.870336 386.13966,51.583653 383.51514,61.298370 L 298.15838,376.92441 C 295.53385,386.63914 301.24717,396.41506 310.96188,399.03957 L 626.58791,484.39635 C 636.30255,487.02086 646.27253,481.30755 648.89705,471.59283 L 734.25375,155.96679 C 735.49097,151.38725 734.71475,146.85751 732.70181,142.96928 L 732.70181,142.77528 L 732.50782,142.38730 L 732.50782,142.19331 C 732.46276,142.11490 732.36008,142.07704 732.31383,141.99931 L 717.76438,111.93045 L 651.80695,114.84034 L 405.82430,48.494855 z " + style="fill:#000000;fill-opacity:0.20000000;fill-rule:evenodd;stroke:none;stroke-width:1.6789947;stroke-miterlimit:4.0000000;stroke-opacity:0.20000000" + id="rect6080" /> + <rect + width="363.28452" + height="363.28452" + rx="2.9260478" + ry="2.9260478" + x="363.42282" + y="-78.837021" + transform="matrix(0.965391,0.260807,-0.260807,0.965391,0.000000,0.000000)" + style="fill:#ffffff;fill-rule:evenodd;stroke:#ffffff;stroke-width:7.7597070;stroke-miterlimit:4.0000000;stroke-opacity:1.0000000" + id="rect911" /> + <rect + width="288.49521" + height="288.49521" + rx="2.3236644" + ry="2.3236644" + x="398.72931" + y="-39.355053" + transform="matrix(0.965391,0.260807,-0.260807,0.965391,0.000000,0.000000)" + style="fill:#f3e533;fill-opacity:1.0000000;fill-rule:evenodd;stroke-width:0.79413080pt" + id="rect912" /> + <path + d="M 552.48969,32.227283 L 486.13725,53.566475 L 486.71922,53.760468 L 235.30476,53.760468 C 225.24184,53.760468 217.26344,61.738811 217.26344,71.801785 L 217.26344,398.87339 C 217.26344,408.93643 225.24178,416.91471 235.30476,416.91471 L 562.37636,416.91471 C 572.43940,416.91471 580.41768,408.93637 580.41768,398.87339 L 580.41768,71.801785 C 580.41768,66.612962 578.25806,62.108236 574.79189,58.804276 L 552.48969,32.227283 z " + style="fill:#000000;fill-opacity:0.20000000;fill-rule:evenodd;stroke:none;stroke-width:1.6789950;stroke-miterlimit:4.0000000;stroke-opacity:1.0000000" + id="rect6079" /> + <rect + width="363.28418" + height="363.28418" + rx="2.9260466" + ry="2.9260466" + x="192.47523" + y="30.531385" + style="fill:#ffffff;fill-rule:evenodd;stroke:#ffffff;stroke-width:7.7597060;stroke-miterlimit:4.0000000;stroke-opacity:1.0000000" + id="rect913" /> + <rect + width="288.49512" + height="288.49512" + rx="2.3236635" + ry="2.3236635" + x="227.78207" + y="70.013809" + style="fill:#ff7f00;fill-rule:evenodd;stroke-width:0.79413080pt" + id="rect914" /> + <path + d="M 348.20848,28.541423 L 291.17463,66.563983 L 305.14211,68.115925 L 55.667554,157.15854 C 46.188236,160.53570 41.232826,170.76437 44.609974,180.24367 L 138.89040,445.04365 L 132.29465,444.84966 L 128.02682,485.39411 L 163.52746,498.58561 L 163.91546,498.58561 C 168.05181,500.44490 172.88654,501.00342 177.49494,499.36159 L 485.55528,389.56176 C 495.03452,386.18460 499.79600,375.76200 496.41886,366.28264 L 386.81301,58.416291 C 385.25785,54.051177 382.02384,50.975478 378.27734,48.910652 L 348.20848,28.541423 z " + style="fill:#000000;fill-opacity:0.20000000;fill-rule:evenodd;stroke:none;stroke-width:1.2500002;stroke-miterlimit:4.0000000;stroke-opacity:1.0000000" + id="rect6078" /> + <rect + width="363.28326" + height="363.28326" + rx="2.9260383" + ry="2.9260383" + x="-41.716114" + y="142.20343" + transform="matrix(0.942003,-0.335604,0.335604,0.942003,0.000000,0.000000)" + style="fill:#ffffff;fill-rule:evenodd;stroke:#ffffff;stroke-width:7.7596951;stroke-miterlimit:4.0000000;stroke-opacity:1.0000000" + id="rect915" /> + <rect + width="288.49469" + height="288.49469" + rx="2.3236592" + ry="2.3236592" + x="-6.4090877" + y="181.68738" + transform="matrix(0.942003,-0.335604,0.335604,0.942003,0.000000,0.000000)" + style="fill:#bf0000;fill-rule:evenodd;stroke-width:0.79413080pt" + id="rect916" /> +</svg> diff --git a/doc/test/html/images/remez-2.png b/doc/test/html/images/remez-2.png Binary files differnew file mode 100644 index 0000000000..e9bfbd9108 --- /dev/null +++ b/doc/test/html/images/remez-2.png diff --git a/doc/test/html/images/remez-3.png b/doc/test/html/images/remez-3.png Binary files differnew file mode 100644 index 0000000000..6493527d56 --- /dev/null +++ b/doc/test/html/images/remez-3.png diff --git a/doc/test/html/images/remez-4.png b/doc/test/html/images/remez-4.png Binary files differnew file mode 100644 index 0000000000..6733bac9b9 --- /dev/null +++ b/doc/test/html/images/remez-4.png diff --git a/doc/test/html/images/remez-5.png b/doc/test/html/images/remez-5.png Binary files differnew file mode 100644 index 0000000000..80727614f8 --- /dev/null +++ b/doc/test/html/images/remez-5.png diff --git a/doc/test/remez.qbk b/doc/test/remez.qbk new file mode 100644 index 0000000000..3a72b12da2 --- /dev/null +++ b/doc/test/remez.qbk @@ -0,0 +1,372 @@ +[section:remez Sample Article (The Remez Method)] + +The [@http://en.wikipedia.org/wiki/Remez_algorithm Remez algorithm] +is a methodology for locating the minimax rational approximation +to a function. This short article gives a brief overview of the method, but +it should not be regarded as a thorough theoretical treatment, for that you +should consult your favorite textbook. + +Imagine that you want to approximate some function f(x) by way of a rational +function R(x), where R(x) may be either a polynomial P(x) or a ratio of two +polynomials P(x)/Q(x) (a rational function). Initially we'll concentrate on the +polynomial case, as it's by far the easier to deal with, later we'll extend +to the full rational function case. + +We want to find the "best" rational approximation, where +"best" is defined to be the approximation that has the least deviation +from f(x). We can measure the deviation by way of an error function: + +E[sub abs](x) = f(x) - R(x) + +which is expressed in terms of absolute error, but we can equally use +relative error: + +E[sub rel](x) = (f(x) - R(x)) / |f(x)| + +And indeed in general we can scale the error function in any way we want, it +makes no difference to the maths, although the two forms above cover almost +every practical case that you're likely to encounter. + +The minimax rational function R(x) is then defined to be the function that +yields the smallest maximal value of the error function. Chebyshev showed +that there is a unique minimax solution for R(x) that has the following +properties: + +* If R(x) is a polynomial of degree N, then there are N+2 unknowns: +the N+1 coefficients of the polynomial, and maximal value of the error +function. +* The error function has N+1 roots, and N+2 extrema (minima and maxima). +* The extrema alternate in sign, and all have the same magnitude. + +That means that if we know the location of the extrema of the error function +then we can write N+2 simultaneous equations: + +R(x[sub i]) + (-1)[super i]E = f(x[sub i]) + +where E is the maximal error term, and x[sub i] are the abscissa values of the +N+2 extrema of the error function. It is then trivial to solve the simultaneous +equations to obtain the polynomial coefficients and the error term. + +['Unfortunately we don't know where the extrema of the error function are located!] + +[h4 The Remez Method] + +The Remez method is an iterative technique which, given a broad range of +assumptions, will converge on the extrema of the error function, and therefore +the minimax solution. + +In the following discussion we'll use a concrete example to illustrate +the Remez method: an approximation to the function e[super x][space] over +the range \[-1, 1\]. + +Before we can begin the Remez method, we must obtain an initial value +for the location of the extrema of the error function. We could "guess" +these, but a much closer first approximation can be obtained by first +constructing an interpolated polynomial approximation to f(x). + +In order to obtain the N+1 coefficients of the interpolated polynomial +we need N+1 points (x[sub 0]...x[sub N]): with our interpolated form +passing through each of those points +that yields N+1 simultaneous equations: + +f(x[sub i]) = P(x[sub i]) = c[sub 0] + c[sub 1]x[sub i] ... + c[sub N]x[sub i][super N] + +Which can be solved for the coefficients c[sub 0]...c[sub N] in P(x). + +Obviously this is not a minimax solution, indeed our only guarantee is that f(x) and +P(x) touch at N+1 locations, away from those points the error may be arbitrarily +large. However, we would clearly like this initial approximation to be as close to +f(x) as possible, and it turns out that using the zeros of an orthogonal polynomial +as the initial interpolation points is a good choice. In our example we'll use the +zeros of a Chebyshev polynomial as these are particularly easy to calculate, +interpolating for a polynomial of degree 4, and measuring /relative error/ +we get the following error function: + +[$images/remez-2.png] + +Which has a peak relative error of 1.2x10[super -3]. + +While this is a pretty good approximation already, judging by the +shape of the error function we can clearly do better. Before starting +on the Remez method propper, we have one more step to perform: locate +all the extrema of the error function, and store +these locations as our initial ['Chebyshev control points]. + +[note +In the simple case of a polynomial approximation, by interpolating through +the roots of a Chebyshev polynomial we have in fact created a ['Chebyshev +approximation] to the function: in terms of /absolute error/ +this is the best a priori choice for the interpolated form we can +achieve, and typically is very close to the minimax solution. + +However, if we want to optimise for /relative error/, or if the approximation +is a rational function, then the initial Chebyshev solution can be quite far +from the ideal minimax solution. + +A more technical discussion of the theory involved can be found in this +[@http://math.fullerton.edu/mathews/n2003/ChebyshevPolyMod.html online course].] + +[h4 Remez Step 1] + +The first step in the Remez method, given our current set of +N+2 Chebyshev control points x[sub i], is to solve the N+2 simultaneous +equations: + +P(x[sub i]) + (-1)[super i]E = f(x[sub i]) + +To obtain the error term E, and the coefficients of the polynomial P(x). + +This gives us a new approximation to f(x) that has the same error /E/ at +each of the control points, and whose error function ['alternates in sign] +at the control points. This is still not necessarily the minimax +solution though: since the control points may not be at the extrema of the error +function. After this first step here's what our approximation's error +function looks like: + +[$images/remez-3.png] + +Clearly this is still not the minimax solution since the control points +are not located at the extrema, but the maximum relative error has now +dropped to 5.6x10[super -4]. + +[h4 Remez Step 2] + +The second step is to locate the extrema of the new approximation, which we do +in two stages: first, since the error function changes sign at each +control point, we must have N+1 roots of the error function located between +each pair of N+2 control points. Once these roots are found by standard root finding +techniques, we know that N extrema are bracketed between each pair of +roots, plus two more between the endpoints of the range and the first and last roots. +The N+2 extrema can then be found using standard function minimisation techniques. + +We now have a choice: multi-point exchange, or single point exchange. + +In single point exchange, we move the control point nearest to the largest extrema to +the absissa value of the extrema. + +In multi-point exchange we swap all the current control points, for the locations +of the extrema. + +In our example we perform multi-point exchange. + +[h4 Iteration] + +The Remez method then performs steps 1 and 2 above iteratively until the control +points are located at the extrema of the error function: this is then +the minimax solution. + +For our current example, two more iterations converges on a minimax +solution with a peak relative error of +5x10[super -4] and an error function that looks like: + +[$images/remez-4.png] + +[h4 Rational Approximations] + +If we wish to extend the Remez method to a rational approximation of the form + +f(x) = R(x) = P(x) / Q(x) + +where P(x) and Q(x) are polynomials, then we proceed as before, except that now +we have N+M+2 unknowns if P(x) is of order N and Q(x) is of order M. This assumes +that Q(x) is normalised so that it's leading coefficient is 1, giving +N+M+1 polynomial coefficients in total, plus the error term E. + +The simultaneous equations to be solved are now: + +P(x[sub i]) / Q(x[sub i]) + (-1)[super i]E = f(x[sub i]) + +Evaluated at the N+M+2 control points x[sub i]. + +Unfortunately these equations are non-linear in the error term E: we can only +solve them if we know E, and yet E is one of the unknowns! + +The method usually adopted to solve these equations is an iterative one: we guess the +value of E, solve the equations to obtain a new value for E (as well as the polynomial +coefficients), then use the new value of E as the next guess. The method is +repeated until E converges on a stable value. + +These complications extend the running time required for the development +of rational approximations quite considerably. It is often desirable +to obtain a rational rather than polynomial approximation none the less: +rational approximations will often match more difficult to approximate +functions, to greater accuracy, and with greater efficiency, than their +polynomial alternatives. For example, if we takes our previous example +of an approximation to e[super x], we obtained 5x10[super -4] accuracy +with an order 4 polynomial. If we move two of the unknowns into the denominator +to give a pair of order 2 polynomials, and re-minimise, then the peak relative error drops +to 8.7x10[super -5]. That's a 5 fold increase in accuracy, for the same number +of terms overall. + +[h4 Practical Considerations] + +Most treatises on approximation theory stop at this point. However, from +a practical point of view, most of the work involves finding the right +approximating form, and then persuading the Remez method to converge +on a solution. + +So far we have used a direct approximation: + +f(x) = R(x) + +But this will converge to a useful approximation only if f(x) is smooth. In +addition round-off errors when evaluating the rational form mean that this +will never get closer than within a few epsilon of machine precision. +Therefore this form of direct approximation is often reserved for situations +where we want efficiency, rather than accuracy. + +The first step in improving the situation is generally to split f(x) into +a dominant part that we can compute accurately by another method, and a +slowly changing remainder which can be approximated by a rational approximation. +We might be tempted to write: + +f(x) = g(x) + R(x) + +where g(x) is the dominant part of f(x), but if f(x)\/g(x) is approximately +constant over the interval of interest then: + +f(x) = g(x)(c + R(x)) + +Will yield a much better solution: here /c/ is a constant that is the approximate +value of f(x)\/g(x) and R(x) is typically tiny compared to /c/. In this situation +if R(x) is optimised for absolute error, then as long as its error is small compared +to the constant /c/, that error will effectively get wiped out when R(x) is added to +/c/. + +The difficult part is obviously finding the right g(x) to extract from your +function: often the asymptotic behaviour of the function will give a clue, so +for example the function __erfc becomes proportional to +e[super -x[super 2]]\/x as x becomes large. Therefore using: + +erfc(z) = (C + R(x)) e[super -x[super 2]]/x + +as the approximating form seems like an obvious thing to try, and does indeed +yield a useful approximation. + +However, the difficulty then becomes one of converging the minimax solution. +Unfortunately, it is known that for some functions the Remez method can lead +to divergent behaviour, even when the initial starting approximation is quite good. +Furthermore, it is not uncommon for the solution obtained in the first Remez step +above to be a bad one: the equations to be solved are generally "stiff", often +very close to being singular, and assuming a solution is found at all, round-off +errors and a rapidly changing error function, can lead to a situation where the +error function does not in fact change sign at each control point as required. +If this occurs, it is fatal to the Remez method. It is also possible to +obtain solutions that are perfectly valid mathematically, but which are +quite useless computationally: either because there is an unavoidable amount +of roundoff error in the computation of the rational function, or because +the denominator has one or more roots over the interval of the approximation. +In the latter case while the approximation may have the correct limiting value at +the roots, the approximation is nonetheless useless. + +Assuming that the approximation does not have any fatal errors, and that the only +issue is converging adequately on the minimax solution, the aim is to +get as close as possible to the minimax solution before beginning the Remez method. +Using the zeros of a Chebyshev polynomial for the initial interpolation is a +good start, but may not be ideal when dealing with relative errors and\/or +rational (rather than polynomial) approximations. One approach is to skew +the initial interpolation points to one end: for example if we raise the +roots of the Chebyshev polynomial to a positive power greater than 1 +then the roots will be skewed towards the middle of the \[-1,1\] interval, +while a positive power less than one +will skew them towards either end. More usefully, if we initially rescale the +points over \[0,1\] and then raise to a positive power, we can skew them to the left +or right. Returning to our example of e[super x][space] over \[-1,1\], the initial +interpolated form was some way from the minimax solution: + +[$images/remez-2.png] + +However, if we first skew the interpolation points to the left (rescale them +to \[0, 1\], raise to the power 1.3, and then rescale back to \[-1,1\]) we +reduce the error from 1.3x10[super -3][space]to 6x10[super -4]: + +[$images/remez-5.png] + +It's clearly still not ideal, but it is only a few percent away from +our desired minimax solution (5x10[super -4]). + +[h4 Remez Method Checklist] + +The following lists some of the things to check if the Remez method goes wrong, +it is by no means an exhaustive list, but is provided in the hopes that it will +prove useful. + +* Is the function smooth enough? Can it be better separated into +a rapidly changing part, and an asymptotic part? +* Does the function being approximated have any "blips" in it? Check +for problems as the function changes computation method, or +if a root, or an infinity has been divided out. The telltale +sign is if there is a narrow region where the Remez method will +not converge. +* Check you have enough accuracy in your calculations: remember that +the Remez method works on the difference between the approximation +and the function being approximated: so you must have more digits of +precision available than the precision of the approximation +being constructed. So for example at double precision, you +shouldn't expect to be able to get better than a float precision +approximation. +* Try skewing the initial interpolated approximation to minimise the +error before you begin the Remez steps. +* If the approximation won't converge or is ill-conditioned from one starting +location, try starting from a different location. +* If a rational function won't converge, one can minimise a polynomial +(which presents no problems), then rotate one term from the numerator to +the denominator and minimise again. In theory one can continue moving +terms one at a time from numerator to denominator, and then re-minimising, +retaining the last set of control points at each stage. +* Try using a smaller interval. It may also be possible to optimise over +one (small) interval, rescale the control points over a larger interval, +and then re-minimise. +* Keep absissa values small: use a change of variable to keep the abscissa +over, say \[0, b\], for some smallish value /b/. + +[h4 References] + +The original references for the Remez Method and it's extension +to rational functions are unfortunately in Russian: + +Remez, E.Ya., ['Fundamentals of numerical methods for Chebyshev approximations], +"Naukova Dumka", Kiev, 1969. + +Remez, E.Ya., Gavrilyuk, V.T., ['Computer development of certain approaches +to the approximate construction of solutions of Chebyshev problems +nonlinearly depending on parameters], Ukr. Mat. Zh. 12 (1960), 324-338. + +Gavrilyuk, V.T., ['Generalization of the first polynomial algorithm of +E.Ya.Remez for the problem of constructing rational-fractional +Chebyshev approximations], Ukr. Mat. Zh. 16 (1961), 575-585. + +Some English language sources include: + +Fraser, W., Hart, J.F., ['On the computation of rational approximations +to continuous functions], Comm. of the ACM 5 (1962), 401-403, 414. + +Ralston, A., ['Rational Chebyshev approximation by Remes' algorithms], +Numer.Math. 7 (1965), no. 4, 322-330. + +A. Ralston, ['Rational Chebyshev approximation, Mathematical +Methods for Digital Computers v. 2] (Ralston A., Wilf H., eds.), +Wiley, New York, 1967, pp. 264-284. + +Hart, J.F. e.a., ['Computer approximations], Wiley, New York a.o., 1968. + +Cody, W.J., Fraser, W., Hart, J.F., ['Rational Chebyshev approximation +using linear equations], Numer.Math. 12 (1968), 242-251. + +Cody, W.J., ['A survey of practical rational and polynomial +approximation of functions], SIAM Review 12 (1970), no. 3, 400-423. + +Barrar, R.B., Loeb, H.J., ['On the Remez algorithm for non-linear +families], Numer.Math. 15 (1970), 382-391. + +Dunham, Ch.B., ['Convergence of the Fraser-Hart algorithm for rational +Chebyshev approximation], Math. Comp. 29 (1975), no. 132, 1078-1082. + +G. L. Litvinov, ['Approximate construction of rational +approximations and the effect of error autocorrection], +Russian Journal of Mathematical Physics, vol.1, No. 3, 1994. + +[endsect][/section:remez The Remez Method] + + + diff --git a/doc/test/stub.cpp b/doc/test/stub.cpp new file mode 100644 index 0000000000..48e76d0860 --- /dev/null +++ b/doc/test/stub.cpp @@ -0,0 +1,69 @@ +/*============================================================================= + Copyright (c) 2006 Joel de Guzman + http://spirit.sourceforge.net/ + + Use, modification and distribution is subject to 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) +=============================================================================*/ +#include <string> + +//[ bar +//` This is the [*/bar/] function +std::string bar() +{ + // return 'em, bar man! + return "bar"; +} +//] + +//[ foo +/*` This is the [*['foo]] function. */ +std::string foo() +{ + // return 'em, foo man! + return "foo"; +} +//] + +//[ foo_bar +std::string foo_bar() /*< The /Mythical/ FooBar. + See [@http://en.wikipedia.org/wiki/Foobar Foobar for details] >*/ +{ + return "foo-bar"; /*< return 'em, foo-bar man! >*/ +} +//] + +//[ class_ +class x +{ +public: + + /*<< Constructor >>*/ + x() : n(0) + { + } + + /*<< Destructor >>*/ + ~x() + { + } + + /*<< Get the `n` member variable >>*/ + int get() const + { + return n; /*<- this will be ignored by quickbook ->*/ + } + + /*<< Set the `n` member variable >>*/ + void set(int n_) + { + n = n_; + } +//<- this will be ignored by quickbook +private: + + int n; +//-> +}; +//] diff --git a/doc/test/test.qbk b/doc/test/test.qbk new file mode 100644 index 0000000000..889d414758 --- /dev/null +++ b/doc/test/test.qbk @@ -0,0 +1,626 @@ +[article Document To Test Formatting + [quickbook 1.4] + [copyright 2007 John Maddock, Joel de Guzman, Eric Niebler and Matias Capeletto] + [purpose Test Formatting Document] + [license + 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]) + ] + [authors [Maddock, John], [de Guzman, Joel], [Niebler, Eric], [Capeletto, Matias] ] + [category math] + [/last-revision $Date: 2007-05-07 10:21:52 +0100 (Mon, 07 May 2007) $] +] + +[include HTML4_symbols.qbk] + +[/ Some composite templates] +[template super[x]'''<superscript>'''[x]'''</superscript>'''] +[template sub[x]'''<subscript>'''[x]'''</subscript>'''] +[template floor[x]'''⌊'''[x]'''⌋'''] +[template floorlr[x][lfloor][x][rfloor]] +[template ceil[x] '''⌈'''[x]'''⌉'''] + +[section Introduction] + +This document is purely a test case to test out HTML and PDF generation and style. + +This is some body text. + + int main() + { + double d = 2.345; + return d; + } + +We can count in Greek too: [alpha], [beta], [gamma]. + +Try some superscrips and subscripts: x[super 2], x[sub i][super 3], [alpha][super 2], +[beta][super [alpha]], [floor x], [floor [alpha]], [ceil a]. + +[endsect] + +[section Code Blocks] + +[section Embedded code] + +These should be syntax highlighted: + + #include <iostream> + + int main() + { + // Sample code + std::cout << "Hello, World\n"; + return 0; + } + +[endsect] + +[section Code With a Very Long Line] + + template <class RealType> RealType inline foo(const RealType& a, const RealType& b, const RealType& c, const RealType& d, const RealType& e, const RealType& f, const RealType& g, const RealType& h){ return 0; } + +[endsect] + +[section Imported code and callouts] + +[import stub.cpp] + +Here's some code with left-placed callouts: + +[class_] + +And again with callouts placed exactly where we put them: + +[foo_bar] + +[endsect] + +[section Larger example] + +Now let's include a larger example, this may span several pages +and should not be chopped off half way through... some FO processors +get this wrong! + + namespace boost{ + + template <class BidirectionalIterator> + class sub_match; + + typedef sub_match<const char*> csub_match; + typedef sub_match<const wchar_t*> wcsub_match; + typedef sub_match<std::string::const_iterator> ssub_match; + typedef sub_match<std::wstring::const_iterator> wssub_match; + + template <class BidirectionalIterator> + class sub_match : public std::pair<BidirectionalIterator, BidirectionalIterator> + { + public: + typedef typename iterator_traits<BidirectionalIterator>::value_type value_type; + typedef typename iterator_traits<BidirectionalIterator>::difference_type difference_type; + typedef BidirectionalIterator iterator; + + bool matched; + + difference_type length()const; + operator basic_string<value_type>()const; + basic_string<value_type> str()const; + + int compare(const sub_match& s)const; + int compare(const basic_string<value_type>& s)const; + int compare(const value_type* s)const; + #ifdef BOOST_REGEX_MATCH_EXTRA + typedef implementation-private capture_sequence_type; + const capture_sequence_type& captures()const; + #endif + }; + // + // comparisons to another sub_match: + // + template <class BidirectionalIterator> + bool operator == (const sub_match<BidirectionalIterator>& lhs, + const sub_match<BidirectionalIterator>& rhs); + template <class BidirectionalIterator> + bool operator != (const sub_match<BidirectionalIterator>& lhs, + const sub_match<BidirectionalIterator>& rhs); + template <class BidirectionalIterator> + bool operator < (const sub_match<BidirectionalIterator>& lhs, + const sub_match<BidirectionalIterator>& rhs); + template <class BidirectionalIterator> + bool operator <= (const sub_match<BidirectionalIterator>& lhs, + const sub_match<BidirectionalIterator>& rhs); + template <class BidirectionalIterator> + bool operator >= (const sub_match<BidirectionalIterator>& lhs, + const sub_match<BidirectionalIterator>& rhs); + template <class BidirectionalIterator> + bool operator > (const sub_match<BidirectionalIterator>& lhs, + const sub_match<BidirectionalIterator>& rhs); + + + // + // comparisons to a basic_string: + // + template <class BidirectionalIterator, class traits, class Allocator> + bool operator == (const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, + traits, + Allocator>& lhs, + const sub_match<BidirectionalIterator>& rhs); + template <class BidirectionalIterator, class traits, class Allocator> + bool operator != (const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, + traits, + Allocator>& lhs, + const sub_match<BidirectionalIterator>& rhs); + template <class BidirectionalIterator, class traits, class Allocator> + bool operator < (const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, + traits, + Allocator>& lhs, + const sub_match<BidirectionalIterator>& rhs); + template <class BidirectionalIterator, class traits, class Allocator> + bool operator > (const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, + traits, + Allocator>& lhs, + const sub_match<BidirectionalIterator>& rhs); + template <class BidirectionalIterator, class traits, class Allocator> + bool operator >= (const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, + traits, + Allocator>& lhs, + const sub_match<BidirectionalIterator>& rhs); + template <class BidirectionalIterator, class traits, class Allocator> + bool operator <= (const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, + traits, + Allocator>& lhs, + const sub_match<BidirectionalIterator>& rhs); + + template <class BidirectionalIterator, class traits, class Allocator> + bool operator == (const sub_match<BidirectionalIterator>& lhs, + const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, + traits, + Allocator>& rhs); + template <class BidirectionalIterator, class traits, class Allocator> + bool operator != (const sub_match<BidirectionalIterator>& lhs, + const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, + traits, + Allocator>& rhs); + template <class BidirectionalIterator, class traits, class Allocator> + bool operator < (const sub_match<BidirectionalIterator>& lhs, + const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, + traits, + Allocator>& rhs); + template <class BidirectionalIterator, class traits, class Allocator> + bool operator > (const sub_match<BidirectionalIterator>& lhs, + const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, + traits, + Allocator>& rhs); + template <class BidirectionalIterator, class traits, class Allocator> + bool operator >= (const sub_match<BidirectionalIterator>& lhs, + const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, + traits, + Allocator>& rhs); + template <class BidirectionalIterator, class traits, class Allocator> + bool operator <= (const sub_match<BidirectionalIterator>& lhs, + const std::basic_string<iterator_traits<BidirectionalIterator>::value_type, + traits, + Allocator>& rhs); + + // + // comparisons to a pointer to a character array: + // + template <class BidirectionalIterator> + bool operator == (typename iterator_traits<BidirectionalIterator>::value_type const* lhs, + const sub_match<BidirectionalIterator>& rhs); + template <class BidirectionalIterator> + bool operator != (typename iterator_traits<BidirectionalIterator>::value_type const* lhs, + const sub_match<BidirectionalIterator>& rhs); + template <class BidirectionalIterator> + bool operator < (typename iterator_traits<BidirectionalIterator>::value_type const* lhs, + const sub_match<BidirectionalIterator>& rhs); + template <class BidirectionalIterator> + bool operator > (typename iterator_traits<BidirectionalIterator>::value_type const* lhs, + const sub_match<BidirectionalIterator>& rhs); + template <class BidirectionalIterator> + bool operator >= (typename iterator_traits<BidirectionalIterator>::value_type const* lhs, + const sub_match<BidirectionalIterator>& rhs); + template <class BidirectionalIterator> + bool operator <= (typename iterator_traits<BidirectionalIterator>::value_type const* lhs, + const sub_match<BidirectionalIterator>& rhs); + + template <class BidirectionalIterator> + bool operator == (const sub_match<BidirectionalIterator>& lhs, + typename iterator_traits<BidirectionalIterator>::value_type const* rhs); + template <class BidirectionalIterator> + bool operator != (const sub_match<BidirectionalIterator>& lhs, + typename iterator_traits<BidirectionalIterator>::value_type const* rhs); + template <class BidirectionalIterator> + bool operator < (const sub_match<BidirectionalIterator>& lhs, + typename iterator_traits<BidirectionalIterator>::value_type const* rhs); + template <class BidirectionalIterator> + bool operator > (const sub_match<BidirectionalIterator>& lhs, + typename iterator_traits<BidirectionalIterator>::value_type const* rhs); + template <class BidirectionalIterator> + bool operator >= (const sub_match<BidirectionalIterator>& lhs, + typename iterator_traits<BidirectionalIterator>::value_type const* rhs); + template <class BidirectionalIterator> + bool operator <= (const sub_match<BidirectionalIterator>& lhs, + typename iterator_traits<BidirectionalIterator>::value_type const* rhs); + + // + // comparisons to a single character: + // + template <class BidirectionalIterator> + bool operator == (typename iterator_traits<BidirectionalIterator>::value_type const& lhs, + const sub_match<BidirectionalIterator>& rhs); + template <class BidirectionalIterator> + bool operator != (typename iterator_traits<BidirectionalIterator>::value_type const& lhs, + const sub_match<BidirectionalIterator>& rhs); + template <class BidirectionalIterator> + bool operator < (typename iterator_traits<BidirectionalIterator>::value_type const& lhs, + const sub_match<BidirectionalIterator>& rhs); + template <class BidirectionalIterator> + bool operator > (typename iterator_traits<BidirectionalIterator>::value_type const& lhs, + const sub_match<BidirectionalIterator>& rhs); + template <class BidirectionalIterator> + bool operator >= (typename iterator_traits<BidirectionalIterator>::value_type const& lhs, + const sub_match<BidirectionalIterator>& rhs); + template <class BidirectionalIterator> + bool operator <= (typename iterator_traits<BidirectionalIterator>::value_type const& lhs, + const sub_match<BidirectionalIterator>& rhs); + + template <class BidirectionalIterator> + bool operator == (const sub_match<BidirectionalIterator>& lhs, + typename iterator_traits<BidirectionalIterator>::value_type const& rhs); + template <class BidirectionalIterator> + bool operator != (const sub_match<BidirectionalIterator>& lhs, + typename iterator_traits<BidirectionalIterator>::value_type const& rhs); + template <class BidirectionalIterator> + bool operator < (const sub_match<BidirectionalIterator>& lhs, + typename iterator_traits<BidirectionalIterator>::value_type const& rhs); + template <class BidirectionalIterator> + bool operator > (const sub_match<BidirectionalIterator>& lhs, + typename iterator_traits<BidirectionalIterator>::value_type const& rhs); + template <class BidirectionalIterator> + bool operator >= (const sub_match<BidirectionalIterator>& lhs, + typename iterator_traits<BidirectionalIterator>::value_type const& rhs); + template <class BidirectionalIterator> + bool operator <= (const sub_match<BidirectionalIterator>& lhs, + typename iterator_traits<BidirectionalIterator>::value_type const& rhs); + // + // addition operators: + // + template <class BidirectionalIterator, class traits, class Allocator> + std::basic_string<typename iterator_traits<BidirectionalIterator>::value_type, traits, Allocator> + operator + (const std::basic_string<typename iterator_traits<BidirectionalIterator>::value_type, + traits, + Allocator>& s, + const sub_match<BidirectionalIterator>& m); + template <class BidirectionalIterator, class traits, class Allocator> + std::basic_string<typename iterator_traits<BidirectionalIterator>::value_type, traits, Allocator> + operator + (const sub_match<BidirectionalIterator>& m, + const std::basic_string<typename iterator_traits<BidirectionalIterator>::value_type, + traits, + Allocator>& s); + template <class BidirectionalIterator> + std::basic_string<typename iterator_traits<BidirectionalIterator>::value_type> + operator + (typename iterator_traits<BidirectionalIterator>::value_type const* s, + const sub_match<BidirectionalIterator>& m); + template <class BidirectionalIterator> + std::basic_string<typename iterator_traits<BidirectionalIterator>::value_type> + operator + (const sub_match<BidirectionalIterator>& m, + typename iterator_traits<BidirectionalIterator>::value_type const * s); + template <class BidirectionalIterator> + std::basic_string<typename iterator_traits<BidirectionalIterator>::value_type> + operator + (typename iterator_traits<BidirectionalIterator>::value_type const& s, + const sub_match<BidirectionalIterator>& m); + template <class BidirectionalIterator> + std::basic_string<typename iterator_traits<BidirectionalIterator>::value_type> + operator + (const sub_match<BidirectionalIterator>& m, + typename iterator_traits<BidirectionalIterator>::value_type const& s); + template <class BidirectionalIterator> + std::basic_string<typename iterator_traits<BidirectionalIterator>::value_type> + operator + (const sub_match<BidirectionalIterator>& m1, + const sub_match<BidirectionalIterator>& m2); + + // + // stream inserter: + // + template <class charT, class traits, class BidirectionalIterator> + basic_ostream<charT, traits>& + operator << (basic_ostream<charT, traits>& os, + const sub_match<BidirectionalIterator>& m); + + } // namespace boost + +[endsect] + +[endsect] + +[section Basic Formatting] + +[section Font Styles] + +Here we go with some inline formatting: +['italic], [*bold], [_underline], [^teletype], [-strikethrough], +we can combine styles as well: ['[*bold italic]], [_[^teletype with underline]]. + +[endsect] + +[section Replaceable Text] + +Text that is intended to be user-replaceable is [~rendered like this]. + +[endsect] + +[section Quotations] + +Here we go: ["A question that sometimes drives me hazy: am I or are the others crazy?]--Einstein + +Note the proper left and right quote marks. Also, while you can simply use ordinary quote marks like "quoted", our quotation, above, will generate correct DocBook quotations (e.g. <quote>quoted</quote>). + +Like all phrase elements, quotations may be nested. Example: + +["Here's the rule for bargains: ["Do other men, for they would do you.] That's +the true business precept.] + +[endsect] + +[section Inline Code] + +This text has inlined code `int main() { return 0; }` in it. +The code should be syntax highlighted. + +[endsect] + +[section Links] + +Try this: [@http://www.boost.org this is [*boost's] website....] it should +be visible as a link. + +This is [@../../../boost/math/distributions.hpp a link to a header file (boost/math/distributions.hpp)], +it should be rewritable and point to the website when built as a PDF. + +This is [@boost:libs/regex/index.html a link to another library's documentation (Boost.Regex)], using the boost: protocol, +it should be rewritten to point to the website when building a PDF. + +This is [@boost:/libs/regex/index.html a link to another library's documentation (Boost.Regex)], using the boost:/ protocol, +it should be rewritten to point to the website when building a PDF. + +This is [@../weighted_tail_quantile.hpp a relative link to a header file within the test source], +it should be rewritten to point to the website when building a PDF. +Although it might be on the website yet. + +[endsect] + +[section Footnotes] + +Here's one [footnote A sample footnote]. + +And here's another [footnote Another sample footnote]. + +[endsect] + +[section Blockquote] + +Lets indent the next paragraph: + +[:Here we go!!!] + +[endsect] + +[section Headings] + +Now try rendering some heading styles: + +[h1 Heading 1] + +[h2 Heading 2] + +[h3 Heading 3] + +[h4 Heading 4] + +[h5 Heading 5] + +[h6 Heading 6] + +[endsect] + +[endsect] + +[section Blurbs] + +[section Preformatted text] + +Here's some sample program output: + +[pre +'''F test for equal standard deviations +____________________________________ + +Sample 1: +Number of Observations = 240 +Sample Standard Deviation = 65.549 + +Sample 2: +Number of Observations = 240 +Sample Standard Deviation = 61.854 + +Test Statistic = 1.123 + +CDF of test statistic: = 8.148e-001 +Upper Critical Value at alpha: = 1.238e+000 +Upper Critical Value at alpha/2: = 1.289e+000 +Lower Critical Value at alpha: = 8.080e-001 +Lower Critical Value at alpha/2: = 7.756e-001 + +Results for Alternative Hypothesis and alpha = 0.0500 + +Alternative Hypothesis Conclusion +Standard deviations are unequal (two sided test) REJECTED +Standard deviation 1 is less than standard deviation 2 REJECTED +Standard deviation 1 is greater than standard deviation 2 REJECTED''' +] + +[endsect] + +[section Admonishments] + +There are four admonishments supported by Docbook XML: + +[note This is a note] + +[tip This is a tip] + +[important This is important] + +[caution This is a caution] + +[warning This is a warning + +They can contain more than one paragraph. +] + +[endsect] + +[section Blurbs] + +[blurb [*An eye catching advertisement or note...] + +These should be rendered in a manner similar to admonishments. + +They can contain more than one paragraph. +] + +[endsect] + +[endsect] + +[section Lists and Tables] + +[section Lists] + +A numbered list: + +# One +# Two +# Three + # Three.a + # Three.b + # Three.c +# Four + # Four.a + # Four.a.i + # Four.a.ii +# Five + +An unordered list: + +* First +* Second +* Third + +A mixture of the two: + +# 1 + * 1.a + # 1.a.1 + # 1.a.2 + * 1.b +# 2 + * 2.a + * 2.b + # 2.b.1 + # 2.b.2 + * 2.b.2.a + * 2.b.2.b + + +[endsect] + +[section Variable Lists] + +[variablelist A Variable List + [[term 1] [The definition of term 1]] + [[term 2] [The definition of term 2]] + [[term 3] [The definition of term 3]] +] + +[endsect] + +[section Tables] + +Here's a big table with code and other tricky things: + +[table Notes on the Implementation of the Beta Distribution +[[Function][Implementation Notes]] +[[pdf] + [f(x;[alpha],[beta]) = x[super[alpha] - 1] (1 - x)[super[beta] -1] / B([alpha], [beta]) + + Implemented using ibeta_derivative(a, b, x).]] + +[[cdf][Using the incomplete beta function ibeta(a, b, x)]] +[[cdf complement][ibetac(a, b, x)]] +[[quantile][Using the inverse incomplete beta function ibeta_inv(a, b, p)]] +[[quantile from the complement][ibetac_inv(a, b, q)]] +[[mean][`a/(a+b)`]] +[[variance][`a * b / (a+b)^2 * (a + b + 1)`]] +[[mode][`(a-1) / (a + b + 2)`]] +[[skewness][`2 (b-a) sqrt(a+b+1)/(a+b+2) * sqrt(a * b)`]] +[[kurtosis excess][ [$images/beta_dist_kurtosis.png] ]] +[[kurtosis][`kurtosis + 3`]] +[[parameter estimation][ ]] +[[alpha + + from mean and variance][`mean * (( (mean * (1 - mean)) / variance)- 1)`]] +[[beta + + from mean and variance][`(1 - mean) * (((mean * (1 - mean)) /variance)-1)`]] +[[The member functions `estimate_alpha` and `estimate_beta` + + from cdf and probability x + + and *either* `alpha` or `beta`] + [Implemented in terms of the inverse incomplete beta functions + +ibeta_inva, and ibeta_invb respectively.]] +[[`estimate_alpha`][`ibeta_inva(beta, x, probability)`]] +[[`estimate_beta`][`ibeta_invb(alpha, x, probability)`]] +] + +[endsect] + +[endsect] + +[section Images] + +These are tricky enough that they warrent their own section. + +Let's start with a PNG file that's set to 120dpi, it should render at +a sensible size in both html and PDF forms. It should print OK too! + +[$images/digamma3.png] + +Now try again with a sample SVG image: + +[$images/open_clipart_library_logo.svg] + + +[endsect] + +[include test_HTML4_symbols.qbk] + +[include remez.qbk] + +[section:array Array Example Boostbook XML Documentation] +[xinclude array.xml] +[xinclude array1.xml] +[xinclude array2.xml] +[xinclude array3.xml] +[xinclude array4.xml] +[endsect] + +[section:accumulators Accumulators Example Doxygen Documentation] +[xinclude statsdoc.xml] +[endsect] + + + diff --git a/doc/test/test_HTML4_symbols.qbk b/doc/test/test_HTML4_symbols.qbk new file mode 100644 index 0000000000..9dc271ee1f --- /dev/null +++ b/doc/test/test_HTML4_symbols.qbk @@ -0,0 +1,253 @@ +[section:test test HTML4 symbols] +[/ Examples of using all the Greek and Math symbols defined in HTML4_symbols.qbk] +[/ See http://www.htmlhelp.com/reference/html40/entities/symbols.html] + +[/ Also some miscellaneous math charaters added to this list - see the end.] + +[/ To use, enclose the template name in square brackets.] + +[section test Greek and Math symbols] + +[fnof], +[Alpha], +[Beta], +[Gamma], +[Delta], +[Epsilon], +[Zeta], +[Eta], +[Theta], +[Iota], +[Kappa], +[Lambda], +[Mu], +[Nu], +[Xi], +[Omicron], +[Pi], +[Rho], +[Sigma], +[Tau], +[Upsilon], +[Phi], +[Chi], +[Psi], +[Omega], +[alpha], +[beta], +[gamma], +[delta], +[epsilon], +[zeta], +[eta], +[theta], +[iota], +[kappa], +[lambda], +[mu], +[nu], +[xi], +[omicron], +[pi], +[rho], +[sigmaf], +[sigma], +[tau], +[upsilon], +[phi], +[chi], +[psi], +[omega], +[thetasym], +[upsih], +[piv], +[bull], +[hellip], +[prime], +[Prime], +[oline], +[frasl], +[weierp], +[image], +[real], +[trade], +[alefsym], +[larr], +[uarr], +[rarr], +[darr], +[harr], +[crarr], +[lArr], +[uArr], +[rArr], +[dArr], +[hArr], +[forall], +[part], +[exist], +[empty], +[nabla], +[isin], +[notin], +[ni], +[prod], +[sum], +[minus], +[lowast], +[radic], +[prop], +[infin], +[ang], +[and], +[or], +[cap], +[cup], +[int], +[there4], +[sim], +[cong], +[asymp], +[ne], +[equiv], +[le], +[ge], +[subset], +[superset], +[nsubset], +[sube], +[supe], +[oplus], +[otimes], +[perp], +[sdot], +[lceil], +[rceil], +[lfloor], +[rfloor], +[lang], +[rang], +[loz], +[spades], +[clubs], +[hearts], +[diams] + +[endsect] + +[section test Latin1 symbols] +[/ Examples of using all the symbols defined in Latin1_symbols.qbk] +[/ http://www.htmlhelp.com/reference/html40/entities/latin1.html ] + +[/ To use, enclose the template name in square brackets.] + +[nbsp], +[iexcl], +[cent], +[pound], +[curren], +[yen], +[brvbar], +[sectsign], +[uml], +[copy], +[ordf], +[laquo], +[not], +[shy], +[reg], +[macron], +[deg], +[plusmn], +[sup2], +[cubed], +[acute], +[micro], +[para], +[middot], +[cedil], +[sup1], +[ordm], +[raquo], +[frac14], +[frac12], +[frac34], +[iquest], +[Agrave], +[Aacute], +[Acirc], +[Atilde], +[Auml], +[Aring], +[AElig], +[Ccedil], +[Egrave], +[Eacute], +[Ecirc], +[Euml], +[Igrave], +[Iacute], +[Icirc], +[Iuml], +[ETH], +[Ntilde], +[Ograve], +[Oacute], +[Ocirc], +[Otilde], +[Ouml], +[times], +[Oslash], +[Ugrave], +[Uacute], +[Ucirc], +[Uuml], +[Yacute], +[THORN], +[szlig], +[agrave], +[aacute], +[acirc], +[atilde], +[auml], +[aring], +[aelig], +[ccedil], +[egrave], +[eacute], +[ecirc], +[euml], +[igrave], +[iacute], +[icirc], +[iuml], +[eth], +[ntilde], +[ograve], +[oacute], +[ocirc], +[otilde], +[ouml], +[divide], +[oslash], +[ugrave], +[uacute], +[ucirc], +[uuml], +[yacute], +[thorn], +[yuml], + +[endsect] + + +[endsect] + +[/ testsymbols.qbk + Copyright 2006 John Maddock and Paul A. Bristow. + 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). +] + + diff --git a/doc/test/weighted_tail_quantile.hpp b/doc/test/weighted_tail_quantile.hpp new file mode 100644 index 0000000000..997ac3a21b --- /dev/null +++ b/doc/test/weighted_tail_quantile.hpp @@ -0,0 +1,144 @@ +/////////////////////////////////////////////////////////////////////////////// +// weighted_tail_quantile.hpp +// +// Copyright 2006 Daniel Egloff, Olivier Gygi. 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) + +#ifndef BOOST_ACCUMULATORS_STATISTICS_WEIGHTED_TAIL_QUANTILE_HPP_DE_01_01_2006 +#define BOOST_ACCUMULATORS_STATISTICS_WEIGHTED_TAIL_QUANTILE_HPP_DE_01_01_2006 + +#include <vector> +#include <limits> +#include <functional> +#include <sstream> +#include <stdexcept> +#include <boost/throw_exception.hpp> +#include <boost/parameter/keyword.hpp> +#include <boost/mpl/placeholders.hpp> +#include <boost/mpl/if.hpp> +#include <boost/type_traits/is_same.hpp> +#include <boost/accumulators/numeric/functional.hpp> +#include <boost/accumulators/framework/depends_on.hpp> +#include <boost/accumulators/framework/accumulator_base.hpp> +#include <boost/accumulators/framework/extractor.hpp> +#include <boost/accumulators/framework/parameters/sample.hpp> +#include <boost/accumulators/statistics_fwd.hpp> +#include <boost/accumulators/statistics/tail.hpp> +#include <boost/accumulators/statistics/tail_quantile.hpp> +#include <boost/accumulators/statistics/parameters/quantile_probability.hpp> + +#ifdef _MSC_VER +# pragma warning(push) +# pragma warning(disable: 4127) // conditional expression is constant +#endif + +namespace boost { namespace accumulators +{ + +namespace impl +{ + /////////////////////////////////////////////////////////////////////////////// + // weighted_tail_quantile_impl + // Tail quantile estimation based on order statistics of weighted samples + /** + @brief Tail quantile estimation based on order statistics of weighted samples (for both left and right tails) + + An estimator \f$\hat{q}\f$ of tail quantiles with level \f$\alpha\f$ based on order statistics + \f$X_{1:n} \leq X_{2:n} \leq\dots\leq X_{n:n}\f$ of weighted samples are given by \f$X_{\lambda:n}\f$ (left tail) + and \f$X_{\rho:n}\f$ (right tail), where + + \f[ + \lambda = \inf\left\{ l \left| \frac{1}{\bar{w}_n}\sum_{i=1}^{l} w_i \geq \alpha \right. \right\} + \f] + + and + + \f[ + \rho = \sup\left\{ r \left| \frac{1}{\bar{w}_n}\sum_{i=r}^{n} w_i \geq (1 - \alpha) \right. \right\}, + \f] + + \f$n\f$ being the number of samples and \f$\bar{w}_n\f$ the sum of all weights. + + @param quantile_probability + */ + template<typename Sample, typename Weight, typename LeftRight> + struct weighted_tail_quantile_impl + : accumulator_base + { + typedef typename numeric::functional::average<Weight, std::size_t>::result_type float_type; + // for boost::result_of + typedef Sample result_type; + + weighted_tail_quantile_impl(dont_care) {} + + template<typename Args> + result_type result(Args const &args) const + { + float_type threshold = sum_of_weights(args) + * ( ( is_same<LeftRight, left>::value ) ? args[quantile_probability] : 1. - args[quantile_probability] ); + + std::size_t n = 0; + Weight sum = Weight(0); + + while (sum < threshold) + { + if (n < static_cast<std::size_t>(tail_weights(args).size())) + { + sum += *(tail_weights(args).begin() + n); + n++; + } + else + { + if (std::numeric_limits<result_type>::has_quiet_NaN) + { + return std::numeric_limits<result_type>::quiet_NaN(); + } + else + { + std::ostringstream msg; + msg << "index n = " << n << " is not in valid range [0, " << tail(args).size() << ")"; + boost::throw_exception(std::runtime_error(msg.str())); + return Sample(0); + } + } + } + + // Note that the cached samples of the left are sorted in ascending order, + // whereas the samples of the right tail are sorted in descending order + return *(boost::begin(tail(args)) + n - 1); + } + }; +} // namespace impl + +/////////////////////////////////////////////////////////////////////////////// +// tag::weighted_tail_quantile<> +// +namespace tag +{ + template<typename LeftRight> + struct weighted_tail_quantile + : depends_on<sum_of_weights, tail_weights<LeftRight> > + { + /// INTERNAL ONLY + typedef accumulators::impl::weighted_tail_quantile_impl<mpl::_1, mpl::_2, LeftRight> impl; + }; +} + +/////////////////////////////////////////////////////////////////////////////// +// extract::weighted_tail_quantile +// +namespace extract +{ + extractor<tag::quantile> const weighted_tail_quantile = {}; +} + +using extract::weighted_tail_quantile; + +}} // namespace boost::accumulators + +#ifdef _MSC_VER +# pragma warning(pop) +#endif + +#endif |
