Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for an old version of boost. Click here for the latest Boost documentation.
PrevUpHomeNext

Function shrink

boost::histogram::algorithm::shrink — Shrink option to be used in reduce().

Synopsis

// In header: <boost/histogram/algorithm/reduce.hpp>


reduce_option shrink(unsigned iaxis, double lower, double upper);

Description

The shrink is inclusive. The bin which contains the first value starts the range of bins to keep. The bin which contains the second value is the last included in that range. When the second value is exactly equal to a lower bin edge, then the previous bin is the last in the range.

Parameters:

iaxis

which axis to operate on.

lower

bin which contains lower is first to be kept.

upper

bin which contains upper is last to be kept, except if upper is equal to the lower edge.


PrevUpHomeNext