HepMC3 event record library
Public Types | Public Member Functions | Protected Attributes
Feature< Feature_type, typename std::enable_if< std::is_integral< Feature_type >::value, void >::type > Class Template Reference

Detailed Description

template<typename Feature_type>
class HepMC3::Feature< Feature_type, typename std::enable_if< std::is_integral< Feature_type >::value, void >::type >

Specialisation of Feature for integral types.

It is a valid operator to compare an int to a float, but the generic version of these operators in the base class will first cast input float to an int, then compare that. In some cases the comparison will be incorrect because of rounding the float. e.g. int x=5; float y=5.5; bool result = x<y; would be wrong because y first gets converted to int 5.

To solve this, we provide specialised comparison operators for integral type and double. Note that the opposite specialisation in which the Feature_type is floating_point is not necessary

Definition at line 205 of file Feature.h.

#include <Feature.h>

+ Inheritance diagram for Feature< Feature_type, typename std::enable_if< std::is_integral< Feature_type >::value, void >::type >:
+ Collaboration diagram for Feature< Feature_type, typename std::enable_if< std::is_integral< Feature_type >::value, void >::type >:

Public Types

using Evaluator_type = std::function< Feature_type(ConstGenParticlePtr)>
 evaluator type
 
using EvaluatorPtr = std::shared_ptr< Evaluator_type >
 shared pointer for evaluator type
 

Public Member Functions

 Feature (Evaluator_type functor)
 Feature.
 
 Feature (const Feature &copy)
 Feature.
 
Feature< Feature_type > abs () const
 abs function
 
Filter operator> (double value) const
 greater operator
 
Filter operator< (double value) const
 less operator
 
Filter operator== (double value) const
 equal operator
 
Filter operator>= (double value) const
 greater or equal operator
 
Filter operator<= (double value) const
 less or equal operator
 
Filter operator!= (double value) const
 not equal operator
 
Feature_type operator() (ConstGenParticlePtr input) const
 access the underlying feature value
 
Filter operator> (Feature_type value) const
 greater than operator
 
Filter operator< (Feature_type value) const
 less than operator
 
Filter operator>= (Feature_type value) const
 greater than or equals operator
 
Filter operator<= (Feature_type value) const
 less than or equals operator
 
virtual Filter operator== (Feature_type value) const
 equality operator
 
virtual Filter operator!= (Feature_type value) const
 inequality operator
 

Protected Attributes

EvaluatorPtr m_internal
 internal copy of func for evaluation on the heap so will persist in resulting Filters even if parent Feature object was destroyed
 

Member Typedef Documentation

◆ Evaluator_type

using Evaluator_type = std::function<Feature_type(ConstGenParticlePtr)>
inherited

evaluator type

Definition at line 62 of file Feature.h.

◆ EvaluatorPtr

using EvaluatorPtr = std::shared_ptr<Evaluator_type>
inherited

shared pointer for evaluator type

Definition at line 64 of file Feature.h.

Constructor & Destructor Documentation

◆ Feature() [1/2]

Feature ( Evaluator_type  functor)
inline

Feature.

Definition at line 221 of file Feature.h.

◆ Feature() [2/2]

Feature ( const Feature< Feature_type, typename std::enable_if< std::is_integral< Feature_type >::value, void >::type > &  copy)
inline

Feature.

Definition at line 223 of file Feature.h.

Member Function Documentation

◆ abs()

Feature< Feature_type > abs ( ) const
inline

abs function

Definition at line 226 of file Feature.h.

References GenericFeature< Feature_type >::m_internal.

◆ operator!=() [1/2]

Filter operator!= ( double  value) const
inline

not equal operator

Definition at line 260 of file Feature.h.

◆ operator!=() [2/2]

virtual Filter operator!= ( Feature_type  value) const
inlinevirtualinherited

◆ operator()()

Feature_type operator() ( ConstGenParticlePtr  input) const
inlineinherited

access the underlying feature value

Definition at line 67 of file Feature.h.

References GenericFeature< Feature_type >::m_internal.

◆ operator<() [1/2]

Filter operator< ( double  value) const
inline

less operator

Definition at line 239 of file Feature.h.

References GenericFeature< Feature_type >::m_internal.

◆ operator<() [2/2]

Filter operator< ( Feature_type  value) const
inlineinherited

less than operator

Returns
Filter function

Definition at line 79 of file Feature.h.

References GenericFeature< Feature_type >::m_internal.

◆ operator<=() [1/2]

Filter operator<= ( double  value) const
inline

less or equal operator

Definition at line 257 of file Feature.h.

◆ operator<=() [2/2]

Filter operator<= ( Feature_type  value) const
inlineinherited

less than or equals operator

Returns
Filter function

Definition at line 93 of file Feature.h.

References GenericFeature< Feature_type >::m_internal.

◆ operator==() [1/2]

Filter operator== ( double  value) const
inline

equal operator

Definition at line 245 of file Feature.h.

References GenericFeature< Feature_type >::m_internal.

◆ operator==() [2/2]

virtual Filter operator== ( Feature_type  value) const
inlinevirtualinherited

◆ operator>() [1/2]

Filter operator> ( double  value) const
inline

greater operator

Definition at line 233 of file Feature.h.

References GenericFeature< Feature_type >::m_internal.

◆ operator>() [2/2]

Filter operator> ( Feature_type  value) const
inlineinherited

greater than operator

Returns
Filter function

Definition at line 73 of file Feature.h.

References GenericFeature< Feature_type >::m_internal.

◆ operator>=() [1/2]

Filter operator>= ( double  value) const
inline

greater or equal operator

Definition at line 254 of file Feature.h.

◆ operator>=() [2/2]

Filter operator>= ( Feature_type  value) const
inlineinherited

greater than or equals operator

Returns
Filter function

Definition at line 86 of file Feature.h.

References GenericFeature< Feature_type >::m_internal.

Field Documentation

◆ m_internal

EvaluatorPtr m_internal
protectedinherited

internal copy of func for evaluation on the heap so will persist in resulting Filters even if parent Feature object was destroyed

Definition at line 122 of file Feature.h.


The documentation for this class was generated from the following file: