head/Acts/Demo.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 /// @file fixture header for the API-surface self-test (head revision)
0012
0013 namespace Acts {
0014
0015 /// A demo type.
0016 struct Demo {
0017   /// A tolerance (now single precision -- BREAKING retype).
0018   float tolerance = 0.0;
0019   /// A label.
0020   int label = 0;
0021   /// A newly added member (addition, not breaking).
0022   bool flag = false;
0023
0024   /// Do a thing, now with an extra required argument (BREAKING).
0025   /// @param x the x
0026   /// @param y the y
0027   void doThing(int x, int y);
0028
0029   // oldFn(double) removed -- BREAKING.
0030 };
0031
0032 /// A free function, now with a *defaulted* argument (addition, not breaking).
0033 /// @param n a number
0034 /// @param scale a scale factor
0035 int compute(int n, double scale = 1.0);
0036
0037 /// A brand new type (addition).
0038 struct NewThing {};
0039
0040 }  // namespace Acts