siscone.h

// -*- C++ -*-
// File: siscone.h                                                           //
// Description: header file for the main SISCone class                       //
// This file is part of the SISCone project.                                 //
// WARNING: this is not the main SISCone trunk but                           //
//          an adaptation to spherical coordinates                           //
// For more details, see http://projects.hepforge.org/siscone                //
//                                                                           //
// Copyright (c) 2006-2008 Gavin Salam and Gregory Soyez                          //
//                                                                           //
// This program is free software; you can redistribute it and/or modify      //
// it under the terms of the GNU General Public License as published by      //
// the Free Software Foundation; either version 2 of the License, or         //
// (at your option) any later version.                                       //
//                                                                           //
// This program is distributed in the hope that it will be useful,           //
// but WITHOUT ANY WARRANTY; without even the implied warranty of            //
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             //
// GNU General Public License for more details.                              //
//                                                                           //
// You should have received a copy of the GNU General Public License         //
// along with this program; if not, write to the Free Software               //
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA //
//                                                                           //
// $Revision::                                                              $//
// $Date::                                                                  $//
 
#ifndef __SPH_SISCONE_H__
#define __SPH_SISCONE_H__
 
#include "protocones.h"
#include "split_merge.h"
 
namespace siscone_spherical{
 
class CSphsiscone : public CSphstable_cones, public CSphsplit_merge{
 public:
  CSphsiscone();
 
  ~CSphsiscone();
 
  int compute_jets(std::vector<CSphmomentum> &_particles, double _radius, double _f, 
                   int _n_pass_max=0, double _Emin=0.0,
                   Esplit_merge_scale _split_merge_scale=SM_Etilde);
 
  int compute_jets_progressive_removal(std::vector<CSphmomentum> &_particles, double _radius, 
                                       int _n_pass_max=0, double _Emin=0.0,
                                       Esplit_merge_scale _ordering_scale=SM_Etilde);
 
  int recompute_jets(double _f, double _Emin = 0.0,
                     Esplit_merge_scale _split_merge_scale=SM_Etilde);
 
  std::vector<std::vector<CSphmomentum> > protocones_list;
 
  // random number initialisation
  static bool init_done;      
 
#ifdef DEBUG_STABLE_CONES
  int nb_hash_cones_total, nb_hash_occupied_total;
#endif
 
  static void set_banner_stream(std::ostream * ostr) {_banner_ostr = ostr;}
 
  static std::ostream * banner_stream() {return _banner_ostr;}
 
 private:
  bool rerun_allowed;         
  static std::ostream * _banner_ostr; 
 
  void _initialise_if_needed();
 
};
 
  
// finally, a bunch of functions to access to 
// basic information (package name, version)
//---------------------------------------------
 
std::string siscone_package_name();
 
std::string siscone_version();
 
}
#endif