Index: tags/siscone-3.0.4/NEWS =================================================================== --- tags/siscone-3.0.4/NEWS (revision 0) +++ tags/siscone-3.0.4/NEWS (revision 420) @@ -0,0 +1,211 @@ +This file contains the history of SISCone releases. For each one, +we give a short summary of the important changes from the previous +version. If you want to see a more detailed list of changes, please +read the ChangeLog file. + +SISCone version 3.0.4 (October 1 2018) +===================== + +* Minor release, improved shared library handling by fixing + inter-dependences. (version to be included in FastJet>=3.3.2) + +SISCone version 3.0.3 (August 3 2016) +===================== + +* Minor release, installing config.h to include flags decided at + configure time. (version to be included in FastJet>=3.2.1) + +SISCone version 3.0.2 (March 16 2016) +===================== + +* Minor release, fixing a bug due to an array being used uninitialised + (no impact on results). Also replaced auto_ptr by unique_ptr when + supported by compiler (version to be included in FastJet>=3.2.0) + +SISCone version 3.0.1 (February 29 2016) +===================== + +* Minor release, fixing a bug due to a rounding issue that occurs the + theta range in (rare) specific configurations where theta=pi in the + split-merge procedure for spherical SISCone + +SISCone version 3.0.0 (September 9 2014) +===================== + +* Added the option of running SISCone with progressive removal, + corresponding to the following algorithm: + + 1. search for stable cones + 2. declare the hardest stable cone a jet and remove its particles + from the list of remaining particles + 3. if there are some remaining particles, go back to 1. + + Use Csiscone::compute_jets_progressive_removal(...) for this version + of SISCone + + The scale used to determine which is the hardest stable cone can be + chosen amongst the same options as the scale used for the + split--merge step [SM_pttilde by default for the pp version of + SISCone, SM_Etilde for the spherical version]. Alternatively, a + user-defined scale choice can be provided using set_user_scale(...). + + Version to be included in FastJet>=3.1.0 + +SISCone version 2.0.6 (April 9 2013) +===================== +* Minor release fixing an issue concerning the installation of + configuration headers and bringing small updates in the autotools + build system (version to be included in FastJet>=3.0.4) + +SISCone version 2.0.5 (January 17 2012) +===================== +* Minor release bringing minor improvements to the build system + (version to be included in FastJet>=3.0.2) + +SISCone version 2.0.4 (November 25 2011) +===================== +* Minor release to remove a few gcc warnings when compiled with + high warning level (-ansi -pedantic -Wextra -Wshadow) + (version to be included in FastJet>=3.0.1) + +SISCone version 2.0.3 (October 5 2011) +===================== +* Minor release to fix a badly documented Etilde variable in the + spherical version of SISCone and to remove a few gcc warnings + (version to be included in FastJet 3.x) + +SISCone version 2.0.2 (May 2011) +===================== +* minor modifications to the build system + (version to be included in FastJet 3.x) + +SISCone version 2.0.1 (May 2009) +===================== +* enabled shared libraries by default + [that was the source of a bug in fastJet] +* replaced _R with _radius to fix build problems on old OSX systems +* fixed some syntax inconsistencies in Makefile.am's + + +SISCone version 2.0.0 (Apr 2009) +===================== +* Added a spherical version of SISCone for use in e+e- collisions + This typically works in the same way as the pp version of SISCone + with the following remarks: + - the classes fot the spherical versions of SISCone are prefixed by + 'CSph' instead of 'C' (e.g. CSphMomentum CSphSISCone) + - the cone radius is defined as its half opening angle (particle + distances are also defined through the angle they define, or, + equivalently, as distances on the surface of a unit sphere) + - For ordering the protojets during the split--merge, we use + E_tilde defined as + / |p_i X p_J|^2 \ + \sum_{i\in J} E_i | 1 + --------------- | + \ |p_i|^2 E_J^2 / + Note that the computation of the overlap uses the "plain" energy + +* Added a flag (Csiscone::use_pt_weighted_splitting) to modify the + split part of the split-merge procedure in such a way that a shared + particle i is assigned the one of the overlapping jets j=1,2 that + has the smaller value of DeltaR_{ij}/p_{tj}. This produces more + circular jets. + +* fixed a bug in the computation of the rapidity range in the + split-merge step + +* the protocones list now contains the full 4-momentum information + (rather than just eta and phi) + +* fixed bugs in example/test.cpp + + +SISCone version 1.3.3 (Aug 2008) +===================== +* added bugfix for g++-4.3 (missing headers for "exit") + + +SISCone version 1.3.2 (Mar 2008) +===================== +* VERSION and PROGRAM (or PACKAGE_NAME) are no longer accessible + directly because of potential conflicts with other packages. + You should use siscone_version() and siscone_package_name() + instead. (Thanks to Rolf Seuster) +* allow the users to set their own default compilation flags. + + +SISCone version 1.3.1 (Mar 2008) +===================== +* fixed some compilation issues under windows + + +SISCone version 1.3.0 (Nov 2007) +===================== + +* The main update in this new release is the switch to + 'autotools'. This means that instead of using the (static) Makefile + build process, you can now use the "standard ./configure; make; make + install" approach. See the INSTALL file for details. + +* added a 'siscone_area' example of how jet areas work within SISCone. + + +SISCone version 1.2.0 (Jun 2007) +===================== + +* 10-15% speed increase by introducing a tiling in the eta-phi plane + allowing for better overlap checking in the split--merge. This can + turn into a bigger effect for area computations. + +* implementing a 'jet area' class to compute active and/or passive + areas. + +* in examples: + - fix bug in the cmdline parsing (there was a segfault with + unrecognised long options), + - add "passes information" to the verbose output of the main siscone + program, + - solve problems with the 'time' example. + + +SISCone version 1.1.1 (Mar 2007) +===================== + +* The major upgrade is the use of pttilde (p-scheme pt) instead + of mt in the split--merge process. Indeed, we have noticed + that mt can lead to IR usafety in the case of two back-to-back + narrow-decay-width unstable particles (e.g. a pair of Higgs bosons). + See http://projects.hepforge.org/siscone/sm_issue.html for details. + + Note that SISCone 1.1.1 allows the user to specify its choice for + the split-merge variable (we highly recommand the default choice) + +* The number of passes is now set to infinity (0) by default + +* Small minor changes in the 'siscone' command-line options + + +SISCone version 1.1.0 (Mar 2007) +===================== + +* dealt with colinearity issues + +* dealt with cocircularity situations (and related rounding errors) + +* use mt instead of pt in the split-merge + pt lead to some IR unsafety for events with momentum conservation + +* move all references to HEPForge + +* Important note: some typos have been fixed. As a consequence, some + end-user members have been affected: + - The contents of the jets is accessed through 'Cjet::contents' + instead of 'Cjet::content' + - The function called to save the jet contents to disk is + 'Csplit_merge::save_contents' instead of 'Csplit_merge::save_content' + Note that 'Csiscone::save_contents' is also valid. + + +SISCone version 1.0.0 (Jan 2007) +===================== + +This is the first stable release of siscone. Index: tags/siscone-3.0.4/examples/sample.cpp =================================================================== --- tags/siscone-3.0.4/examples/sample.cpp (revision 0) +++ tags/siscone-3.0.4/examples/sample.cpp (revision 420) @@ -0,0 +1,95 @@ +/////////////////////////////////////////////////////////////////////////////// +// File: sample.cpp // +// Description: example program for the Csiscone class (see documentation) // +// This file is part of the SISCone project. // +// For more details, see http://projects.hepforge.org/siscone // +// // +// Copyright (c) 2006 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:: $// +/////////////////////////////////////////////////////////////////////////////// + +#include +#include +#include +#include "siscone/momentum.h" +#include "siscone/siscone.h" + +#define R 0.7 +#define f 0.5 +#define f_alt 0.75 + +using namespace std; +using namespace siscone; + +int main(){ + vector particles; // list of particles + Csiscone siscone; // main object for the cone algorithm + int i; // loop index + int N; // number of particles + double px,py,pz,E; // particles 4-momentum + char fline[512]; // line to read from a file + + // read particles + FILE *flux; + flux = fopen("events/single-event.dat", "r"); + if (flux==NULL){ + cerr << "cannot read event" << endl; + return 1; + } + + N=0; + while (fgets(fline, 512, flux)!=NULL){ + if (fline[0]!='#'){ // skip lines beginning with '#' + if (sscanf(fline, "%le%le%le%le", &px, &py, &pz, &E)==4){ + particles.push_back(Cmomentum(px, py, pz, E)); + N++; + } else { + cout << "error in reading event file Giving up." << endl; + fclose(flux); + return 2; + } + } + } + fclose(flux); + + // compute jets + // first compute with multiple passes (default) + i=siscone.compute_jets(particles, R, f); + cout << " " << i << " jets found in multi-pass run" << endl; + + // then, recompute it with a different f + i=siscone.recompute_jets(f_alt); + cout << " " << i << " jets found with alternative f" << endl; + + // one pass + i=siscone.compute_jets(particles, R, f, 1); + cout << " " << i << " jets found in single-pass run" << endl; + + // show jets + vector::iterator it_j; + int i1; + fprintf(stdout, "# pT eta phi px py pz E \n"); + for (it_j = siscone.jets.begin(), i1=0 ; + it_j != siscone.jets.end() ; it_j++, i1++){ + fprintf(stdout, "Jet %3d: %10.3f %8.3f %8.3f %10.3f %10.3f %10.3f %10.3f\n", + i1, it_j->v.perp(), it_j->v.eta, it_j->v.phi, it_j->v.px, it_j->v.py, it_j->v.pz, it_j->v.E); + } + + return 0; +} Property changes on: tags/siscone-3.0.4/examples/sample.cpp ___________________________________________________________________ Added: svn:keywords ## -0,0 +1 ## +Date Rev \ No newline at end of property Index: tags/siscone-3.0.4/examples/times.cpp =================================================================== --- tags/siscone-3.0.4/examples/times.cpp (revision 0) +++ tags/siscone-3.0.4/examples/times.cpp (revision 420) @@ -0,0 +1,124 @@ +/////////////////////////////////////////////////////////////////////////////// +// File: times.cpp // +// Description: example program that computes execution times // +// This file is part of the SISCone project. // +// For more details, see http://projects.hepforge.org/siscone // +// // +// Copyright (c) 2006 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:: $// +/////////////////////////////////////////////////////////////////////////////// + +#include +#include +#include +#include +#include +#include + +#include "siscone/momentum.h" +#include "siscone/siscone.h" + +#define Nruns 32 +#define R 0.7 +#define f 0.5 + +using namespace std; +using namespace siscone; + +timeval time_start, time_end; + +// compute time spent between time_start and time_end +int time_spent(){ + timeval time_diff; + + // compute different with initial time + time_diff.tv_sec = time_end.tv_sec-time_start.tv_sec; + if (time_end.tv_usec > time_start.tv_usec){ + time_diff.tv_usec = time_end.tv_usec-time_start.tv_usec; + } else { + time_diff.tv_sec--; + time_diff.tv_usec = (1000000+time_end.tv_usec)-time_start.tv_usec; + } + + return 1000000*time_diff.tv_sec+time_diff.tv_usec; +} + + + +int main(){ + vector particles; + Csiscone siscone; + double eta,phi; + + // number of events and particles + int i, N; + int n_ev, part_inc; + + // time statistics variables + int time_siscone; + + // save files + FILE *flux; + + // initialise random number generator + cout << "initialise random number generator" << endl; + timeval timestamp; + + gettimeofday(×tamp, NULL); + srand(timestamp.tv_usec); + + flux = fopen("times.dat", "w+"); + + N = 1; + part_inc = 1; + do{ + fprintf(stdout, "\r%5d particles\n", N); + time_siscone=0; + + for (n_ev=0;n_ev} + .x. = {rpn x .ic. @} + .y. = {rpn y .ic. @} + draw symbol 1 at .x. .y. + .ic. += 1 +end while + +# draw jet contents +set symbol size 0.2 +while {rpn .ic. ..num_col_data.. >} + .x. = {rpn x .ic. @} + .y. = {rpn y .ic. @} + .z. = {rpn z .ic. @} + if {rpn .z. 0 ==} + set color red + else if {rpn .z. 1 ==} + set color green + else if {rpn .z. 2 ==} + set color blue + else if {rpn .z. 3 ==} + set color cyan + else if {rpn .z. 4 ==} + set color magenta + else if {rpn .z. 5 ==} + set color yellow + else if {rpn .z. 6 ==} + set color black + else if {rpn .z. 7 ==} + set color orange + else if {rpn .z. 8 ==} + set color brown + else if {rpn .z. 9 ==} + set color LightGray + else if {rpn .z. 10 ==} + set color ForestGreen + else + set color skyblue + end if + .z. = {rpn .z. 11 +} + draw symbol .z. at .x. .y. + .ic. += 1 +end while Index: tags/siscone-3.0.4/examples/main.cpp =================================================================== --- tags/siscone-3.0.4/examples/main.cpp (revision 0) +++ tags/siscone-3.0.4/examples/main.cpp (revision 420) @@ -0,0 +1,117 @@ +/////////////////////////////////////////////////////////////////////////////// +// File: main.cpp // +// Description: main program that runs siscone from the command line // +// This file is part of the SISCone project. // +// For more details, see http://projects.hepforge.org/siscone // +// // +// Copyright (c) 2006 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:: $// +/////////////////////////////////////////////////////////////////////////////// + +#include +#include +#include +#include "siscone/momentum.h" +#include "siscone/siscone.h" +#include "options.h" + +using namespace std; +using namespace siscone; + +int main(int argc, char *argv[]){ + vector particles; + Csiscone siscone; + int i,N; + double px,py,pz,E; + Coptions opts; + char fline[512]; + + if (opts.parse_options(argc, argv)) + exit(1); + + // deal with help message + if (opts.help_flag){ + opts.print_help(); + exit(0); + } + + // deal with version flag + if (opts.version_flag){ + opts.print_version(); + exit(0); + } + + // various files used to read input data and store results + FILE *flux; + FILE *fpart; + + // read particles + if (opts.verbose_flag) cout << "reading particles" << endl; + flux = fopen(opts.ev_name, "r"); + if (flux==NULL){ + cerr << "cannot read event '" << opts.ev_name << "'" << endl; + cerr << "specify the event to read using the -e option" << endl; + return 1; + } + + N=0; + fpart = fopen("particles.dat", "w+"); + while ((opts.N_stop!=0) && (fgets(fline, 512, flux)!=NULL)){ + if (fline[0]!='#'){ // skip lines beginning with '#' + if (sscanf(fline, "%le%le%le%le", &px, &py, &pz, &E)==4){ + particles.push_back(Cmomentum(px, py, pz, E)); + fprintf(fpart, "%e\t%e\n", particles[N].eta, particles[N].phi); + N++; + opts.N_stop--; + } else { + cout << "error in reading event file Giving up." << endl; + fclose(flux); + fclose(fpart); + exit(2); + } + } + } + fclose(flux); + fclose(fpart); + if (opts.verbose_flag) + cout << " working with " << N << " particles" << endl; + + // compute jets + if (opts.verbose_flag) cout << "computing jet contents" << endl; + i=siscone.compute_jets(particles, opts.R, opts.f, opts.npass, opts.ptmin, opts.SM_var); + if (opts.verbose_flag){ + unsigned int pass; + for (pass=0;pass +#include +#include +#include "siscone/momentum.h" +#include "siscone/siscone.h" +#include "siscone/area.h" +#include "options.h" + +using namespace std; +using namespace siscone; + +int main(int argc, char *argv[]){ + vector particles; + Carea siscone_with_area; + int i,N; + double px,py,pz,E; + Coptions opts; + char fline[512]; + + if (opts.parse_options(argc, argv)) + exit(1); + + // deal with help message + if (opts.help_flag){ + opts.print_help(); + exit(0); + } + + // deal with version flag + if (opts.version_flag){ + opts.print_version(); + exit(0); + } + + // various files used to read input data and store results + FILE *flux; + FILE *fpart; + + // read particles + if (opts.verbose_flag) cout << "reading particles" << endl; + flux = fopen(opts.ev_name, "r"); + if (flux==NULL){ + cerr << "cannot read event" << endl; + return 1; + } + + N=0; + fpart = fopen("particles.dat", "w+"); + while ((opts.N_stop!=0) && (fgets(fline, 512, flux)!=NULL)){ + if (fline[0]!='#'){ // skip lines beginning with '#' + if (sscanf(fline, "%le%le%le%le", &px, &py, &pz, &E)==4){ + particles.push_back(Cmomentum(px, py, pz, E)); + fprintf(fpart, "%e\t%e\n", particles[N].eta, particles[N].phi); + N++; + opts.N_stop--; + } else { + cout << "error in reading event file Giving up." << endl; + fclose(flux); + fclose(fpart); + exit(2); + } + } + } + fclose(flux); + fclose(fpart); + if (opts.verbose_flag) + cout << " working with " << N << " particles" << endl; + + // compute jets + if (opts.verbose_flag) cout << "computing jet contents" << endl; + i=siscone_with_area.compute_areas(particles, opts.R, opts.f, opts.npass, opts.SM_var); + if (opts.verbose_flag){ + unsigned int pass; + for (pass=0;pass::iterator ja; + for (ja=siscone_with_area.jet_areas.begin();ja!=siscone_with_area.jet_areas.end();ja++){ + fprintf(flux, "%e\t%e\t%e\t%e\t%e\n", + ja->v.perp(), ja->v.eta, ja->v.phi, + ja->active_area, ja->passive_area); + } + + fclose(flux); + + if (opts.verbose_flag) + cout << "bye..." << endl; + + return 0; +} Index: tags/siscone-3.0.4/examples/mem_check =================================================================== --- tags/siscone-3.0.4/examples/mem_check (revision 0) +++ tags/siscone-3.0.4/examples/mem_check (revision 420) @@ -0,0 +1,48 @@ +#!/bin/bash + +# this assumes that +# - you have pprof, sed, dc and awk +# - you have linked test with google profiler libraries (see src/Makefile) +get_mem_usage_event(){ + echo $i; + HEAPPROFILE=hp ./test $i + heap_file=`ls -1 *.heap | tail -n 1` + pprof --text --alloc_space --files ./test $heap_file | grep "??" > m.dat + mem_used=`awk '{print $4}' m.dat` +} + +save_to_file(){ + echo $i" "$mem_usage" "$mem_usage2 >> mem_usage.dat +} + +#rm mem_usage.dat + +get_mem_usage(){ + mem_usage=0.0 + mem_usage2=0.0 + for (( j=0 ; j<$N_runs ; j++ )); do + get_mem_usage_event + mem_usage=`echo "6 k $mem_usage $mem_used + p" | dc` + mem_usage2=`echo "6 k $mem_usage2 $mem_used $mem_used * + p" | dc` + done + mem_usage=`echo "6 k $mem_usage $N_runs / p" | dc` + mem_usage2=`echo "6 k $mem_usage2 $N_runs / $mem_usage $mem_usage * - p" | dc` + save_to_file +} + +N_runs=1000 +for (( i=10 ; i<100 ; i+=10 )); do + get_mem_usage +done +N_runs=100 +for (( i=100 ; i<1000 ; i+=50 )); do + get_mem_usage +done +N_runs=10 +for (( i=1000 ; i<5001 ; i+=500 )); do + get_mem_usage +done +#N_runs=5 +#for (( i=6000 ; i<6001 ; i+=500 )); do +# get_mem_usage +#done Property changes on: tags/siscone-3.0.4/examples/mem_check ___________________________________________________________________ Added: svn:executable ## -0,0 +1 ## +* \ No newline at end of property Index: tags/siscone-3.0.4/examples/spherical.cpp =================================================================== --- tags/siscone-3.0.4/examples/spherical.cpp (revision 0) +++ tags/siscone-3.0.4/examples/spherical.cpp (revision 420) @@ -0,0 +1,97 @@ +/////////////////////////////////////////////////////////////////////////////// +// File: spherical.cpp // +// Description: example program for the CSphsiscone class (spherical SISCone)// +// 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 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:: 227 $// +// $Date:: 2008-06-12 20:00:44 -0400 (Thu, 12 Jun 2008) $// +/////////////////////////////////////////////////////////////////////////////// + +#include +#include +#include +#include "siscone/spherical/momentum.h" +#include "siscone/spherical/siscone.h" + +#define R 0.7 +#define f 0.5 +#define f_alt 0.75 + +using namespace std; +using namespace siscone_spherical; + +int main(){ + vector particles; // list of particles + CSphsiscone siscone; // main object for the cone algorithm + int i; // loop index + int N; // number of particles + double px,py,pz,E; // particles 4-momentum + char fline[512]; // line to read from a file + + // read particles + FILE *flux; + flux = fopen("events/single-event.dat", "r"); + if (flux==NULL){ + cerr << "cannot read event" << endl; + return 1; + } + + N=0; + while (fgets(fline, 512, flux)!=NULL){ + if (fline[0]!='#'){ // skip lines beginning with '#' + if (sscanf(fline, "%le%le%le%le", &px, &py, &pz, &E)==4){ + particles.push_back(CSphmomentum(px, py, pz, E)); + N++; + } else { + cout << "error in reading event file Giving up." << endl; + fclose(flux); + return 2; + } + } + } + fclose(flux); + + // compute jets + // first compute with multiple passes (default) + i=siscone.compute_jets(particles, R, f); + cout << " " << i << " jets found in multi-pass run" << endl; + + // then, recompute it with a different f + i=siscone.recompute_jets(f_alt); + cout << " " << i << " jets found with alternative f" << endl; + + // one pass + i=siscone.compute_jets(particles, R, f, 1); + cout << " " << i << " jets found in single-pass run" << endl; + + // show jets + vector::iterator it_j; + int i1; + fprintf(stdout, "# theta phi px py pz E \n"); + for (it_j = siscone.jets.begin(), i1=0 ; + it_j != siscone.jets.end() ; it_j++, i1++){ + fprintf(stdout, "Jet %3d: %8.3f %8.3f %10.3f %10.3f %10.3f %10.3f\n", + i1, it_j->v._theta, it_j->v._phi, it_j->v.px, it_j->v.py, it_j->v.pz, it_j->v.E); + } + + return 0; +} Index: tags/siscone-3.0.4/examples/options.cpp =================================================================== --- tags/siscone-3.0.4/examples/options.cpp (revision 0) +++ tags/siscone-3.0.4/examples/options.cpp (revision 420) @@ -0,0 +1,242 @@ +/////////////////////////////////////////////////////////////////////////////// +// File: options.cpp // +// Description: management of the cmdline options of the main program // +// This file is part of the SISCone project. // +// For more details, see http://projects.hepforge.org/siscone // +// // +// Copyright (c) 2006 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:: $// +/////////////////////////////////////////////////////////////////////////////// + +#include "options.h" +#include +#include +#include + +using namespace std; +using namespace siscone; + +#define N_DEFAULT -1 +#define R_DEFAULT 0.7 +#define THRESHOLD_DEFAULT 0.5 +#define PTMIN_DEFAULT 0.0 +#define NPASS_DEFAULT 0 +#define DEFAULT_EVENT "events/single-event.dat" +#define SM_DEFAULT SM_pttilde + +/******************************************* + * Coptions implementation * + * options for the 'cone' sample * + *******************************************/ + +// default ctor +//-------------- +Coptions::Coptions(){ + // set default flags values + help_flag=0; + version_flag=0; + verbose_flag=1; + + // set default options values + N_stop = N_DEFAULT; + R = R_DEFAULT; + f = THRESHOLD_DEFAULT; + npass = NPASS_DEFAULT; + ev_name = NULL; + SM_var = SM_DEFAULT; +} + + +// default dtor +//-------------- +Coptions::~Coptions(){ + if (ev_name!=NULL) + delete[] ev_name; +} + + +// parse oprions +// - argc number of arguments from the command line +// - argv arguments from the command line +// return 1 on error, 0 on success +//--------------------------------- +int Coptions::parse_options(int argc, char **argv){ + int opt_param; + int option_index; + bool stop=false; + + // browse the command-line options{ + static struct option siscone_options[]={ + // options that set a flag + {"verbose", no_argument, &verbose_flag, 1}, + {"quiet", no_argument, &verbose_flag, 0}, + {"help", no_argument, &help_flag , 1}, + {"version", no_argument, &version_flag, 1}, + // options setting parameters + {"number", required_argument, NULL, 'N'}, + {"radius", required_argument, NULL, 'R'}, + {"fraction", required_argument, NULL, 'f'}, + {"ptmin", required_argument, NULL, 'p'}, + {"npass", required_argument, NULL, 'n'}, + {"event", required_argument, NULL, 'e'}, + {"sm", required_argument, NULL, 's'}, + {0,0,0,0} + }; + + + do{ + // getopt_long stores the option index here. + option_index=0; + + // retreive options + opt_param = getopt_long(argc, argv, "hvqN:R:f:p:n:e:s:", + siscone_options, &option_index); + + // Detect the end of the options. + if (opt_param == -1) + stop=true; + + // branch according to 'opt_param' + switch (opt_param){ + case 'h': help_flag = 1; break; // help + case 'v': verbose_flag = 1; break; // verbose + case 'q': verbose_flag = 0; break; // quiet + case 'N': // max number of paprticles + sscanf(optarg, "%d", &N_stop); + if (N_stop<=0){ + cout << "Warning: the specified number of particles must be positive. Using default one" << endl; + N_stop = N_DEFAULT; + } + break; + case 'R': + sscanf(optarg, "%lf", &R); + if (R<=0){ + cout << "Warning: the specified cone radius must be positive. Using default one" << endl; + R = R_DEFAULT; + } + break; + case 'f': + sscanf(optarg, "%lf", &f); + if ((f<0) || (f>1)){ + cout << "Warning: the specified split/merge threshold must be in [0,1]. Using default one" << endl; + f = THRESHOLD_DEFAULT; + } + break; + case 'p': + sscanf(optarg, "%lf", &ptmin); + if (ptmin<0){ + cout << "Warning: the specified minimal pT must be non-negative. Using default one" << endl; + ptmin = PTMIN_DEFAULT; + } + break; + case 'n': // max number of paprticles + sscanf(optarg, "%d", &npass); + if (npass<0){ + cout << "Warning: the specified number of passes must be non negative. Using default one" << endl; + npass = NPASS_DEFAULT; + } + break; + case 'e': + if (ev_name==NULL){ + ev_name = new char[strlen(optarg)+1]; + strcpy(ev_name, optarg); + } + break; + case 's': + char tmp[512]; + strcpy(tmp, optarg); + if (strcmp(tmp, "pttilde")==0){ + SM_var = SM_pttilde; + } else if (strcmp(tmp, "mt")==0){ + SM_var = SM_mt; + } else if (strcmp(tmp, "pt")==0){ + SM_var = SM_pt; + } else if (strcmp(tmp, "Et")==0){ + SM_var = SM_Et; + } else { + cout << "Warning: the specified varible for split--merge is not valid (should be pttilde, pt, mt or Et). Using pttilde as the default one." << endl; + SM_var = SM_pttilde; + } + break; + case 0: + case -1: + break; + case '?': + fprintf(stderr, "Giving up.\n"); + return 1; + break; + default: + if (!help_flag){ + fprintf(stderr, "unrecognized option %c. Giving up.\n", opt_param); + return 1; + } + } + } while (!stop); + + if (ev_name==NULL){ + ev_name = new char[strlen(DEFAULT_EVENT)+1]; + strcpy(ev_name, DEFAULT_EVENT); + } + + return 0; +} + + +// print the help message +//------------------------ +int Coptions::print_help(){ + cout << siscone_package_name() << " " << siscone_version() << endl; + cout << "Usage: " << siscone_package_name() << " " << endl; + cout << endl; + cout << "Here is an exhaustive list of the arguments:" << endl; + cout << "Parameters control (with default values):" << endl; + cout << " -n , --number= : set the maximum number of particles allowed (all)" << endl; + cout << " -R , --radius= : set the radius (" << R_DEFAULT << ")" << endl; + cout << " -f , --fraction=: set the overlap parameter (" << THRESHOLD_DEFAULT << ")" << endl; + cout << " -p , --ptmin= : set the minimal pT for protojets (" << PTMIN_DEFAULT << ")" << endl; + cout << " -n , --npass= : set the maximal number of passes (0 for no limit) (" << NPASS_DEFAULT << ")" << endl; + cout << " -e , --event= : set the event filename (" << DEFAULT_EVENT << ")" << endl; + cout << " -s , --sm= : variable for split--merge: pttilde, mt, pt or Et (pttilde)" << endl; + cout << endl; + cout << "Output flags" << endl; + cout << " --version : show version information" << endl; + cout << " -h, --help : show this message" << endl; + cout << " -v, --verbose: be verbose (on by default)" << endl; + cout << " -q, --quiet : be quiet" << endl; + cout << endl; + + return 0; +} + + +// print program version +//----------------------- +int Coptions::print_version(){ + cout << siscone_package_name() << " " << siscone_version() << endl; + cout << "Copyright (C) 2006." << endl; + cout << siscone_package_name() << " comes with NO WARRANTY," << endl; + cout << "to the extent permitted by law." << endl; + cout << "You may redistribute copies of " << siscone_package_name() << endl; + cout << "under the terms of the GNU General Public License." << endl; + cout << "For more information about these matters," << endl; + cout << "see the files named COPYING." << endl; + cout << "Please send bugs or comments to AUTHORS" << endl; + + return 0; +} Property changes on: tags/siscone-3.0.4/examples/options.cpp ___________________________________________________________________ Added: svn:keywords ## -0,0 +1 ## +Date Rev \ No newline at end of property Index: tags/siscone-3.0.4/examples/test.cpp =================================================================== --- tags/siscone-3.0.4/examples/test.cpp (revision 0) +++ tags/siscone-3.0.4/examples/test.cpp (revision 420) @@ -0,0 +1,119 @@ +/////////////////////////////////////////////////////////////////////////////// +// File: test.cpp // +// Description: example program that implements tests with random particles // +// and output various informations // +// // +// Note: for a usage example of SISCone, we advise looking at main.cpp // +// or http://projects.hepforge.org/siscone/usage.html // +// // +// This file is part of the SISCone project. // +// For more details, see http://projects.hepforge.org/siscone // +// // +// Copyright (c) 2006 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:: $// +/////////////////////////////////////////////////////////////////////////////// + +#include +#include +#include +#include +#include +#include + +#include "siscone/momentum.h" +#include "siscone/siscone.h" + +#define N_default 500 +#define R 0.7 +#define F 0.75 + +using namespace std; +using namespace siscone; + +int main(int argc, char* argv[]){ + vector particles; + Cmomentum *v; + double phi=0, eta=0, pt=1; + unsigned int N; + + unsigned int i; + FILE *flux; + + if (argc==1){ + //cout << "using default number of particles" << endl; + N = N_default; + } else { + sscanf(argv[1], "%u", &N); + //cout << "using " << N << " particles" << endl; + } + + // Initialise random number generator + timeval timestamp; + gettimeofday(×tamp, NULL); + srand(timestamp.tv_usec); + + // build particle list + cout << "build particle list" << endl; + flux = fopen("particles.dat", "w+"); + for (i=0;ieta, v->phi, v->perp()); + } + } + fclose(flux); + + cout << "bye..." << endl; + + return 0; +} Property changes on: tags/siscone-3.0.4/examples/test.cpp ___________________________________________________________________ Added: svn:keywords ## -0,0 +1 ## +Date Rev \ No newline at end of property Index: tags/siscone-3.0.4/examples/options.h =================================================================== --- tags/siscone-3.0.4/examples/options.h (revision 0) +++ tags/siscone-3.0.4/examples/options.h (revision 420) @@ -0,0 +1,74 @@ +/////////////////////////////////////////////////////////////////////////////// +// File: options.h // +// Description: management of the cmdline options of the main program // +// This file is part of the SISCone project. // +// For more details, see http://projects.hepforge.org/siscone // +// // +// Copyright (c) 2006 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 __OPTIONS_H__ +#define __OPTIONS_H__ + +#include "siscone/siscone.h" + +/** + * \class Coptions + + * options for the 'cone' sample + */ +class Coptions{ + public: + /// default ctor + Coptions(); + + /// default dtor + ~Coptions(); + + /// parse oprions + /// \param argc number of arguments from the command line + /// \param argv arguments from the command line + /// \return 1 on error, 0 on success + int parse_options(int argc, char **argv); + + /// print the help message + int print_help(); + + /// print program version + int print_version(); + + // flags + int help_flag; ///< do we need to print the help message + int version_flag; ///< do we need to print the version description + int verbose_flag; ///< do we need to print the help message + + // options + int N_stop; ///< maximum number of particle + double R; ///< cone radius + double f; ///< split/merge threshold + double ptmin; ///< minimal pT for jet candidates + char *ev_name; ///< event to read + int npass; ///< number of passes (0 for \infty) + + /// variable for split-merge + siscone::Esplit_merge_scale SM_var; +}; + +#endif Property changes on: tags/siscone-3.0.4/examples/options.h ___________________________________________________________________ Added: svn:keywords ## -0,0 +1 ## +Date Rev \ No newline at end of property Index: tags/siscone-3.0.4/examples =================================================================== --- tags/siscone-3.0.4/examples (revision 419) +++ tags/siscone-3.0.4/examples (revision 420) Property changes on: tags/siscone-3.0.4/examples ___________________________________________________________________ Added: svn:ignore ## -0,0 +1,17 ## +*.dat +test +sample +times +siscone + +Makefile.in + +Makefile + +.deps + +siscone_area + +spherical + +.libs Index: tags/siscone-3.0.4/m4/ax_prefix_config_h.m4 =================================================================== --- tags/siscone-3.0.4/m4/ax_prefix_config_h.m4 (revision 0) +++ tags/siscone-3.0.4/m4/ax_prefix_config_h.m4 (revision 420) @@ -0,0 +1,215 @@ +# =========================================================================== +# http://autoconf-archive.cryp.to/ax_prefix_config_h.html +# =========================================================================== +# +# SYNOPSIS +# +# AX_PREFIX_CONFIG_H [(OUTPUT-HEADER [,PREFIX [,ORIG-HEADER]])] +# +# DESCRIPTION +# +# This is a new variant from ac_prefix_config_ this one will use a +# lowercase-prefix if the config-define was starting with a +# lowercase-char, e.g. "#define const", "#define restrict", or "#define +# off_t", (and this one can live in another directory, e.g. +# testpkg/config.h therefore I decided to move the output-header to be the +# first arg) +# +# takes the usual config.h generated header file; looks for each of the +# generated "#define SOMEDEF" lines, and prefixes the defined name (ie. +# makes it "#define PREFIX_SOMEDEF". The result is written to the output +# config.header file. The PREFIX is converted to uppercase for the +# conversions. +# +# Defaults: +# +# OUTPUT-HEADER = $PACKAGE-config.h +# PREFIX = $PACKAGE +# ORIG-HEADER, from AM_CONFIG_HEADER(config.h) +# +# Your configure.ac script should contain both macros in this order, and +# unlike the earlier variations of this prefix-macro it is okay to place +# the AX_PREFIX_CONFIG_H call before the AC_OUTPUT invokation. +# +# Example: +# +# AC_INIT(config.h.in) # config.h.in as created by "autoheader" +# AM_INIT_AUTOMAKE(testpkg, 0.1.1) # makes #undef VERSION and PACKAGE +# AM_CONFIG_HEADER(config.h) # prep config.h from config.h.in +# AX_PREFIX_CONFIG_H(mylib/_config.h) # prep mylib/_config.h from it.. +# AC_MEMORY_H # makes "#undef NEED_MEMORY_H" +# AC_C_CONST_H # makes "#undef const" +# AC_OUTPUT(Makefile) # creates the "config.h" now +# # and also mylib/_config.h +# +# if the argument to AX_PREFIX_CONFIG_H would have been omitted then the +# default outputfile would have been called simply "testpkg-config.h", but +# even under the name "mylib/_config.h" it contains prefix-defines like +# +# #ifndef TESTPKG_VERSION +# #define TESTPKG_VERSION "0.1.1" +# #endif +# #ifndef TESTPKG_NEED_MEMORY_H +# #define TESTPKG_NEED_MEMORY_H 1 +# #endif +# #ifndef _testpkg_const +# #define _testpkg_const _const +# #endif +# +# and this "mylib/_config.h" can be installed along with other +# header-files, which is most convenient when creating a shared library +# (that has some headers) where some functionality is dependent on the +# OS-features detected at compile-time. No need to invent some +# "mylib-confdefs.h.in" manually. :-) +# +# Note that some AC_DEFINEs that end up in the config.h file are actually +# self-referential - e.g. AC_C_INLINE, AC_C_CONST, and the AC_TYPE_OFF_T +# say that they "will define inline|const|off_t if the system does not do +# it by itself". You might want to clean up about these - consider an +# extra mylib/conf.h that reads something like: +# +# #include +# #ifndef _testpkg_const +# #define _testpkg_const const +# #endif +# +# and then start using _testpkg_const in the header files. That is also a +# good thing to differentiate whether some library-user has starting to +# take up with a different compiler, so perhaps it could read something +# like this: +# +# #ifdef _MSC_VER +# #include +# #else +# #include +# #endif +# #ifndef _testpkg_const +# #define _testpkg_const const +# #endif +# +# LICENSE +# +# Copyright (c) 2008 Guido U. Draheim +# Copyright (c) 2008 Marten Svantesson +# Copyright (c) 2008 Gerald Point +# +# 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, see . +# +# As a special exception, the respective Autoconf Macro's copyright owner +# gives unlimited permission to copy, distribute and modify the configure +# scripts that are the output of Autoconf when processing the Macro. You +# need not follow the terms of the GNU General Public License when using +# or distributing such scripts, even though portions of the text of the +# Macro appear in them. The GNU General Public License (GPL) does govern +# all other use of the material that constitutes the Autoconf Macro. +# +# This special exception to the GPL applies to versions of the Autoconf +# Macro released by the Autoconf Archive. When you make and distribute a +# modified version of the Autoconf Macro, you may extend this special +# exception to the GPL to apply to your modified version as well. + +AC_DEFUN([AX_PREFIX_CONFIG_H],[dnl +AC_BEFORE([AC_CONFIG_HEADERS],[$0])dnl +AC_CONFIG_COMMANDS([ifelse($1,,$PACKAGE-config.h,$1)],[dnl +AS_VAR_PUSHDEF([_OUT],[ac_prefix_conf_OUT])dnl +AS_VAR_PUSHDEF([_DEF],[ac_prefix_conf_DEF])dnl +AS_VAR_PUSHDEF([_PKG],[ac_prefix_conf_PKG])dnl +AS_VAR_PUSHDEF([_LOW],[ac_prefix_conf_LOW])dnl +AS_VAR_PUSHDEF([_UPP],[ac_prefix_conf_UPP])dnl +AS_VAR_PUSHDEF([_INP],[ac_prefix_conf_INP])dnl +m4_pushdef([_script],[conftest.prefix])dnl +m4_pushdef([_symbol],[m4_cr_Letters[]m4_cr_digits[]_])dnl +_OUT=`echo ifelse($1, , $PACKAGE-config.h, $1)` +_DEF=`echo _$_OUT | sed -e "y:m4_cr_letters:m4_cr_LETTERS[]:" -e "s/@<:@^m4_cr_Letters@:>@/_/g"` +_PKG=`echo ifelse($2, , $PACKAGE, $2)` +_LOW=`echo _$_PKG | sed -e "y:m4_cr_LETTERS-:m4_cr_letters[]_:"` +_UPP=`echo $_PKG | sed -e "y:m4_cr_letters-:m4_cr_LETTERS[]_:" -e "/^@<:@m4_cr_digits@:>@/s/^/_/"` +_INP=`echo "ifelse($3,,,$3)" | sed -e 's/ *//'` +if test ".$_INP" = "."; then + for ac_file in : $CONFIG_HEADERS; do test "_$ac_file" = _: && continue + case "$ac_file" in + *.h) _INP=$ac_file ;; + *) + esac + test ".$_INP" != "." && break + done +fi +if test ".$_INP" = "."; then + case "$_OUT" in + */*) _INP=`basename "$_OUT"` + ;; + *-*) _INP=`echo "$_OUT" | sed -e "s/@<:@_symbol@:>@*-//"` + ;; + *) _INP=config.h + ;; + esac +fi +if test -z "$_PKG" ; then + AC_MSG_ERROR([no prefix for _PREFIX_PKG_CONFIG_H]) +else + if test ! -f "$_INP" ; then if test -f "$srcdir/$_INP" ; then + _INP="$srcdir/$_INP" + fi fi + AC_MSG_NOTICE(creating $_OUT - prefix $_UPP for $_INP defines) + if test -f $_INP ; then + echo "s/^@%:@undef *\\(@<:@m4_cr_LETTERS[]_@:>@\\)/@%:@undef $_UPP""_\\1/" > _script + echo "s/^@%:@undef *\\(@<:@m4_cr_letters@:>@\\)/@%:@undef $_LOW""_\\1/" >> _script + echo "s/^@%:@def[]ine *\\(@<:@m4_cr_LETTERS[]_@:>@@<:@_symbol@:>@*\\)\\(.*\\)/@%:@ifndef $_UPP""_\\1 \\" >> _script + echo "@%:@def[]ine $_UPP""_\\1 \\2 \\" >> _script + echo "@%:@endif/" >>_script + echo "s/^@%:@def[]ine *\\(@<:@m4_cr_letters@:>@@<:@_symbol@:>@*\\)\\(.*\\)/@%:@ifndef $_LOW""_\\1 \\" >> _script + echo "@%:@define $_LOW""_\\1 \\2 \\" >> _script + echo "@%:@endif/" >> _script + # now executing _script on _DEF input to create _OUT output file + echo "@%:@ifndef $_DEF" >$tmp/pconfig.h + echo "@%:@def[]ine $_DEF 1" >>$tmp/pconfig.h + echo ' ' >>$tmp/pconfig.h + echo /'*' $_OUT. Generated automatically at end of configure. '*'/ >>$tmp/pconfig.h + + sed -f _script $_INP >>$tmp/pconfig.h + echo ' ' >>$tmp/pconfig.h + echo '/* once:' $_DEF '*/' >>$tmp/pconfig.h + echo "@%:@endif" >>$tmp/pconfig.h + if cmp -s $_OUT $tmp/pconfig.h 2>/dev/null; then + AC_MSG_NOTICE([$_OUT is unchanged]) + else + ac_dir=`AS_DIRNAME(["$_OUT"])` + AS_MKDIR_P(["$ac_dir"]) + rm -f "$_OUT" + mv $tmp/pconfig.h "$_OUT" + fi + cp _script _configs.sed + else + AC_MSG_ERROR([input file $_INP does not exist - skip generating $_OUT]) + fi + rm -f conftest.* +fi +m4_popdef([_symbol])dnl +m4_popdef([_script])dnl +AS_VAR_POPDEF([_INP])dnl +AS_VAR_POPDEF([_UPP])dnl +AS_VAR_POPDEF([_LOW])dnl +AS_VAR_POPDEF([_PKG])dnl +AS_VAR_POPDEF([_DEF])dnl +AS_VAR_POPDEF([_OUT])dnl +],[PACKAGE="$PACKAGE"])]) + +dnl implementation note: a bug report (31.5.2005) from Marten Svantesson points +dnl out a problem where `echo "\1"` results in a Control-A. The unix standard +dnl http://www.opengroup.org/onlinepubs/000095399/utilities/echo.html +dnl defines all backslash-sequences to be inherently non-portable asking +dnl for replacement mit printf. Some old systems had problems with that +dnl one either. However, the latest libtool (!) release does export an $ECHO +dnl (and $echo) that does the right thing - just one question is left: what +dnl was the first version to have it? Is it greater 2.58 ? Index: tags/siscone-3.0.4/Doxyfile =================================================================== --- tags/siscone-3.0.4/Doxyfile (revision 0) +++ tags/siscone-3.0.4/Doxyfile (revision 420) @@ -0,0 +1,2355 @@ +# Doxyfile 1.8.8 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = SISCone + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = 3.0.4 + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in +# the documentation. The maximum height of the logo should not exceed 55 pixels +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo +# to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = doc/devel + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = YES + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a +# new page for each member. If set to NO, the documentation of a member will be +# part of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by by putting a % sign in front of the word +# or globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO these classes will be included in the various overviews. This option has +# no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the +# todo list. This list is created by putting \todo commands in the +# documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the +# test list. This list is created by putting \test commands in the +# documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES the list +# will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO doxygen will only warn about wrong or incomplete parameter +# documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. + +INPUT = + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = doc \ + src/old \ + tests \ + timings + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER ) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = YES + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# compiled with the --with-libclang option. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = NO + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = doc/devel/html/footer.html + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefor more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra stylesheet files is of importance (e.g. the last +# stylesheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the stylesheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated ( +# YES) or that it should be included in the master .chm file ( NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated ( +# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /