AnnealingUtility.hpp

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file AnnealingUtility.hpp

// This file is part of the Acts project.
//
// Copyright (C) 2019 CERN for the benefit of the Acts project
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

#pragma once

#include "Acts/Utilities/Definitions.hpp"

#include <vector>

namespace Acts {
class AnnealingUtility {
 public:
  struct State {
    // Points to current temperature value in m_cfg.setOfTemperatures
    unsigned int currentTemperatureIndex{0};

    // Checks if equilibrium is reached
    bool equilibriumReached{false};
  };

  struct Config {
    // Config constructor with default temperature list: {64.,16.,4.,2.,1.5,1.}
    Config(const std::vector<double>& temperatures = {64., 16., 4., 2., 1.5,
                                                      1.})
        : setOfTemperatures(temperatures) {}

    // Insensitivity of calculated weight at cutoff
    double cutOff{9.};

    // Set of temperatures, annealing starts at setOfTemperatures[0]
    // and anneals towards setOfTemperatures[last]
    std::vector<double> setOfTemperatures;
  };

  AnnealingUtility(const Config& cfg = Config()) : m_cfg(cfg) {}

  void anneal(State& state) const;

  double getWeight(State& state, double chi2,
                   const std::vector<double>& allChi2) const;

  double getWeight(State& state, double chi2) const;

 private:
  Config m_cfg;
};
}  // namespace Acts