FastJet 3.0.0
|
00001 00002 //STARTHEADER 00003 // $Id: base.hh 2577 2011-09-13 15:11:38Z salam $ 00004 // 00005 // Copyright (c) 2005-2011, Matteo Cacciari, Gavin P. Salam and Gregory Soyez 00006 // 00007 //---------------------------------------------------------------------- 00008 // This file is part of FastJet. 00009 // 00010 // FastJet is free software; you can redistribute it and/or modify 00011 // it under the terms of the GNU General Public License as published by 00012 // the Free Software Foundation; either version 2 of the License, or 00013 // (at your option) any later version. 00014 // 00015 // The algorithms that underlie FastJet have required considerable 00016 // development and are described in hep-ph/0512210. If you use 00017 // FastJet as part of work towards a scientific publication, please 00018 // include a citation to the FastJet paper. 00019 // 00020 // FastJet is distributed in the hope that it will be useful, 00021 // but WITHOUT ANY WARRANTY; without even the implied warranty of 00022 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00023 // GNU General Public License for more details. 00024 // 00025 // You should have received a copy of the GNU General Public License 00026 // along with FastJet. If not, see <http://www.gnu.org/licenses/>. 00027 //---------------------------------------------------------------------- 00028 //ENDHEADER 00029 00030 #ifndef __FASTJET_FASTJET_BASE_HH__ 00031 #define __FASTJET_FASTJET_BASE_HH__ 00032 00033 /// \namespace fastjet 00034 /// the FastJet namespace 00035 /// 00036 /// all the fastjet-related material is put under that namespace 00037 00038 // define this for easier readability (and obfuscation?) in 00039 // a range of places 00040 #define FASTJET_BEGIN_NAMESPACE namespace fastjet { 00041 #define FASTJET_END_NAMESPACE } 00042 00043 // define the doxygen groupd 00044 /// \defgroup basic_classes Fundamental FastJet classes 00045 /// \defgroup area_classes Area-related classes 00046 /// \defgroup sec_area_classes Secondary area-related classes 00047 /// \defgroup plugins Plugins for non-native jet definitions 00048 /// \defgroup selectors Selectors 00049 /// \defgroup tools FastJet tools 00050 /// \{ \defgroup tools_generic Generic tools 00051 /// \defgroup tools_background Background subtraction 00052 /// \defgroup tools_taggers Taggers 00053 /// \} 00054 /// \defgroup extra_info Access to extra information 00055 /// \defgroup error_handling Error handling 00056 /// \defgroup advanced_usage Advanced usage 00057 /// \if internal_doc 00058 /// \defgroup internal 00059 /// \endif 00060 #endif // __FASTJET_FASTJET_BASE_HH__