JAANET::JEvtWeightFactorConstant< JEvtWeightFactor_t > Struct Template Reference

Class for constant event-weight factors. More...

#include <JEvtWeightFactorConstant.hh>

Inheritance diagram for JAANET::JEvtWeightFactorConstant< JEvtWeightFactor_t >:

Classes
struct	JEvtWeightFactorConstantHelper
	Auxiliary class for I/O of constant event-weight factor. More...

Public Types
typedef JEvtWeightFactorConstant< JEvtWeightFactor_t >	JEvtWeightFactorConstant_t
typedef JClonable< JClonable_t >::clone_type	clone_type

Public Member Functions
	JEvtWeightFactorConstant ()
	Default constructor.
	JEvtWeightFactorConstant (const double constant)
	Constructor.
bool	is_valid () const override final
	Check whether this constant event-weight factor is valid.
double	getFactor (const Evt &evt) const override final
	Get event-weight factor of given event.
bool	less (const JEvtWeightFactorConstant_t &object) const
	Check if this event-weight constant is less than given event-weight constant.
JProperties	getProperties (const JEquationParameters &eqpars=JEvtWeightFactor::getEquationParameters()) override final
	Get properties of this class.
JProperties	getProperties (const JEquationParameters &eqpars=JEvtWeightFactor::getEquationParameters()) const override final
	Get properties of this class.
std::istream &	read (std::istream &in) override final
	Stream input.
std::ostream &	write (std::ostream &out) const override final
	Write event-weight factor to output.
virtual clone_type	clone () const override
	Get clone of this object.

Private Attributes
double	constant
	constant value

Detailed Description

template<class JEvtWeightFactor_t>
struct JAANET::JEvtWeightFactorConstant< JEvtWeightFactor_t >

Class for constant event-weight factors.

The template argument refers to the type of event-weighter.

Definition at line 34 of file JEvtWeightFactorConstant.hh.

Member Typedef Documentation

JEvtWeightFactorConstant_t

template<class JEvtWeightFactor_t >

JEvtWeightFactorConstant<JEvtWeightFactor_t> JAANET::JEvtWeightFactorConstant< JEvtWeightFactor_t >::JEvtWeightFactorConstant_t

Definition at line 38 of file JEvtWeightFactorConstant.hh.

clone_type

template<class JClonable_t , class JDerived_t >

JClonable<JClonable_t>::clone_type JLANG::JClonable< JClonable_t, JDerived_t >::clone_type

inherited

Definition at line 61 of file JClonable.hh.

Constructor & Destructor Documentation

JEvtWeightFactorConstant() [1/2]

template<class JEvtWeightFactor_t >

JAANET::JEvtWeightFactorConstant< JEvtWeightFactor_t >::JEvtWeightFactorConstant ( )

inline

Default constructor.

Definition at line 44 of file JEvtWeightFactorConstant.hh.

                               :
      constant(1.0)
    {}

JEvtWeightFactorConstant() [2/2]

template<class JEvtWeightFactor_t >

JAANET::JEvtWeightFactorConstant< JEvtWeightFactor_t >::JEvtWeightFactorConstant ( const double constant )

inline

Constructor.

Parameters

constant

constant

Definition at line 54 of file JEvtWeightFactorConstant.hh.

                                                    :
      constant(constant)
    {
      this->check_validity();
    }

Member Function Documentation

is_valid()

template<class JEvtWeightFactor_t >

bool JAANET::JEvtWeightFactorConstant< JEvtWeightFactor_t >::is_valid ( ) const

inlinefinaloverride

Check whether this constant event-weight factor is valid.

Returns

true if valid; else false

Definition at line 66 of file JEvtWeightFactorConstant.hh.

    {
      return constant > 0.0;
    }

getFactor()

template<class JEvtWeightFactor_t >

double JAANET::JEvtWeightFactorConstant< JEvtWeightFactor_t >::getFactor ( const Evt & evt ) const

inlinefinaloverride

Get event-weight factor of given event.

Parameters

evt

event

Returns

