Index: contrib/contribs/EnergyCorrelator/tags/1.3.2/EnergyCorrelator.cc =================================================================== --- contrib/contribs/EnergyCorrelator/tags/1.3.2/EnergyCorrelator.cc (revision 0) +++ contrib/contribs/EnergyCorrelator/tags/1.3.2/EnergyCorrelator.cc (revision 1393) @@ -0,0 +1,1091 @@ +// EnergyCorrelator Package +// Questions/Comments? Email the authors: +// larkoski@mit.edu, lnecib@mit.edu, +// gavin.salam@cern.ch jthaler@jthaler.net +// +// Copyright (c) 2013-2016 +// Andrew Larkoski, Lina Necib, Gavin Salam, and Jesse Thaler +// +// $Id$ +//---------------------------------------------------------------------- +// This file is part of FastJet contrib. +// +// It 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. +// +// It 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 code. If not, see . +//---------------------------------------------------------------------- + +#include "EnergyCorrelator.hh" +#include +#include +using namespace std; + +FASTJET_BEGIN_NAMESPACE // defined in fastjet/internal/base.hh + +namespace contrib { + + double EnergyCorrelator::result(const PseudoJet& jet) const { + + // if jet does not have constituents, throw error + if (!jet.has_constituents()) throw Error("EnergyCorrelator called on jet with no constituents."); + + // get N = 0 case out of the way + if (_N == 0) return 1.0; + + // find constituents + std::vector particles = jet.constituents(); + + // return zero if the number of constituents is less than _N + if (particles.size() < _N) return 0.0 ; + + double answer = 0.0; + + // take care of N = 1 case. + if (_N == 1) { + for (unsigned int i = 0; i < particles.size(); i++) { + answer += energy(particles[i]); + } + return answer; + } + + double half_beta = _beta/2.0; + + // take care of N = 2 case. + if (_N == 2) { + for (unsigned int i = 0; i < particles.size(); i++) { + for (unsigned int j = i + 1; j < particles.size(); j++) { //note offset by one so that angle is never called on identical pairs + answer += energy(particles[i]) + * energy(particles[j]) + * pow(angleSquared(particles[i],particles[j]), half_beta); + } + } + return answer; + } + + + // if N > 5, then throw error + if (_N > 5) { + throw Error("EnergyCorrelator is only hard coded for N = 0,1,2,3,4,5"); + } + + + // Now deal with N = 3,4,5. Different options if storage array is used or not. + if (_strategy == storage_array) { + + // For N > 2, fill static storage array to save computation time. + unsigned int nC = particles.size(); + // Make energy storage + double *energyStore = new double[nC]; + + // Make angular storage + double **angleStore = new double*[nC]; + + precompute_energies_and_angles(particles, energyStore, angleStore); + + // Define n_angles so it is the same function for ECFs and ECFGs + unsigned int n_angles = _N * (_N - 1) / 2; + // now do recursion + if (_N == 3) { + answer = evaluate_n3(nC, n_angles, energyStore, angleStore); + } else if (_N == 4) { + answer = evaluate_n4(nC, n_angles, energyStore, angleStore); + } else if (_N == 5) { + answer = evaluate_n5(nC, n_angles, energyStore, angleStore); + } else { + assert(_N <= 5); + } + // Deleting arrays + delete[] energyStore; + + for (unsigned int i = 0; i < particles.size(); i++) { + delete[] angleStore[i]; + } + delete[] angleStore; + + } else if (_strategy == slow) { + if (_N == 3) { + for (unsigned int i = 0; i < particles.size(); i++) { + for (unsigned int j = i + 1; j < particles.size(); j++) { + double ans_ij = energy(particles[i]) + * energy(particles[j]) + * pow(angleSquared(particles[i],particles[j]), half_beta); + for (unsigned int k = j + 1; k < particles.size(); k++) { + answer += ans_ij + * energy(particles[k]) + * pow(angleSquared(particles[i],particles[k]), half_beta) + * pow(angleSquared(particles[j],particles[k]), half_beta); + } + } + } + } else if (_N == 4) { + for (unsigned int i = 0; i < particles.size(); i++) { + for (unsigned int j = i + 1; j < particles.size(); j++) { + double ans_ij = energy(particles[i]) + * energy(particles[j]) + * pow(angleSquared(particles[i],particles[j]), half_beta); + for (unsigned int k = j + 1; k < particles.size(); k++) { + double ans_ijk = ans_ij + * energy(particles[k]) + * pow(angleSquared(particles[i],particles[k]), half_beta) + * pow(angleSquared(particles[j],particles[k]), half_beta); + for (unsigned int l = k + 1; l < particles.size(); l++) { + answer += ans_ijk + * energy(particles[l]) + * pow(angleSquared(particles[i],particles[l]), half_beta) + * pow(angleSquared(particles[j],particles[l]), half_beta) + * pow(angleSquared(particles[k],particles[l]), half_beta); + } + } + } + } + } else if (_N == 5) { + for (unsigned int i = 0; i < particles.size(); i++) { + for (unsigned int j = i + 1; j < particles.size(); j++) { + double ans_ij = energy(particles[i]) + * energy(particles[j]) + * pow(angleSquared(particles[i],particles[j]), half_beta); + for (unsigned int k = j + 1; k < particles.size(); k++) { + double ans_ijk = ans_ij + * energy(particles[k]) + * pow(angleSquared(particles[i],particles[k]), half_beta) + * pow(angleSquared(particles[j],particles[k]), half_beta); + for (unsigned int l = k + 1; l < particles.size(); l++) { + double ans_ijkl = ans_ijk + * energy(particles[l]) + * pow(angleSquared(particles[i],particles[l]), half_beta) + * pow(angleSquared(particles[j],particles[l]), half_beta) + * pow(angleSquared(particles[k],particles[l]), half_beta); + for (unsigned int m = l + 1; m < particles.size(); m++) { + answer += ans_ijkl + * energy(particles[m]) + * pow(angleSquared(particles[i],particles[m]), half_beta) + * pow(angleSquared(particles[j],particles[m]), half_beta) + * pow(angleSquared(particles[k],particles[m]), half_beta) + * pow(angleSquared(particles[l],particles[m]), half_beta); + } + } + } + } + } + } else { + assert(_N <= 5); + } + } else { + assert(_strategy == slow || _strategy == storage_array); + } + + return answer; + } + + double EnergyCorrelator::energy(const PseudoJet& jet) const { + if (_measure == pt_R) { + return jet.perp(); + } else if (_measure == E_theta || _measure == E_inv) { + return jet.e(); + } else { + assert(_measure==pt_R || _measure==E_theta || _measure==E_inv); + return std::numeric_limits::quiet_NaN(); + } + } + + double EnergyCorrelator::angleSquared(const PseudoJet& jet1, const PseudoJet& jet2) const { + if (_measure == pt_R) { + return jet1.squared_distance(jet2); + } else if (_measure == E_theta) { + // doesn't seem to be a fastjet built in for this + double dot = jet1.px()*jet2.px() + jet1.py()*jet2.py() + jet1.pz()*jet2.pz(); + double norm1 = jet1.px()*jet1.px() + jet1.py()*jet1.py() + jet1.pz()*jet1.pz(); + double norm2 = jet2.px()*jet2.px() + jet2.py()*jet2.py() + jet2.pz()*jet2.pz(); + + double costheta = dot/(sqrt(norm1 * norm2)); + if (costheta > 1.0) costheta = 1.0; // Need to handle case of numerical overflow + double theta = acos(costheta); + return theta*theta; + + } else if (_measure == E_inv) { + if (jet1.E() < 0.0000001 || jet2.E() < 0.0000001) return 0.0; + else { + double dot4 = max(jet1.E()*jet2.E() - jet1.px()*jet2.px() - jet1.py()*jet2.py() - jet1.pz()*jet2.pz(),0.0); + return 2.0 * dot4 / jet1.E() / jet2.E(); + } + } else { + assert(_measure==pt_R || _measure==E_theta || _measure==E_inv); + return std::numeric_limits::quiet_NaN(); + } + } + + + double EnergyCorrelator::multiply_angles(double angle_list[], int n_angles, unsigned int N_total) const { + // Compute the product of the n_angles smallest angles. + // std::partial_sort could also work, but since angle_list contains + // less than 10 elements, this way is usually faster. + double product = 1; + + for (int a = 0; a < n_angles; a++) { + double cur_min = angle_list[0]; + int cur_min_pos = 0; + for (unsigned int b = 1; b < N_total; b++) { + if (angle_list[b] < cur_min) { + cur_min = angle_list[b]; + cur_min_pos = b; + } + } + + // multiply it by the next smallest + product *= cur_min; + angle_list[cur_min_pos] = INT_MAX; + } + return product; + } + + void EnergyCorrelator::precompute_energies_and_angles(std::vector const &particles, double* energyStore, double** angleStore) const { + // Fill storage with energy/angle information + unsigned int nC = particles.size(); + for (unsigned int i = 0; i < nC; i++) { + angleStore[i] = new double[i]; + } + + double half_beta = _beta/2.0; + for (unsigned int i = 0; i < particles.size(); i++) { + energyStore[i] = energy(particles[i]); + for (unsigned int j = 0; j < i; j++) { + if (half_beta == 1.0){ + angleStore[i][j] = angleSquared(particles[i], particles[j]); + } else { + angleStore[i][j] = pow(angleSquared(particles[i], particles[j]), half_beta); + } + } + } + } + + double EnergyCorrelator::evaluate_n3(unsigned int nC, unsigned int n_angles, double* energyStore, double** angleStore) const { + unsigned int N_total = 3; + double angle1, angle2, angle3; + double angle; + double answer = 0; + + for (unsigned int i = 2; i < nC; i++) { + for (unsigned int j = 1; j < i; j++) { + double mult_energy_i_j = energyStore[i] * energyStore[j]; + + for (unsigned int k = 0; k < j; k++) { + angle1 = angleStore[i][j]; + angle2 = angleStore[i][k]; + angle3 = angleStore[j][k]; + + double angle_list[] = {angle1, angle2, angle3}; + + if (n_angles == N_total) { + angle = angle1 * angle2 * angle3; + } else { + angle = multiply_angles(angle_list, n_angles, N_total); + } + + answer += mult_energy_i_j + * energyStore[k] + * angle; + } + } + } + return answer; + } + + double EnergyCorrelator::evaluate_n4(unsigned int nC, unsigned int n_angles, double* energyStore, double** angleStore) const { + double answer = 0; + double angle1, angle2, angle3, angle4, angle5, angle6; + unsigned int N_total = 6; + double angle; + + for (unsigned int i = 3; i < nC; i++) { + for (unsigned int j = 2; j < i; j++) { + for (unsigned int k = 1; k < j; k++) { + for (unsigned int l = 0; l < k; l++) { + + angle1 = angleStore[i][j]; + angle2 = angleStore[i][k]; + angle3 = angleStore[i][l]; + angle4 = angleStore[j][k]; + angle5 = angleStore[j][l]; + angle6 = angleStore[k][l]; + + double angle_list[] = {angle1, angle2, angle3, angle4, angle5, angle6}; + + if (n_angles == N_total) { + angle = angle1 * angle2 * angle3 * angle4 * angle5 * angle6; + } else { + angle = multiply_angles(angle_list, n_angles, N_total); + } + + answer += energyStore[i] + * energyStore[j] + * energyStore[k] + * energyStore[l] + * angle; + } + } + } + } + return answer; + } + + double EnergyCorrelator::evaluate_n5(unsigned int nC, unsigned int n_angles, double* energyStore, double** angleStore) const { + + double answer = 0; + double angle1, angle2, angle3, angle4, angle5, angle6, angle7, angle8, angle9, angle10; + unsigned int N_total = 10; + double angle; + + for (unsigned int i = 4; i < nC; i++) { + for (unsigned int j = 3; j < i; j++) { + for (unsigned int k = 2; k < j; k++) { + for (unsigned int l = 1; l < k; l++) { + for (unsigned int m = 0; m < l; m++) { + + angle1 = angleStore[i][j]; + angle2 = angleStore[i][k]; + angle3 = angleStore[i][l]; + angle4 = angleStore[i][m]; + angle5 = angleStore[j][k]; + angle6 = angleStore[j][l]; + angle7 = angleStore[j][m]; + angle8 = angleStore[k][l]; + angle9 = angleStore[k][m]; + angle10 = angleStore[l][m]; + + double angle_list[] = {angle1, angle2, angle3, angle4, angle5, angle6, angle7, angle8, + angle9, angle10}; + + angle = multiply_angles(angle_list, n_angles, N_total); + + answer += energyStore[i] + * energyStore[j] + * energyStore[k] + * energyStore[l] + * energyStore[m] + * angle; + } + } + } + } + } + return answer; + } + + + + double EnergyCorrelatorGeneralized::multiply_angles(double angle_list[], int n_angles, unsigned int N_total) const { + + return _helper_correlator.multiply_angles(angle_list, n_angles, N_total); + } + + void EnergyCorrelatorGeneralized::precompute_energies_and_angles(std::vector const &particles, double* energyStore, double** angleStore) const { + + return _helper_correlator.precompute_energies_and_angles(particles, energyStore, angleStore); + } + + double EnergyCorrelatorGeneralized::evaluate_n3(unsigned int nC, unsigned int n_angles, double* energyStore, double** angleStore) const { + + return _helper_correlator.evaluate_n3(nC, n_angles, energyStore, angleStore); + } + + double EnergyCorrelatorGeneralized::evaluate_n4(unsigned int nC, unsigned int n_angles, double* energyStore, double** angleStore) const { + + return _helper_correlator.evaluate_n4(nC, n_angles, energyStore, angleStore); + } + + double EnergyCorrelatorGeneralized::evaluate_n5(unsigned int nC, unsigned int n_angles, double* energyStore, double** angleStore) const { + + return _helper_correlator.evaluate_n5(nC, n_angles, energyStore, angleStore); + } + + double EnergyCorrelatorGeneralized::result(const PseudoJet& jet) const { + + // if jet does not have constituents, throw error + if (!jet.has_constituents()) throw Error("EnergyCorrelator called on jet with no constituents."); + + // Throw an error if N < 0 + // Not needed if N is unsigned integer + //if (_N < 0 ) throw Error("N cannot be negative"); + // get N = 0 case out of the way + if (_N == 0) return 1.0; + + // take care of N = 1 case. + if (_N == 1) return 1.0; + + // find constituents + std::vector particles = jet.constituents(); + double answer = 0.0; + + // return zero if the number of constituents is less than _N for the ECFG + if (particles.size() < _N) return 0.0 ; + + // The normalization is the energy or pt of the jet, which is also ECF(1, beta) + double EJ = _helper_correlator.result(jet); + + // The overall normalization + double norm = pow(EJ, _N); + + // Find the max number of angles and throw an error if unsuitable + int N_total = int(_N*(_N-1)/2); + if (_angles > N_total) throw Error("Requested number of angles for EnergyCorrelatorGeneralized is larger than number of angles available"); + if (_angles < -1) throw Error("Negative number of angles called for EnergyCorrelatorGeneralized"); + + double half_beta = _beta/2.0; + + // take care of N = 2 case. + if (_N == 2) { + for (unsigned int i = 0; i < particles.size(); i++) { + for (unsigned int j = i + 1; j < particles.size(); j++) { //note offset by one so that angle is never called on identical pairs + answer += energy(particles[i]) + * energy(particles[j]) + * pow(angleSquared(particles[i],particles[j]), half_beta)/norm; + } + } + return answer; + } + + + // if N > 4, then throw error + if (_N > 5) { + throw Error("EnergyCorrelatorGeneralized is only hard coded for N = 0,1,2,3,4,5"); + } + + // Now deal with N = 3,4,5. Different options if storage array is used or not. + if (_strategy == EnergyCorrelator::storage_array) { + + // For N > 2, fill static storage array to save computation time. + + unsigned int nC = particles.size(); + // Make energy storage +// double energyStore[nC]; + double *energyStore = new double[nC]; + + // Make angular storage +// double angleStore[nC][nC]; + double **angleStore = new double*[nC]; + + precompute_energies_and_angles(particles, energyStore, angleStore); + + unsigned int n_angles = _angles; + if (_angles < 0) { + n_angles = N_total; + } + + // now do recursion + if (_N == 3) { + answer = evaluate_n3(nC, n_angles, energyStore, angleStore) / norm; + } else if (_N == 4) { + answer = evaluate_n4(nC, n_angles, energyStore, angleStore) / norm; + } else if (_N == 5) { + answer = evaluate_n5(nC, n_angles, energyStore, angleStore) / norm; + } else { + assert(_N <= 5); + } + // Deleting arrays + delete[] energyStore; + + for (unsigned int i = 0; i < particles.size(); i++) { + delete[] angleStore[i]; + } + delete[] angleStore; + } else if (_strategy == EnergyCorrelator::slow) { + if (_N == 3) { + unsigned int N_total = 3; + double angle1, angle2, angle3; + double angle; + + for (unsigned int i = 0; i < particles.size(); i++) { + for (unsigned int j = i + 1; j < particles.size(); j++) { + for (unsigned int k = j + 1; k < particles.size(); k++) { + + angle1 = angleSquared(particles[i], particles[j]); + angle2 = angleSquared(particles[i], particles[k]); + angle3 = angleSquared(particles[j], particles[k]); + + if (_angles == -1){ + angle = angle1*angle2*angle3; + } else { + double angle_list[] = {angle1, angle2, angle3}; + std::vector angle_vector(angle_list, angle_list + N_total); + std::sort(angle_vector.begin(), angle_vector.begin() + N_total); + + angle = angle_vector[0]; + for ( int l = 1; l < _angles; l++) { angle = angle * angle_vector[l]; } + } + answer += energy(particles[i]) + * energy(particles[j]) + * energy(particles[k]) + * pow(angle, half_beta) /norm; + } + } + } + } else if (_N == 4) { + double angle1, angle2, angle3, angle4, angle5, angle6; + unsigned int N_total = 6; + double angle; + + for (unsigned int i = 0; i < particles.size(); i++) { + for (unsigned int j = i + 1; j < particles.size(); j++) { + for (unsigned int k = j + 1; k < particles.size(); k++) { + for (unsigned int l = k + 1; l < particles.size(); l++) { + + angle1 = angleSquared(particles[i], particles[j]); + angle2 = angleSquared(particles[i], particles[k]); + angle3 = angleSquared(particles[i], particles[l]); + angle4 = angleSquared(particles[j], particles[k]); + angle5 = angleSquared(particles[j], particles[l]); + angle6 = angleSquared(particles[k], particles[l]); + + if(_angles == -1) { + angle = angle1*angle2*angle3*angle4*angle5*angle6; + } else { + + double angle_list[] = {angle1, angle2, angle3, angle4, angle5, angle6}; + std::vector angle_vector(angle_list, angle_list + N_total); + std::sort(angle_vector.begin(), angle_vector.begin() + N_total); + + angle = angle_vector[0]; + for ( int s = 1; s < _angles; s++) { angle = angle * angle_vector[s]; } + + } + answer += energy(particles[i]) + * energy(particles[j]) + * energy(particles[k]) + * energy(particles[l]) + * pow(angle, half_beta)/norm; + } + } + } + } + } else if (_N == 5) { + double angle1, angle2, angle3, angle4, angle5, angle6, angle7, angle8, angle9, angle10; + unsigned int N_total = 10; + double angle; + + for (unsigned int i = 0; i < particles.size(); i++) { + for (unsigned int j = i + 1; j < particles.size(); j++) { + for (unsigned int k = j + 1; k < particles.size(); k++) { + for (unsigned int l = k + 1; l < particles.size(); l++) { + for (unsigned int m = l + 1; m < particles.size(); m++) { + + angle1 = angleSquared(particles[i], particles[j]); + angle2 = angleSquared(particles[i], particles[k]); + angle3 = angleSquared(particles[i], particles[l]); + angle4 = angleSquared(particles[j], particles[k]); + angle5 = angleSquared(particles[j], particles[l]); + angle6 = angleSquared(particles[k], particles[l]); + angle7 = angleSquared(particles[m], particles[i]); + angle8 = angleSquared(particles[m], particles[j]); + angle9 = angleSquared(particles[m], particles[k]); + angle10 = angleSquared(particles[m], particles[l]); + + if (_angles == -1){ + angle = angle1*angle2*angle3*angle4*angle5*angle6*angle7*angle8*angle9*angle10; + } else { + double angle_list[] = {angle1, angle2, angle3, angle4, angle5, angle6, + angle7, angle8, angle9, angle10}; + std::vector angle_vector(angle_list, angle_list + N_total); + std::sort(angle_vector.begin(), angle_vector.begin() + N_total); + + angle = angle_vector[0]; + for ( int s = 1; s < _angles; s++) { angle = angle * angle_vector[s]; } + } + answer += energy(particles[i]) + * energy(particles[j]) + * energy(particles[k]) + * energy(particles[l]) + * energy(particles[m]) + * pow(angle, half_beta) /norm; + } + } + } + } + } + } else { + assert(_N <= 5); + } + } else { + assert(_strategy == EnergyCorrelator::slow || _strategy == EnergyCorrelator::storage_array); + } + return answer; + } + + + std::vector EnergyCorrelatorGeneralized::result_all_angles(const PseudoJet& jet) const { + + // if jet does not have constituents, throw error + if (!jet.has_constituents()) throw Error("EnergyCorrelator called on jet with no constituents."); + + // Throw an error if N < 1 + if (_N < 1 ) throw Error("N cannot be negative or zero"); + + // get the N = 1 case out of the way + if (_N == 1) { + std::vector ans (1, 1.0); + return ans; + } + + // find constituents + std::vector particles = jet.constituents(); + + // return zero if the number of constituents is less than _N for the ECFG + if (particles.size() < _N) { + std::vector ans (_N, 0.0); + return ans; + } + + // The normalization is the energy or pt of the jet, which is also ECF(1, beta) + double EJ = _helper_correlator.result(jet); + + // The overall normalization + double norm = pow(EJ, _N); + + // Find the max number of angles and throw an error if it unsuitable + int N_total = _N * (_N - 1)/2; + + double half_beta = _beta/2.0; + + // take care of N = 2 case. + if (_N == 2) { + double answer = 0.0; + for (unsigned int i = 0; i < particles.size(); i++) { + for (unsigned int j = i + 1; j < particles.size(); j++) { //note offset by one so that angle is never called on identical pairs + answer += energy(particles[i]) + * energy(particles[j]) + * pow(angleSquared(particles[i],particles[j]), half_beta)/norm; + } + } + std::vector ans(N_total, answer); + return ans; + } + + // Prepare the answer vector + std::vector ans (N_total, 0.0); + // if N > 4, then throw error + if (_N > 5) { + throw Error("EnergyCorrelatorGeneralized is only hard coded for N = 0,1,2,3,4,5"); + } + + // Now deal with N = 3,4,5. Different options if storage array is used or not. + if (_strategy == EnergyCorrelator::storage_array) { + + // For N > 2, fill static storage array to save computation time. + + // Make energy storage + std::vector energyStore; + energyStore.resize(particles.size()); + + // Make angular storage + std::vector < std::vector > angleStore; + angleStore.resize(particles.size()); + for (unsigned int i = 0; i < angleStore.size(); i++) { + angleStore[i].resize(i); + } + + // Fill storage with energy/angle information + for (unsigned int i = 0; i < particles.size(); i++) { + energyStore[i] = energy(particles[i]); + for (unsigned int j = 0; j < i; j++) { + if (half_beta == 1){ + angleStore[i][j] = angleSquared(particles[i], particles[j]); + } else { + angleStore[i][j] = pow(angleSquared(particles[i], particles[j]), half_beta); + } + } + } + + // now do recursion + if (_N == 3) { + double angle1, angle2, angle3; + + for (unsigned int i = 2; i < particles.size(); i++) { + for (unsigned int j = 1; j < i; j++) { + for (unsigned int k = 0; k < j; k++) { + + angle1 = angleStore[i][j]; + angle2 = angleStore[i][k]; + angle3 = angleStore[j][k]; + + double angle_list[] = {angle1, angle2, angle3}; + std::vector angle_vector(angle_list, angle_list + N_total); + std::sort(angle_vector.begin(), angle_vector.begin() + N_total); + + std::vector final_angles (N_total, angle_vector[0]); + + double z_product = energyStore[i] * energyStore[j] * energyStore[k]/norm; + ans[0] += z_product * final_angles[0]; + for ( int s=1 ; s angle_vector(angle_list, angle_list + N_total); + std::sort(angle_vector.begin(), angle_vector.begin() + N_total); + + std::vector final_angles (N_total, angle_vector[0]); + + double z_product = energyStore[i] * energyStore[j] * energyStore[k] * energyStore [l]/norm; + ans[0] += z_product * final_angles[0]; + for ( int s=1 ; s angle_vector(angle_list, angle_list + N_total); + std::sort(angle_vector.begin(), angle_vector.begin() + N_total); + + std::vector final_angles (N_total, angle_vector[0]); + + double z_product = energyStore[i] * energyStore[j] * energyStore[k] + * energyStore[l] * energyStore[m]/norm; + ans[0] += z_product * final_angles[0]; + for ( int s=1 ; s angle_vector(angle_list, angle_list + N_total); + std::sort(angle_vector.begin(), angle_vector.begin() + N_total); + + std::vector final_angles (N_total, angle_vector[0]); + + double z_product = energy(particles[i]) + * energy(particles[j]) + * energy(particles[k])/norm; + + ans[0] += z_product * final_angles[0]; + for ( int s=1 ; s angle_vector(angle_list, angle_list + N_total); + std::sort(angle_vector.begin(), angle_vector.begin() + N_total); + + std::vector final_angles (N_total, angle_vector[0]); + + double z_product = energy(particles[i]) + * energy(particles[j]) + * energy(particles[k]) + * energy(particles[l])/norm; + ans[0] += z_product * final_angles[0]; + for ( int s=1 ; s angle_vector(angle_list, angle_list + N_total); + std::sort(angle_vector.begin(), angle_vector.begin() + N_total); + + std::vector final_angles (N_total, angle_vector[0]); + + double z_product = energy(particles[i]) + * energy(particles[j]) + * energy(particles[k]) + * energy(particles[l]) + * energy(particles[m])/norm; + + ans[0] += z_product * final_angles[0]; + for ( int s=1 ; s. + +---------------------------------------------------------------------------- + +The core classes from 1305.0007, and defined since version 1.0, are: + +EnergyCorrelator(int N, double beta, Measure measure) + + Called ECF(N,beta) in arXiv:1305.0007. Corresponds to the N-point + correlation function, with beta the angular exponent, while measure + = pt_R (default) or E_theta sets how energies and angles are + determined. + +EnergyCorrelatorRatio(int N, double beta, Measure measure) + + Called r_N^(beta) in arXiv:1305.0007. + Equals ECF(N+1,beta)/ECF(N,beta). + +EnergyCorrelatorDoubleRatio(int N, double beta, Measure measure) + + Called C_N^(beta) in arXiv:1305.0007. Equals r_N/r_{N-1}. This + observable provides good boosted N-prong object discrimination. + (N=1 for quark/gluon, N=2 for boosted W/Z/H, N=3 for boosted top) + Also given in EnergyCorrelatorCseries as of version 1.2. + +---------------------------------------------------------------------------- + +The D2 observable from 1409.6298, as well as C1 and C2 alias classes, were +added in version 1.1: + +EnergyCorrelatorC1(double beta, Measure measure) + + This calculates the double ratio observable C_1^(beta) which is + useful for quark versus gluon discrimination. + +EnergyCorrelatorC2(double beta, Measure measure) + + This calculates the double ratio observable C_2^(beta) which is + useful for boosted W/Z/H identification. + +EnergyCorrelatorD2(double beta, Measure measure) + + Called D_2^(beta) in arXiv:1409.6298. + Equals ECF(3,beta)*ECF(1,beta)^3/ECF(2,beta)^3. + This is the recommended function for boosted 2-prong object + discrimination (boosted W/Z/H). + +---------------------------------------------------------------------------- + +Generalized energy correlators were introduced in 1609.07483 and appear in +version 1.2. They are defined in the class: + +EnergyCorrelatorGeneralized(int angles, int N, double beta, Measure measure) + + Called {}_v e_n^{(beta)} in 1609.07483, but will be denoted here as + ECFG(angles,N,beta), where v=angles and n=N. As for EnergyCorrelator, + beta is the angular exponent, while measure = pt_R (default) or E_theta + sets how energies and angles are determined. The integer angles + determines the number of angles in the observable. The choice angles=-1 + sets angles = N choose 2, which corresponds to the N-point + normalized (dimensionless) correlation function, with + ECFN(N,beta) = ECFG(N choose 2,N,beta) = ECF(N,beta)/ECF(1,beta)^N + +From the generalized correlators, a variety of useful ratios are defined. +They are mainly organized by series, with special values highlighted for +recommended usage. + +---------------------------------------------------------------------------- + +EnergyCorrelatorGeneralizedD2(double alpha, double beta, Measure measure) + + Called D_2^(alpha, beta) in arXiv:1609.07483 + Equals ECFN(3,alpha)/ECFN(2,beta)^(3 alpha/beta). + Useful for groomed 2-prong object tagging. We recommend the use of alpha=1 + and beta=2. + +---------------------------------------------------------------------------- + +EnergyCorrelatorNseries(int i, double beta, Measure measure) + + Called N_i^(beta) in arXiv:1609.07483 + Equals ECFG(2,n+1,beta)/ECFN(1,n,beta)^2. + +EnergyCorrelatorN2(double beta, Measure measure) + + Called N_2^(beta) in arXiv:1609.07483 + Equals ECFG(2,3,beta)/ECFG(1,2,beta)^2. + Useful for groomed and ungroomed 2-prong object tagging. + +EnergyCorrelatorN3(double beta, Measure measure) + + Called N_3^(beta) in arXiv:1609.07483 + Equals ECFG(2,4,beta)/ECFG(1,3,beta)^2. + Useful for groomed 3-prong object tagging. + +---------------------------------------------------------------------------- + +EnergyCorrelatorMseries(int i, double beta, Measure measure) + + Called M_i^(beta) in arXiv:1609.07483 + Equals ECFG(1,n+1,beta)/ECFG(1,n,beta). + +EnergyCorrelatorM2(double beta, Measure measure) + + Called M_2^(beta) in arXiv:1609.07483 + Equals ECFG(1,3,beta)/ECFG(1,2,beta). + Useful for groomed 2-prong object tagging. + + +---------------------------------------------------------------------------- + +EnergyCorrelatorUseries(int i, double beta, Measure measure) + + Called U_i^(beta) in arXiv:1609.07483 + Equals ECFG(1,n+1,beta). + +EnergyCorrelatorU1(double beta, Measure measure) + + Called U_1^(beta) in arXiv:1609.07483 + Equals ECFG(1,2,beta). + Useful for quark vs. gluon discrimination. + +EnergyCorrelatorU2(double beta, Measure measure) + + Called U_2^(beta) in arXiv:1609.07483 + Equals ECFG(1,3,beta). + Useful for quark vs. gluon discrimination. + +EnergyCorrelatorU3(double beta, Measure measure) + + Called U_3^(beta) in arXiv:1609.07483 + Equals ECFG(1,4,beta). + Useful for quark vs. gluon discrimination. +---------------------------------------------------------------------------- + +The argument Measure in each of the above functions sets how energies +and angles are defined in the observable. The measure + + pt_R + +uses hadron collider coordinates (transverse momenta and boost-invariant +angles). The "energy" in this case is defined as the pT of the jet, +and the "angle" is the distance between the jets in phi, eta space. + +The measure + + E_theta + +uses particle energies and angles and is appropriate for e+e- +collider applications. The "energy" is the jet energy and the angle +between 2 jets is computed from the dot product of the 3 vectors p1 and p2. + +The measure + + E_inv + +uses particle energies and angles and is also appropriate for e+e- +collider applications. In this case “theta” is replaced by Mandelstam +invariants with the same behavior in the collinear limits, leading to a more +calculation friendly observables. The "energy" is defined as the jet energy +and the "angle squared" is defined as (2p_i \cdot p_j/E_i E_j), +where p_i,p_j are the momenta of the jets i adn j, and E_i, E_j are their +respective energies. + +General usage is shown in the example.cc program, and recommended usage +is shown in example_basic_usage.cc. + Index: contrib/contribs/EnergyCorrelator/tags/1.3.2/example.cc =================================================================== --- contrib/contribs/EnergyCorrelator/tags/1.3.2/example.cc (revision 0) +++ contrib/contribs/EnergyCorrelator/tags/1.3.2/example.cc (revision 1393) @@ -0,0 +1,686 @@ +// Example showing usage of energy correlator classes. +// +// Compile it with "make example" and run it with +// +// ./example < ../data/single-event.dat +// +// Copyright (c) 2013-2016 +// Andrew Larkoski, Lina Necib, Gavin Salam, and Jesse Thaler +// +// $Id$ +//---------------------------------------------------------------------- +// This file is part of FastJet contrib. +// +// It 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. +// +// It 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 code. If not, see . +//---------------------------------------------------------------------- + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "fastjet/PseudoJet.hh" +#include "fastjet/ClusterSequence.hh" +#include "fastjet/JetDefinition.hh" + +#include +#include "EnergyCorrelator.hh" // In external code, this should be fastjet/contrib/EnergyCorrelator.hh + +using namespace std; +using namespace fastjet; +using namespace fastjet::contrib; + +// forward declaration to make things clearer +void read_event(vector &event); +void analyze(const vector & input_particles); + +//---------------------------------------------------------------------- +int main(){ + + //---------------------------------------------------------- + // read in input particles + vector event; + read_event(event); + cout << "# read an event with " << event.size() << " particles" << endl; + + //---------------------------------------------------------- + // illustrate how this EnergyCorrelator contrib works + + analyze(event); + + return 0; +} + +// read in input particles +void read_event(vector &event){ + string line; + while (getline(cin, line)) { + istringstream linestream(line); + // take substrings to avoid problems when there are extra "pollution" + // characters (e.g. line-feed). + if (line.substr(0,4) == "#END") {return;} + if (line.substr(0,1) == "#") {continue;} + double px,py,pz,E; + linestream >> px >> py >> pz >> E; + PseudoJet particle(px,py,pz,E); + + // push event onto back of full_event vector + event.push_back(particle); + } +} + +//////// +// +// Main Routine for Analysis +// +/////// + +void analyze(const vector & input_particles) { + + /////// EnergyCorrelator ///////////////////////////// + + // Initial clustering with anti-kt algorithm + JetAlgorithm algorithm = antikt_algorithm; + double jet_rad = 1.00; // jet radius for anti-kt algorithm + JetDefinition jetDef = JetDefinition(algorithm,jet_rad,E_scheme,Best); + ClusterSequence clust_seq(input_particles,jetDef); + vector antikt_jets = sorted_by_pt(clust_seq.inclusive_jets()); + + for (int j = 0; j < 2; j++) { // Two hardest jets per event + if (antikt_jets[j].perp() > 200) { + + PseudoJet myJet = antikt_jets[j]; + + // various values of beta + vector betalist; + betalist.push_back(0.1); + betalist.push_back(0.2); + betalist.push_back(0.5); + betalist.push_back(1.0); + betalist.push_back(1.5); + betalist.push_back(2.0); + + // various values of alpha + vector alphalist; + alphalist.push_back(0.1); + alphalist.push_back(0.2); + alphalist.push_back(0.5); + alphalist.push_back(1.0); + + + // checking the two energy/angle modes + vector measurelist; + measurelist.push_back(EnergyCorrelator::pt_R); + measurelist.push_back(EnergyCorrelator::E_theta); + //measurelist.push_back(EnergyCorrelator::E_inv); + + vector modename; + modename.push_back("pt_R"); + modename.push_back("E_theta"); + //modename.push_back("E_inv"); + + for (unsigned int M = 0; M < measurelist.size(); M++) { + + cout << "-------------------------------------------------------------------------------------" << endl; + cout << "EnergyCorrelator: ECF(N,beta) with " << modename[M] << endl; + cout << "-------------------------------------------------------------------------------------" << endl; + printf("%7s %14s %14s %14s %14s %15s\n","beta", "N=1 (GeV)", "N=2 (GeV^2)", "N=3 (GeV^3)", "N=4 (GeV^4)", "N=5 (GeV^5)"); + + for (unsigned int B = 0; B < betalist.size(); B++) { + double beta = betalist[B]; + + EnergyCorrelator ECF0(0,beta,measurelist[M]); + EnergyCorrelator ECF1(1,beta,measurelist[M]); + EnergyCorrelator ECF2(2,beta,measurelist[M]); + EnergyCorrelator ECF3(3,beta,measurelist[M]); + EnergyCorrelator ECF4(4,beta,measurelist[M]); + EnergyCorrelator ECF5(5,beta,measurelist[M]); + + printf("%7.3f %14.2f %14.2f %14.6g %14.6g %15.6g \n",beta,ECF1(myJet),ECF2(myJet),ECF3(myJet),ECF4(myJet),ECF5(myJet)); + } + cout << "-------------------------------------------------------------------------------------" << endl << endl; + + cout << "-------------------------------------------------------------------------------------" << endl; + cout << "EnergyCorrelatorRatio: r_N^(beta) = ECF(N+1,beta)/ECF(N,beta) with " << modename[M] << endl; + cout << "-------------------------------------------------------------------------------------" << endl; + printf("%7s %14s %14s %14s %14s %15s \n","beta", "N=0 (GeV)", "N=1 (GeV)", "N=2 (GeV)", "N=3 (GeV)","N=4 (GeV)"); + + for (unsigned int B = 0; B < betalist.size(); B++) { + double beta = betalist[B]; + + EnergyCorrelatorRatio r0(0,beta,measurelist[M]); + EnergyCorrelatorRatio r1(1,beta,measurelist[M]); + EnergyCorrelatorRatio r2(2,beta,measurelist[M]); + EnergyCorrelatorRatio r3(3,beta,measurelist[M]); + EnergyCorrelatorRatio r4(4,beta,measurelist[M]); + + printf("%7.3f %14.4f %14.4f %14.6g %14.6g %15.6g \n",beta,r0(myJet),r1(myJet),r2(myJet),r3(myJet),r4(myJet)); + } + cout << "-------------------------------------------------------------------------------------" << endl << endl; + + cout << "-------------------------------------------------------------------------------------" << endl; + cout << "EnergyCorrelatorDoubleRatio: C_N^(beta) = r_N^(beta)/r_{N-1}^(beta) with " << modename[M] << endl; + cout << "-------------------------------------------------------------------------------------" << endl; + printf("%7s %14s %14s %14s %14s \n","beta", "N=1", "N=2", "N=3", "N=4"); + + for (unsigned int B = 0; B < betalist.size(); B++) { + double beta = betalist[B]; + + EnergyCorrelatorDoubleRatio C1(1,beta,measurelist[M]); + EnergyCorrelatorDoubleRatio C2(2,beta,measurelist[M]); + EnergyCorrelatorDoubleRatio C3(3,beta,measurelist[M]); + EnergyCorrelatorDoubleRatio C4(4,beta,measurelist[M]); + + printf("%7.3f %14.6f %14.6f %14.6f %14.6f \n",beta,C1(myJet),C2(myJet),C3(myJet),C4(myJet)); + } + cout << "-------------------------------------------------------------------------------------" << endl << endl; + + cout << "-------------------------------------------------------------------------------------" << endl; + cout << "EnergyCorrelatorC1: C_1^(beta) = ECF(2,beta)/ECF(1,beta)^2 with " << modename[M] << endl; + cout << "-------------------------------------------------------------------------------------" << endl; + printf("%7s %14s \n","beta","C1 obs"); + + for (unsigned int B = 0; B < betalist.size(); B++) { + double beta = betalist[B]; + + EnergyCorrelatorC1 c1(beta,measurelist[M]); + + printf("%7.3f %14.6f \n",beta,c1(myJet)); + } + cout << "-------------------------------------------------------------------------------------" << endl << endl; + + cout << "-------------------------------------------------------------------------------------" << endl; + cout << "EnergyCorrelatorC2: C_2^(beta) = ECF(3,beta)*ECF(1,beta)/ECF(2,beta)^2 with " << modename[M] << endl; + cout << "-------------------------------------------------------------------------------------" << endl; + printf("%7s %14s \n","beta","C2 obs"); + + for (unsigned int B = 0; B < betalist.size(); B++) { + double beta = betalist[B]; + + EnergyCorrelatorC2 c2(beta,measurelist[M]); + + printf("%7.3f %14.6f \n",beta,c2(myJet)); + } + cout << "-------------------------------------------------------------------------------------" << endl << endl; + + + cout << "-------------------------------------------------------------------------------------" << endl; + cout << "EnergyCorrelatorD2: D_2^(beta) = ECF(3,beta)*ECF(1,beta)^3/ECF(2,beta)^3 with " << modename[M] << endl; + cout << "-------------------------------------------------------------------------------------" << endl; + printf("%7s %14s \n","beta","D2 obs"); + + for (unsigned int B = 0; B < betalist.size(); B++) { + double beta = betalist[B]; + + EnergyCorrelatorD2 d2(beta,measurelist[M]); + + printf("%7.3f %14.6f \n",beta,d2(myJet)); + } + cout << "-------------------------------------------------------------------------------------" << endl << endl; + + cout << "-------------------------------------------------------------------------------------" << endl; + cout << "EnergyCorrelatorGeneralizedD2: D_2^(alpha, beta) = ECFN(3,alpha)/ECFN(2,beta)^(3*alpha/beta) with " << modename[M] << endl; + cout << "-------------------------------------------------------------------------------------" << endl; + printf("%7s %18s %18s %18s %18s\n","beta","alpha = 0.100","alpha = 0.200","alpha = 0.500","alpha = 1.000"); + + for (unsigned int B = 1; B < betalist.size(); B++) { + double beta = betalist[B]; + + printf("%7.3f ", beta); + for (unsigned int A = 0; A < alphalist.size(); A++) { + double alpha = alphalist[A]; + + EnergyCorrelatorGeneralizedD2 d2(alpha, beta, measurelist[M]); + + printf("%18.6g ", d2(myJet)); + } + printf("\n"); + } + cout << "-------------------------------------------------------------------------------------" << endl << endl; + + + + cout << "-------------------------------------------------------------------------------------" << endl; + cout << "EnergyCorrelatorGeneralized (angles = N Choose 2): ECFN(N, beta) with " << modename[M] << endl; + cout << "-------------------------------------------------------------------------------------" << endl; + printf("%7s %7s %14s %14s %14s\n","beta", "N=1", "N=2", "N=3", "N=4"); + + + for (unsigned int B = 0; B < betalist.size(); B++) { + double beta = betalist[B]; + + EnergyCorrelatorGeneralized ECF1(-1,1, beta, measurelist[M]); + EnergyCorrelatorGeneralized ECF2(-1,2, beta, measurelist[M]); + EnergyCorrelatorGeneralized ECF3(-1,3, beta, measurelist[M]); + EnergyCorrelatorGeneralized ECF4(-1,4, beta, measurelist[M]); + //EnergyCorrelatorGeneralized ECF5(-1, 5, beta, measurelist[M]); + + printf("%7.3f %7.2f %14.10f %14.10f %14.10f \n", beta, ECF1(myJet), ECF2(myJet), ECF3(myJet), + ECF4(myJet)); + } + cout << "-------------------------------------------------------------------------------------" << + endl << endl; + + cout << "-------------------------------------------------------------------------------------" << endl; + cout << "EnergyCorrelatorGeneralized: ECFG(angles, N, beta=1) with " << modename[M] << endl; + cout << "-------------------------------------------------------------------------------------" << endl; + printf("%7s %7s %14s %14s %14s\n","angles", "N=1", "N=2", "N=3", "N=4"); + + double beta = 1.0; + for (unsigned int A = 1; A < 2; A++) { + double angle = A; + + EnergyCorrelatorGeneralized ECF1(angle, 1, beta, measurelist[M]); + EnergyCorrelatorGeneralized ECF2(angle, 2, beta, measurelist[M]); + EnergyCorrelatorGeneralized ECF3(angle, 3, beta, measurelist[M]); + EnergyCorrelatorGeneralized ECF4(angle, 4, beta, measurelist[M], EnergyCorrelator::slow); + + printf("%7.0f %7.2f %14.10f %14.10f %14.10f \n", angle, ECF1(myJet), ECF2(myJet), ECF3(myJet), + ECF4(myJet)); + + } + + for (unsigned int A = 2; A < 4; A++) { + double angle = A; + + EnergyCorrelatorGeneralized ECF3(angle, 3, beta, measurelist[M]); + EnergyCorrelatorGeneralized ECF4(angle, 4, beta, measurelist[M]); + + printf("%7.0f %7s %14s %14.10f %14.10f \n", angle, " " , " " ,ECF3(myJet), ECF4(myJet)); + } + + for (unsigned int A = 4; A < 7; A++) { + double angle = A; + + EnergyCorrelatorGeneralized ECF4(angle, 4, beta, measurelist[M]); + printf("%7.0f %7s %14s %14s %14.10f \n", angle, " ", " ", " ", ECF4(myJet) ); + } + cout << "-------------------------------------------------------------------------------------" << + endl << endl; + + cout << "-------------------------------------------------------------------------------------" << endl; + cout << "EnergyCorrelatorNseries: N_i(beta) = ECFG(i+1, 2, beta)/ECFG(i, 1, beta)^2 with " << modename[M] << endl; + cout << "-------------------------------------------------------------------------------------" << endl; + printf("%7s %14s %14s %14s \n","beta", "N=1", "N=2", "N=3"); + + for (unsigned int B = 0; B < betalist.size(); B++) { + double beta = betalist[B]; + + EnergyCorrelatorNseries N1(1,beta,measurelist[M]); + EnergyCorrelatorNseries N2(2,beta,measurelist[M]); + EnergyCorrelatorNseries N3(3,beta,measurelist[M]); + + printf("%7.3f %14.6f %14.6f %14.6f \n",beta,N1(myJet),N2(myJet),N3(myJet)); + + } + cout << "-------------------------------------------------------------------------------------" << endl << endl; + + + cout << "-------------------------------------------------------------------------------------" << endl; + cout << "EnergyCorrelatorN2: N2(beta) = ECFG(3, 2, beta)/ECFG(2, 1, beta)^2 with " << modename[M] << endl; + cout << "-------------------------------------------------------------------------------------" << endl; + printf("%7s %14s \n","beta", "N2 obs"); + + for (unsigned int B = 0; B < betalist.size(); B++) { + double beta = betalist[B]; + + EnergyCorrelatorN2 N2(beta,measurelist[M]); + + printf("%7.3f %14.6f \n",beta,N2(myJet)); + } + cout << "-------------------------------------------------------------------------------------" << endl << endl; + + + cout << "-------------------------------------------------------------------------------------" << endl; + cout << "EnergyCorrelatorN3: N3(beta) = ECFG(4, 2, beta)/ECFG(3, 1, beta)^2 with " << modename[M] << endl; + cout << "-------------------------------------------------------------------------------------" << endl; + printf("%7s %14s \n","beta", "N3 obs"); + + for (unsigned int B = 0; B < betalist.size(); B++) { + double beta = betalist[B]; + + EnergyCorrelatorN3 N3(beta,measurelist[M]); + + printf("%7.3f %14.6f \n",beta,N3(myJet)); + } + cout << "-------------------------------------------------------------------------------------" << endl << endl; + + cout << "-------------------------------------------------------------------------------------" << endl; + cout << "EnergyCorrelatorMseries: M_i(beta) = ECFG(i+1, 1, beta)/ECFN(i, 1, beta) with " << modename[M] << endl; + cout << "-------------------------------------------------------------------------------------" << endl; + printf("%7s %14s %14s %14s \n","beta", "N=1", "N=2", "N=3"); + + for (unsigned int B = 0; B < betalist.size(); B++) { + double beta = betalist[B]; + + EnergyCorrelatorMseries M1(1,beta,measurelist[M]); + EnergyCorrelatorMseries M2(2,beta,measurelist[M]); + EnergyCorrelatorMseries M3(3,beta,measurelist[M]); + + + printf("%7.3f %14.6f %14.6f %14.6f \n",beta,M1(myJet),M2(myJet),M3(myJet)); + } + cout << "-------------------------------------------------------------------------------------" << endl << endl; + + + cout << "-------------------------------------------------------------------------------------" << endl; + cout << "EnergyCorrelatorM2: M2(beta) = ECFG(3, 1, beta)/ECFG(3, 1, beta) with " << modename[M] << endl; + cout << "-------------------------------------------------------------------------------------" << endl; + printf("%7s %14s \n","beta", "M2 obs"); + + for (unsigned int B = 0; B < betalist.size(); B++) { + double beta = betalist[B]; + + EnergyCorrelatorM2 M2(beta,measurelist[M]); + + printf("%7.3f %14.6f \n",beta,M2(myJet)); + } + cout << "-------------------------------------------------------------------------------------" << endl << endl; + + cout << "-------------------------------------------------------------------------------------" << endl; + cout << "EnergyCorrelatorCseries: C_i(beta) = ECFN(i-1, beta)*ECFN(i+1, beta)/ECFN(i, beta)^2 with " << modename[M] << endl; + cout << "-------------------------------------------------------------------------------------" << endl; + printf("%7s %20s %20s %20s \n","beta", "N=1", "N=2", "N=3"); + + for (unsigned int B = 0; B < betalist.size(); B++) { + double beta = betalist[B]; + + EnergyCorrelatorCseries C1(1,beta,measurelist[M]); + EnergyCorrelatorCseries C2(2,beta,measurelist[M]); + EnergyCorrelatorCseries C3(3,beta,measurelist[M]); + + + printf("%7.3f %20.10f %20.10f %20.10f \n",beta,C1(myJet),C2(myJet),C3(myJet)); + } + cout << "-------------------------------------------------------------------------------------" << endl << endl; + + + cout << "-------------------------------------------------------------------------------------" << endl; + cout << "EnergyCorrelatorUseries: U_i(beta) = ECFG(i+1, 1, beta) with " << modename[M] << endl; + cout << "-------------------------------------------------------------------------------------" << endl; + printf("%7s %20s %20s %20s \n","beta", "N=1", "N=2", "N=3"); + + for (unsigned int B = 0; B < betalist.size(); B++) { + double beta = betalist[B]; + + EnergyCorrelatorUseries U1(1,beta,measurelist[M]); + EnergyCorrelatorUseries U2(2,beta,measurelist[M]); + EnergyCorrelatorUseries U3(3,beta,measurelist[M]); + + + printf("%7.3f %20.10f %20.10f %20.10f \n",beta,U1(myJet),U2(myJet),U3(myJet)); + } + cout << "-------------------------------------------------------------------------------------" << endl << endl; + + cout << "-------------------------------------------------------------------------------------" << endl; + cout << "EnergyCorrelatorU1: U1(beta) = ECFG(2, 1, beta) with " << modename[M] << endl; + cout << "-------------------------------------------------------------------------------------" << endl; + printf("%7s %14s \n","beta", "U1 obs"); + + for (unsigned int B = 0; B < betalist.size(); B++) { + double beta = betalist[B]; + + EnergyCorrelatorU1 U1(beta,measurelist[M]); + + printf("%7.3f %14.10f \n",beta,U1(myJet)); + } + cout << "-------------------------------------------------------------------------------------" << endl << endl; + + cout << "-------------------------------------------------------------------------------------" << endl; + cout << "EnergyCorrelatorU2: U2(beta) = ECFG(3, 1, beta) with " << modename[M] << endl; + cout << "-------------------------------------------------------------------------------------" << endl; + printf("%7s %14s \n","beta", "U2 obs"); + + for (unsigned int B = 0; B < betalist.size(); B++) { + double beta = betalist[B]; + + EnergyCorrelatorU2 U2(beta,measurelist[M]); + + printf("%7.3f %14.10f \n",beta,U2(myJet)); + } + cout << "-------------------------------------------------------------------------------------" << endl << endl; + + cout << "-------------------------------------------------------------------------------------" << endl; + cout << "EnergyCorrelatorU3: U3(beta) = ECFG(4, 1, beta) with " << modename[M] << endl; + cout << "-------------------------------------------------------------------------------------" << endl; + printf("%7s %14s \n","beta", "U3 obs"); + + for (unsigned int B = 0; B < betalist.size(); B++) { + double beta = betalist[B]; + + EnergyCorrelatorU3 U3(beta,measurelist[M]); + + printf("%7.3f %14.10f \n",beta,U3(myJet)); + } + cout << "-------------------------------------------------------------------------------------" << endl << endl; + + + // timing tests for the developers + double do_timing_test = false; + if (do_timing_test) { + + cout << "jet with pt = " << myJet.pt() << " and " << myJet.constituents().size() << " constituents" << endl; + + clock_t clock_begin, clock_end; + double num_iter; + double beta = 0.5; + + cout << setprecision(6); + + // test C1 + num_iter = 20000; + clock_begin = clock(); + EnergyCorrelatorDoubleRatio C1s(1,beta,measurelist[M],EnergyCorrelator::slow); + EnergyCorrelatorDoubleRatio C1f(1,beta,measurelist[M],EnergyCorrelator::storage_array); + cout << "timing " << C1s.description() << endl; + cout << "timing " << C1f.description() << endl; + for (int t = 0; t < num_iter; t++) { + C1s(myJet); + } + clock_end = clock(); + cout << "Slow method: " << (clock_end-clock_begin)/double(CLOCKS_PER_SEC*num_iter)*1000 << " ms per C1"<< endl; + + num_iter = 20000; + clock_begin = clock(); + for (int t = 0; t < num_iter; t++) { + C1f(myJet); + } + clock_end = clock(); + cout << "Storage array method: " << (clock_end-clock_begin)/double(CLOCKS_PER_SEC*num_iter)*1000 << " ms per C1"<< endl; + + + // test C2 + num_iter = 1000; + clock_begin = clock(); + for (int t = 0; t < num_iter; t++) { + EnergyCorrelatorDoubleRatio C2(2,beta,measurelist[M],EnergyCorrelator::slow); + C2(myJet); + } + clock_end = clock(); + cout << "Slow method: " << (clock_end-clock_begin)/double(CLOCKS_PER_SEC*num_iter)*1000 << " ms per C2"<< endl; + + num_iter = 10000; + clock_begin = clock(); + for (int t = 0; t < num_iter; t++) { + EnergyCorrelatorDoubleRatio C2(2,beta,measurelist[M],EnergyCorrelator::storage_array); + C2(myJet); + } + clock_end = clock(); + cout << "Storage array method: " << (clock_end-clock_begin)/double(CLOCKS_PER_SEC*num_iter)*1000 << " ms per C2"<< endl; + + // test C3 + num_iter = 100; + clock_begin = clock(); + + for (int t = 0; t < num_iter; t++) { + EnergyCorrelatorDoubleRatio C3(3,beta,measurelist[M],EnergyCorrelator::slow); + C3(myJet); + } + clock_end = clock(); + cout << "Slow method: " << (clock_end-clock_begin)/double(CLOCKS_PER_SEC*num_iter)*1000 << " ms per C3"<< endl; + + num_iter = 3000; + clock_begin = clock(); + for (int t = 0; t < num_iter; t++) { + EnergyCorrelatorDoubleRatio C3(3,beta,measurelist[M],EnergyCorrelator::storage_array); + C3(myJet); + } + clock_end = clock(); + cout << "Storage array method: " << (clock_end-clock_begin)/double(CLOCKS_PER_SEC*num_iter)*1000 << " ms per C3"<< endl; + + // test C4 + num_iter = 10; + clock_begin = clock(); + + for (int t = 0; t < num_iter; t++) { + EnergyCorrelatorDoubleRatio C4(4,beta,measurelist[M],EnergyCorrelator::slow); + C4(myJet); + } + clock_end = clock(); + cout << "Slow method: " << (clock_end-clock_begin)/double(CLOCKS_PER_SEC*num_iter)*1000 << " ms per C4"<< endl; + + num_iter = 300; + clock_begin = clock(); + for (int t = 0; t < num_iter; t++) { + EnergyCorrelatorDoubleRatio C4(4,beta,measurelist[M],EnergyCorrelator::storage_array); + C4(myJet); + } + clock_end = clock(); + cout << "Storage array method: " << (clock_end-clock_begin)/double(CLOCKS_PER_SEC*num_iter)*1000 << " ms per C4"<< endl; + + // test N2 + num_iter = 10; + clock_begin = clock(); + + num_iter = 300; + clock_begin = clock(); + for (int t = 0; t < num_iter; t++) { + EnergyCorrelatorN2 N2(beta,measurelist[M],EnergyCorrelator::storage_array); + N2(myJet); + } + clock_end = clock(); + EnergyCorrelatorN2 N2test(beta,measurelist[M],EnergyCorrelator::storage_array); + cout << "Beta is: "<< beta << endl; + cout << "Result of N2: "<< N2test(myJet) << endl; + cout << "Storage array method: " << (clock_end-clock_begin)/double(CLOCKS_PER_SEC*num_iter)*1000 << " ms per N2"<< endl; + + + num_iter = 300; + clock_begin = clock(); + for (int t = 0; t < num_iter; t++) { + EnergyCorrelatorN3 N3(beta,measurelist[M],EnergyCorrelator::storage_array); + N3(myJet); + } + clock_end = clock(); + EnergyCorrelatorN3 N3test(beta,measurelist[M],EnergyCorrelator::storage_array); + cout << "Beta is: "<< beta << endl; + cout << "Result of N3: "<< N3test(myJet) << endl; + cout << "Storage array method: " << (clock_end-clock_begin)/double(CLOCKS_PER_SEC*num_iter)*1000 << " ms per N3"<< endl; + + + + + num_iter = 300; + clock_begin = clock(); + for (int t = 0; t < num_iter; t++) { + EnergyCorrelatorGeneralized ECF1(2,3, beta, measurelist[M]); + ECF1(myJet); + } + clock_end = clock(); + EnergyCorrelatorGeneralized ECF1test(2,3, beta, measurelist[M]); + cout << "Beta is: "<< beta << endl; + cout << "Result of 2e3: "<< ECF1test(myJet) << endl; + cout << "Storage array method: " << (clock_end-clock_begin)/double(CLOCKS_PER_SEC*num_iter)*1000 << " ms per 2e3"<< endl; + + + num_iter = 300; + clock_begin = clock(); + for (int t = 0; t < num_iter; t++) { + EnergyCorrelatorGeneralized ECF3(2,4, beta, measurelist[M]); + ECF3(myJet); + } + clock_end = clock(); + EnergyCorrelatorGeneralized ECF2test(2,4, beta, measurelist[M]); + cout << "Beta is: "<< beta << endl; + cout << "Result of 2e4: "<< ECF2test(myJet) << endl; + cout << "Storage array method: " << (clock_end-clock_begin)/double(CLOCKS_PER_SEC*num_iter)*1000 << " ms per 2e4"<< endl; + + +// num_iter = 300; +// clock_begin = clock(); +// for (int t = 0; t < num_iter; t++) { +// EnergyCorrelatorGeneralized ECF5(2,5, beta, measurelist[M]); +// ECF5(myJet); +// } +// clock_end = clock(); +// EnergyCorrelatorGeneralized ECF5test(2,5, beta, measurelist[M]); +// cout << "Beta is: "<< beta << endl; +// cout << "Result of 2e5: "<< ECF5test(myJet) << endl; +// cout << "Storage array method: " << (clock_end-clock_begin)/double(CLOCKS_PER_SEC*num_iter)*1000 << " ms per 2e5"<< endl; +// + + // test M2 + num_iter = 10; + clock_begin = clock(); + + for (int t = 0; t < num_iter; t++) { + EnergyCorrelatorM2 M2(beta,measurelist[M],EnergyCorrelator::slow); + M2(myJet); + } + clock_end = clock(); + cout << "Slow method: " << (clock_end-clock_begin)/double(CLOCKS_PER_SEC*num_iter)*1000 << " ms per M2"<< endl; + + num_iter = 300; + clock_begin = clock(); + for (int t = 0; t < num_iter; t++) { + EnergyCorrelatorM2 M2(beta,measurelist[M],EnergyCorrelator::storage_array); + M2(myJet); + } + clock_end = clock(); + cout << "Storage array method: " << (clock_end-clock_begin)/double(CLOCKS_PER_SEC*num_iter)*1000 << " ms per M2"<< endl; + + // test M3 + num_iter = 10; + clock_begin = clock(); + + for (int t = 0; t < num_iter; t++) { + EnergyCorrelatorMseries M3(3,beta,measurelist[M],EnergyCorrelator::slow); + M3(myJet); + } + clock_end = clock(); + cout << "Slow method: " << (clock_end-clock_begin)/double(CLOCKS_PER_SEC*num_iter)*1000 << " ms per M3"<< endl; + + num_iter = 300; + clock_begin = clock(); + for (int t = 0; t < num_iter; t++) { + EnergyCorrelatorMseries M3(3,beta,measurelist[M],EnergyCorrelator::storage_array); + M3(myJet); + } + clock_end = clock(); + cout << "Storage array method: " << (clock_end-clock_begin)/double(CLOCKS_PER_SEC*num_iter)*1000 << " ms per M3"<< endl; + + + } + } + } + } +} + + + Property changes on: contrib/contribs/EnergyCorrelator/tags/1.3.2/example.cc ___________________________________________________________________ Added: svn:keywords ## -0,0 +1 ## +Id \ No newline at end of property Index: contrib/contribs/EnergyCorrelator/tags/1.3.2/Doxyfile =================================================================== --- contrib/contribs/EnergyCorrelator/tags/1.3.2/Doxyfile (revision 0) +++ contrib/contribs/EnergyCorrelator/tags/1.3.2/Doxyfile (revision 1393) @@ -0,0 +1,1633 @@ +# Doxyfile 1.7.1 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project +# +# All text after a 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. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# by quotes) that should identify the project. + +PROJECT_NAME = EnergyCorrelator (fjcontrib) + +# 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 = 1.2.0 + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# 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 = + +# 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 cause performance problems for the file system. + +CREATE_SUBDIRS = 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. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English +# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, +# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) 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. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) 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. + +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" "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. + +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. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then 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. + +FULL_PATH_NAMES = YES + +# If the FULL_PATH_NAMES tag is set to YES then 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. + +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 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. + +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 +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) + +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 comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +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 behaviour. +# 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 behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +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. + +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. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that acts +# 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 = + +# 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. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +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. + +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, CSharp, C, +# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. 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 that for custom extensions +# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. + +EXTENSION_MAPPING = + +# 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); v.s. +# func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip 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. + +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 (the default) +# 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. + +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. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES (the default) 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. + +SUBGROUPING = YES + +# When TYPEDEF_HIDES_STRUCT 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. + +TYPEDEF_HIDES_STRUCT = NO + +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to +# determine which symbols to keep in memory and which to flush to disk. +# When the cache is full, less often used symbols will be written to disk. +# For small to medium size projects (<1000 input files) the default value is +# probably good enough. For larger projects a too small cache size can cause +# doxygen to be busy swapping symbols to and from disk most of the time +# causing a significant performance penality. +# If the system has enough physical memory increasing the cache will improve the +# performance by keeping more symbols in memory. Note that the value works on +# a logarithmic scale so increasing the size by one will rougly double the +# memory usage. The cache size is given by this formula: +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols + +SYMBOL_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 and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = YES + +# 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. + +EXTRACT_LOCAL_CLASSES = NO + +# 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 (the default) only methods in the interface are included. + +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. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) 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. + +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 (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = YES + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +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 (the default) these blocks will be appended to the +# function's detailed documentation block. + +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 (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +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. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# 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. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) 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. + +SORT_MEMBER_DOCS = NO + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +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 default) +# the constructors will appear in the respective orders defined by +# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. +# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO +# and ignored for detailed docs if SORT_MEMBER_DOCS is set to 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 default) +# the group names will appear in their defined order. + +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 default), 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. + +SORT_BY_SCOPE_NAME = 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. + +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. + +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. + +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. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of 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 initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +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. + +SHOW_USED_FILES = YES + +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# in the documentation. The default is NO. + +SHOW_DIRECTORIES = 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 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 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 , where is the value of +# the FILE_VERSION_FILTER tag, and is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +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. The 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. + +LAYOUT_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED 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. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR 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. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be abled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +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) + +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 stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be 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. + +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, which is +# also the default input encoding. 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. + +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 pattern (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 *.h *.hh *.hxx +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 + +FILE_PATTERNS = *.c *.cc *.cxx *.cpp *.c++ \ + *.h *.hh *.hxx *.hpp *.h++ \ + *.ii *.ixx *.ipp *.i++ *.icc \ + *.php *.php3 *.inc *.m *.py *.f90 *.f \ + NEWS + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should +# 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. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or +# directories that are symbolic links (a Unix filesystem feature) are excluded +# from the input. + +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 + +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. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are 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. + +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 +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER +# is applied to all files. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +#--------------------------------------------------------------------------- +# 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 also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = NO + +# If the REFERENCED_BY_RELATION tag is set to YES +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = NO + +# 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. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# 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. + +REFERENCES_LINK_SOURCE = 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. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) 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. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# 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. + +ALPHABETICAL_INDEX = NO + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +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 one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +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. If left blank `html' will be used as the default path. + +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). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# 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 the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# stylesheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = + +# 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. +# The allowed range is 0 to 359. + +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. + +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. + +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. + +HTML_TIMESTAMP = YES + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +HTML_ALIGN_MEMBERS = 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. For this to work a browser that supports +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). + +HTML_DYNAMIC_SECTIONS = NO + +# 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, 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. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# 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. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, 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. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# When GENERATE_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. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_HTMLHELP tag is set to YES, 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. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, 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. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, 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). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING = + +# If the GENERATE_HTMLHELP tag is set to YES, 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. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +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. + +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. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#namespace + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to +# add. For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see +# +# Qt Help Project / Custom Filters. + +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. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, 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. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files +# will be generated, which together with the HTML files, 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. + +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. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. + +DISABLE_INDEX = NO + +# This tag can be used to set the number of enum values (range [1..20]) +# that doxygen will group on one line in the generated HTML documentation. + +ENUM_VALUES_PER_LINE = 4 + +# 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. + +GENERATE_TREEVIEW = NO + +# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, +# and Class Hierarchy pages using a tree view instead of an ordered list. + +USE_INLINE_TREES = NO + +# 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. + +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. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# 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. + +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 before the changes have effect. + +FORMULA_TRANSPARENT = YES + +# 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. + +SEARCHENGINE = YES + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a PHP enabled web server instead of at the web client +# using Javascript. Doxygen will generate the search PHP script and index +# file to put on the web server. The advantage of the server +# based approach is that it scales better to large projects and allows +# full text search. The disadvances is that it is more difficult to setup +# and does not have live searching capabilities. + +SERVER_BASED_SEARCH = NO + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = NO + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. +# Note that when enabling USE_PDFLATEX this option is only used for +# generating bitmaps for formulas in the HTML output, but not in the +# Makefile that is written to the output directory. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4wide + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = NO + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = NO + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +# If LATEX_SOURCE_CODE is set to YES then doxygen will include +# source code with syntax highlighting in the LaTeX output. +# Note that which sources are shown also depends on other settings +# such as SOURCE_BROWSER. + +LATEX_SOURCE_CODE = NO + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. +# This is useful +# if you want to understand what is going on. +# On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = YES + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# in the INCLUDE_PATH (see below) will be search if a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = include/ + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse +# the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option is superseded by the HAVE_DOT option below. This is only a +# fallback. It is recommended to install and use dot, since it yields more +# powerful graphs. + +CLASS_DIAGRAMS = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = YES + +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is +# allowed to run in parallel. When set to 0 (the default) doxygen will +# base this on the number of processors available in the system. You can set it +# explicitly to a value larger than 0 to get control over the balance +# between CPU load and processing speed. + +DOT_NUM_THREADS = 0 + +# By default doxygen will write a font called FreeSans.ttf to the output +# directory and reference it in all dot files that doxygen generates. This +# font does not include all possible unicode characters however, so when you need +# these (or just want a differently looking font) you can specify the font name +# using DOT_FONTNAME. You need need to make sure dot is able to find the font, +# which can be done by putting it in a standard location or by setting the +# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory +# containing the font. + +DOT_FONTNAME = FreeSans.ttf + +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the output directory to look for the +# FreeSans.ttf font (which doxygen will put there itself). If you specify a +# different font using DOT_FONTNAME you can set the path where dot +# can find it using this tag. + +DOT_FONTPATH = + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# the CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are png, jpg, or gif +# If left blank png will be used. + +DOT_IMAGE_FORMAT = png + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 2 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. Warning: Depending on the platform used, +# enabling this option may lead to badly anti-aliased labels on the edges of +# a graph (i.e. they become hard to read). + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = YES + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES Index: contrib/contribs/EnergyCorrelator/tags/1.3.2/EnergyCorrelator.hh =================================================================== --- contrib/contribs/EnergyCorrelator/tags/1.3.2/EnergyCorrelator.hh (revision 0) +++ contrib/contribs/EnergyCorrelator/tags/1.3.2/EnergyCorrelator.hh (revision 1393) @@ -0,0 +1,1078 @@ +#ifndef __FASTJET_CONTRIB_ENERGYCORRELATOR_HH__ +#define __FASTJET_CONTRIB_ENERGYCORRELATOR_HH__ + +// EnergyCorrelator Package +// Questions/Comments? Email the authors. +// larkoski@mit.edu, lnecib@mit.edu, +// gavin.salam@cern.ch jthaler@jthaler.net +// +// Copyright (c) 2013-2016 +// Andrew Larkoski, Lina Necib Gavin Salam, and Jesse Thaler +// +// $Id$ +//---------------------------------------------------------------------- +// This file is part of FastJet contrib. +// +// It 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. +// +// It 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 code. If not, see . +//---------------------------------------------------------------------- + +#include +#include "fastjet/FunctionOfPseudoJet.hh" + +#include +#include + +FASTJET_BEGIN_NAMESPACE // defined in fastjet/internal/base.hh + +namespace contrib{ + +/// \mainpage EnergyCorrelator contrib +/// +/// The EnergyCorrelator contrib provides an implementation of energy +/// correlators and their ratios as described in arXiv:1305.0007 by +/// Larkoski, Salam and Thaler. Additionally, the ratio observable +/// D2 described in arXiv:1409.6298 by Larkoski, Moult and Neill +/// is also included in this contrib. Finally, a generalized version of +/// the energy correlation functions is added, defined in +/// arXiv:1609.07483 by Moult, Necib and Thaler, which allow the +/// definition of the M series, N series, and U series observables. +/// There is also a generalized version of D2. +/// +/// +///

