FastJet  3.2.1
base.hh
1 
2 //FJSTARTHEADER
3 // $Id: base.hh 4047 2016-03-03 13:21:49Z soyez $
4 //
5 // Copyright (c) 2005-2014, Matteo Cacciari, Gavin P. Salam and Gregory Soyez
6 //
7 //----------------------------------------------------------------------
8 // This file is part of FastJet.
9 //
10 // FastJet is free software; you can redistribute it and/or modify
11 // it under the terms of the GNU General Public License as published by
12 // the Free Software Foundation; either version 2 of the License, or
13 // (at your option) any later version.
14 //
15 // The algorithms that underlie FastJet have required considerable
16 // development. They are described in the original FastJet paper,
17 // hep-ph/0512210 and in the manual, arXiv:1111.6097. If you use
18 // FastJet as part of work towards a scientific publication, please
19 // quote the version you use and include a citation to the manual and
20 // optionally also to hep-ph/0512210.
21 //
22 // FastJet is distributed in the hope that it will be useful,
23 // but WITHOUT ANY WARRANTY; without even the implied warranty of
24 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 // GNU General Public License for more details.
26 //
27 // You should have received a copy of the GNU General Public License
28 // along with FastJet. If not, see <http://www.gnu.org/licenses/>.
29 //----------------------------------------------------------------------
30 //FJENDHEADER
31 
32 #ifndef __FASTJET_FASTJET_BASE_HH__
33 #define __FASTJET_FASTJET_BASE_HH__
34 
35 #include "fastjet/config.h"
36 
37 /// \namespace fastjet
38 /// the FastJet namespace
39 ///
40 /// all the fastjet-related material is put under that namespace
41 
42 // define this for easier readability (and obfuscation?) in
43 // a range of places
44 #define FASTJET_BEGIN_NAMESPACE namespace fastjet {
45 #define FASTJET_END_NAMESPACE }
46 
47 // define a macro to mark virtual function in derived classes as
48 // overriding the base-class definition
49 #ifdef FASTJET_HAVE_OVERRIDE
50 #define FASTJET_OVERRIDE override
51 #else
52 #define FASTJET_OVERRIDE
53 #endif
54 
55 #endif // __FASTJET_FASTJET_BASE_HH__