event-weight factor

Definition at line 78 of file JEvtWeightFactorConstant.hh.

    {
      return constant;
    }

less()

template<class JEvtWeightFactor_t >

bool JAANET::JEvtWeightFactorConstant< JEvtWeightFactor_t >::less ( const JEvtWeightFactorConstant_t & object ) const

inline

Check if this event-weight constant is less than given event-weight constant.

Parameters

object

event-weight constant

Returns

true if this event-weight constant is less than given event-weight constant; else false

Definition at line 90 of file JEvtWeightFactorConstant.hh.

    {
      return this->constant < object.constant;
    }

getProperties() [1/2]

template<class JEvtWeightFactor_t >

JProperties JAANET::JEvtWeightFactorConstant< JEvtWeightFactor_t >::getProperties ( const JEquationParameters & eqpars = JEvtWeightFactor::getEquationParameters() )

inlinefinaloverride

Get properties of this class.

Parameters

eqpars

equation parameters

Definition at line 101 of file JEvtWeightFactorConstant.hh.

    {
      return JEvtWeightFactorConstantHelper(*this, eqpars);
    }

getProperties() [2/2]

template<class JEvtWeightFactor_t >

JProperties JAANET::JEvtWeightFactorConstant< JEvtWeightFactor_t >::getProperties ( const JEquationParameters & eqpars = JEvtWeightFactor::getEquationParameters() ) const

inlinefinaloverride

Get properties of this class.

Parameters

eqpars

equation parameters

Definition at line 112 of file JEvtWeightFactorConstant.hh.

    {
      return JEvtWeightFactorConstantHelper(*this, eqpars);      
    }

read()

template<class JEvtWeightFactor_t >

std::istream & JAANET::JEvtWeightFactorConstant< JEvtWeightFactor_t >::read ( std::istream & in )

inlinefinaloverride

Stream input.

Parameters

in	input stream

Returns

input stream

Definition at line 124 of file JEvtWeightFactorConstant.hh.

    {
      using namespace std;
 
      streampos pos = in.tellg();      
      
      if (!(in >> constant)) {
 
        in.clear();
        in.seekg(pos);
 
        JProperties properties = getProperties();
 
        in >> properties;
      }
 
      this->check_validity();
 
      return in;
    }

write()

template<class JEvtWeightFactor_t >

std::ostream & JAANET::JEvtWeightFactorConstant< JEvtWeightFactor_t >::write ( std::ostream & out ) const

inlinefinaloverride

Write event-weight factor to output.

Parameters

out	output stream

Returns

output stream

Definition at line 152 of file JEvtWeightFactorConstant.hh.

    {
      using namespace JPP;
      
      return out << FIXED(10,3) << constant;
    }

clone()

template<class JClonable_t , class JDerived_t >

virtual clone_type JLANG::JClonable< JClonable_t, JDerived_t >::clone ( ) const

inlineoverridevirtualinherited

Get clone of this object.

Returns

pointer to newly created object

Reimplemented in JPHYSICS::JPD0Transformer_t< JArgument_t >, JPHYSICS::JPDFTransformer< 2, JArgument_t >, JPHYSICS::JPDFTransformer< 3, JArgument_t >, JPHYSICS::JPDFTransformer< 4, JArgument_t >, JPHYSICS::JPDFTransformer< 5, JArgument_t >, JPHYSICS::JPDFTransformer_t< JArgument_t >, JPHYSICS::JPDGTransformer_t< JArgument_t >, and JTOOLS::JMultiMapTransformer< N, JArgument_t >::JMultiMapDefaultTransformer.

Definition at line 69 of file JClonable.hh.

    {
      return new JDerived_t(static_cast<const JDerived_t&>(*this));
    }

Member Data Documentation

constant

template<class JEvtWeightFactor_t >

double JAANET::JEvtWeightFactorConstant< JEvtWeightFactor_t >::constant

private

constant value

Definition at line 186 of file JEvtWeightFactorConstant.hh.

---

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

• JEvtWeightFactorConstant.hh