There are 4 main classes: +/// +/// - EnergyCorrelator +/// - EnergyCorrelatorRatio +/// - EnergyCorrelatorDoubleRatio +/// - EnergyCorrelatorGeneralized +/// +///

There are five classes that define useful combinations of the ECFs. +/// +/// - EnergyCorrelatorNseries +/// - EnergyCorrelatorMseries +/// - EnergyCorrelatorUseries +/// - EnergyCorrelatorD2 +/// - EnergyCorrelatorGeneralizedD2 +/// +///

There are also aliases for easier access: +/// - EnergyCorrelatorCseries (same as EnergyCorrelatorDoubleRatio) +/// - EnergyCorrelatorC1 (EnergyCorrelatorCseries with i=1) +/// - EnergyCorrelatorC2 (EnergyCorrelatorCseries with i=2) +/// - EnergyCorrelatorN2 (EnergyCorrelatorNseries with i=2) +/// - EnergyCorrelatorN3 (EnergyCorrelatorNseries with i=3) +/// - EnergyCorrelatorM2 (EnergyCorrelatorMseries with i=2) +/// - EnergyCorrelatorU1 (EnergyCorrelatorUseries with i=1) +/// - EnergyCorrelatorU2 (EnergyCorrelatorUseries with i=2) +/// - EnergyCorrelatorU3 (EnergyCorrelatorUseries with i=3) +/// +/// Each of these classes is a FastJet FunctionOfPseudoJet. +/// EnergyCorrelatorDoubleRatio (which is equivalent to EnergyCorrelatorCseries) +/// is in particular is useful for quark/gluon discrimination and boosted +/// object tagging. +/// +/// Using the original 2- and 3-point correlators, EnergyCorrelationD2 has +/// been shown to be the optimal combination for boosted 2-prong tagging. +/// +/// The EnergyCorrelatorNseries and EnergyCorrelatorMseries use +/// generalized correlation functions with different angular scaling, +/// and are intended for use on 2-prong and 3-prong jets. +/// The EnergyCorrelatorUseries is useful for quark/gluon discrimimation. +/// +/// See the file example.cc for an illustration of usage and +/// example_basic_usage.cc for the most commonly used functions. + +//------------------------------------------------------------------------ +/// \class EnergyCorrelator +/// ECF(N,beta) is the N-point energy correlation function, with an angular exponent beta. +/// +/// It is defined as follows +/// +/// - \f$ \mathrm{ECF}(1,\beta) = \sum_i E_i \f$ +/// - \f$ \mathrm{ECF}(2,\beta) = \sum_{i { + friend class EnergyCorrelatorGeneralized; ///< This allow ECFG to access the energy and angle definitions + ///< of this class, which are otherwise private. + public: + + enum Measure { + pt_R, ///< use transverse momenta and boost-invariant angles, + ///< eg \f$\mathrm{ECF}(2,\beta) = \sum_{i=3 this leads to many expensive recomputations, + ///< but has only O(n) memory usage for n particles + + storage_array /// the interparticle angles are cached. This gives a significant speed + /// improvement for N>=3, but has a memory requirement of (4n^2) bytes. + }; + + public: + + /// constructs an N-point correlator with angular exponent beta, + /// using the specified choice of energy and angular measure as well + /// one of two possible underlying computational Strategy + EnergyCorrelator(unsigned int N, + double beta, + Measure measure = pt_R, + Strategy strategy = storage_array) : + _N(N), _beta(beta), _measure(measure), _strategy(strategy) {}; + + /// destructor + virtual ~EnergyCorrelator(){} + + /// returns the value of the energy correlator for a jet's + /// constituents. (Normally accessed by the parent class's + /// operator()). + double result(const PseudoJet& jet) const; + + std::string description() const; + + /// returns the the part of the description related to the parameters + std::string description_parameters() const; + std::string description_no_N() const; + + private: + + unsigned int _N; + double _beta; + Measure _measure; + Strategy _strategy; + + double energy(const PseudoJet& jet) const; + double angleSquared(const PseudoJet& jet1, const PseudoJet& jet2) const; + double multiply_angles(double angles[], int n_angles, unsigned int N_total) const; + void precompute_energies_and_angles(std::vector const &particles, double* energyStore, double** angleStore) const; + double evaluate_n3(unsigned int nC, unsigned int n_angles, double* energyStore, double** angleStore) const; + double evaluate_n4(unsigned int nC, unsigned int n_angles, double* energyStore, double** angleStore) const; + double evaluate_n5(unsigned int nC, unsigned int n_angles, double* energyStore, double** angleStore) const; + }; + +// core EnergyCorrelator::result code in .cc file. + + +//------------------------------------------------------------------------ +/// \class EnergyCorrelatorRatio +/// A class to calculate the ratio of (N+1)-point to N-point energy correlators, +/// ECF(N+1,beta)/ECF(N,beta), +/// called \f$ r_N^{(\beta)} \f$ in the publication. + class EnergyCorrelatorRatio : public FunctionOfPseudoJet { + + public: + + /// constructs an (N+1)-point to N-point correlator ratio with + /// angular exponent beta, using the specified choice of energy and + /// angular measure as well one of two possible underlying + /// computational strategies + EnergyCorrelatorRatio(unsigned int N, + double beta, + EnergyCorrelator::Measure measure = EnergyCorrelator::pt_R, + EnergyCorrelator::Strategy strategy = EnergyCorrelator::storage_array) + : _N(N), _beta(beta), _measure(measure), _strategy(strategy) {}; + + virtual ~EnergyCorrelatorRatio() {} + + /// returns the value of the energy correlator ratio for a jet's + /// constituents. (Normally accessed by the parent class's + /// operator()). + double result(const PseudoJet& jet) const; + + std::string description() const; + + private: + + unsigned int _N; + double _beta; + + EnergyCorrelator::Measure _measure; + EnergyCorrelator::Strategy _strategy; + + + }; + + inline double EnergyCorrelatorRatio::result(const PseudoJet& jet) const { + + double numerator = EnergyCorrelator(_N + 1, _beta, _measure, _strategy).result(jet); + double denominator = EnergyCorrelator(_N, _beta, _measure, _strategy).result(jet); + + return numerator/denominator; + + } + + +//------------------------------------------------------------------------ +/// \class EnergyCorrelatorDoubleRatio +/// Calculates the double ratio of energy correlators, ECF(N-1,beta)*ECF(N+1)/ECF(N,beta)^2. +/// +/// A class to calculate a double ratio of energy correlators, +/// ECF(N-1,beta)*ECF(N+1,beta)/ECF(N,beta)^2, +/// called \f$C_N^{(\beta)}\f$ in the publication, and equal to +/// \f$ r_N^{(\beta)}/r_{N-1}^{(\beta)} \f$. +/// + + class EnergyCorrelatorDoubleRatio : public FunctionOfPseudoJet { + + public: + + EnergyCorrelatorDoubleRatio(unsigned int N, + double beta, + EnergyCorrelator::Measure measure = EnergyCorrelator::pt_R, + EnergyCorrelator::Strategy strategy = EnergyCorrelator::storage_array) + : _N(N), _beta(beta), _measure(measure), _strategy(strategy) { + + if (_N < 1) throw Error("EnergyCorrelatorDoubleRatio: N must be 1 or greater."); + + }; + + virtual ~EnergyCorrelatorDoubleRatio() {} + + + /// returns the value of the energy correlator double-ratio for a + /// jet's constituents. (Normally accessed by the parent class's + /// operator()). + double result(const PseudoJet& jet) const; + + std::string description() const; + + private: + + unsigned int _N; + double _beta; + EnergyCorrelator::Measure _measure; + EnergyCorrelator::Strategy _strategy; + + + }; + + + inline double EnergyCorrelatorDoubleRatio::result(const PseudoJet& jet) const { + + double numerator = EnergyCorrelator(_N - 1, _beta, _measure, _strategy).result(jet) * EnergyCorrelator(_N + 1, _beta, _measure, _strategy).result(jet); + double denominator = pow(EnergyCorrelator(_N, _beta, _measure, _strategy).result(jet), 2.0); + + return numerator/denominator; + + } + +//------------------------------------------------------------------------ +/// \class EnergyCorrelatorC1 +/// A class to calculate the normalized 2-point energy correlators, +/// ECF(2,beta)/ECF(1,beta)^2, +/// called \f$ C_1^{(\beta)} \f$ in the publication. + class EnergyCorrelatorC1 : public FunctionOfPseudoJet { + + public: + + /// constructs a 2-point correlator ratio with + /// angular exponent beta, using the specified choice of energy and + /// angular measure as well one of two possible underlying + /// computational strategies + EnergyCorrelatorC1(double beta, + EnergyCorrelator::Measure measure = EnergyCorrelator::pt_R, + EnergyCorrelator::Strategy strategy = EnergyCorrelator::storage_array) + : _beta(beta), _measure(measure), _strategy(strategy) {}; + + virtual ~EnergyCorrelatorC1() {} + + /// returns the value of the energy correlator ratio for a jet's + /// constituents. (Normally accessed by the parent class's + /// operator()). + double result(const PseudoJet& jet) const; + + std::string description() const; + + private: + + double _beta; + + EnergyCorrelator::Measure _measure; + EnergyCorrelator::Strategy _strategy; + + + }; + + + inline double EnergyCorrelatorC1::result(const PseudoJet& jet) const { + + double numerator = EnergyCorrelator(2, _beta, _measure, _strategy).result(jet); + double denominator = EnergyCorrelator(1, _beta, _measure, _strategy).result(jet); + + return numerator/denominator/denominator; + + } + + +//------------------------------------------------------------------------ +/// \class EnergyCorrelatorC2 +/// A class to calculate the double ratio of 3-point to 2-point +/// energy correlators, +/// ECF(3,beta)*ECF(1,beta)/ECF(2,beta)^2, +/// called \f$ C_2^{(\beta)} \f$ in the publication. + class EnergyCorrelatorC2 : public FunctionOfPseudoJet { + + public: + + /// constructs a 3-point to 2-point correlator double ratio with + /// angular exponent beta, using the specified choice of energy and + /// angular measure as well one of two possible underlying + /// computational strategies + EnergyCorrelatorC2(double beta, + EnergyCorrelator::Measure measure = EnergyCorrelator::pt_R, + EnergyCorrelator::Strategy strategy = EnergyCorrelator::storage_array) + : _beta(beta), _measure(measure), _strategy(strategy) {}; + + virtual ~EnergyCorrelatorC2() {} + + /// returns the value of the energy correlator ratio for a jet's + /// constituents. (Normally accessed by the parent class's + /// operator()). + double result(const PseudoJet& jet) const; + + std::string description() const; + + private: + + double _beta; + + EnergyCorrelator::Measure _measure; + EnergyCorrelator::Strategy _strategy; + + + }; + + + inline double EnergyCorrelatorC2::result(const PseudoJet& jet) const { + + double numerator3 = EnergyCorrelator(3, _beta, _measure, _strategy).result(jet); + double numerator1 = EnergyCorrelator(1, _beta, _measure, _strategy).result(jet); + double denominator = EnergyCorrelator(2, _beta, _measure, _strategy).result(jet); + + return numerator3*numerator1/denominator/denominator; + + } + + +//------------------------------------------------------------------------ +/// \class EnergyCorrelatorD2 +/// A class to calculate the observable formed from the ratio of the +/// 3-point and 2-point energy correlators, +/// ECF(3,beta)*ECF(1,beta)^3/ECF(2,beta)^3, +/// called \f$ D_2^{(\beta)} \f$ in the publication. + class EnergyCorrelatorD2 : public FunctionOfPseudoJet { + + public: + + /// constructs an 3-point to 2-point correlator ratio with + /// angular exponent beta, using the specified choice of energy and + /// angular measure as well one of two possible underlying + /// computational strategies + EnergyCorrelatorD2(double beta, + EnergyCorrelator::Measure measure = EnergyCorrelator::pt_R, + EnergyCorrelator::Strategy strategy = EnergyCorrelator::storage_array) + : _beta(beta), _measure(measure), _strategy(strategy) {}; + + virtual ~EnergyCorrelatorD2() {} + + /// returns the value of the energy correlator ratio for a jet's + /// constituents. (Normally accessed by the parent class's + /// operator()). + double result(const PseudoJet& jet) const; + + std::string description() const; + + private: + + double _beta; + + EnergyCorrelator::Measure _measure; + EnergyCorrelator::Strategy _strategy; + + + }; + + + inline double EnergyCorrelatorD2::result(const PseudoJet& jet) const { + + double numerator3 = EnergyCorrelator(3, _beta, _measure, _strategy).result(jet); + double numerator1 = EnergyCorrelator(1, _beta, _measure, _strategy).result(jet); + double denominator2 = EnergyCorrelator(2, _beta, _measure, _strategy).result(jet); + + return numerator3*numerator1*numerator1*numerator1/denominator2/denominator2/denominator2; + + } + + +//------------------------------------------------------------------------ +/// \class EnergyCorrelatorGeneralized +/// A generalized and normalized version of the N-point energy correlators, with +/// angular exponent beta and v number of pairwise angles. When \f$v = {N \choose 2}\f$ +/// (or, for convenience, \f$v = -1\f$), EnergyCorrelatorGeneralized just gives normalized +/// versions of EnergyCorrelator: +/// - \f$ \mathrm{ECFG}(-1,1,\beta) = \mathrm{ECFN}(N,\beta) = \mathrm{ECF}(N,\beta)/\mathrm{ECF}(1,\beta)\f$ +/// +/// Note that there is no separate class that implements ECFN, though it is a +/// notation that we will use in this documentation. Examples of the low-point normalized +/// correlators are: +/// - \f$\mathrm{ECFN}(1,\beta) = 1\f$ +/// - \f$\mathrm{ECFN}(2,\beta) = \sum_{i { + public: + + /// constructs an N-point correlator with v_angles pairwise angles + /// and angular exponent beta, + /// using the specified choice of energy and angular measure as well + /// one of two possible underlying computational Strategy + EnergyCorrelatorGeneralized(int v_angles, + unsigned int N, + double beta, + EnergyCorrelator::Measure measure = EnergyCorrelator::pt_R, + EnergyCorrelator::Strategy strategy = EnergyCorrelator::storage_array) + : _angles(v_angles), _N(N), _beta(beta), _measure(measure), _strategy(strategy), _helper_correlator(1,_beta, _measure, _strategy) {}; + + /// destructor + virtual ~EnergyCorrelatorGeneralized(){} + + /// returns the value of the normalized energy correlator for a jet's + /// constituents. (Normally accessed by the parent class's + /// operator()). + + double result(const PseudoJet& jet) const; + std::vector result_all_angles(const PseudoJet& jet) const; + + private: + + int _angles; + unsigned int _N; + double _beta; + EnergyCorrelator::Measure _measure; + EnergyCorrelator::Strategy _strategy; + EnergyCorrelator _helper_correlator; + + double energy(const PseudoJet& jet) const; + double angleSquared(const PseudoJet& jet1, const PseudoJet& jet2) const; + double multiply_angles(double angles[], int n_angles, unsigned int N_total) const; + void precompute_energies_and_angles(std::vector const &particles, double* energyStore, double** angleStore) const; + double evaluate_n3(unsigned int nC, unsigned int n_angles, double* energyStore, double** angleStore) const; + double evaluate_n4(unsigned int nC, unsigned int n_angles, double* energyStore, double** angleStore) const; + double evaluate_n5(unsigned int nC, unsigned int n_angles, double* energyStore, double** angleStore) const; + }; + + + +//------------------------------------------------------------------------ +/// \class EnergyCorrelatorGeneralizedD2 +/// A class to calculate the observable formed from the ratio of the +/// 3-point and 2-point energy correlators, +/// ECFN(3,alpha)/ECFN(2,beta)^3 alpha/beta, +/// called \f$ D_2^{(\alpha, \beta)} \f$ in the publication. + class EnergyCorrelatorGeneralizedD2 : public FunctionOfPseudoJet { + + public: + + /// constructs an 3-point to 2-point correlator ratio with + /// angular exponent beta, using the specified choice of energy and + /// angular measure as well one of two possible underlying + /// computational strategies + EnergyCorrelatorGeneralizedD2( + double alpha, + double beta, + EnergyCorrelator::Measure measure = EnergyCorrelator::pt_R, + EnergyCorrelator::Strategy strategy = EnergyCorrelator::storage_array) + : _alpha(alpha), _beta(beta), _measure(measure), _strategy(strategy) {}; + + virtual ~EnergyCorrelatorGeneralizedD2() {} + + /// returns the value of the energy correlator ratio for a jet's + /// constituents. (Normally accessed by the parent class's + /// operator()). + double result(const PseudoJet& jet) const; + + std::string description() const; + + private: + + double _alpha; + double _beta; + + EnergyCorrelator::Measure _measure; + EnergyCorrelator::Strategy _strategy; + + + }; + + + inline double EnergyCorrelatorGeneralizedD2::result(const PseudoJet& jet) const { + + double numerator = EnergyCorrelatorGeneralized(-1, 3, _alpha, _measure, _strategy).result(jet); + double denominator = EnergyCorrelatorGeneralized(-1, 2, _beta, _measure, _strategy).result(jet); + + return numerator/pow(denominator, 3.0*_alpha/_beta); + + } + + +//------------------------------------------------------------------------ +/// \class EnergyCorrelatorNseries +/// A class to calculate the observable formed from the ratio of the +/// 3-point and 2-point energy correlators, +/// N_n = ECFG(2,n+1,beta)/ECFG(1,n,beta)^2, +/// called \f$ N_i^{(\alpha, \beta)} \f$ in the publication. +/// By definition, N_1^{beta} = ECFG(1, 2, 2*beta), where the angular exponent +/// is twice as big since the N series should involve two pairwise angles. + class EnergyCorrelatorNseries : public FunctionOfPseudoJet { + + public: + + /// constructs a n 3-point to 2-point correlator ratio with + /// angular exponent beta, using the specified choice of energy and + /// angular measure as well one of two possible underlying + /// computational strategies + EnergyCorrelatorNseries( + unsigned int n, + double beta, + EnergyCorrelator::Measure measure = EnergyCorrelator::pt_R, + EnergyCorrelator::Strategy strategy = EnergyCorrelator::storage_array) + : _n(n), _beta(beta), _measure(measure), _strategy(strategy) { + + if (_n < 1) throw Error("EnergyCorrelatorNseries: n must be 1 or greater."); + + }; + + virtual ~EnergyCorrelatorNseries() {} + + /// returns the value of the energy correlator ratio for a jet's + /// constituents. (Normally accessed by the parent class's + /// operator()). + double result(const PseudoJet& jet) const; + + std::string description() const; + + private: + + unsigned int _n; + double _beta; + EnergyCorrelator::Measure _measure; + EnergyCorrelator::Strategy _strategy; + + }; + + + inline double EnergyCorrelatorNseries::result(const PseudoJet& jet) const { + + if (_n == 1) return EnergyCorrelatorGeneralized(1, 2, 2*_beta, _measure, _strategy).result(jet); + // By definition, N1 = ECFN(2, 2 beta) + double numerator = EnergyCorrelatorGeneralized(2, _n + 1, _beta, _measure, _strategy).result(jet); + double denominator = EnergyCorrelatorGeneralized(1, _n, _beta, _measure, _strategy).result(jet); + + return numerator/denominator/denominator; + + } + + + +//------------------------------------------------------------------------ +/// \class EnergyCorrelatorN2 +/// A class to calculate the observable formed from the ratio of the +/// 3-point and 2-point energy correlators, +/// ECFG(2,3,beta)/ECFG(1,2,beta)^2, +/// called \f$ N_2^{(\beta)} \f$ in the publication. + class EnergyCorrelatorN2 : public FunctionOfPseudoJet { + + public: + + /// constructs an 3-point to 2-point correlator ratio with + /// angular exponent beta, using the specified choice of energy and + /// angular measure as well one of two possible underlying + /// computational strategies + EnergyCorrelatorN2(double beta, + EnergyCorrelator::Measure measure = EnergyCorrelator::pt_R, + EnergyCorrelator::Strategy strategy = EnergyCorrelator::storage_array) + : _beta(beta), _measure(measure), _strategy(strategy) {}; + + virtual ~EnergyCorrelatorN2() {} + + /// returns the value of the energy correlator ratio for a jet's + /// constituents. (Normally accessed by the parent class's + /// operator()). + double result(const PseudoJet& jet) const; + + std::string description() const; + + private: + + double _beta; + + EnergyCorrelator::Measure _measure; + EnergyCorrelator::Strategy _strategy; + + + }; + + + inline double EnergyCorrelatorN2::result(const PseudoJet& jet) const { + + double numerator = EnergyCorrelatorGeneralized(2, 3, _beta, _measure, _strategy).result(jet); + double denominator = EnergyCorrelatorGeneralized(1, 2, _beta, _measure, _strategy).result(jet); + + return numerator/denominator/denominator; + + } + + +//------------------------------------------------------------------------ +/// \class EnergyCorrelatorN3 +/// A class to calculate the observable formed from the ratio of the +/// 3-point and 2-point energy correlators, +/// ECFG(2,4,beta)/ECFG(1,3,beta)^2, +/// called \f$ N_3^{(\beta)} \f$ in the publication. + class EnergyCorrelatorN3 : public FunctionOfPseudoJet { + + public: + + /// constructs an 3-point to 2-point correlator ratio with + /// angular exponent beta, using the specified choice of energy and + /// angular measure as well one of two possible underlying + /// computational strategies + EnergyCorrelatorN3(double beta, + EnergyCorrelator::Measure measure = EnergyCorrelator::pt_R, + EnergyCorrelator::Strategy strategy = EnergyCorrelator::storage_array) + : _beta(beta), _measure(measure), _strategy(strategy) {}; + + virtual ~EnergyCorrelatorN3() {} + + /// returns the value of the energy correlator ratio for a jet's + /// constituents. (Normally accessed by the parent class's + /// operator()). + double result(const PseudoJet& jet) const; + + std::string description() const; + + private: + + double _beta; + + EnergyCorrelator::Measure _measure; + EnergyCorrelator::Strategy _strategy; + + + }; + + + inline double EnergyCorrelatorN3::result(const PseudoJet& jet) const { + + double numerator = EnergyCorrelatorGeneralized(2, 4, _beta, _measure, _strategy).result(jet); + double denominator = EnergyCorrelatorGeneralized(1, 3, _beta, _measure, _strategy).result(jet); + + return numerator/denominator/denominator; + + } + + +//------------------------------------------------------------------------ +/// \class EnergyCorrelatorMseries +/// A class to calculate the observable formed from the ratio of the +/// 3-point and 2-point energy correlators, +/// M_n = ECFG(1,n+1,beta)/ECFG(1,n,beta), +/// called \f$ M_i^{(\alpha, \beta)} \f$ in the publication. +/// By definition, M_1^{beta} = ECFG(1,2,beta) + class EnergyCorrelatorMseries : public FunctionOfPseudoJet { + + public: + + /// constructs a n 3-point to 2-point correlator ratio with + /// angular exponent beta, using the specified choice of energy and + /// angular measure as well one of two possible underlying + /// computational strategies + EnergyCorrelatorMseries( + unsigned int n, + double beta, + EnergyCorrelator::Measure measure = EnergyCorrelator::pt_R, + EnergyCorrelator::Strategy strategy = EnergyCorrelator::storage_array) + : _n(n), _beta(beta), _measure(measure), _strategy(strategy) { + + if (_n < 1) throw Error("EnergyCorrelatorMseries: n must be 1 or greater."); + + }; + + virtual ~EnergyCorrelatorMseries() {} + + /// returns the value of the energy correlator ratio for a jet's + /// constituents. (Normally accessed by the parent class's + /// operator()). + double result(const PseudoJet& jet) const; + + std::string description() const; + + private: + + unsigned int _n; + double _beta; + EnergyCorrelator::Measure _measure; + EnergyCorrelator::Strategy _strategy; + + }; + + + inline double EnergyCorrelatorMseries::result(const PseudoJet& jet) const { + + if (_n == 1) return EnergyCorrelatorGeneralized(1, 2, _beta, _measure, _strategy).result(jet); + + double numerator = EnergyCorrelatorGeneralized(1, _n + 1, _beta, _measure, _strategy).result(jet); + double denominator = EnergyCorrelatorGeneralized(1, _n, _beta, _measure, _strategy).result(jet); + + return numerator/denominator; + + } + +//------------------------------------------------------------------------ +/// \class EnergyCorrelatorM2 +/// A class to calculate the observable formed from the ratio of the +/// 3-point and 2-point energy correlators, +/// ECFG(1,3,beta)/ECFG(1,2,beta), +/// called \f$ M_2^{(\beta)} \f$ in the publication. + class EnergyCorrelatorM2 : public FunctionOfPseudoJet { + + public: + + /// constructs an 3-point to 2-point correlator ratio with + /// angular exponent beta, using the specified choice of energy and + /// angular measure as well one of two possible underlying + /// computational strategies + EnergyCorrelatorM2(double beta, + EnergyCorrelator::Measure measure = EnergyCorrelator::pt_R, + EnergyCorrelator::Strategy strategy = EnergyCorrelator::storage_array) + : _beta(beta), _measure(measure), _strategy(strategy) {}; + + virtual ~EnergyCorrelatorM2() {} + + /// returns the value of the energy correlator ratio for a jet's + /// constituents. (Normally accessed by the parent class's + /// operator()). + double result(const PseudoJet& jet) const; + + std::string description() const; + + private: + + double _beta; + + EnergyCorrelator::Measure _measure; + EnergyCorrelator::Strategy _strategy; + + + }; + + + inline double EnergyCorrelatorM2::result(const PseudoJet& jet) const { + + double numerator = EnergyCorrelatorGeneralized(1, 3, _beta, _measure, _strategy).result(jet); + double denominator = EnergyCorrelatorGeneralized(1, 2, _beta, _measure, _strategy).result(jet); + + return numerator/denominator; + + } + + +//------------------------------------------------------------------------ +/// \class EnergyCorrelatorCseries +/// Calculates the C series energy correlators, ECFN(N-1,beta)*ECFN(N+1,beta)/ECFN(N,beta)^2. +/// This is equivalent to EnergyCorrelatorDoubleRatio +/// +/// A class to calculate a double ratio of energy correlators, +/// ECFN(N-1,beta)*ECFN(N+1,beta)/ECFN(N,beta)^2, +/// called \f$C_N^{(\beta)}\f$ in the publication, and equal to +/// \f$ r_N^{(\beta)}/r_{N-1}^{(\beta)} \f$. +/// + + class EnergyCorrelatorCseries : public FunctionOfPseudoJet { + + public: + + EnergyCorrelatorCseries(unsigned int N, + double beta, + EnergyCorrelator::Measure measure = EnergyCorrelator::pt_R, + EnergyCorrelator::Strategy strategy = EnergyCorrelator::storage_array) + : _N(N), _beta(beta), _measure(measure), _strategy(strategy) { + + if (_N < 1) throw Error("EnergyCorrelatorCseries: N must be 1 or greater."); + + }; + + virtual ~EnergyCorrelatorCseries() {} + + + /// returns the value of the energy correlator double-ratio for a + /// jet's constituents. (Normally accessed by the parent class's + /// operator()). + double result(const PseudoJet& jet) const; + + std::string description() const; + + private: + + unsigned int _N; + double _beta; + EnergyCorrelator::Measure _measure; + EnergyCorrelator::Strategy _strategy; + + + }; + + + inline double EnergyCorrelatorCseries::result(const PseudoJet& jet) const { + + double numerator = EnergyCorrelatorGeneralized(-1, _N - 1, _beta, _measure, _strategy).result(jet) * EnergyCorrelatorGeneralized(-1, _N + 1, _beta, _measure, _strategy).result(jet); + double denominator = pow(EnergyCorrelatorGeneralized(-1, _N, _beta, _measure, _strategy).result(jet), 2.0); + + return numerator/denominator; + + } + +//------------------------------------------------------------------------ +/// \class EnergyCorrelatorUseries +/// A class to calculate the observable used for quark versus gluon discrimination +/// U_n = ECFG(1,n+1,beta), +/// called \f$ U_i^{(\beta)} \f$ in the publication. + + class EnergyCorrelatorUseries : public FunctionOfPseudoJet { + + public: + + /// constructs a n 3-point to 2-point correlator ratio with + /// angular exponent beta, using the specified choice of energy and + /// angular measure as well one of two possible underlying + /// computational strategies + EnergyCorrelatorUseries( + unsigned int n, + double beta, + EnergyCorrelator::Measure measure = EnergyCorrelator::pt_R, + EnergyCorrelator::Strategy strategy = EnergyCorrelator::storage_array) + : _n(n), _beta(beta), _measure(measure), _strategy(strategy) { + + if (_n < 1) throw Error("EnergyCorrelatorUseries: n must be 1 or greater."); + + }; + + virtual ~EnergyCorrelatorUseries() {} + + /// returns the value of the energy correlator ratio for a jet's + /// constituents. (Normally accessed by the parent class's + /// operator()). + double result(const PseudoJet& jet) const; + + std::string description() const; + + private: + + unsigned int _n; + double _beta; + EnergyCorrelator::Measure _measure; + EnergyCorrelator::Strategy _strategy; + + }; + + + inline double EnergyCorrelatorUseries::result(const PseudoJet& jet) const { + + double answer = EnergyCorrelatorGeneralized(1, _n + 1, _beta, _measure, _strategy).result(jet); + return answer; + + } + + +//------------------------------------------------------------------------ +/// \class EnergyCorrelatorU1 +/// A class to calculate the observable formed from +/// ECFG(1,2,beta), +/// called \f$ U_1^{(\beta)} \f$ in the publication. + class EnergyCorrelatorU1 : public FunctionOfPseudoJet { + + public: + + /// constructs a 2-point correlator with + /// angular exponent beta, using the specified choice of energy and + /// angular measure as well one of two possible underlying + /// computational strategies + EnergyCorrelatorU1(double beta, + EnergyCorrelator::Measure measure = EnergyCorrelator::pt_R, + EnergyCorrelator::Strategy strategy = EnergyCorrelator::storage_array) + : _beta(beta), _measure(measure), _strategy(strategy) {}; + + virtual ~EnergyCorrelatorU1() {} + + /// returns the value of the energy correlator ratio for a jet's + /// constituents. (Normally accessed by the parent class's + /// operator()). + double result(const PseudoJet& jet) const; + + std::string description() const; + + private: + + double _beta; + + EnergyCorrelator::Measure _measure; + EnergyCorrelator::Strategy _strategy; + + + }; + + + inline double EnergyCorrelatorU1::result(const PseudoJet& jet) const { + + double answer = EnergyCorrelatorGeneralized(1, 2, _beta, _measure, _strategy).result(jet); + + return answer; + + } + + + //------------------------------------------------------------------------ + /// \class EnergyCorrelatorU2 + /// A class to calculate the observable formed from + /// ECFG(1,3,beta), + /// called \f$ U_2^{(\beta)} \f$ in the publication. + class EnergyCorrelatorU2 : public FunctionOfPseudoJet { + + public: + + /// constructs a 3-point correlator with + /// angular exponent beta, using the specified choice of energy and + /// angular measure as well one of two possible underlying + /// computational strategies + EnergyCorrelatorU2(double beta, + EnergyCorrelator::Measure measure = EnergyCorrelator::pt_R, + EnergyCorrelator::Strategy strategy = EnergyCorrelator::storage_array) + : _beta(beta), _measure(measure), _strategy(strategy) {}; + + virtual ~EnergyCorrelatorU2() {} + + /// returns the value of the energy correlator ratio for a jet's + /// constituents. (Normally accessed by the parent class's + /// operator()). + double result(const PseudoJet& jet) const; + + std::string description() const; + + private: + + double _beta; + + EnergyCorrelator::Measure _measure; + EnergyCorrelator::Strategy _strategy; + + + }; + + + inline double EnergyCorrelatorU2::result(const PseudoJet& jet) const { + + double answer = EnergyCorrelatorGeneralized(1, 3, _beta, _measure, _strategy).result(jet); + + return answer; + + } + + + //------------------------------------------------------------------------ + /// \class EnergyCorrelatorU3 + /// A class to calculate the observable formed from + /// ECFG(1,4,beta), + /// called \f$ U_3^{(\beta)} \f$ in the publication. + class EnergyCorrelatorU3 : public FunctionOfPseudoJet { + + public: + + /// constructs a 4-point correlator with + /// angular exponent beta, using the specified choice of energy and + /// angular measure as well one of two possible underlying + /// computational strategies + EnergyCorrelatorU3(double beta, + EnergyCorrelator::Measure measure = EnergyCorrelator::pt_R, + EnergyCorrelator::Strategy strategy = EnergyCorrelator::storage_array) + : _beta(beta), _measure(measure), _strategy(strategy) {}; + + virtual ~EnergyCorrelatorU3() {} + + /// returns the value of the energy correlator ratio for a jet's + /// constituents. (Normally accessed by the parent class's + /// operator()). + double result(const PseudoJet& jet) const; + + std::string description() const; + + private: + + double _beta; + + EnergyCorrelator::Measure _measure; + EnergyCorrelator::Strategy _strategy; + + + }; + + + inline double EnergyCorrelatorU3::result(const PseudoJet& jet) const { + + double answer = EnergyCorrelatorGeneralized(1, 4, _beta, _measure, _strategy).result(jet); + + return answer; + + } + + + +} // namespace contrib + +FASTJET_END_NAMESPACE + +#endif // __FASTJET_CONTRIB_ENERGYCORRELATOR_HH__ Property changes on: contrib/contribs/EnergyCorrelator/tags/1.3.2/EnergyCorrelator.hh ___________________________________________________________________ Added: svn:keywords ## -0,0 +1 ## +Id \ No newline at end of property Index: contrib/contribs/EnergyCorrelator/tags/1.3.2/example_basic_usage.cc =================================================================== --- contrib/contribs/EnergyCorrelator/tags/1.3.2/example_basic_usage.cc (revision 0) +++ contrib/contribs/EnergyCorrelator/tags/1.3.2/example_basic_usage.cc (revision 1393) @@ -0,0 +1,234 @@ +// Example showing basic usage of energy correlator classes. +// +// Compile it with "make example" and run it with +// +// ./example_basic_usage < ../data/single-event.dat +// +// Copyright (c) 2013-2016 +// Andrew Larkoski, Lina Necib, Gavin Salam, and Jesse Thaler +// +// $Id: example.cc 958 2016-08-17 00:25:14Z linoush $ +//---------------------------------------------------------------------- +// This file is part of FastJet contrib. +// +// It 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. +// +// It 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 code. If not, see . +//---------------------------------------------------------------------- + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "fastjet/PseudoJet.hh" +#include "fastjet/ClusterSequence.hh" +#include "fastjet/JetDefinition.hh" + +#include +#include "EnergyCorrelator.hh" // In external code, this should be fastjet/contrib/EnergyCorrelator.hh + +using namespace std; +using namespace fastjet; +using namespace fastjet::contrib; + +// forward declaration to make things clearer +void read_event(vector &event); +void analyze(const vector & input_particles); + +//---------------------------------------------------------------------- +int main(){ + + //---------------------------------------------------------- + // read in input particles + vector event; + read_event(event); + cout << "# read an event with " << event.size() << " particles" << endl; + + //---------------------------------------------------------- + // illustrate how this EnergyCorrelator contrib works + + analyze(event); + + return 0; +} + +// read in input particles +void read_event(vector &event){ + string line; + while (getline(cin, line)) { + istringstream linestream(line); + // take substrings to avoid problems when there are extra "pollution" + // characters (e.g. line-feed). + if (line.substr(0,4) == "#END") {return;} + if (line.substr(0,1) == "#") {continue;} + double px,py,pz,E; + linestream >> px >> py >> pz >> E; + PseudoJet particle(px,py,pz,E); + + // push event onto back of full_event vector + event.push_back(particle); + } +} + +//////// +// +// Main Routine for Analysis +// +/////// + +void analyze(const vector & input_particles) { + + /////// EnergyCorrelator ///////////////////////////// + + // Initial clustering with anti-kt algorithm + JetAlgorithm algorithm = antikt_algorithm; + double jet_rad = 1.00; // jet radius for anti-kt algorithm + JetDefinition jetDef = JetDefinition(algorithm,jet_rad,E_scheme,Best); + ClusterSequence clust_seq(input_particles,jetDef); + vector antikt_jets = sorted_by_pt(clust_seq.inclusive_jets()); + + for (int j = 0; j < 1; j++) { // Hardest jet per event + if (antikt_jets[j].perp() > 200) { + + PseudoJet myJet = antikt_jets[j]; + + + // The angularity is set by the value of beta + double beta; + + cout << "-------------------------------------------------------------------------------------" << endl; + cout << "EnergyCorrelator: C series " << endl; + cout << "-------------------------------------------------------------------------------------" << endl; + printf("%7s %14s %14s %14s\n","beta", "C1", "C2", "C3"); + + + beta = 1.0; + //Defining the Cseries for beta= 1.0 + EnergyCorrelatorC1 C1s(beta); + EnergyCorrelatorC2 C2s(beta); + EnergyCorrelatorCseries C3s(3, beta); + + + printf("%7.3f %14.6f %14.6f %14.6f\n",beta,C1s(myJet),C2s(myJet),C3s(myJet)); + + beta = 2.0; + //Defining the Cseries for beta= 2.0 + EnergyCorrelatorC1 C1s_2(beta); + EnergyCorrelatorC2 C2s_2(beta); + EnergyCorrelatorCseries C3s_2(3, beta); + + + printf("%7.3f %14.6f %14.6f %14.6f\n",beta,C1s_2(myJet),C2s_2(myJet),C3s_2(myJet)); + + + cout << "-------------------------------------------------------------------------------------" << endl; + cout << "EnergyCorrelator: D2, orignal (alpha=beta) and generalized " << endl; + cout << "-------------------------------------------------------------------------------------" << endl; + printf("%7s %14s %14s %14s\n","beta","D2", "D2(alpha=1)", "D2(alpha=2)"); + + + beta = 1.0; + EnergyCorrelatorD2 d2(beta); + double alpha = 1.0; + EnergyCorrelatorGeneralizedD2 d2_generalized(alpha, beta); + alpha = 2.0; + EnergyCorrelatorGeneralizedD2 d2_generalized_2(alpha, beta); + + printf("%7.3f %14.6f %14.6f %14.6f\n",beta,d2(myJet), d2_generalized(myJet), d2_generalized_2(myJet)); + beta = 2.0; + EnergyCorrelatorD2 d2_2(beta); + alpha = 1.0; + EnergyCorrelatorGeneralizedD2 d2_generalized_3(alpha, beta); + alpha = 2.0; + EnergyCorrelatorGeneralizedD2 d2_generalized_4(alpha, beta); + printf("%7.3f %14.6f %14.6f %14.6f\n",beta,d2_2(myJet), d2_generalized_3(myJet), d2_generalized_4(myJet)); + + + cout << "-------------------------------------------------------------------------------------" << endl; + cout << "EnergyCorrelator: N series " << endl; + cout << "-------------------------------------------------------------------------------------" << endl; + printf("%7s %14s %14s\n","beta", "N2", "N3"); + + + beta = 1.0; + // Directly defining the EnergyCorrelator N2 and N3 + EnergyCorrelatorN2 N2(beta); + EnergyCorrelatorN3 N3(beta); + printf("%7.3f %14.6f %14.6f\n",beta, N2(myJet), N3(myJet)); + + beta = 2.0; + EnergyCorrelatorN2 N2_2(beta); + EnergyCorrelatorN3 N3_2(beta); + printf("%7.3f %14.6f %14.6f\n",beta, N2_2(myJet), N3_2(myJet)); + + + cout << "-------------------------------------------------------------------------------------" << endl; + cout << "EnergyCorrelator: M series " << endl; + cout << "-------------------------------------------------------------------------------------" << endl; + printf("%7s %14s %14s\n","beta", "M2", "M3"); + + beta = 1.0; + //Directly defining M2 + EnergyCorrelatorM2 M2(beta); + EnergyCorrelatorMseries M3(3, beta); + printf("%7.3f %14.6f %14.6f\n", beta, M2(myJet), M3(myJet)); + + beta = 2.0; + EnergyCorrelatorM2 M2_2(beta); + EnergyCorrelatorMseries M3_2(3, beta); + printf("%7.3f %14.6f %14.6f\n", beta, M2_2(myJet), M3_2(myJet)); + + cout << "-------------------------------------------------------------------------------------" << endl; + cout << "EnergyCorrelator: U series " << endl; + cout << "-------------------------------------------------------------------------------------" << endl; + printf("%7s %14s %14s %14s\n","beta", "U1", "U2", "U3"); + + + beta = 0.5; + //Defining the Useries for beta= 0.5 + EnergyCorrelatorU1 U1s(beta); + EnergyCorrelatorU2 U2s(beta); + EnergyCorrelatorU3 U3s(beta); + + + printf("%7.3f %14.8f %14.8f %14.8f\n",beta,U1s(myJet),U2s(myJet),U3s(myJet)); + + beta = 1.0; + //Defining the Useries for beta= 1.0 + EnergyCorrelatorU1 U1s_2(beta); + EnergyCorrelatorU2 U2s_2(beta); + EnergyCorrelatorU3 U3s_2(beta); + + + printf("%7.3f %14.8f %14.8f %14.8f\n",beta,U1s_2(myJet),U2s_2(myJet),U3s_2(myJet)); + + beta = 2.0; + //Defining the Useries for beta= 2.0 + EnergyCorrelatorU1 U1s_3(beta); + EnergyCorrelatorU2 U2s_3(beta); + EnergyCorrelatorU3 U3s_3(beta); + + + printf("%7.3f %14.8f %14.8f %14.8f\n",beta,U1s_3(myJet),U2s_3(myJet),U3s_3(myJet)); + } + } +} + + + + Index: contrib/contribs/EnergyCorrelator/tags/1.3.2/AUTHORS =================================================================== --- contrib/contribs/EnergyCorrelator/tags/1.3.2/AUTHORS (revision 0) +++ contrib/contribs/EnergyCorrelator/tags/1.3.2/AUTHORS (revision 1393) @@ -0,0 +1,23 @@ +The EnergyCorrelator FastJet contrib was written and is maintained and developed by: + + Andrew Larkoski + Lina Necib + Gavin Salam + Jesse Thaler + +For physics details, see: + + Energy Correlation Functions for Jet Substructure. + Andrew J. Larkoski, Gavin P. Salam, and Jesse Thaler. + JHEP 1306, 108 (2013) + arXiv:1305.0007. + + Power Counting to Better Jet Observables. + Andrew J. Larkoski, Ian Moult, and Duff Neill. + JHEP 1412, 009 (2014) + arXiv:1409.6298. + + New Angles on Energy Correlation Functions. + Ian Moult, Lina Necib, and Jesse Thaler. + arXiv:1609.07483. +---------------------------------------------------------------------- Index: contrib/contribs/EnergyCorrelator/tags/1.3.2/VERSION =================================================================== --- contrib/contribs/EnergyCorrelator/tags/1.3.2/VERSION (revision 0) +++ contrib/contribs/EnergyCorrelator/tags/1.3.2/VERSION (revision 1393) @@ -0,0 +1 @@ +1.3.2 \ No newline at end of file Index: contrib/contribs/EnergyCorrelator/tags/1.3.2/example.ref =================================================================== --- contrib/contribs/EnergyCorrelator/tags/1.3.2/example.ref (revision 0) +++ contrib/contribs/EnergyCorrelator/tags/1.3.2/example.ref (revision 1393) @@ -0,0 +1,922 @@ +# read an event with 354 particles +#-------------------------------------------------------------------------- +# FastJet release 3.4.2 +# M. Cacciari, G.P. Salam and G. Soyez +# A software package for jet finding and analysis at colliders +# http://fastjet.fr +# +# Please cite EPJC72(2012)1896 [arXiv:1111.6097] if you use this package +# for scientific work and optionally PLB641(2006)57 [hep-ph/0512210]. +# +# FastJet is provided without warranty under the GNU GPL v2 or higher. +# It uses T. Chan's closest pair algorithm, S. Fortune's Voronoi code +# and 3rd party plugin jet algorithms. See COPYING file for details. +#-------------------------------------------------------------------------- +------------------------------------------------------------------------------------- +EnergyCorrelator: ECF(N,beta) with pt_R +------------------------------------------------------------------------------------- + beta N=1 (GeV) N=2 (GeV^2) N=3 (GeV^3) N=4 (GeV^4) N=5 (GeV^5) + 0.100 983.64 265690.56 2.75407e+07 1.28721e+09 3.01137e+10 + 0.200 983.64 172787.11 8.22275e+06 1.34175e+08 8.88561e+08 + 0.500 983.64 52039.98 364021 608244 356259 + 1.000 983.64 10006.49 9934.06 2670.1 271.978 + 1.500 983.64 3001.20 1066.15 118.174 4.24269 + 2.000 983.64 1272.64 260.176 14.8758 0.223955 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorRatio: r_N^(beta) = ECF(N+1,beta)/ECF(N,beta) with pt_R +------------------------------------------------------------------------------------- + beta N=0 (GeV) N=1 (GeV) N=2 (GeV) N=3 (GeV) N=4 (GeV) + 0.100 983.6369 270.1104 103.657 46.7387 23.3945 + 0.200 983.6369 175.6615 47.5889 16.3175 6.62239 + 0.500 983.6369 52.9057 6.99503 1.6709 0.585717 + 1.000 983.6369 10.1730 0.992762 0.268782 0.101861 + 1.500 983.6369 3.0511 0.355242 0.110841 0.0359022 + 2.000 983.6369 1.2938 0.204437 0.0571759 0.015055 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorDoubleRatio: C_N^(beta) = r_N^(beta)/r_{N-1}^(beta) with pt_R +------------------------------------------------------------------------------------- + beta N=1 N=2 N=3 N=4 + 0.100 0.274604 0.383758 0.450898 0.500538 + 0.200 0.178584 0.270913 0.342885 0.405845 + 0.500 0.053786 0.132217 0.238870 0.350540 + 1.000 0.010342 0.097588 0.270742 0.378972 + 1.500 0.003102 0.116430 0.312016 0.323906 + 2.000 0.001315 0.158011 0.279675 0.263310 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorC1: C_1^(beta) = ECF(2,beta)/ECF(1,beta)^2 with pt_R +------------------------------------------------------------------------------------- + beta C1 obs + 0.100 0.274604 + 0.200 0.178584 + 0.500 0.053786 + 1.000 0.010342 + 1.500 0.003102 + 2.000 0.001315 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorC2: C_2^(beta) = ECF(3,beta)*ECF(1,beta)/ECF(2,beta)^2 with pt_R +------------------------------------------------------------------------------------- + beta C2 obs + 0.100 0.383758 + 0.200 0.270913 + 0.500 0.132217 + 1.000 0.097588 + 1.500 0.116430 + 2.000 0.158011 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorD2: D_2^(beta) = ECF(3,beta)*ECF(1,beta)^3/ECF(2,beta)^3 with pt_R +------------------------------------------------------------------------------------- + beta D2 obs + 0.100 1.397496 + 0.200 1.517007 + 0.500 2.458216 + 1.000 9.435950 + 1.500 37.535182 + 2.000 120.129760 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorGeneralizedD2: D_2^(alpha, beta) = ECFN(3,alpha)/ECFN(2,beta)^(3*alpha/beta) with pt_R +------------------------------------------------------------------------------------- + beta alpha = 0.100 alpha = 0.200 alpha = 0.500 alpha = 1.000 + 0.200 0.383449 1.51701 156.246 1.74179e+06 + 0.500 0.167136 0.288212 2.45822 431.139 + 1.000 0.114048 0.134198 0.363667 9.43595 + 1.500 0.0918639 0.0870688 0.12331 1.08485 + 2.000 0.0782734 0.0632123 0.0553789 0.21881 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorGeneralized (angles = N Choose 2): ECFN(N, beta) with pt_R +------------------------------------------------------------------------------------- + beta N=1 N=2 N=3 N=4 + 0.100 1.00 0.2746037664 0.0289380967 0.0013750278 + 0.200 1.00 0.1785836568 0.0086399808 0.0001433286 + 0.500 1.00 0.0537857869 0.0003824922 0.0000006497 + 1.000 1.00 0.0103421840 0.0000104381 0.0000000029 + 1.500 1.00 0.0031018827 0.0000011202 0.0000000001 + 2.000 1.00 0.0013153375 0.0000002734 0.0000000000 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorGeneralized: ECFG(angles, N, beta=1) with pt_R +------------------------------------------------------------------------------------- + angles N=1 N=2 N=3 N=4 + 1 1.00 0.0103421840 0.0007353402 0.0000733472 + 2 0.0000460939 0.0000010704 + 3 0.0000104381 0.0000000552 + 4 0.0000000114 + 5 0.0000000045 + 6 0.0000000029 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorNseries: N_i(beta) = ECFG(i+1, 2, beta)/ECFG(i, 1, beta)^2 with pt_R +------------------------------------------------------------------------------------- + beta N=1 N=2 N=3 + 0.100 0.178584 0.551898 1.506618 + 0.200 0.078954 0.534774 1.521976 + 0.500 0.010342 0.487547 1.601014 + 1.000 0.001315 0.430942 1.979487 + 1.500 0.000437 0.391935 3.250084 + 2.000 0.000220 0.365859 6.700247 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorN2: N2(beta) = ECFG(3, 2, beta)/ECFG(2, 1, beta)^2 with pt_R +------------------------------------------------------------------------------------- + beta N2 obs + 0.100 0.551898 + 0.200 0.534774 + 0.500 0.487547 + 1.000 0.430942 + 1.500 0.391935 + 2.000 0.365859 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorN3: N3(beta) = ECFG(4, 2, beta)/ECFG(3, 1, beta)^2 with pt_R +------------------------------------------------------------------------------------- + beta N3 obs + 0.100 1.506618 + 0.200 1.521976 + 0.500 1.601014 + 1.000 1.979487 + 1.500 3.250084 + 2.000 6.700247 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorMseries: M_i(beta) = ECFG(i+1, 1, beta)/ECFN(i, 1, beta) with pt_R +------------------------------------------------------------------------------------- + beta N=1 N=2 N=3 + 0.100 0.274604 0.225158 0.151396 + 0.200 0.178584 0.206357 0.146715 + 0.500 0.053786 0.149827 0.130985 + 1.000 0.010342 0.071101 0.099746 + 1.500 0.003102 0.027603 0.065806 + 2.000 0.001315 0.010448 0.036511 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorM2: M2(beta) = ECFG(3, 1, beta)/ECFG(3, 1, beta) with pt_R +------------------------------------------------------------------------------------- + beta M2 obs + 0.100 0.225158 + 0.200 0.206357 + 0.500 0.149827 + 1.000 0.071101 + 1.500 0.027603 + 2.000 0.010448 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorCseries: C_i(beta) = ECFN(i-1, beta)*ECFN(i+1, beta)/ECFN(i, beta)^2 with pt_R +------------------------------------------------------------------------------------- + beta N=1 N=2 N=3 + 0.100 0.2746037664 0.3837575950 0.4508977207 + 0.200 0.1785836568 0.2709126926 0.3428854490 + 0.500 0.0537857869 0.1322170711 0.2388696533 + 1.000 0.0103421840 0.0975883303 0.2707417692 + 1.500 0.0031018827 0.1164297328 0.3120164994 + 2.000 0.0013153375 0.1580111821 0.2796746959 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorUseries: U_i(beta) = ECFG(i+1, 1, beta) with pt_R +------------------------------------------------------------------------------------- + beta N=1 N=2 N=3 + 0.100 0.2746037664 0.0618292258 0.0093606928 + 0.200 0.1785836568 0.0368519186 0.0054067344 + 0.500 0.0537857869 0.0080585540 0.0010555469 + 1.000 0.0103421840 0.0007353402 0.0000733472 + 1.500 0.0031018827 0.0000856204 0.0000056343 + 2.000 0.0013153375 0.0000137425 0.0000005017 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorU1: U1(beta) = ECFG(2, 1, beta) with pt_R +------------------------------------------------------------------------------------- + beta U1 obs + 0.100 0.2746037664 + 0.200 0.1785836568 + 0.500 0.0537857869 + 1.000 0.0103421840 + 1.500 0.0031018827 + 2.000 0.0013153375 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorU2: U2(beta) = ECFG(3, 1, beta) with pt_R +------------------------------------------------------------------------------------- + beta U2 obs + 0.100 0.0618292258 + 0.200 0.0368519186 + 0.500 0.0080585540 + 1.000 0.0007353402 + 1.500 0.0000856204 + 2.000 0.0000137425 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorU3: U3(beta) = ECFG(4, 1, beta) with pt_R +------------------------------------------------------------------------------------- + beta U3 obs + 0.100 0.0093606928 + 0.200 0.0054067344 + 0.500 0.0010555469 + 1.000 0.0000733472 + 1.500 0.0000056343 + 2.000 0.0000005017 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelator: ECF(N,beta) with E_theta +------------------------------------------------------------------------------------- + beta N=1 (GeV) N=2 (GeV^2) N=3 (GeV^3) N=4 (GeV^4) N=5 (GeV^5) + 0.100 1378.16 504056.94 6.83627e+07 4.04064e+09 1.15642e+11 + 0.200 1378.16 316828.68 1.84412e+07 3.45185e+08 2.47586e+09 + 0.500 1378.16 86243.22 614652 941845 459093 + 1.000 1378.16 14186.79 11682.6 2060.77 92.9815 + 1.500 1378.16 3751.90 907.112 39.3366 0.273239 + 2.000 1378.16 1439.57 152.709 1.84456 0.00237065 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorRatio: r_N^(beta) = ECF(N+1,beta)/ECF(N,beta) with E_theta +------------------------------------------------------------------------------------- + beta N=0 (GeV) N=1 (GeV) N=2 (GeV) N=3 (GeV) N=4 (GeV) + 0.100 1378.1622 365.7457 135.625 59.1058 28.6198 + 0.200 1378.1622 229.8922 58.2055 18.7182 7.17256 + 0.500 1378.1622 62.5784 7.12696 1.53232 0.48744 + 1.000 1378.1622 10.2940 0.823486 0.176396 0.0451197 + 1.500 1378.1622 2.7224 0.241774 0.0433647 0.00694617 + 2.000 1378.1622 1.0446 0.10608 0.0120789 0.00128521 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorDoubleRatio: C_N^(beta) = r_N^(beta)/r_{N-1}^(beta) with E_theta +------------------------------------------------------------------------------------- + beta N=1 N=2 N=3 N=4 + 0.100 0.265387 0.370818 0.435803 0.484212 + 0.200 0.166811 0.253186 0.321588 0.383186 + 0.500 0.045407 0.113888 0.215004 0.318106 + 1.000 0.007469 0.079997 0.214207 0.255786 + 1.500 0.001975 0.088810 0.179360 0.160180 + 2.000 0.000758 0.101555 0.113867 0.106401 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorC1: C_1^(beta) = ECF(2,beta)/ECF(1,beta)^2 with E_theta +------------------------------------------------------------------------------------- + beta C1 obs + 0.100 0.265387 + 0.200 0.166811 + 0.500 0.045407 + 1.000 0.007469 + 1.500 0.001975 + 2.000 0.000758 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorC2: C_2^(beta) = ECF(3,beta)*ECF(1,beta)/ECF(2,beta)^2 with E_theta +------------------------------------------------------------------------------------- + beta C2 obs + 0.100 0.370818 + 0.200 0.253186 + 0.500 0.113888 + 1.000 0.079997 + 1.500 0.088810 + 2.000 0.101555 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorD2: D_2^(beta) = ECF(3,beta)*ECF(1,beta)^3/ECF(2,beta)^3 with E_theta +------------------------------------------------------------------------------------- + beta D2 obs + 0.100 1.397274 + 0.200 1.517804 + 0.500 2.508161 + 1.000 10.709981 + 1.500 44.958245 + 2.000 133.988418 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorGeneralizedD2: D_2^(alpha, beta) = ECFN(3,alpha)/ECFN(2,beta)^(3*alpha/beta) with E_theta +------------------------------------------------------------------------------------- + beta alpha = 0.100 alpha = 0.200 alpha = 0.500 alpha = 1.000 + 0.200 0.383339 1.5178 159.974 2.07149e+06 + 0.500 0.166972 0.287964 2.50816 509.206 + 1.000 0.113484 0.13302 0.36375 10.71 + 1.500 0.0907379 0.0850408 0.118872 1.14377 + 2.000 0.0767315 0.0608132 0.0514049 0.21389 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorGeneralized (angles = N Choose 2): ECFN(N, beta) with E_theta +------------------------------------------------------------------------------------- + beta N=1 N=2 N=3 N=4 + 0.100 1.00 0.2653865755 0.0261167137 0.0011200786 + 0.200 1.00 0.1668106769 0.0070451023 0.0000956866 + 0.500 1.00 0.0454071552 0.0002348163 0.0000002611 + 1.000 1.00 0.0074693640 0.0000044631 0.0000000006 + 1.500 1.00 0.0019753776 0.0000003465 0.0000000000 + 2.000 1.00 0.0007579352 0.0000000583 0.0000000000 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorGeneralized: ECFG(angles, N, beta=1) with E_theta +------------------------------------------------------------------------------------- + angles N=1 N=2 N=3 N=4 + 1 1.00 0.0074693640 0.0005219446 0.0000521319 + 2 0.0000242551 0.0000005388 + 3 0.0000044631 0.0000000205 + 4 0.0000000035 + 5 0.0000000011 + 6 0.0000000006 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorNseries: N_i(beta) = ECFG(i+1, 2, beta)/ECFG(i, 1, beta)^2 with E_theta +------------------------------------------------------------------------------------- + beta N=1 N=2 N=3 + 0.100 0.166811 0.551800 1.506192 + 0.200 0.068920 0.534652 1.521253 + 0.500 0.007469 0.487710 1.598907 + 1.000 0.000758 0.434746 1.977674 + 1.500 0.000207 0.401351 3.333270 + 2.000 0.000082 0.372570 7.518334 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorN2: N2(beta) = ECFG(3, 2, beta)/ECFG(2, 1, beta)^2 with E_theta +------------------------------------------------------------------------------------- + beta N2 obs + 0.100 0.551800 + 0.200 0.534652 + 0.500 0.487710 + 1.000 0.434746 + 1.500 0.401351 + 2.000 0.372570 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorN3: N3(beta) = ECFG(4, 2, beta)/ECFG(3, 1, beta)^2 with E_theta +------------------------------------------------------------------------------------- + beta N3 obs + 0.100 1.506192 + 0.200 1.521253 + 0.500 1.598907 + 1.000 1.977674 + 1.500 3.333270 + 2.000 7.518334 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorMseries: M_i(beta) = ECFG(i+1, 1, beta)/ECFN(i, 1, beta) with E_theta +------------------------------------------------------------------------------------- + beta N=1 N=2 N=3 + 0.100 0.265387 0.225134 0.151350 + 0.200 0.166811 0.206335 0.146685 + 0.500 0.045407 0.149607 0.131015 + 1.000 0.007469 0.069878 0.099880 + 1.500 0.001975 0.025930 0.065823 + 2.000 0.000758 0.009248 0.036027 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorM2: M2(beta) = ECFG(3, 1, beta)/ECFG(3, 1, beta) with E_theta +------------------------------------------------------------------------------------- + beta M2 obs + 0.100 0.225134 + 0.200 0.206335 + 0.500 0.149607 + 1.000 0.069878 + 1.500 0.025930 + 2.000 0.009248 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorCseries: C_i(beta) = ECFN(i-1, beta)*ECFN(i+1, beta)/ECFN(i, beta)^2 with E_theta +------------------------------------------------------------------------------------- + beta N=1 N=2 N=3 + 0.100 0.2653865755 0.3708178471 0.4358031826 + 0.200 0.1668106769 0.2531859580 0.3215882713 + 0.500 0.0454071552 0.1138884647 0.2150035566 + 1.000 0.0074693640 0.0799967491 0.2142068062 + 1.500 0.0019753776 0.0888095113 0.1793603915 + 2.000 0.0007579352 0.1015545382 0.1138668084 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorUseries: U_i(beta) = ECFG(i+1, 1, beta) with E_theta +------------------------------------------------------------------------------------- + beta N=1 N=2 N=3 + 0.100 0.2653865755 0.0597476192 0.0090428096 + 0.200 0.1668106769 0.0344188111 0.0050487063 + 0.500 0.0454071552 0.0067932369 0.0008900155 + 1.000 0.0074693640 0.0005219446 0.0000521319 + 1.500 0.0019753776 0.0000512213 0.0000033715 + 2.000 0.0007579352 0.0000070092 0.0000002525 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorU1: U1(beta) = ECFG(2, 1, beta) with E_theta +------------------------------------------------------------------------------------- + beta U1 obs + 0.100 0.2653865755 + 0.200 0.1668106769 + 0.500 0.0454071552 + 1.000 0.0074693640 + 1.500 0.0019753776 + 2.000 0.0007579352 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorU2: U2(beta) = ECFG(3, 1, beta) with E_theta +------------------------------------------------------------------------------------- + beta U2 obs + 0.100 0.0597476192 + 0.200 0.0344188111 + 0.500 0.0067932369 + 1.000 0.0005219446 + 1.500 0.0000512213 + 2.000 0.0000070092 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorU3: U3(beta) = ECFG(4, 1, beta) with E_theta +------------------------------------------------------------------------------------- + beta U3 obs + 0.100 0.0090428096 + 0.200 0.0050487063 + 0.500 0.0008900155 + 1.000 0.0000521319 + 1.500 0.0000033715 + 2.000 0.0000002525 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelator: ECF(N,beta) with pt_R +------------------------------------------------------------------------------------- + beta N=1 (GeV) N=2 (GeV^2) N=3 (GeV^3) N=4 (GeV^4) N=5 (GeV^5) + 0.100 910.03 163661.63 1.08582e+07 3.40995e+08 5.90794e+09 + 0.200 910.03 111307.49 3.95012e+06 5.96384e+07 4.78368e+08 + 0.500 910.03 40470.38 446453 2.14768e+06 5.56487e+06 + 1.000 910.03 13863.90 65435.2 142223 166409 + 1.500 910.03 8417.59 26549 39560.1 31484.2 + 2.000 910.03 6328.24 16871.1 21082 13743.6 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorRatio: r_N^(beta) = ECF(N+1,beta)/ECF(N,beta) with pt_R +------------------------------------------------------------------------------------- + beta N=0 (GeV) N=1 (GeV) N=2 (GeV) N=3 (GeV) N=4 (GeV) + 0.100 910.0320 179.8416 66.3456 31.4043 17.3256 + 0.200 910.0320 122.3116 35.4884 15.0979 8.02115 + 0.500 910.0320 44.4714 11.0316 4.81054 2.59111 + 1.000 910.0320 15.2345 4.71983 2.17349 1.17006 + 1.500 910.0320 9.2498 3.15399 1.49008 0.795857 + 2.000 910.0320 6.9539 2.66601 1.24959 0.651912 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorDoubleRatio: C_N^(beta) = r_N^(beta)/r_{N-1}^(beta) with pt_R +------------------------------------------------------------------------------------- + beta N=1 N=2 N=3 N=4 + 0.100 0.197621 0.368911 0.473344 0.551696 + 0.200 0.134404 0.290147 0.425431 0.531277 + 0.500 0.048868 0.248061 0.436069 0.538632 + 1.000 0.016741 0.309811 0.460503 0.538330 + 1.500 0.010164 0.340980 0.472444 0.534103 + 2.000 0.007641 0.383385 0.468712 0.521701 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorC1: C_1^(beta) = ECF(2,beta)/ECF(1,beta)^2 with pt_R +------------------------------------------------------------------------------------- + beta C1 obs + 0.100 0.197621 + 0.200 0.134404 + 0.500 0.048868 + 1.000 0.016741 + 1.500 0.010164 + 2.000 0.007641 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorC2: C_2^(beta) = ECF(3,beta)*ECF(1,beta)/ECF(2,beta)^2 with pt_R +------------------------------------------------------------------------------------- + beta C2 obs + 0.100 0.368911 + 0.200 0.290147 + 0.500 0.248061 + 1.000 0.309811 + 1.500 0.340980 + 2.000 0.383385 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorD2: D_2^(beta) = ECF(3,beta)*ECF(1,beta)^3/ECF(2,beta)^3 with pt_R +------------------------------------------------------------------------------------- + beta D2 obs + 0.100 1.866758 + 0.200 2.158775 + 0.500 5.076145 + 1.000 18.506536 + 1.500 33.547049 + 2.000 50.172493 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorGeneralizedD2: D_2^(alpha, beta) = ECFN(3,alpha)/ECFN(2,beta)^(3*alpha/beta) with pt_R +------------------------------------------------------------------------------------- + beta alpha = 0.100 alpha = 0.200 alpha = 0.500 alpha = 1.000 + 0.200 0.292397 2.15878 2039.5 1.02914e+09 + 0.500 0.0881403 0.196161 5.07615 6375.25 + 1.000 0.0491425 0.0609786 0.273494 18.5065 + 1.500 0.0360723 0.0328557 0.0582816 0.840412 + 2.000 0.0299305 0.0226199 0.0229208 0.129983 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorGeneralized (angles = N Choose 2): ECFN(N, beta) with pt_R +------------------------------------------------------------------------------------- + beta N=1 N=2 N=3 N=4 + 0.100 1.00 0.1976212201 0.0144075072 0.0004971883 + 0.200 1.00 0.1344036550 0.0052413202 0.0000869560 + 0.500 1.00 0.0488679347 0.0005923876 0.0000031314 + 1.000 1.00 0.0167406417 0.0000868243 0.0000002074 + 1.500 1.00 0.0101642297 0.0000352272 0.0000000577 + 2.000 1.00 0.0076413374 0.0000223859 0.0000000307 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorGeneralized: ECFG(angles, N, beta=1) with pt_R +------------------------------------------------------------------------------------- + angles N=1 N=2 N=3 N=4 + 1 1.00 0.0167406417 0.0005149099 0.0000275956 + 2 0.0001201519 0.0000010521 + 3 0.0000868243 0.0000003239 + 4 0.0000002207 + 5 0.0000001864 + 6 0.0000002074 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorNseries: N_i(beta) = ECFG(i+1, 2, beta)/ECFG(i, 1, beta)^2 with pt_R +------------------------------------------------------------------------------------- + beta N=1 N=2 N=3 + 0.100 0.134404 0.501515 2.093230 + 0.200 0.066590 0.490962 2.107355 + 0.500 0.016741 0.472128 2.270271 + 1.000 0.007641 0.428733 3.968204 + 1.500 0.005197 0.367850 11.456776 + 2.000 0.003938 0.329248 20.513687 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorN2: N2(beta) = ECFG(3, 2, beta)/ECFG(2, 1, beta)^2 with pt_R +------------------------------------------------------------------------------------- + beta N2 obs + 0.100 0.501515 + 0.200 0.490962 + 0.500 0.472128 + 1.000 0.428733 + 1.500 0.367850 + 2.000 0.329248 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorN3: N3(beta) = ECFG(4, 2, beta)/ECFG(3, 1, beta)^2 with pt_R +------------------------------------------------------------------------------------- + beta N3 obs + 0.100 2.093230 + 0.200 2.107355 + 0.500 2.270271 + 1.000 3.968204 + 1.500 11.456776 + 2.000 20.513687 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorMseries: M_i(beta) = ECFG(i+1, 1, beta)/ECFN(i, 1, beta) with pt_R +------------------------------------------------------------------------------------- + beta N=1 N=2 N=3 + 0.100 0.197621 0.140440 0.090587 + 0.200 0.134404 0.127907 0.086996 + 0.500 0.048868 0.087042 0.076041 + 1.000 0.016741 0.030758 0.053593 + 1.500 0.010164 0.010637 0.025871 + 2.000 0.007641 0.005839 0.009492 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorM2: M2(beta) = ECFG(3, 1, beta)/ECFG(3, 1, beta) with pt_R +------------------------------------------------------------------------------------- + beta M2 obs + 0.100 0.140440 + 0.200 0.127907 + 0.500 0.087042 + 1.000 0.030758 + 1.500 0.010637 + 2.000 0.005839 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorCseries: C_i(beta) = ECFN(i-1, beta)*ECFN(i+1, beta)/ECFN(i, beta)^2 with pt_R +------------------------------------------------------------------------------------- + beta N=1 N=2 N=3 + 0.100 0.1976212201 0.3689110739 0.4733439247 + 0.200 0.1344036550 0.2901472976 0.4254309496 + 0.500 0.0488679347 0.2480607340 0.4360689366 + 1.000 0.0167406417 0.3098112813 0.4605028221 + 1.500 0.0101642297 0.3409799143 0.4724436009 + 2.000 0.0076413374 0.3833849510 0.4687122507 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorUseries: U_i(beta) = ECFG(i+1, 1, beta) with pt_R +------------------------------------------------------------------------------------- + beta N=1 N=2 N=3 + 0.100 0.1976212201 0.0277540195 0.0025141656 + 0.200 0.1344036550 0.0171911179 0.0014955586 + 0.500 0.0488679347 0.0042535497 0.0003234433 + 1.000 0.0167406417 0.0005149099 0.0000275956 + 1.500 0.0101642297 0.0001081211 0.0000027972 + 2.000 0.0076413374 0.0000446167 0.0000004235 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorU1: U1(beta) = ECFG(2, 1, beta) with pt_R +------------------------------------------------------------------------------------- + beta U1 obs + 0.100 0.1976212201 + 0.200 0.1344036550 + 0.500 0.0488679347 + 1.000 0.0167406417 + 1.500 0.0101642297 + 2.000 0.0076413374 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorU2: U2(beta) = ECFG(3, 1, beta) with pt_R +------------------------------------------------------------------------------------- + beta U2 obs + 0.100 0.0277540195 + 0.200 0.0171911179 + 0.500 0.0042535497 + 1.000 0.0005149099 + 1.500 0.0001081211 + 2.000 0.0000446167 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorU3: U3(beta) = ECFG(4, 1, beta) with pt_R +------------------------------------------------------------------------------------- + beta U3 obs + 0.100 0.0025141656 + 0.200 0.0014955586 + 0.500 0.0003234433 + 1.000 0.0000275956 + 1.500 0.0000027972 + 2.000 0.0000004235 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelator: ECF(N,beta) with E_theta +------------------------------------------------------------------------------------- + beta N=1 (GeV) N=2 (GeV^2) N=3 (GeV^3) N=4 (GeV^4) N=5 (GeV^5) + 0.100 934.39 173035.93 1.18699e+07 3.87688e+08 7.03067e+09 + 0.200 934.39 117791.85 4.35182e+06 6.9149e+07 5.87495e+08 + 0.500 934.39 43220.34 507379 2.59e+06 7.00209e+06 + 1.000 934.39 15182.02 75656.7 165116 178354 + 1.500 934.39 9296.03 30143 40417 24563.7 + 2.000 934.39 6943.30 18259.8 17679.3 7116.38 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorRatio: r_N^(beta) = ECF(N+1,beta)/ECF(N,beta) with E_theta +------------------------------------------------------------------------------------- + beta N=0 (GeV) N=1 (GeV) N=2 (GeV) N=3 (GeV) N=4 (GeV) + 0.100 934.3868 185.1866 68.5978 32.6615 18.1349 + 0.200 934.3868 126.0633 36.945 15.8896 8.49608 + 0.500 934.3868 46.2553 11.7394 5.10466 2.70351 + 1.000 934.3868 16.2481 4.98331 2.18244 1.08017 + 1.500 934.3868 9.9488 3.24257 1.34084 0.607757 + 2.000 934.3868 7.4309 2.62985 0.968209 0.402525 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorDoubleRatio: C_N^(beta) = r_N^(beta)/r_{N-1}^(beta) with E_theta +------------------------------------------------------------------------------------- + beta N=1 N=2 N=3 N=4 + 0.100 0.198191 0.370425 0.476130 0.555237 + 0.200 0.134916 0.293067 0.430089 0.534693 + 0.500 0.049503 0.253795 0.434833 0.529617 + 1.000 0.017389 0.306701 0.437950 0.494940 + 1.500 0.010647 0.325926 0.413512 0.453265 + 2.000 0.007953 0.353909 0.368161 0.415742 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorC1: C_1^(beta) = ECF(2,beta)/ECF(1,beta)^2 with E_theta +------------------------------------------------------------------------------------- + beta C1 obs + 0.100 0.198191 + 0.200 0.134916 + 0.500 0.049503 + 1.000 0.017389 + 1.500 0.010647 + 2.000 0.007953 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorC2: C_2^(beta) = ECF(3,beta)*ECF(1,beta)/ECF(2,beta)^2 with E_theta +------------------------------------------------------------------------------------- + beta C2 obs + 0.100 0.370425 + 0.200 0.293067 + 0.500 0.253795 + 1.000 0.306701 + 1.500 0.325926 + 2.000 0.353909 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorD2: D_2^(beta) = ECF(3,beta)*ECF(1,beta)^3/ECF(2,beta)^3 with E_theta +------------------------------------------------------------------------------------- + beta D2 obs + 0.100 1.869035 + 0.200 2.172229 + 0.500 5.126818 + 1.000 17.637552 + 1.500 30.610782 + 2.000 44.502015 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorGeneralizedD2: D_2^(alpha, beta) = ECFN(3,alpha)/ECFN(2,beta)^(3*alpha/beta) with E_theta +------------------------------------------------------------------------------------- + beta alpha = 0.100 alpha = 0.200 alpha = 0.500 alpha = 1.000 + 0.200 0.293612 2.17223 2081.08 1.03834e+09 + 0.500 0.0883254 0.196576 5.12682 6301.71 + 1.000 0.0490663 0.0606632 0.27123 17.6376 + 1.500 0.0360925 0.0328242 0.0584128 0.818048 + 2.000 0.0300462 0.0227477 0.0233544 0.130767 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorGeneralized (angles = N Choose 2): ECFN(N, beta) with E_theta +------------------------------------------------------------------------------------- + beta N=1 N=2 N=3 N=4 + 0.100 1.00 0.1981905437 0.0145501117 0.0005085991 + 0.200 1.00 0.1349155085 0.0053344701 0.0000907149 + 0.500 1.00 0.0495033749 0.0006219455 0.0000033978 + 1.000 1.00 0.0173890665 0.0000927400 0.0000002166 + 1.500 1.00 0.0106474132 0.0000369493 0.0000000530 + 2.000 1.00 0.0079526591 0.0000223829 0.0000000232 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorGeneralized: ECFG(angles, N, beta=1) with E_theta +------------------------------------------------------------------------------------- + angles N=1 N=2 N=3 N=4 + 1 1.00 0.0173890665 0.0005243822 0.0000276026 + 2 0.0001290539 0.0000011436 + 3 0.0000927400 0.0000003720 + 4 0.0000002479 + 5 0.0000002021 + 6 0.0000002166 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorNseries: N_i(beta) = ECFG(i+1, 2, beta)/ECFG(i, 1, beta)^2 with E_theta +------------------------------------------------------------------------------------- + beta N=1 N=2 N=3 + 0.100 0.134916 0.502292 2.091587 + 0.200 0.067180 0.491827 2.107891 + 0.500 0.017389 0.472830 2.289141 + 1.000 0.007953 0.426794 4.159019 + 1.500 0.005251 0.366194 11.630367 + 2.000 0.003828 0.328039 19.240170 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorN2: N2(beta) = ECFG(3, 2, beta)/ECFG(2, 1, beta)^2 with E_theta +------------------------------------------------------------------------------------- + beta N2 obs + 0.100 0.502292 + 0.200 0.491827 + 0.500 0.472830 + 1.000 0.426794 + 1.500 0.366194 + 2.000 0.328039 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorN3: N3(beta) = ECFG(4, 2, beta)/ECFG(3, 1, beta)^2 with E_theta +------------------------------------------------------------------------------------- + beta N3 obs + 0.100 2.091587 + 0.200 2.107891 + 0.500 2.289141 + 1.000 4.159019 + 1.500 11.630367 + 2.000 19.240170 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorMseries: M_i(beta) = ECFG(i+1, 1, beta)/ECFN(i, 1, beta) with E_theta +------------------------------------------------------------------------------------- + beta N=1 N=2 N=3 + 0.100 0.198191 0.140807 0.091081 + 0.200 0.134916 0.127947 0.087436 + 0.500 0.049503 0.086121 0.076197 + 1.000 0.017389 0.030156 0.052638 + 1.500 0.010647 0.010921 0.024416 + 2.000 0.007953 0.006325 0.009110 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorM2: M2(beta) = ECFG(3, 1, beta)/ECFG(3, 1, beta) with E_theta +------------------------------------------------------------------------------------- + beta M2 obs + 0.100 0.140807 + 0.200 0.127947 + 0.500 0.086121 + 1.000 0.030156 + 1.500 0.010921 + 2.000 0.006325 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorCseries: C_i(beta) = ECFN(i-1, beta)*ECFN(i+1, beta)/ECFN(i, beta)^2 with E_theta +------------------------------------------------------------------------------------- + beta N=1 N=2 N=3 + 0.100 0.1981905437 0.3704251544 0.4761303115 + 0.200 0.1349155085 0.2930674174 0.4300888197 + 0.500 0.0495033749 0.2537948134 0.4348330516 + 1.000 0.0173890665 0.3067005727 0.4379497669 + 1.500 0.0106474132 0.3259256469 0.4135119649 + 2.000 0.0079526591 0.3539093501 0.3681613681 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorUseries: U_i(beta) = ECFG(i+1, 1, beta) with E_theta +------------------------------------------------------------------------------------- + beta N=1 N=2 N=3 + 0.100 0.1981905437 0.0279066279 0.0025417550 + 0.200 0.1349155085 0.0172619856 0.0015093221 + 0.500 0.0495033749 0.0042632685 0.0003248489 + 1.000 0.0173890665 0.0005243822 0.0000276026 + 1.500 0.0106474132 0.0001162849 0.0000028392 + 2.000 0.0079526591 0.0000503042 0.0000004582 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorU1: U1(beta) = ECFG(2, 1, beta) with E_theta +------------------------------------------------------------------------------------- + beta U1 obs + 0.100 0.1981905437 + 0.200 0.1349155085 + 0.500 0.0495033749 + 1.000 0.0173890665 + 1.500 0.0106474132 + 2.000 0.0079526591 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorU2: U2(beta) = ECFG(3, 1, beta) with E_theta +------------------------------------------------------------------------------------- + beta U2 obs + 0.100 0.0279066279 + 0.200 0.0172619856 + 0.500 0.0042632685 + 1.000 0.0005243822 + 1.500 0.0001162849 + 2.000 0.0000503042 +------------------------------------------------------------------------------------- + +------------------------------------------------------------------------------------- +EnergyCorrelatorU3: U3(beta) = ECFG(4, 1, beta) with E_theta +------------------------------------------------------------------------------------- + beta U3 obs + 0.100 0.0025417550 + 0.200 0.0015093221 + 0.500 0.0003248489 + 1.000 0.0000276026 + 1.500 0.0000028392 + 2.000 0.0000004582 +------------------------------------------------------------------------------------- + Index: contrib/contribs/EnergyCorrelator/tags/1.3.2/ChangeLog =================================================================== --- contrib/contribs/EnergyCorrelator/tags/1.3.2/ChangeLog (revision 0) +++ contrib/contribs/EnergyCorrelator/tags/1.3.2/ChangeLog (revision 1393) @@ -0,0 +1,321 @@ +2024-02-22 Jesse Thaler + + * NEWS + * VERSION + Preparing for 1.3.2 release + + * Makefile + Removed extraneous "-lm" + + * example.cc + * example.ref + Changed some of the print formats from "f" to "g" to minimize floating point + rounding issues + +2018-02-08 Jesse Thaler + + * NEWS + * VERSION + Making 1.3.1 + + +2018-02-08 Lina Necib + + * EnergyCorrelator.cc + Debugging memory allocation, deleting energyStore/angleStore properly this time + + +2018-02-04 Lina Necib + + * EnergyCorrelator.cc + Debugging memory allocation, deleting energyStore/angleStore + + * VERSION + Making 1.3.1-devel + +2018-01-09 Jesse Thaler + + * NEWS + * VERSION + Finalizing 1.3.0 + +2018-01-09 Lina Necib + + * NEWS + Preparing for version candidate + + * VERSION + Making 1.3.0-rc1 + +2018-01-07 Lina Necib + + * EnergyCorrelator.hh/cc + Sped up evaluations of ECFs. + Functions are defined in ECFs and called to evaluate ECFGs. + + * VERSION + Making 1.2.3-devel + + +2018-01-04 Lina Necib + + * EnergyCorrelator.hh/cc + Sped up evaluations of ECFG by a factor of 4. + Refactored some of the code in functions + + * VERSION + Making 1.2.2-devel + + * example.cc + Added some timings tests for ECFGs, N2, and N3. + + +2017-01-25 Jesse Thaler + + * EnergyCorrelator.hh/cc + Converting all _N to unsigned integers, removing _N < 0 warning + Added warning to constructors for N < 1 in some cases. + + * VERSION + Making 1.2.1-devel + + * Makefile + Added -Wextra to compiler flags + +2016-10-07 Jesse Thaler + + * AUTHORS/COPYING: + Updated the publication arXiv number to 1609.07483. + + * EnergyCorrelator.hh + Fixed typo in EnergyCorrelatorGeneralized description + + * NEWS + Added "USeries" to news. + + * VERSION + Changed version to 1.2.0 + +2016-09-27 Lina Necib + + * EnergyCorrelator.hh/README + Updated the publication arXiv number to 1609.07483. + +2016-09-23 Lina Necib + + * EnergyCorrelator.cc + Made the evaluation of ECFG faster by replacing sort -> partial_sort and simplified multiplication syntax + * example.cc/ref + Fixed minor typo + * VERSION + Changed version to 1.2.0-rc3 + +2016-09-23 Lina Necib + + * EnergyCorrelator.hh + Fixed minor doxygen typo + * example.cc/ref + Changed EnergyCorrelatorNormalized -> EnergyCorrelatorGeneralized in function explanations + * VERSION + Changed version to 1.2.0-rc2 + +2016-09-22 Jesse Thaler + + * EnergyCorrelator.cc/hh + Renamed EnergyCorrelatorNormalized -> EnergyCorrelatorGeneralized + Changed order of arguments for EnergyCorrelatorGeneralized + Updated doxygen documentation + * example_basic_usage.cc + Changed EnergyCorrelatorNormalized -> EnergyCorrelatorGeneralized + * README + Updated for EnergyCorrelatorGeneralized + +2016-09-15 Lina Necib + + *VERSION: + 1.2.0-rc1 + +2016-08-24 Jesse Thaler + + Minor comment fixes throughout. + + * EnergyCorrelator.cc/hh + Put in _helper_correlator when defining overall normalization + Removed angle error for result_all_angles() + *NEWS: + Made this more readable. + *README: + Clarified some of the documentation. + +2016-08-23 Lina Necib + + *VERSION: + *NEWS: + *AUTHORS: + *COPYING: + *README: + *EnergyCorrelator.cc + Added if statement that the ECF and ECFNs return exactly zero + if the number of particles is less than N of the ECF. + *EnergyCorrelator.hh + *example.cc + *example_basic_usage.cc + Updated this example. + +2016-08-21 Lina Necib + + *VERSION: + *NEWS: + *AUTHORS: + *COPYING: + *README: + *EnergyCorrelator.cc + Added Cseries. + *EnergyCorrelator.hh + Added Cseries. + *example.cc + Added example of Cseries + *example_basic_usage.cc + Simplified examples. + +2016-08-17 Lina Necib + + *VERSION: + *NEWS: + *AUTHORS: + Added placeholder for new reference + *COPYING: + Added placeholder for new reference + *README: + added information on different measures E_inv + *EnergyCorrelator.cc + Minor text edits + added comments + *EnergyCorrelator.hh + Minor text edits + added comments + *example_basic_usage.cc + added a simplified example file that shows the use of the + different observables. + + +2016-06-23 Lina Necib + + *VERSION: + 1.2.0-alpha0 + *NEWS: + *AUTHORS: + Lina Necib + *COPYING: + *README: + added descriptions of functions that will appear shortly + arXiv:160X.XXXXX + + *EnergyCorrelator.cc + added code to calculate normalized ECFS. + *EnergyCorrelator.hh + added code to calculate normalized ECFS, Nseries, generalized + D2, N2, N3, and M2. + + *example.cc + added calculation of normalized ECFS, Nseries, generalized + D2, N2, N3, and M2 to example file. + + +2014-11-20 Jesse Thaler + + * README: + Typos fixed + +2014-11-13 Andrew Larkoski + + *VERSION: + *NEWS: + release of version 1.1.0 + + *AUTHORS: + *COPYING: + *README: + added reference to arXiv:1409.6298. + + *EnergyCorrelator.cc + *EnergyCorrelator.hh + added code to calculate C1, C2, and D2 observables. + + *example.cc + added calculation of C1, C2, and D2 to example file. + +2013-05-01 Gavin Salam + + * VERSION: + * NEWS: + release of version 1.0.1 + + * README: + updated to reflect v1.0 interface. + +2013-05-01 Jesse Thaler + + * EnergyCorrelator.cc + Switched from NAN to std::numeric_limits::quiet_NaN() + +2013-04-30 Jesse Thaler + + * EnergyCorrelator.cc + Implemented Gregory Soyez's suggestions on errors/asserts + +2013-04-30 Gavin Salam + + * VERSION: + * NEWS: + released v. 1.0.0 + + * EnergyCorrelator.hh: + * example.cc + small changes to documentation to reflect the change below + an + gave an explicit command-line in the example. + +2013-04-29 Jesse Thaler + + * EnergyCorrelator.cc + - Added support for N = 5 + + * example.cc|.ref + - Added N = 5 to test suite. + +2013-04-29 Gavin Salam + + * EnergyCorrelator.hh|cc: + - reduced memory usage from roughly 8n^2 to 4n^2 bytes (note that + sums are now performed in a different order, so results may + change to within rounding error). + + - Implemented description() for all three classes. + + - Worked on doxygen-style comments and moved some bits of code into + the .cc file. + + * Doxyfile: *** ADDED *** + + * example.cc: + developers' timing component now uses clock(), to get + finer-grained timing, and also outputs a description for some of + the correlators being used. + +2013-04-26 + 04-27 Jesse Thaler + + * EnergyCorrelator.hh|cc: + added temporary storage array for interparticle angles, to speed + up the energy correlator calculation for N>2 + + * example.cc + has internal option for printing out timing info. + +2013-04-26 Gavin Salam + Jesse & Andrew + + * Makefile: + added explicit dependencies + + * example.cc (analyze): + added a little bit of commented code for timing tests. + +2013-03-10 + Initial creation Index: contrib/contribs/EnergyCorrelator/tags/1.3.2/COPYING =================================================================== --- contrib/contribs/EnergyCorrelator/tags/1.3.2/COPYING (revision 0) +++ contrib/contribs/EnergyCorrelator/tags/1.3.2/COPYING (revision 1393) @@ -0,0 +1,360 @@ +The EnergyCorrelator contrib to FastJet is released +under the terms of the GNU General Public License v2 (GPLv2). + +A copy of the GPLv2 is to be found at the end of this file. + +While the GPL license grants you considerable freedom, please bear in +mind that this code's use falls under guidelines similar to those that +are standard for Monte Carlo event generators +(http://www.montecarlonet.org/GUIDELINES). In particular, if you use +this code as part of work towards a scientific publication, whether +directly or contained within another program you should include a citation +to + + arXiv:1305.0007 + arXiv:1409.6298 + arXiv:1609.07483 + +====================================================================== +====================================================================== +====================================================================== + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. Index: contrib/contribs/EnergyCorrelator/tags/1.3.2 =================================================================== --- contrib/contribs/EnergyCorrelator/tags/1.3.2 (revision 1392) +++ contrib/contribs/EnergyCorrelator/tags/1.3.2 (revision 1393) Property changes on: contrib/contribs/EnergyCorrelator/tags/1.3.2 ___________________________________________________________________ Added: svn:ignore ## -0,0 +1,5 ## +example + +Makefile.bak + +html