![](\"boost.png\")
";
19 | print "\n"; 20 | print "Compile time for each successful regression test in seconds.\n"; 21 | print "
\n"; 22 | 23 | print "
| Test | \n"; 25 | 26 | while(<>) { 27 | if(/^\*\*\* (.*) \*\*\*$/) { 28 | $filename = $1; 29 | $first = ($first == 0 ? 0 : $first-1); 30 | if($first == 0) { 31 | print "|||
| $filename | \n"; 32 | } 33 | } elsif(/^\*\* (.*)/) { 34 | $compiler = $1; 35 | if($first) { 36 | print "$compiler | \n"; 37 | } else { 38 | $ct = 1; 39 | } 40 | } elsif($ct && /^CPU time: ([.0-9]*) s user, ([.0-9]*) s system/) { 41 | $time = $1 + $2; 42 | } elsif($ct && /^Pass$/) { 43 | printf "%.02f | \n", $time; 44 | $ct = 0; 45 | } elsif($ct && /^Fail$/) { 46 | print "- | \n"; 47 | $ct = 0; 48 | } 49 | } 50 | 51 | print "
|
17 | |
20 |
21 |
22 | {{Library}}23 | 24 |Acknowledgments25 | |
26 |
29 | {{text}} 30 |
31 | 32 |
Revised 37 | 04 38 | December, 2006
39 | 40 |Copyright © 2006 {{author}}
42 | 43 |Distributed under the Boost Software License, Version 1.0. (See 44 | accompanying file LICENSE_1_0.txt or 45 | copy at http://www.boost.org/LICENSE_1_0.txt)
47 | 48 | 49 | -------------------------------------------------------------------------------- /more/writingdoc/template/bibliography.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 ||
17 | |
20 |
21 |
22 | {{Library}}23 | 24 |Bibliography25 | |
26 |
29 | {{bibliographical information}} 30 |
31 | 32 |
Revised 37 | 04 38 | December, 2006
39 | 40 |Copyright © 2006 {{author}}
42 | 43 |Distributed under the Boost Software License, Version 1.0. (See 44 | accompanying file LICENSE_1_0.txt or 45 | copy at http://www.boost.org/LICENSE_1_0.txt)
47 | 48 | 49 | -------------------------------------------------------------------------------- /doc/src/images/note.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | ]> 15 | 34 | -------------------------------------------------------------------------------- /doc/pdf/build: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | boost_version=$(grep 'define.*BOOST_LIB_VERSION' ../../boost/version.hpp | sed 's/.*"\([^"]*\)".*/\1/') 3 | echo Boost version tag = $boost_version 4 | (cd ../../libs/accumulators/doc && bjam -a --hash) 2>&1 | tee build.log 5 | (cd ../../libs/container/doc && rm -rf *.pdf && bjam -a --hash pdfinstall xsl:param=fop1.extensions=1 && cp *.pdf ../../../doc/pdf) 2>&1 | tee -a build.log 6 | (cd ../../libs/interprocess/doc && rm -rf *.pdf && bjam -a --hash pdf pdfinstall xsl:param=fop1.extensions=1 && cp *.pdf ../../../doc/pdf) 2>&1 | tee -a build.log 7 | (cd ../../libs/intrusive/doc && rm -rf *.pdf && bjam -a --hash pdf pdfinstall xsl:param=fop1.extensions=1 && cp *.pdf ../../../doc/pdf) 2>&1 | tee -a build.log 8 | (cd ../../libs/functional/overloaded_function/doc && rm -rf *.pdf && bjam -a --hash pdf pdfinstall && cp *.pdf ../../../../doc/pdf) 2>&1 | tee -a build.log 9 | (cd ../../libs/local_function/doc && rm -rf *.pdf && bjam -a --hash pdf pdfinstall && cp *.pdf ../../../doc/pdf) 2>&1 | tee -a build.log 10 | (cd ../../libs/utility/identity_type/doc && rm -rf *.pdf && bjam -a --hash pdf pdf_doc_install && cp *.pdf ../../../../doc/pdf) 2>&1 | tee -a build.log 11 | (cd ../../libs/numeric/odeint/doc && rm -rf *.pdf && bjam -a --hash --enable-index pdf pdfinstall && cp *.pdf ../../../../doc/pdf) 2>&1 | tee -a build.log 12 | (cd ../../libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk && bjam release) 2>&1 | tee -a build.log 13 | cp ../../dist/bin/doxygen_xml2qbk* /usr/bin 14 | chmod +wrx /usr/bin/doxygen_xml2qbk* 15 | (cd ../../libs/geometry/doc && rm -rf *.pdf && ./make_qbk.py && bjam pdfinstall -a --hash xsl:param=fop1.extensions=1 xsl:param=xep.extensions=0 && cp *.pdf ../../../doc/pdf) 2>&1 | tee -a build.log 16 | bjam -a --hash --enable-index pdf -d2 xsl:param=fop1.extensions=0 xsl:param=xep.extensions=1 2>&1 | tee -a build.log 17 | rm -rf boost_${boost_version}_pdf 18 | mkdir boost_${boost_version}_pdf 19 | mv *.pdf boost_${boost_version}_pdf 20 | -------------------------------------------------------------------------------- /more/writingdoc/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 ||
17 | |
20 |
21 |
22 | Writing Documentation for Boost23 | 24 |Index25 | |
26 |
29 | 30 |
Contents
31 | 32 |-
33 |
- Introduction 34 | 35 |
- Documentation Structure 36 | 37 |
- HTML Design 38 |
40 | 41 |
Revised 46 | 04 47 | December, 2006
48 | 49 |Copyright © 2001 William E. Kempf
51 | 52 |Distributed under the Boost Software License, Version 1.0. (See 53 | accompanying file LICENSE_1_0.txt or 54 | copy at http://www.boost.org/LICENSE_1_0.txt)
56 | 57 | 58 | -------------------------------------------------------------------------------- /more/writingdoc/template/faq.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 ||
17 | |
20 |
21 |
22 | {{Library}}23 | 24 |Frequently Asked Questions (FAQs)25 | |
26 |
29 | 30 |
-
31 |
- {{question}} 32 | 33 |
- {{question}} 34 |
{{question}}
37 | 38 |{{answer}}
39 | 40 |{{question}}
41 | 42 |{{answer}}
43 |44 | 45 |
Revised 50 | 04 51 | December, 2006
52 | 53 |Copyright © 2006 {{author}}
55 | 56 |Distributed under the Boost Software License, Version 1.0. (See 57 | accompanying file LICENSE_1_0.txt or 58 | copy at http://www.boost.org/LICENSE_1_0.txt)
60 | 61 | 62 | -------------------------------------------------------------------------------- /doc/src/images/home.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 6 | 7 | 8 | 9 | 10 | ]> 11 | 27 | -------------------------------------------------------------------------------- /more/getting_started/index.rst: -------------------------------------------------------------------------------- 1 | .. Copyright David Abrahams 2006. Distributed under the Boost 2 | .. Software License, Version 1.0. (See accompanying 3 | .. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) 4 | 5 | ============================ 6 | |(logo)|__ Getting Started 7 | ============================ 8 | 9 | .. |(logo)| image:: ../../boost.png 10 | :alt: Boost 11 | :class: boost-logo 12 | 13 | __ ../../index.htm 14 | 15 | .. Admonition:: Use the latest version of this Getting Started guide 16 | 17 | The `Boost website version of this Getting Started guide`_ may 18 | have updated information, such as the location of additional installers 19 | or improved installation procedures, so you might want use that version 20 | if you've got an Internet connection available. 21 | 22 | .. _`Boost website version of this Getting Started guide`: 23 | http://www.boost.org/more/getting_started/index.html 24 | 25 | Welcome 26 | ------- 27 | 28 | Welcome to the Boost libraries! By the time you've completed this 29 | tutorial, you'll be at least somewhat comfortable with the contents 30 | of a Boost distribution and how to go about using it. 31 | 32 | What's Here 33 | ----------- 34 | 35 | This document is designed to be an *extremely* gentle introduction, 36 | so we included a fair amount of material that may already be very 37 | familiar to you. To keep things simple, we also left out some 38 | information intermediate and advanced users will probably want. At 39 | the end of this document, we'll refer you on to resources that can 40 | help you pursue these topics further. 41 | 42 | Preliminaries 43 | ------------- 44 | 45 | We use one typographic convention that might not be immediately 46 | obvious: *italic* text in examples is meant as a descriptive 47 | placeholder for something else, usually information that you'll 48 | provide. For example: 49 | 50 | .. parsed-literal:: 51 | 52 | **$** echo "My name is *your name*\ " 53 | 54 | Here you're expected to imagine replacing the text “your name” with 55 | your actual name. 56 | 57 | Ready? 58 | ------ 59 | 60 | Let's go! 61 | 62 | .. footer:: 63 | .. class:: nextpage 64 | 65 | | **Next:** `Getting Started on Microsoft Windows`__ 66 | | **or:** `Getting Started on Unix variants (e.g. Linux, MacOS)`__ 67 | 68 | __ windows.html 69 | __ unix-variants.html 70 | 71 | -------------------------------------------------------------------------------- /more/getting_started/detail/header-only.rst: -------------------------------------------------------------------------------- 1 | .. Copyright David Abrahams 2006. Distributed under the Boost 2 | .. Software License, Version 1.0. (See accompanying 3 | .. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) 4 | 5 | Header-Only Libraries 6 | ===================== 7 | 8 | The first thing many people want to know is, “how do I build 9 | Boost?” The good news is that often, there's nothing to build. 10 | 11 | .. admonition:: Nothing to Build? 12 | 13 | Most Boost libraries are **header-only**: they consist *entirely 14 | of header files* containing templates and inline functions, and 15 | require no separately-compiled library binaries or special 16 | treatment when linking. 17 | 18 | .. .. _separate: 19 | 20 | The only Boost libraries that *must* be built separately are: 21 | 22 | * Boost.Chrono_ 23 | * Boost.Context_ 24 | * Boost.Filesystem_ 25 | * Boost.GraphParallel_ 26 | * Boost.IOStreams_ 27 | * Boost.Locale_ 28 | * Boost.MPI_ 29 | * Boost.ProgramOptions_ 30 | * Boost.Python_ (see the `Boost.Python build documentation`__ 31 | before building and installing it) 32 | * Boost.Regex_ 33 | * Boost.Serialization_ 34 | * Boost.Signals_ 35 | * Boost.System_ 36 | * Boost.Thread_ 37 | * Boost.Timer_ 38 | * Boost.Wave_ 39 | 40 | __ ../../libs/python/doc/building.html 41 | 42 | A few libraries have optional separately-compiled binaries: 43 | 44 | * Boost.DateTime_ has a binary component that is only needed if 45 | you're using its ``to_string``\ /\ ``from_string`` or serialization 46 | features, or if you're targeting Visual C++ 6.x or Borland. 47 | 48 | * Boost.Graph_ also has a binary component that is only needed if 49 | you intend to `parse GraphViz files`__. 50 | 51 | * Boost.Math_ has binary components for the TR1 and C99 52 | cmath functions. 53 | 54 | * Boost.Random_ has a binary component which is only needed if 55 | you're using ``random_device``. 56 | 57 | * Boost.Test_ can be used in “header-only” or “separately compiled” 58 | mode, although **separate compilation is recommended for serious 59 | use**. 60 | 61 | * Boost.Exception_ provides non-intrusive implementation of 62 | exception_ptr for 32-bit _MSC_VER==1310 and _MSC_VER==1400 63 | which requires a separately-compiled binary. This is enabled by 64 | #define BOOST_ENABLE_NON_INTRUSIVE_EXCEPTION_PTR. 65 | 66 | __ ../../libs/graph/doc/read_graphviz.html 67 | -------------------------------------------------------------------------------- /more/writingdoc/template/overview.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 ||
17 | |
20 |
21 |
22 | {{Library}}23 | 24 |Overview25 | |
26 |
29 | 30 |
-
31 |
- Introduction 32 | 33 |
- First topic 34 | 35 |
- Second topic 36 | 37 |
- Footnotes 38 |
Introduction
41 | 42 |{{text}}
43 | 44 |First Topic
45 | 46 |{{text}}
47 | 48 |Second Topic
49 | 50 |{{text}}
51 | 52 |Footnotes
53 | 54 | 61 |62 | 63 |
Revised 68 | 04 69 | December, 2006
70 | 71 |Copyright © 2006 {{author}}
73 | 74 |Distributed under the Boost Software License, Version 1.0. (See 75 | accompanying file LICENSE_1_0.txt or 76 | copy at http://www.boost.org/LICENSE_1_0.txt)
78 | 79 | 80 | -------------------------------------------------------------------------------- /more/writingdoc/template/rationale.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 ||
17 | |
20 |
21 |
22 | {{Library}}23 | 24 |Rationale25 | |
26 |
29 | 30 |
-
31 |
- Introduction 32 | 33 |
- First topic 34 | 35 |
- Second topic 36 | 37 |
- Footnotes 38 |
Introduction
41 | 42 |{{text}}
43 | 44 |First Topic
45 | 46 |{{text}}
47 | 48 |Second Topic
49 | 50 |{{text}}
51 | 52 |Footnotes
53 | 54 | 61 |62 | 63 |
Revised 68 | 04 69 | December, 2006
70 | 71 |Copyright © 2006 {{author}}
73 | 74 |Distributed under the Boost Software License, Version 1.0. (See 75 | accompanying file LICENSE_1_0.txt or 76 | copy at http://www.boost.org/LICENSE_1_0.txt)
78 | 79 | 80 | -------------------------------------------------------------------------------- /more/writingdoc/template/definitions.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 ||
17 | |
20 |
21 |
22 | {{Library}}23 | 24 |Definitions25 | |
26 |
29 | 30 |
Contents
31 | 32 |-
33 |
- Introduction 34 | 35 |
- Definitions 36 | 37 |
- 38 | 43 | 44 |
46 | 47 |
Introduction
48 | 49 |{{Introductory text}}
50 | 51 |Definitions
52 | 53 | 60 |61 | 62 |
Revised 67 | 04 68 | December, 2006
69 | 70 |Copyright © 2006 {{author}}
72 | 73 |Distributed under the Boost Software License, Version 1.0. (See 74 | accompanying file LICENSE_1_0.txt or 75 | copy at http://www.boost.org/LICENSE_1_0.txt)
77 | 78 | 79 | -------------------------------------------------------------------------------- /libs/platform_maintainers.txt: -------------------------------------------------------------------------------- 1 | # Copyright (C) 2005, 2007 Douglas Gregor|
17 | |
20 |
21 |
22 | Writing Documentation for Boost23 | 24 |Introduction25 | |
26 |
29 | 30 |
Boost does not have any requirements on how you write your 31 | documentation. If you are submitting a library that already has written 32 | documentation in HTML format, there is no reason to change it to follow any 33 | of the guidelines presented here. However, if you have documentation that's 34 | not in HTML format and can't be easily converted to HTML, or if you're 35 | starting on a library from scratch or have a library with no documentation 36 | then these guidelines can make writing the documentation much easier.
37 | 38 |The section on Documentation Structure 39 | describes how to go about structuring the documentation's content. This 40 | section may be helpful even for libraries that already have documentation. 41 | If there's a desire to present the library for possible inclusion by the 42 | C++ Standards Committee then there may be a need to restructure the 43 | documentation's content in order to insure the content meets explicit 44 | requirements for library components (Section 17.3).
45 | 46 |The section on HTML Design gives general rules 47 | to follow when writing HTML documentation in order to give a professional 48 | and consistent look. This section also contains some template files that 49 | can be used to rapidly create documentation pages.
50 |51 | 52 |
Revised 57 | 04 58 | December, 2006
59 | 60 |Copyright © 2001 William E. Kempf
62 | 63 |Distributed under the Boost Software License, Version 1.0. (See 64 | accompanying file LICENSE_1_0.txt or 65 | copy at http://www.boost.org/LICENSE_1_0.txt)
67 | 68 | 69 | -------------------------------------------------------------------------------- /more/getting_started/detail/build-from-source-tail.rst: -------------------------------------------------------------------------------- 1 | .. Copyright David Abrahams 2006. Distributed under the Boost 2 | .. Software License, Version 1.0. (See accompanying 3 | .. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) 4 | 5 | Building the special ``stage`` target places Boost 6 | library binaries in the ``stage``\ |/|\ ``lib``\ |/| subdirectory of 7 | the Boost tree. To use a different directory pass the 8 | ``--stagedir=``\ *directory* option to ``b2``. 9 | 10 | .. Note:: ``b2`` is case-sensitive; it is important that all the 11 | parts shown in **bold** type above be entirely lower-case. 12 | 13 | For a description of other options you can pass when invoking 14 | ``b2``, type:: 15 | 16 | b2 --help 17 | 18 | In particular, to limit the amount of time spent building, you may 19 | be interested in: 20 | 21 | * reviewing the list of library names with ``--show-libraries`` 22 | * limiting which libraries get built with the ``--with-``\ 23 | *library-name* or ``--without-``\ *library-name* options 24 | * choosing a specific build variant by adding ``release`` or 25 | ``debug`` to the command line. 26 | 27 | .. Note:: Boost.Build can produce a great deal of output, which can 28 | make it easy to miss problems. If you want to make sure 29 | everything is went well, you might redirect the output into a 30 | file by appending “``>build.log 2>&1``” to your command line. 31 | 32 | Expected Build Output 33 | --------------------- 34 | 35 | During the process of building Boost libraries, you can expect to 36 | see some messages printed on the console. These may include 37 | 38 | * Notices about Boost library configuration—for example, the Regex 39 | library outputs a message about ICU when built without Unicode 40 | support, and the Python library may be skipped without error (but 41 | with a notice) if you don't have Python installed. 42 | 43 | * Messages from the build tool that report the number of targets 44 | that were built or skipped. Don't be surprised if those numbers 45 | don't make any sense to you; there are many targets per library. 46 | 47 | * Build action messages describing what the tool is doing, which 48 | look something like: 49 | 50 | .. parsed-literal:: 51 | 52 | *toolset-name*.c++ *long*\ /\ *path*\ /\ *to*\ /\ *file*\ /\ *being*\ /\ *built* 53 | 54 | * Compiler warnings. 55 | 56 | In Case of Build Errors 57 | ----------------------- 58 | 59 | The only error messages you see when building Boost—if any—should 60 | be related to the IOStreams library's support of zip and bzip2 61 | formats as described here__. Install the relevant development 62 | packages for libz and libbz2 if you need those features. Other 63 | errors when building Boost libraries are cause for concern. 64 | 65 | __ ../../libs/iostreams/doc/installation.html 66 | 67 | If it seems like the build system can't find your compiler and/or 68 | linker, consider setting up a ``user-config.jam`` file as described 69 | `here`__. If that isn't your problem or the ``user-config.jam`` file 70 | doesn't work for you, please address questions about configuring Boost 71 | for your compiler to the `Boost.Build mailing list`_. 72 | 73 | __ http://www.boost.org/build/doc/html/bbv2/overview/configuration.html 74 | -------------------------------------------------------------------------------- /more/getting_started/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 |
12 |
13 |
14 |
15 |
16 |
17 |
56 |
64 |
65 |
66 |
--------------------------------------------------------------------------------
/rst.css:
--------------------------------------------------------------------------------
1 | @import url("doc/src/boostbook.css");
2 | @import url("doc/src/docutils.css");
3 | /* Copyright David Abrahams 2006. Distributed under the Boost
4 | Software License, Version 1.0. (See accompanying
5 | file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
6 | */
7 |
8 | dl.docutils dt {
9 | font-weight: bold }
10 |
11 | img.boost-logo {
12 | border: none;
13 | vertical-align: middle
14 | }
15 |
16 | pre.literal-block span.concept {
17 | font-style: italic;
18 | }
19 |
20 | .nav {
21 | display: inline;
22 | list-style-type: none;
23 | }
24 |
25 | .prevpage {
26 | padding-top: -5px;
27 | text-align: left;
28 | float: left;
29 | }
30 |
31 | .nextpage {
32 | padding-top: -20px;
33 | text-align: right;
34 | float: right;
35 | }
36 |
37 | div.small {
38 | font-size: smaller }
39 |
40 | h2 a {
41 | font-size: 90%;
42 | }
43 | h3 a {
44 | font-size: 80%;
45 | }
46 | h4 a {
47 | font-size: 70%;
48 | }
49 | h5 a {
50 | font-size: 60%;
51 | }
52 |
53 | dl,table
54 | {
55 | text-align: left;
56 | font-size: 10pt;
57 | line-height: 1.15;
58 | }
59 |
60 |
61 | /*=============================================================================
62 | Tables
63 | =============================================================================*/
64 |
65 | /* The only clue docutils gives us that tables are logically tables,
66 | and not, e.g., footnotes, is that they have border="1". Therefore
67 | we're keying off of that. We used to manually patch docutils to
68 | add a "table" class to all logical tables, but that proved much too
69 | fragile.
70 | */
71 |
72 | table[border="1"]
73 | {
74 | width: 92%;
75 | margin-left: 4%;
76 | margin-right: 4%;
77 | }
78 |
79 | table[border="1"]
80 | {
81 | padding: 4px;
82 | }
83 |
84 | /* Table Cells */
85 | table[border="1"] tr td
86 | {
87 | padding: 0.5em;
88 | text-align: left;
89 | font-size: 9pt;
90 | }
91 |
92 | table[border="1"] tr th
93 | {
94 | padding: 0.5em 0.5em 0.5em 0.5em;
95 | border: 1pt solid white;
96 | font-size: 80%;
97 | }
98 |
99 | @media screen
100 | {
101 |
102 | /* Tables */
103 | table[border="1"] tr td
104 | {
105 | border: 1px solid #DCDCDC;
106 | }
107 |
108 | table[border="1"] tr th
109 | {
110 | background-color: #F0F0F0;
111 | border: 1px solid #DCDCDC;
112 | }
113 |
114 | pre,
115 | .screen
116 | {
117 | border: 1px solid #DCDCDC;
118 | }
119 |
120 | td pre
121 | td .screen
122 | {
123 | border: 0px
124 | }
125 |
126 | .sidebar pre
127 | {
128 | border: 0px
129 | }
130 |
131 | }
132 |
133 | pre,
134 | .screen
135 | {
136 | font-size: 9pt;
137 | display: block;
138 | margin: 1pc 4% 0pc 4%;
139 | padding: 0.5pc 0.5pc 0.5pc 0.5pc;
140 | }
141 |
142 | /* Program listings in tables don't get borders */
143 | td pre,
144 | td .screen
145 | {
146 | margin: 0pc 0pc 0pc 0pc;
147 | padding: 0pc 0pc 0pc 0pc;
148 | }
149 |
150 |
--------------------------------------------------------------------------------
/more/getting_started/detail/distro.rst:
--------------------------------------------------------------------------------
1 | .. Copyright David Abrahams 2006. Distributed under the Boost
2 | .. Software License, Version 1.0. (See accompanying
3 | .. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
4 |
5 | The Boost Distribution
6 | ======================
7 |
8 | This is a sketch of the resulting directory structure:
9 |
10 | .. parsed-literal::
11 |
12 | |boost_ver-bold|\ |//| .................\ *The “boost root directory”*
13 | **index.htm** .........\ *A copy of www.boost.org starts here*
14 | **boost**\ |//| .........................\ *All Boost Header files*
15 | |precompiled-dir|
16 | **libs**\ |//| ............\ *Tests, .cpp*\ s\ *, docs, etc., by library*
17 | **index.html** ........\ *Library documentation starts here*
18 | **algorithm**\ |//|
19 | **any**\ |//|
20 | **array**\ |//|
21 | *…more libraries…*
22 | **status**\ |//| .........................\ *Boost-wide test suite*
23 | **tools**\ |//| ...........\ *Utilities, e.g. Boost.Build, quickbook, bcp*
24 | **more**\ |//| ..........................\ *Policy documents, etc.*
25 | **doc**\ |//| ...............\ *A subset of all Boost library docs*
26 |
27 | .. sidebar:: Header Organization
28 |
29 | .. class:: pre-wrap
30 |
31 | The organization of Boost library headers isn't entirely uniform,
32 | but most libraries follow a few patterns:
33 |
34 | * Some older libraries and most very small libraries place all
35 | public headers directly into ``boost``\ |/|.
36 |
37 | * Most libraries' public headers live in a subdirectory of
38 | ``boost``\ |/|, named after the library. For example, you'll find
39 | the Python library's ``def.hpp`` header in
40 |
41 | .. parsed-literal::
42 |
43 | ``boost``\ |/|\ ``python``\ |/|\ ``def.hpp``.
44 |
45 | * Some libraries have an “aggregate header” in ``boost``\ |/| that
46 | ``#include``\ s all of the library's other headers. For
47 | example, Boost.Python_'s aggregate header is
48 |
49 | .. parsed-literal::
50 |
51 | ``boost``\ |/|\ ``python.hpp``.
52 |
53 | * Most libraries place private headers in a subdirectory called
54 | ``detail``\ |/|, or ``aux_``\ |/|. Don't expect to find
55 | anything you can use in these directories.
56 |
57 | It's important to note the following:
58 |
59 | .. _Boost root directory:
60 |
61 | 1. The path to the **boost root directory** (often |default-root|) is
62 | sometimes referred to as ``$BOOST_ROOT`` in documentation and
63 | mailing lists .
64 |
65 | 2. To compile anything in Boost, you need a directory containing
66 | the ``boost``\ |/| subdirectory in your ``#include`` path. |include-paths|
67 |
68 | 3. Since all of Boost's header files have the ``.hpp`` extension,
69 | and live in the ``boost``\ |/| subdirectory of the boost root, your
70 | Boost ``#include`` directives will look like:
71 |
72 | .. parsed-literal::
73 |
74 | #include 
Getting Started
13 |
14 |
15 |
16 |
17 |
18 |
24 | Use the latest version of this Getting Started guide
19 |The Boost website version of this Getting Started guide may 20 | have updated information, such as the location of additional installers 21 | or improved installation procedures, so you might want use that version 22 | if you've got an Internet connection available.
23 |
25 |
30 | Welcome
26 |Welcome to the Boost libraries! By the time you've completed this 27 | tutorial, you'll be at least somewhat comfortable with the contents 28 | of a Boost distribution and how to go about using it.
29 |
31 |
39 | What's Here
32 |This document is designed to be an extremely gentle introduction, 33 | so we included a fair amount of material that may already be very 34 | familiar to you. To keep things simple, we also left out some 35 | information intermediate and advanced users will probably want. At 36 | the end of this document, we'll refer you on to resources that can 37 | help you pursue these topics further.
38 |
40 |
51 | Preliminaries
41 |We use one typographic convention that might not be immediately 42 | obvious: italic text in examples is meant as a descriptive 43 | placeholder for something else, usually information that you'll 44 | provide. For example:
45 |46 | $ echo "My name is your name" 47 |48 |
Here you're expected to imagine replacing the text “your name” with 49 | your actual name.
50 |
52 |
55 | Ready?
53 |Let's go!
54 | |
15 | Home | 16 |Libraries | 17 |People | 18 |FAQ | 19 |More | 20 |
22 |
23 | 
24 |
25 |
24 |
26 |
29 |
46 | 27 | Images 28 |
30 | These are tricky enough that they warrent their own section. 31 |
32 |33 | Let's start with a PNG file that's set to 120dpi, it should render at a sensible 34 | size in both html and PDF forms. It should print OK too! 35 |
36 |
37 | 
38 |
40 | Now try again with a sample SVG image: 41 |
42 |43 | 44 |
45 || 48 | | 54 | |
56 |
57 |
58 |
59 |
60 |
61 |
--------------------------------------------------------------------------------
/doc/test/array.xml:
--------------------------------------------------------------------------------
1 |
58 | std::vector std::vector<> block. It is safer and has no worse performance than
24 | ordinary arrays. In c_array, which I (carray. This is the essence of these approaches
31 | spiced with many feedback from array array |
17 | |
20 |
21 |
22 | {{Library}}23 | 24 |Index25 | |
26 |
29 | 30 |
Contents
31 | 32 |-
33 |
- Overview 34 | 35 |
- Reference 36 | 37 |
-
38 |
-
39 |
- {{header}} 40 | 41 |
-
42 |
-
43 |
- Macros 44 | 45 |
-
46 |
-
47 |
- {{macro name}} 48 |
50 |
51 | - Values 52 | 53 |
-
54 |
-
55 |
- {{value name}} 56 |
58 |
59 | - Types 60 | 61 |
-
62 |
-
63 |
- {{type name}} 64 |
66 |
67 | - Classes 68 | 69 |
-
70 |
-
71 |
- {{class name}} 72 |
74 |
75 | - Functions 76 | 77 |
-
78 |
-
79 |
- {{function 80 | name}} 81 |
83 |
84 | - Objects 85 | 86 |
-
87 |
-
88 |
- {{object name}} 89 |
91 |
93 |
95 |
96 | - Configuration Information 97 | 98 |
- Rationale 99 | 100 |
- Definitions 101 | 102 |
- Frequently Asked Questions (FAQs) 103 | 104 |
- Bibliography 105 | 106 |
- Acknowledgments 107 |
109 | 110 |
Revised 115 | 04 116 | December, 2006
117 | 118 |Copyright © 2006 {{author}}
120 | 121 |Distributed under the Boost Software License, Version 1.0. (See 122 | accompanying file LICENSE_1_0.txt or 123 | copy at http://www.boost.org/LICENSE_1_0.txt)
125 | 126 | 127 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto !eol svneol=native#text/plain 2 | *.gitattributes text svneol=native#text/plain 3 | 4 | # Scriptish formats 5 | *.bat text svneol=native#text/plain 6 | *.bsh text svneol=native#text/x-beanshell 7 | *.cgi text svneol=native#text/plain 8 | *.cmd text svneol=native#text/plain 9 | *.js text svneol=native#text/javascript 10 | *.php text svneol=native#text/x-php 11 | *.pl text svneol=native#text/x-perl 12 | *.pm text svneol=native#text/x-perl 13 | *.py text svneol=native#text/x-python 14 | *.sh eol=lf svneol=LF#text/x-sh 15 | configure eol=lf svneol=LF#text/x-sh 16 | 17 | # Image formats 18 | *.bmp binary svneol=unset#image/bmp 19 | *.gif binary svneol=unset#image/gif 20 | *.ico binary svneol=unset#image/ico 21 | *.jpeg binary svneol=unset#image/jpeg 22 | *.jpg binary svneol=unset#image/jpeg 23 | *.png binary svneol=unset#image/png 24 | *.tif binary svneol=unset#image/tiff 25 | *.tiff binary svneol=unset#image/tiff 26 | *.svg text svneol=native#image/svg%2Bxml 27 | 28 | # Data formats 29 | *.pdf binary svneol=unset#application/pdf 30 | *.avi binary svneol=unset#video/avi 31 | *.doc binary svneol=unset#application/msword 32 | *.dsp text svneol=crlf#text/plain 33 | *.dsw text svneol=crlf#text/plain 34 | *.eps binary svneol=unset#application/postscript 35 | *.gz binary svneol=unset#application/gzip 36 | *.mov binary svneol=unset#video/quicktime 37 | *.mp3 binary svneol=unset#audio/mpeg 38 | *.ppt binary svneol=unset#application/vnd.ms-powerpoint 39 | *.ps binary svneol=unset#application/postscript 40 | *.psd binary svneol=unset#application/photoshop 41 | *.rdf binary svneol=unset#text/rdf 42 | *.rss text svneol=unset#text/xml 43 | *.rtf binary svneol=unset#text/rtf 44 | *.sln text svneol=native#text/plain 45 | *.swf binary svneol=unset#application/x-shockwave-flash 46 | *.tgz binary svneol=unset#application/gzip 47 | *.vcproj text svneol=native#text/xml 48 | *.vcxproj text svneol=native#text/xml 49 | *.vsprops text svneol=native#text/xml 50 | *.wav binary svneol=unset#audio/wav 51 | *.xls binary svneol=unset#application/vnd.ms-excel 52 | *.zip binary svneol=unset#application/zip 53 | 54 | # Text formats 55 | .htaccess text svneol=native#text/plain 56 | *.bbk text svneol=native#text/xml 57 | *.cmake text svneol=native#text/plain 58 | *.css text svneol=native#text/css 59 | *.dtd text svneol=native#text/xml 60 | *.htm text svneol=native#text/html 61 | *.html text svneol=native#text/html 62 | *.ini text svneol=native#text/plain 63 | *.log text svneol=native#text/plain 64 | *.mak text svneol=native#text/plain 65 | *.qbk text svneol=native#text/plain 66 | *.rst text svneol=native#text/plain 67 | *.sql text svneol=native#text/x-sql 68 | *.txt text svneol=native#text/plain 69 | *.xhtml text svneol=native#text/xhtml%2Bxml 70 | *.xml text svneol=native#text/xml 71 | *.xsd text svneol=native#text/xml 72 | *.xsl text svneol=native#text/xml 73 | *.xslt text svneol=native#text/xml 74 | *.xul text svneol=native#text/xul 75 | *.yml text svneol=native#text/plain 76 | boost-no-inspect text svneol=native#text/plain 77 | CHANGES text svneol=native#text/plain 78 | COPYING text svneol=native#text/plain 79 | INSTALL text svneol=native#text/plain 80 | Jamfile text svneol=native#text/plain 81 | Jamroot text svneol=native#text/plain 82 | Jamfile.v2 text svneol=native#text/plain 83 | Jamrules text svneol=native#text/plain 84 | Makefile* text svneol=native#text/plain 85 | README text svneol=native#text/plain 86 | TODO text svneol=native#text/plain 87 | 88 | # Code formats 89 | *.c text svneol=native#text/plain 90 | *.cpp text svneol=native#text/plain 91 | *.h text svneol=native#text/plain 92 | *.hpp text svneol=native#text/plain 93 | *.ipp text svneol=native#text/plain 94 | *.tpp text svneol=native#text/plain 95 | *.jam text svneol=native#text/plain 96 | *.java text svneol=native#text/plain 97 | -------------------------------------------------------------------------------- /doc/test/gold/boost/accumulators/tag/weighted_tail_quantile.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | |
14 | Home | 15 |Libraries | 16 |People | 17 |FAQ | 18 |More | 19 |
21 |
22 | 
23 |
24 |
23 |
25 |
26 |
37 |
38 |
27 |
30 | Struct template weighted_tail_quantile
28 |boost::accumulators::tag::weighted_tail_quantile
29 |Synopsis
31 |// In header: <doc/test/weighted_tail_quantile.hpp> 32 | 33 | template<typename LeftRight> 34 | struct weighted_tail_quantile : public boost::accumulators::depends_on< sum_of_weights, tail_weights< LeftRight > > 35 | { 36 | };
| 40 | | 46 | |
48 |
49 |
50 |
51 |
52 |
53 |
--------------------------------------------------------------------------------
/more/getting_started/detail/library-naming.rst:
--------------------------------------------------------------------------------
1 | .. Copyright David Abrahams 2006. Distributed under the Boost
2 | .. Software License, Version 1.0. (See accompanying
3 | .. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
4 |
5 | In order to choose the right binary for your build configuration
6 | you need to know how Boost binaries are named. Each library
7 | filename is composed of a common sequence of elements that describe
8 | how it was built. For example,
9 | ``libboost_regex-vc71-mt-d-1_34.lib`` can be broken down into the
10 | following elements:
11 |
12 | ``lib``
13 | *Prefix*: except on Microsoft Windows, every Boost library
14 | name begins with this string. On Windows, only ordinary static
15 | libraries use the ``lib`` prefix; import libraries and DLLs do
16 | not. [#distinct]_
17 |
18 | ``boost_regex``
19 | *Library name*: all boost library filenames begin with ``boost_``.
20 |
21 | ``-vc71``
22 | *Toolset tag*: identifies the toolset_ and version used to build
23 | the binary.
24 |
25 | ``-mt``
26 | *Threading tag*: indicates that the library was
27 | built with multithreading support enabled. Libraries built
28 | without multithreading support can be identified by the absence
29 | of ``-mt``.
30 |
31 | ``-d``
32 | *ABI tag*: encodes details that affect the library's
33 | interoperability with other compiled code. For each such
34 | feature, a single letter is added to the tag:
35 |
36 | +-----+------------------------------------------------------------------------------+---------------------+
37 | |Key |Use this library when: |Boost.Build option |
38 | +=====+==============================================================================+=====================+
39 | |``s``|linking statically to the C++ standard library and compiler runtime support |runtime-link=static |
40 | | |libraries. | |
41 | +-----+------------------------------------------------------------------------------+---------------------+
42 | |``g``|using debug versions of the standard and runtime support libraries. |runtime-debugging=on |
43 | +-----+------------------------------------------------------------------------------+---------------------+
44 | |``y``|using a special `debug build of Python`__. |python-debugging=on |
45 | +-----+------------------------------------------------------------------------------+---------------------+
46 | |``d``|building a debug version of your code. [#debug-abi]_ |variant=debug |
47 | +-----+------------------------------------------------------------------------------+---------------------+
48 | |``p``|using the STLPort standard library rather than the default one supplied with |stdlib=stlport |
49 | | |your compiler. | |
50 | +-----+------------------------------------------------------------------------------+---------------------+
51 |
52 | For example, if you build a debug version of your code for use
53 | with debug versions of the static runtime library and the
54 | STLPort standard library in “native iostreams” mode,
55 | the tag would be: ``-sgdpn``. If none of the above apply, the
56 | ABI tag is ommitted.
57 |
58 | ``-1_34``
59 | *Version tag*: the full Boost release number, with periods
60 | replaced by underscores. For example, version 1.31.1 would be
61 | tagged as "-1_31_1".
62 |
63 | ``.lib``
64 | *Extension*: determined according to the operating system's usual
65 | convention. On most unix-style platforms the extensions are
66 | ``.a`` and ``.so`` for static libraries (archives) and shared
67 | libraries, respectively. On Windows, ``.dll`` indicates a shared
68 | library and ``.lib`` indicates a
69 | static or import library. Where supported by toolsets on unix
70 | variants, a full version extension is added (e.g. ".so.1.34") and
71 | a symbolic link to the library file, named without the trailing
72 | version number, will also be created.
73 |
74 | .. .. _Boost.Build toolset names: toolset-name_
75 |
76 | __ ../../libs/python/doc/building.html#python-debugging-builds
77 |
78 |
--------------------------------------------------------------------------------
50 |