/usr/include/boost/histogram
Edit: /usr/include/boost/histogram/unsafe_access.hpp (3254B)
// Copyright 2018 Hans Dembinski
//
// 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_HISTOGRAM_UNSAFE_ACCESS_HPP
#define BOOST_HISTOGRAM_UNSAFE_ACCESS_HPP
#include
#include
namespace boost {
namespace histogram {
/** Unsafe read/write access to private data that potentially breaks consistency.
This struct enables access to private data of some classes. It is intended for library
developers who need this to implement algorithms efficiently, for example,
serialization. Users should not use this. If you are a user who absolutely needs this to
get a specific effect, please submit an issue on Github. Perhaps the public
interface is insufficient and should be extended for your use case.
Unlike the normal interface, the unsafe_access interface may change between versions.
If your code relies on unsafe_access, it may or may not break when you update Boost.
This is another reason to not use it unless you are ok with these conditions.
*/
struct unsafe_access {
/**
Get axes.
@param hist histogram.
*/
template
static auto& axes(Histogram& hist) {
return hist.axes_;
}
/// @copydoc axes()
template
static const auto& axes(const Histogram& hist) {
return hist.axes_;
}
/**
Get mutable axis reference with compile-time number.
@param hist histogram.
@tparam I axis index (optional, default: 0).
*/
template
static decltype(auto) axis(Histogram& hist, std::integral_constant = {}) {
assert(I < hist.rank());
return detail::axis_get(hist.axes_);
}
/**
Get mutable axis reference with run-time number.
@param hist histogram.
@param i axis index.
*/
template
static decltype(auto) axis(Histogram& hist, unsigned i) {
assert(i < hist.rank());
return detail::axis_get(hist.axes_, i);
}
/**
Get storage.
@param hist histogram.
*/
template
static auto& storage(Histogram& hist) {
return hist.storage_;
}
/// @copydoc storage()
template
static const auto& storage(const Histogram& hist) {
return hist.storage_;
}
/**
Get index offset.
@param hist histogram
*/
template
static auto& offset(Histogram& hist) {
return hist.offset_;
}
/// @copydoc offset()
template
static const auto& offset(const Histogram& hist) {
return hist.offset_;
}
/**
Get buffer of unlimited_storage.
@param storage instance of unlimited_storage.
*/
template
static constexpr auto& unlimited_storage_buffer(unlimited_storage& storage) {
return storage.buffer_;
}
/**
Get implementation of storage_adaptor.
@param storage instance of storage_adaptor.
*/
template
static constexpr auto& storage_adaptor_impl(storage_adaptor& storage) {
return static_cast::impl_type&>(storage);
}
};
} // namespace histogram
} // namespace boost
#endif