ParameterTypes.hpp

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

// This file is part of the Acts project.
//
// Copyright (C) 2016-2018 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 <algorithm>
#include <cmath>

namespace Acts {
struct unbound_parameter {
  static constexpr bool may_modify_value{
      false};  

  template <typename T>
  static T getValue(const T& input) {
    return input;
  }

  template <typename T>
  static T getDifference(const T& first, const T& second) {
    return first - second;
  }
};

struct local_parameter : public unbound_parameter {};

template <typename T, T (*MIN)(), T (*MAX)()>
struct bound_parameter {
  static constexpr bool may_modify_value{
      true};                      
  static constexpr T min{MIN()};  
  static constexpr T max{MAX()};  

  template <typename U>
  static U getValue(const U& input) {
    return (input > max) ? max : ((input < min) ? min : input);
  }

  template <typename U>
  static U getDifference(const U& first, const U& second) {
    return getValue(first) - getValue(second);
  }
};

template <typename T, T (*MIN)(), T (*MAX)()>
struct cyclic_parameter {
  static constexpr bool may_modify_value{
      true};                      
  static constexpr T min{MIN()};  
  static constexpr T max{MAX()};  

  template <typename U>
  static U getValue(const U& input) {
    if (min <= input && input < max) {
      return input;
    } else {
      return input - (max - min) * std::floor((input - min) / (max - min));
    }
  }

  template <typename U>
  static U getDifference(const U& first, const U& second) {
    static constexpr U half_period = (max - min) / 2;
    U tmp = getValue(first) - getValue(second);
    return (tmp < -half_period
                ? tmp + 2 * half_period
                : (tmp > half_period ? tmp - 2 * half_period : tmp));
  }
};

//  template<typename ParameterPolicy,typename ParameterPolicy::par_id_type
//  parID>
//  struct parameter_traits;
}  // namespace Acts