doxygen/ThePEG_8h_source.html

// -*- C++ -*-

//

// ThePEG.h is a part of ThePEG - Toolkit for HEP Event Generation

// Copyright (C) 1999-2019 Leif Lonnblad

//

// ThePEG is licenced under version 3 of the GPL, see COPYING for details.

// Please respect the MCnet academic guidelines, see GUIDELINES for details.

//

#ifndef ThePEG_H

#define ThePEG_H


#ifndef ThePEG_ALTERNATE_CONFIG


#include "ThePEG/Pointer/Ptr.h"

#include "ThePEG/Pointer/PtrTraits.h"

#include "ThePEG/Pointer/RCPtr.h"

#include "ThePEG/Utilities/Rebinder.fh"

#include "ThePEG/Utilities/Interval.fh"

#include "ThePEG/Utilities/ClassDescription.fh"

#include "ThePEG/Interface/InterfaceBase.fh"

#include "ThePEG/Persistency/PersistentOStream.fh"

#include "ThePEG/Persistency/PersistentIStream.fh"

#include "TemplateTools.h"

#include "Complex.h"

#include "Unitsystem.h"

#include "Constants.h"

#include "std.h"


namespace ThePEG {


// Introduce some identifiers in the ThePEG namespace/

using namespace ThePEG::Pointer;

using ThePEG::Pointer::Ptr;

using namespace ThePEG::Units;


struct Base: public ReferenceCounted {


  virtual ~Base() {}


  static void Init() {}


  void debug() const;


  virtual void debugme() const;


};


typedef Base PersistentBase;


struct TraitsType {};


struct Veto {


  Veto();

};


struct Stop {};


template <typename T>

inline constexpr

auto sqr(const T& x) -> decltype(x*x) {

  return x*x;

}


// Debugging in ThePEG may be swithced off completely by this

// compilation swithc, eliminating possible overhead in error

// checking.

#ifndef ThePEG_NO_DEBUG

#define ThePEG_DEBUG_LEVEL Debug::level

#define ThePEG_DEBUG_ITEM(item) Debug::debugItem(item)

#else

#define ThePEG_DEBUG_LEVEL 0

#define ThePEG_DEBUG_ITEM(item) false

#endif


}


#include "Pointers.h"

#include "Containers.h"


#else


#include ThePEG_ALTERNATIVE_CONFIG


#endif


#endif /* ThePEG_H */


Containers.h
This file defines a number of containers.

Pointers.h
This file declares typedefs of commonly used pointers in ThePEG.

TemplateTools.h
Useful template machinery.

ThePEG::Pointer::ReferenceCounted
ReferenceCounted must be the (virtual) base class of all classes which may be pointed to by the RCPtr...
Definition: ReferenceCounted.h:30

ThePEG::Pointer
The namespace for the reference counted pointer classes.
Definition: Ptr.h:18

ThePEG::Units
The Units namespace contains the declaration of a number of classes for variables with dimension.
Definition: Unitsystem.h:35

ThePEG
This is the main namespace within which all identifiers in ThePEG are declared.
Definition: FactoryBase.h:28

ThePEG::PersistentBase
Base PersistentBase
Define the base class from which all persistent classes in ThePEG are derived.
Definition: ThePEG.h:86

ThePEG::sqr
constexpr auto sqr(const T &x) -> decltype(x *x)
The square function should really have been included in the standard C++ library.
Definition: ThePEG.h:117

std.h
This file introduces a number of std:: classes into the ThePEG namespace.

ThePEG::Base
Define the base class from which all (polymorphic) classes in ThePEG are derived.
Definition: ThePEG.h:54

ThePEG::Base::debugme
virtual void debugme() const
Print out debugging information for this object on std::cerr.

ThePEG::Base::debug
void debug() const
Print out debugging information for this object on std::cerr.

ThePEG::Base::Init
static void Init()
The standard Init function used to initialize the interfaces.
Definition: ThePEG.h:65

ThePEG::Base::~Base
virtual ~Base()
The virtual destructor.
Definition: ThePEG.h:57

ThePEG::Pointer::Ptr
Ptr is a templated class to provide typedefs for pointers types ThePEG should use for a given type.
Definition: Ptr.h:35

ThePEG::Stop
A standard exception class to be used to temporarily stop the generation of an event.
Definition: ThePEG.h:109

ThePEG::TraitsType
TraitsType is an empty, non-polymorphic, base class.
Definition: ThePEG.h:94

ThePEG::Veto
A standard exception class to be used for vetoing a whole event.
Definition: ThePEG.h:99

ThePEG::Veto::Veto
Veto()
the default constructor.