Go to the documentation of this file.
11 #ifndef FUNCTIONAL_DETAILS_H
12 #define FUNCTIONAL_DETAILS_H
17 #include <type_traits>
29 #include <range/v3/version.hpp>
30 #include <range/v3/view/const.hpp>
31 #include <range/v3/view/zip.hpp>
33 #if RANGE_V3_VERSION < 900
35 using namespace ranges::view;
39 #if defined( __clang__ ) && ( __clang_major__ < 11 ) || defined( __APPLE__ ) && ( __clang_major__ < 12 )
40 # define GF_SUPPRESS_SPURIOUS_CLANG_WARNING_BEGIN \
41 _Pragma( "clang diagnostic push" ) _Pragma( "clang diagnostic ignored \"-Wunused-lambda-capture\"" )
42 # define GF_SUPPRESS_SPURIOUS_CLANG_WARNING_END _Pragma( "clang diagnostic pop" )
44 # define GF_SUPPRESS_SPURIOUS_CLANG_WARNING_BEGIN
45 # define GF_SUPPRESS_SPURIOUS_CLANG_WARNING_END
50 #define GAUDI_FUNCTIONAL_CONSTRUCTOR_USES_TUPLE
58 template <
typename OS,
typename Arg>
64 template <
typename OS,
typename Arg,
typename... Args>
78 template <
typename A,
typename B>
80 return a.size() == b.size();
84 template <
typename A,
typename B,
typename... C>
85 inline bool check_sizes(
const A& a,
const B& b,
const C&...
c ) noexcept {
90 template <
typename... Args>
94 mess <<
"Zipped containers have different sizes : ";
101 template <
typename... Args>
106 return ranges::views::zip( std::forward<Args>(
args )... );
110 template <
typename... Args>
115 return ranges::views::const_( ranges::views::zip( std::forward<Args>(
args )... ) );
123 [](
const std::string& i ) { return DataObjID{ i }; } );
131 template <
typename T>
132 using is_optional_ = decltype(
bool{ std::declval<T>() }, std::declval<T>().value() );
134 template <
typename Arg>
135 constexpr
bool is_optional_v = Gaudi::cpp17::is_detected_v<details2::is_optional_, Arg>;
137 template <
typename Arg>
140 template <
typename Arg>
143 template <
typename T>
147 template <
typename F,
typename Arg,
typename = require_is_not_optional<Arg>>
148 decltype(
auto ) operator()( F&& f, Arg&& arg )
const {
149 return std::invoke( std::forward<F>( f ), std::forward<Arg>( arg ) );
151 template <
typename F,
typename Arg,
typename = require_is_optional<Arg>>
153 if ( arg ) std::invoke( std::forward<F>( f ), *std::forward<Arg>( arg ) );
163 template <
typename Value, auto N>
164 using RepeatValues_ = decltype( get_values_helper<Value>( std::make_index_sequence<N>() ) );
168 template <
typename Out1,
typename Out2,
169 typename = std::enable_if_t<std::is_constructible_v<Out1, Out2> && std::is_base_of_v<DataObject, Out1>>>
171 return out_handle.
put( std::make_unique<Out1>( std::forward<Out2>(
out ) ) );
174 template <
typename Out1,
typename Out2,
typename = std::enable_if_t<std::is_constructible_v<Out1, Out2>>>
176 return out_handle.put( std::forward<Out2>(
out ) );
180 template <
typename OutHandle,
typename OptOut,
typename = require_is_optional<OptOut>>
181 void put(
const OutHandle& out_handle, OptOut&&
out ) {
182 if (
out )
put( out_handle, *std::forward<OptOut>(
out ) );
192 template <
typename Container>
195 template <
typename Container,
typename Value>
196 auto operator()( Container&
c, Value&&
v )
const -> decltype(
c.push_back(
v ) ) {
197 return c.push_back( std::forward<Value>(
v ) );
200 template <
typename Container,
typename Value>
202 return c.insert( std::forward<Value>(
v ) );
206 template <
typename Container,
typename Value,
207 typename = std::enable_if_t<std::is_pointer_v<typename Container::value_type>>,
208 typename = std::enable_if_t<std::is_convertible_v<Value, c_remove_ptr_t<Container>>>>
218 template <
typename In,
typename = std::enable_if_t<!std::is_po
inter_v<In>>>
223 template <
typename In,
typename = std::enable_if_t<!std::is_po
inter_v<std::decay_t<In>>>>
225 return std::forward<In>( in );
228 template <
typename In>
230 assert( in !=
nullptr );
238 template <
typename T>
241 template <
typename T,
typename IT>
244 template <
typename T,
typename IT>
247 template <
typename T>
250 template <
typename Container,
typename Value>
254 template <
typename Container,
typename Value>
259 template <
typename In>
261 template <
template <
typename>
class Handle,
typename I,
typename = std::enable_if_t<std::is_convertible_v<I, In>>>
265 template <
template <
typename>
class Handle,
typename I,
typename IT>
269 template <
template <
typename>
class Handle,
typename I,
typename IT>
273 template <
template <
typename>
class Handle,
typename I,
274 typename = std::enable_if_t<std::is_convertible_v<I*, In>>>
276 return h.getIfExists();
280 template <
typename T>
284 template <
typename T>
290 template <
typename Container>
292 static constexpr
bool is_pointer = std::is_pointer_v<Container>;
293 static constexpr
bool is_range = details2::is_gaudi_range_v<Container>;
294 using val_t = std::add_const_t<std::remove_pointer_t<Container>>;
295 using ptr_t = std::add_pointer_t<val_t>;
296 using ref_t = std::add_lvalue_reference_t<val_t>;
301 using value_type = std::conditional_t<is_pointer, ptr_t, val_t>;
304 using it_t =
typename ContainerVector::const_iterator;
308 using ret_t = std::conditional_t<is_pointer, ptr_t, ref_t>;
321 if constexpr ( is_range ) {
336 explicit operator bool()
const {
return !is_null(); }
340 template <
typename T>
343 std::bool_constant < is_pointer or is_range > {} );
349 template <
typename X = Container>
351 return *m_containers[i];
354 template <
typename X = Container>
356 return m_containers[i];
359 template <
typename X = Container>
361 return *m_containers[i];
364 template <
typename X = Container>
366 return m_containers[i];
374 template <
typename Tr>
376 template <
typename Tr,
typename T>
378 template <
typename Tr,
typename T>
381 template <
typename T>
382 constexpr
auto is_tool_v = std::is_base_of_v<IAlgTool, std::decay_t<T>>;
384 template <
typename T>
387 template <
typename T>
394 template <
typename Tr,
typename Base = GaudiAlgorithm>
401 template <
typename Tr,
typename T>
403 template <
typename Tr,
typename T>
406 template <
typename Traits>
408 std::is_base_of_v<Gaudi::details::LegacyAlgorithmAdapter, details::BaseClass_t<Traits>>;
411 #define GAUDI_FUNCTIONAL_MAKE_VECTOR_OF_HANDLES_USES_DATAOBJID
413 template <
typename Handles>
416 handles.reserve( init.
size() );
418 [&](
const auto& loc ) ->
typename Handles::value_type {
419 return { loc, owner };
424 template <
typename Handle,
typename Algo>
431 template <
typename IFace,
typename Algo>
433 return handle.bind(
ctx );
436 template <
typename Handle>
437 auto getKey(
const Handle&
h ) -> decltype(
h.objKey() ) {
443 template <
typename... In>
448 "EventContext can only appear as first argument" );
450 template <
typename Algorithm,
typename Handles>
456 template <
typename Algorithm,
typename Handles>
458 return std::apply( [&](
const auto&... handle ) {
return algo(
get( handle, algo,
ctx )... ); }, handles );
463 template <
typename... In>
468 "EventContext can only appear as first argument" );
470 template <
typename Algorithm,
typename Handles>
472 return std::apply( [&](
const auto&... handle ) {
return algo(
ctx,
get( handle, algo,
ctx )... ); }, handles );
475 template <
typename Algorithm,
typename Handles>
481 template <
typename... In>
484 template <
typename OutputSpec,
typename InputSpec,
typename Traits_>
487 template <
typename Out,
typename In,
typename Tr>
490 auto sc = parent.setProperty( prop, newLoc );
491 if ( sc.isFailure() )
throw GaudiException(
"Could not set Property", prop +
" -> " + newLoc, sc );
494 template <
typename Out,
typename In,
typename Tr>
499 ss <<
'[', newLocs,
", ", [](
std::ostream & os,
const auto& i ) ->
auto& {
return os <<
"'" << i <<
"'"; } )
501 auto sc = parent.setProperty( prop, ss.
str() );
502 if ( sc.isFailure() )
throw GaudiException(
"Could not set Property", prop +
" -> " + ss.
str(), sc );
505 template <
typename... Out,
typename... In,
typename Traits_>
511 const OArgs& outputs, std::index_sequence<J...> )
513 , m_inputs(
std::tuple_cat(
std::forward_as_tuple( this ),
std::
get<I>( inputs ) )... )
514 , m_outputs(
std::tuple_cat(
std::forward_as_tuple( this ),
std::
get<J>( outputs ) )... ) {
530 std::index_sequence_for<Out...>{} ) {}
546 template <std::
size_t N = 0>
547 decltype(
auto ) inputLocation()
const {
548 return getKey( std::get<N>( m_inputs ) );
550 template <
typename T>
551 decltype(
auto ) inputLocation()
const {
556 template <std::
size_t N = 0>
557 decltype(
auto ) outputLocation()
const {
558 return getKey( std::get<N>( m_outputs ) );
560 template <
typename T>
561 decltype(
auto ) outputLocation()
const {
573 template <
typename Traits_>
592 template <
typename... In,
typename Traits_>
599 , m_inputs(
std::tuple_cat(
std::forward_as_tuple( this ),
std::
get<I>( inputs ) )... ) {
618 template <std::
size_t N = 0>
619 decltype(
auto ) inputLocation()
const {
620 return getKey( std::get<N>( m_inputs ) );
622 template <
typename T>
623 decltype(
auto ) inputLocation()
const {
634 template <
typename Traits_>
641 template <
typename... Out,
typename Traits_>
648 , m_outputs(
std::tuple_cat(
std::forward_as_tuple( this ),
std::
get<J>( outputs ) )... ) {
666 template <std::
size_t N = 0>
667 decltype(
auto ) outputLocation()
const {
668 return getKey( std::get<N>( m_outputs ) );
679 template <
typename Fun,
typename Container,
typename... Args>
681 static_assert(
sizeof...( Args ) == 0,
"Args should not be used!" );
684 template <
typename Fun,
typename Container>
686 fun.postprocess(
c );
typename Tr::BaseClass BaseClass_t
auto operator()(Container &c, Value &&v) const
std::enable_if_t< std::is_pointer_v< X >, ptr_t > operator[](size_type i) const
std::add_const_t< std::remove_pointer_t< Container > > val_t
const In & operator()(const In *in) const
constexpr auto size(const T &, Args &&...) noexcept
bool PyHelper() setProperty(IInterface *p, char *name, char *value)
std::tuple< details::InputHandle_t< Traits_, In >... > m_inputs
DataHandleMixin(std::string name, ISvcLocator *locator, const KeyValue &input, const KeyValue &output)
auto get(const ToolHandle< Gaudi::Interface::Bind::IBinder< IFace >> &handle, const Algo &, const EventContext &ctx)
std::enable_if_t<!is_optional_v< Arg > > require_is_not_optional
GAUDI_API const EventContext & currentContext()
bool isReEntrant() const override
DataHandleMixin(std::string name, ISvcLocator *locator, const KeyValue &output)
Gaudi::cpp17::detected_or_t< detail2::DefaultInputHandle< T >, detail2::InputHandle_t, Tr, T > InputHandle_t
DataHandleMixin(std::string name, ISvcLocator *pSvcLocator, RepeatValues_< KeyValue, N_out > const &outputs)
constexpr struct Gaudi::Functional::details::invoke_optionally_t invoke_optionally
bool isReEntrant() const override
auto operator()(Container &c, Value &&v) const -> decltype(c.push_back(v))
DataHandleMixin(std::string name, ISvcLocator *pSvcLocator, const IArgs &inputs, std::index_sequence< I... >)
T back_inserter(T... args)
ContainerVector m_containers
auto operator()(const Handle< I > &h) -> const In &
typename it_t::iterator_category iterator_category
std::tuple< details::InputHandle_t< Traits_, In >... > m_inputs
void reserve(size_type size)
constexpr unsigned int outputLocationSize() const
bool isReEntrant() const override
typename ContainerVector::size_type size_type
decltype(auto) const_range(Args &&... args)
Zips multiple containers together to form a single const range.
DataHandleMixin(std::string name, ISvcLocator *locator, RepeatValues_< KeyValue, N_in > const &inputs, const KeyValue &output)
GAUDI_API const std::string typeinfoName(const std::type_info &)
Get platform independent information about the class type.
std::enable_if_t<!std::is_pointer_v< X >, ref_t > operator[](size_type i) const
friend auto operator-(const iterator &lhs, const iterator &rhs)
DataHandleMixin(std::string name, ISvcLocator *pSvcLocator, const IArgs &inputs, std::index_sequence< I... >, const OArgs &outputs, std::index_sequence< J... >)
auto get_values_helper(std::index_sequence< I... >)
std::vector< DataObjID > to_DataObjID(const std::vector< std::string > &in)
In operator()(In &&in) const
auto operator()(const Handle< Gaudi::Range_< I, IT >> &h) -> const In
DataObjectHandle.h GaudiKernel/DataObjectHandle.h.
static auto apply(const Algorithm &algo, Handles &handles)
Handles make_vector_of_handles(IDataHandleHolder *owner, const std::vector< DataObjID > &init)
std::remove_pointer_t< typename Container::value_type > c_remove_ptr_t
DataHandleMixin(std::string name, ISvcLocator *pSvcLocator, RepeatValues_< KeyValue, N_in > const &inputs, RepeatValues_< KeyValue, N_out > const &outputs)
std::enable_if_t<!std::is_pointer_v< X >, ref_t > at(size_type i) const
constexpr unsigned int inputLocationSize() const
bool check_sizes(const A &a, const B &b, const C &... c) noexcept
Compare sizes of 3 or more containers.
void operator()(F &&f, Arg &&arg) const
static auto apply(const Algorithm &algo, const EventContext &ctx, Handles &handles)
typename Tr::template InputHandle< T > InputHandle_t
std::conditional_t< is_tool_v< T >, ToolHandle_t< T >, DataObjectReadHandle< T > > DefaultInputHandle
DataHandleMixin(std::string name, ISvcLocator *pSvcLocator, const OArgs &outputs, std::index_sequence< J... >)
std::conditional_t< is_pointer, ptr_t, val_t > value_type
typename details::detector< Default, void, Op, Args... >::type detected_or_t
Base class from which all concrete algorithm classes should be derived.
auto applyPostProcessing(const Fun &fun, Container &c) -> decltype(fun.postprocess(c), void())
constexpr unsigned int inputLocationSize() const
void put(const OutHandle &out_handle, OptOut &&out)
static auto apply(const Algorithm &algo, Handles &handles)
typename Tr::template OutputHandle< T > OutputHandle_t
constexpr struct Gaudi::Functional::details::deref_t deref
std::tuple< details::OutputHandle_t< Traits_, Out >... > m_outputs
std::enable_if_t< std::is_pointer_v< X >, ptr_t > at(size_type i) const
std::enable_if_t< is_optional_v< Arg > > require_is_optional
void push_back(T &&container)
void updateHandleLocation(DataHandleMixin< Out, In, Tr > &parent, const std::string &prop, const std::string &newLoc)
Header file for std:chrono::duration-based Counters.
friend bool operator==(const iterator &lhs, const iterator &rhs)
std::tuple< details::OutputHandle_t< Traits_, Out >... > m_outputs
bool isReEntrant() const override
const In & operator()(const In &in) const
T * put(std::unique_ptr< T > object) const
Register object in transient store.
decltype(auto) verifySizes(Args &... args)
Verify the data container sizes have the same sizes.
static auto apply(const Algorithm &algo, const EventContext &ctx, Handles &handles)
friend bool operator!=(const iterator &lhs, const iterator &rhs)
std::conditional_t< is_optional_v< T >, typename T::value_type, T > remove_optional_t
typename it_t::difference_type difference_type
constexpr bool is_optional_v
void push_back(Container &c, const Value &v, std::false_type)
T & deref_if(T *const t, std::true_type)
decltype(get_values_helper< Value >(std::make_index_sequence< N >())) RepeatValues_
constexpr unsigned int outputLocationSize() const
typename it_t::iterator_category value_type
typename it_t::pointer pointer
typename ContainerVector::const_iterator it_t
void updateHandleLocations(DataHandleMixin< Out, In, Tr > &parent, const std::string &prop, const std::vector< std::string > &newLocs)
auto operator()(Container &c, Value &&v) const -> decltype(c.insert(v))
std::add_lvalue_reference_t< val_t > ref_t
typename it_t::reference reference
auto operator()(const Handle< Gaudi::NamedRange_< I, IT >> &h) -> const In
Gaudi::cpp17::detected_or_t< Base, detail2::BaseClass_t, Tr > BaseClass_t
void printSizes(OS &out, Arg &&arg, Args &&... args)
Print the parameters.
constexpr static const auto FAILURE
decltype(bool{ std::declval< T >() }, std::declval< T >().value()) is_optional_
DataHandleMixin(std::string name, ISvcLocator *pSvcLocator, std::tuple<>={}, std::tuple<>={})
std::conditional_t< is_pointer, ptr_t, ref_t > ret_t
constexpr struct Gaudi::Functional::details::insert_t insert
auto operator()(const Handle< I > &h) -> const In
Gaudi::cpp17::detected_or_t< DataObjectWriteHandle< T >, detail2::OutputHandle_t, Tr, T > OutputHandle_t
typename filter_evtcontext_t< In... >::type filter_evtcontext
DataHandleMixin(std::string name, ISvcLocator *pSvcLocator, RepeatValues_< KeyValue, N_in > const &inputs)
vector_of_const_()=default
std::add_pointer_t< val_t > ptr_t
DataHandleMixin(std::string name, ISvcLocator *locator, const KeyValue &input, RepeatValues_< KeyValue, N_out > const &outputs)
decltype(auto) range(Args &&... args)
Zips multiple containers together to form a single range.
Stream & ostream_joiner(Stream &os, Iterator first, Iterator last, Separator sep, OutputElement output=OutputElement{})
DataHandleMixin(std::string name, ISvcLocator *locator, const KeyValue &input)
auto getKey(const Handle &h) -> decltype(h.objKey())
bool is_null(size_type i) const