Acts/Vertexing/VertexingError.hpp

0001 // This file is part of the ACTS project.
0002 //
0003 // Copyright (C) 2016 CERN for the benefit of the ACTS project
0004 //
0005 // This Source Code Form is subject to the terms of the Mozilla Public
0006 // License, v. 2.0. If a copy of the MPL was not distributed with this
0007 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
0008
0009 #pragma once
0010
0011 #include <system_error>
0012 #include <type_traits>
0013
0014 namespace Acts {
0015
0016 /// Error codes for vertexing operations
0017 /// @ingroup errors
0018 enum class VertexingError {
0019   // ensure all values are non-zero
0020   /// Numeric failure in calculation.
0021   NumericFailure = 1,
0022   /// Empty input provided.
0023   EmptyInput,
0024   /// Error while finding vertex seed.
0025   SeedingError,
0026   /// Unable to converge.
0027   NotConverged,
0028   /// Unable to find element.
0029   ElementNotFound,
0030   /// No covariance provided.
0031   NoCovariance,
0032   /// Encountered non-invertible matrix.
0033   SingularMatrix,
0034   /// Encountered negative or zero variance.
0035   NonPositiveVariance,
0036   /// Encountered a matrix that is not positive definite.
0037   MatrixNotPositiveDefinite,
0038   /// Invalid input provided.
0039   InvalidInput,
0040   /// Could not remove track from collection.
0041   CouldNotRemoveTrack,
0042 };
0043
0044 /// Create error code from VertexingError
0045 /// @param e The error code enum value
0046 /// @return Standard error code
0047 std::error_code make_error_code(Acts::VertexingError e);
0048
0049 }  // namespace Acts
0050
0051 namespace std {
0052 // register with STL
0053 template <>
0054 struct is_error_code_enum<Acts::VertexingError> : std::true_type {};
0055 }  // namespace std