Skip to content

Commit 2c40e25

Browse files
committed
updated readme
1 parent 8505bbf commit 2c40e25

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Tested platforms:
1212
- Windows: Visual Studio 2015
1313
- Python: 2.7 and 3.6
1414

15-
It is very customisable through policy classes, but the default policies were carefully designed so that most users won't need to customize anything. In the standard configuration, this library offers a unique safety guarantee not found elsewhere: bin counts *cannot overflow* or *be capped*. While being safe to use, the library also has a convenient interface, is memory conserving, and faster than other libraries (see benchmarks).
15+
The histogram is very customisable through policy classes, but the default policies were carefully designed so that most users won't need to customize anything. In the standard configuration, this library offers a unique safety guarantee not found elsewhere: bin counts *cannot overflow* or *be capped*. While being safe to use, the library also has a convenient interface, is memory conserving, and faster than other libraries (see benchmarks).
1616

1717
The histogram class comes in two variants which share a common interface. The *static* variant uses compile-time information to provide maximum performance, at the cost of runtime flexibility and potentially larger executables. The *dynamic* variant is a bit slower, but configurable at run-time and may produce smaller executables. Python bindings for the latter are included, implemented with `Boost.Python`.
1818

@@ -27,7 +27,7 @@ Check out the [full documentation](http://hdembinski.github.io/histogram/doc/htm
2727
* Multi-dimensional histogram
2828
* Simple and convenient interface in C++ and Python
2929
* Static and dynamic implementation in C++ with common interface
30-
* Counters cannot overflow or be capped (+)
30+
* High dynamic range: Counters cannot overflow or be capped (+)
3131
* Better performance than other libraries (see benchmarks for details)
3232
* Efficient move operations
3333
* Efficient conversion between static and dynamic implementation
@@ -37,17 +37,17 @@ Check out the [full documentation](http://hdembinski.github.io/histogram/doc/htm
3737
* Support for under-/overflow bins (can be disabled individually for each dimension)
3838
* Support for variance tracking (++)
3939
* Support for addition and scaling of histograms
40-
* Support for serialization based on `Boost.Serialization`
41-
* Support for Python 2.x and 3.x
42-
* Support for Numpy
40+
* Optional serialization based on `Boost.Serialization`
41+
* Optional Python-bindings for Python 2.x and 3.x
42+
* Optional Numpy support
4343

4444
(+) In the standard configuration, if you don't use weighted increments.
4545
(++) If you don't use weighted increments, variance tracking come at zero cost. If you use weighted increments, extra space is reserved internally to keep track of a variance counter per bin. The conversion happens automatically and transparently.
4646

4747
## Dependencies
4848

49-
* [Boost](http://www.boost.org)
50-
* Optional: [CMake](https://cmake.org) [Python](http://www.python.org) [Numpy](http://www.numpy.org)
49+
* [Boost](http://www.boost.org) *header-only installation*
50+
* Optional: [CMake](https://cmake.org) [Python](http://www.python.org) [Numpy](http://www.numpy.org) [Boost.Python](https://www.boost.org/doc/libs/release/libs/python/) [Boost.Serialization](https://www.boost.org/doc/libs/release/libs/serialization/) [Boost.Iostreams](https://www.boost.org/doc/libs/release/libs/iostreams/)
5151

5252
## Build instructions
5353

0 commit comments

Comments
 (0)