libs/histogram/doc/histogram.qbk

   1 [/
   2             Copyright Hans Dembinski 2016 - 2019.
   3    Distributed under the Boost Software License, Version 1.0.
   4       (See accompanying file LICENSE_1_0.txt or copy at
   5             https://www.boost.org/LICENSE_1_0.txt)
   6 ]
   7
   8 [library Boost.Histogram
   9     [quickbook 1.6]
  10     [copyright 2016 - 2019 Hans Dembinski]
  11     [purpose Histogram library]
  12     [authors [Dembinski, Hans]]
  13     [id histogram]
  14     [dirname histogram]
  15     [license
  16         Distributed under the Boost Software License, Version 1.0.
  17         (See accompanying file LICENSE_1_0.txt or copy at
  18         http://www.boost.org/LICENSE_1_0.txt)
  19     ]
  20 ]
  21
  22 [$../logo/color.svg]
  23
  24 Boost.Histogram provides an easy-to-use, fast, and extensible multi-dimensional histograms and profiles.
  25
  26 [variablelist
  27   [
  28     [
  29       [link histogram.overview Overview]
  30     ]
  31     [
  32       An overview of the features included in the library, the motivation and rationale.
  33     ]
  34   ]
  35   [
  36     [
  37       [link histogram.getting_started Getting started]
  38     ]
  39     [
  40       See the library in action in a few heavily commented examples. Copy/paste from these examples to kick-start your project.
  41     ]
  42   ]
  43   [
  44     [
  45       [link histogram.guide User guide]
  46     ]
  47     [
  48       An in-depth user guide that introduces all aspects of the library, starting simple and ending with the advanced features.
  49     ]
  50   ]
  51   [
  52     [
  53       [link histogram.reference Reference]
  54     ]
  55     [
  56       Detailed class and function reference.
  57     ]
  58   ]
  59   [
  60     [
  61       [link histogram.concepts Concepts]
  62     ]
  63     [
  64       Read this if you want to make custom axis types, storage types, and more that work with the library.
  65     ]
  66   ]
  67   [
  68     [
  69       [link histogram.benchmarks Benchmarks]
  70     ]
  71     [
  72       The performance of this library is compared with other popular libraries.
  73     ]
  74   ]
  75   [
  76     [
  77       [link histogram.rationale Rationale]
  78     ]
  79     [
  80       Thoughts behind the design for contributors and future maintainers of the library.
  81     ]
  82   ]
  83   [
  84     [
  85       [link histogram.history Revision history]
  86     ]
  87     [
  88       Log of code changes.
  89     ]
  90   ]
  91 ]
  92
  93 [include overview.qbk]
  94 [include getting_started.qbk]
  95 [include guide.qbk]
  96 [include benchmarks.qbk]
  97 [include concepts.qbk]
  98 [xinclude reference_pp.xml]
  99 [include rationale.qbk]
 100 [include changelog.qbk]
 101
 102 [*Acknowledgments]
 103
 104 Klemens Morgenstern helped to make this library Boost-compliant, converting the documentation and adding Jamfiles, and provided code improvements.
 105
 106 Mateusz Loskot kindly agreed to fill the role of the Review Manager for this library and contributed various patches.
 107
 108 Steven Watanabe provided a very detailed review of the documentation and code of the library. Great reviews were submitted by Bjorn Reese, Jim Pivarski, Klemens Morgenstern, and Alex Hagen-Zanker. Comments and suggestions were provided by Andrea Bocci, degksi, Glen Fernandes, Gavin Lambert, Seth, and Mateusz Loskot. Peter Dimov, Vinnie Falco, and Glen Fernandes were invaluable source of information and feedback on the Cpplang Slack.
 109
 110 The members of the [@http://www.scikit-hep.org Scikit-HEP project] provided valuable feedback and input on the design of this library, special thanks go to Henry Schreiner and Jim Pivarski.