Merge branch '501-file-headers-optimiser-expressions' into 'master'

File headers to optimiser expressions

See merge request !321

optimizer/Expression/MaxNormRadialPeak.cpp

+//
+// Struct MaxNormRadialPeak
+//   A simple expression computing the maximum norm of all peak errors (given as
+//   first and second argument) for a range of peaks (third argument and fourth argument)
+//   according to
+//
+//   \f[
+//   result = ||measurement_i - value_i||_\infty
+//   \f]
+//
+// Copyright (c) 2018, Matthias Frey, Paul Scherrer Institut, Villigen PSI, Switzerland
+// All rights reserved
+//
+// Implemented as part of the PhD thesis
+// "Precise Simulations of Multibunches in High Intensity Cyclotrons"
+// and the paper
+// "Matching of turn pattern measurements for cyclotrons using multiobjective optimization"
+// (https://doi.org/10.1103/PhysRevAccelBeams.22.064602)
+//
+// This file is part of OPAL.
+//
+// OPAL 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 3 of the License, or
+// (at your option) any later version.
+//
+// You should have received a copy of the GNU General Public License
+// along with OPAL. If not, see <https://www.gnu.org/licenses/>.
+//
 #include "Expression/MaxNormRadialPeak.h"
 
 const std::string name = "MaxNormRadialPeak";

optimizer/Expression/MaxNormRadialPeak.h

+//
+// Struct MaxNormRadialPeak
+//   A simple expression computing the maximum norm of all peak errors (given as
+//   first and second argument) for a range of peaks (third argument and fourth argument)
+//   according to
+//
+//   \f[
+//   result = ||measurement_i - value_i||_\infty
+//   \f]
+//
+// Copyright (c) 2018, Matthias Frey, Paul Scherrer Institut, Villigen PSI, Switzerland
+// All rights reserved
+//
+// Implemented as part of the PhD thesis
+// "Precise Simulations of Multibunches in High Intensity Cyclotrons"
+// and the paper
+// "Matching of turn pattern measurements for cyclotrons using multiobjective optimization"
+// (https://doi.org/10.1103/PhysRevAccelBeams.22.064602)
+//
+// This file is part of OPAL.
+//
+// OPAL 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 3 of the License, or
+// (at your option) any later version.
+//
+// You should have received a copy of the GNU General Public License
+// along with OPAL. If not, see <https://www.gnu.org/licenses/>.
+//
 #ifndef __MAX_NORM_RADIALPEAK_H__
 #define __MAX_NORM_RADIALPEAK_H__
 
@@ -14,16 +43,6 @@
 #include "Util/PeakReader.h"
 #include "Expression/Parser/function.hpp"
 
-/**
- *  A simple expression computing the maximum norm of all peak errors (given as
- *  first and second argument) for a range of peaks (third argument and fourth argument)
- *  according to
- *
- *  \f[
- *    result = ||measurement_i - value_i||_\infty
- *  \f]
- *
- */
 struct MaxNormRadialPeak {
 
     static const std::string name;

optimizer/Expression/NumberOfPeaks.cpp

+//
+// Struct NumberOfPeaks
+//   A simple expression to check the number of turns in a circular machine. It checks
+//   probe files (*.peaks) and counts the number of turns.
+//
+// Copyright (c) 2018, Matthias Frey, Paul Scherrer Institut, Villigen PSI, Switzerland
+// All rights reserved
+//
+// Implemented as part of the PhD thesis
+// "Precise Simulations of Multibunches in High Intensity Cyclotrons"
+// and the paper
+// "Matching of turn pattern measurements for cyclotrons using multiobjective optimization"
+// (https://doi.org/10.1103/PhysRevAccelBeams.22.064602)
+//
+// This file is part of OPAL.
+//
+// OPAL 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 3 of the License, or
+// (at your option) any later version.
+//
+// You should have received a copy of the GNU General Public License
+// along with OPAL. If not, see <https://www.gnu.org/licenses/>.
+//
 #include "Expression/NumberOfPeaks.h"
 
 const std::string name = "NumberOfPeaks";

optimizer/Expression/NumberOfPeaks.h

+//
+// Struct NumberOfPeaks
+//   A simple expression to check the number of turns in a circular machine. It checks
+//   probe files (*.peaks) and counts the number of turns.
+//
+// Copyright (c) 2018, Matthias Frey, Paul Scherrer Institut, Villigen PSI, Switzerland
+// All rights reserved
+//
+// Implemented as part of the PhD thesis
+// "Precise Simulations of Multibunches in High Intensity Cyclotrons"
+// and the paper
+// "Matching of turn pattern measurements for cyclotrons using multiobjective optimization"
+// (https://doi.org/10.1103/PhysRevAccelBeams.22.064602)
+//
+// This file is part of OPAL.
+//
+// OPAL 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 3 of the License, or
+// (at your option) any later version.
+//
+// You should have received a copy of the GNU General Public License
+// along with OPAL. If not, see <https://www.gnu.org/licenses/>.
+//
 #ifndef __NUMBER_OF_PEAKS_H__
 #define __NUMBER_OF_PEAKS_H__
 
@@ -14,10 +38,6 @@
 #include "Util/PeakReader.h"
 #include "Expression/Parser/function.hpp"
 
-/**
- *  A simple expression to check the number of turns in a circular machine. It checks
- *  probe files (*.peaks) and counts the number of turns.
- */
 struct NumberOfPeaks {
 
     static const std::string name;

optimizer/Expression/SumErrSqRadialPeak.cpp

+//
+// Struct SumErrSqRadialPeak
+//   A simple expression computing the sum of all peak errors (given as
+//   first and second argument) for a range of peaks (third argument and fourth argument)
+//   according to
+//
+//   \f[
+//     result = \frac{1}{n} * \sqrt{\sum_{i=start}^end (measurement_i - value_i)^2}
+//   \f]
+//
+// Copyright (c) 2017 - 2018, Matthias Frey, Paul Scherrer Institut, Villigen PSI, Switzerland
+// All rights reserved
+//
+// Implemented as part of the PhD thesis
+// "Precise Simulations of Multibunches in High Intensity Cyclotrons"
+// and the paper
+// "Matching of turn pattern measurements for cyclotrons using multiobjective optimization"
+// (https://doi.org/10.1103/PhysRevAccelBeams.22.064602)
+//
+// This file is part of OPAL.
+//
+// OPAL 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 3 of the License, or
+// (at your option) any later version.
+//
+// You should have received a copy of the GNU General Public License
+// along with OPAL. If not, see <https://www.gnu.org/licenses/>.
+//
 #include "Expression/SumErrSqRadialPeak.h"
 
 const std::string name = "SumErrSqRadialPeak";

optimizer/Expression/SumErrSqRadialPeak.h

+//
+// Struct SumErrSqRadialPeak
+//   A simple expression computing the sum of all peak errors (given as
+//   first and second argument) for a range of peaks (third argument and fourth argument)
+//   according to
+//
+//   \f[
+//     result = \frac{1}{n} * \sqrt{\sum_{i=start}^end (measurement_i - value_i)^2}
+//   \f]
+//
+// Copyright (c) 2017 - 2018, Matthias Frey, Paul Scherrer Institut, Villigen PSI, Switzerland
+// All rights reserved
+//
+// Implemented as part of the PhD thesis
+// "Precise Simulations of Multibunches in High Intensity Cyclotrons"
+// and the paper
+// "Matching of turn pattern measurements for cyclotrons using multiobjective optimization"
+// (https://doi.org/10.1103/PhysRevAccelBeams.22.064602)
+//
+// This file is part of OPAL.
+//
+// OPAL 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 3 of the License, or
+// (at your option) any later version.
+//
+// You should have received a copy of the GNU General Public License
+// along with OPAL. If not, see <https://www.gnu.org/licenses/>.
+//
 #ifndef __SUMERRSQRADIALPEAK_H__
 #define __SUMERRSQRADIALPEAK_H__
 
@@ -12,16 +41,6 @@
 #include "Util/PeakReader.h"
 #include "Expression/Parser/function.hpp"
 
-/**
- *  A simple expression computing the sum of all peak errors (given as
- *  first and second argument) for a range of peaks (third argument and fourth argument)
- *  according to
- *
- *  \f[
- *    result = \frac{1}{n} * \sqrt{\sum_{i=start}^end (measurement_i - value_i)^2}
- *  \f]
- *
- */
 struct SumErrSqRadialPeak {
 
     static const std::string name;

optimizer/Util/PeakReader.cpp

+//
+// Class PeakReader
+//   Implements a parser and value extractor for peak files (*.peaks)
+//
+// Copyright (c) 2017 - 2018, Matthias Frey, Paul Scherrer Institut, Villigen PSI, Switzerland
+// All rights reserved
+//
+// Implemented as part of the PhD thesis
+// "Precise Simulations of Multibunches in High Intensity Cyclotrons"
+// and the paper
+// "Matching of turn pattern measurements for cyclotrons using multiobjective optimization"
+// (https://doi.org/10.1103/PhysRevAccelBeams.22.064602)
+//
+// This file is part of OPAL.
+//
+// OPAL 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 3 of the License, or
+// (at your option) any later version.
+//
+// You should have received a copy of the GNU General Public License
+// along with OPAL. If not, see <https://www.gnu.org/licenses/>.
+//
 #include <fstream>
 #include <iterator>
 

optimizer/Util/PeakReader.h

+//
+// Class PeakReader
+//   Implements a parser and value extractor for peak files (*.peaks)
+//
+// Copyright (c) 2017 - 2018, Matthias Frey, Paul Scherrer Institut, Villigen PSI, Switzerland
+// All rights reserved
+//
+// Implemented as part of the PhD thesis
+// "Precise Simulations of Multibunches in High Intensity Cyclotrons"
+// and the paper
+// "Matching of turn pattern measurements for cyclotrons using multiobjective optimization"
+// (https://doi.org/10.1103/PhysRevAccelBeams.22.064602)
+//
+// This file is part of OPAL.
+//
+// OPAL 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 3 of the License, or
+// (at your option) any later version.
+//
+// You should have received a copy of the GNU General Public License
+// along with OPAL. If not, see <https://www.gnu.org/licenses/>.
+//
 #ifndef __PEAKREADER_H__
 #define __PEAKREADER_H__
 
@@ -6,10 +29,6 @@
 
 #include "Util/OptPilotException.h"
 
-/**
- *  \class PeakReader
- *  \brief Implements a parser and value extractor for peak files (*.peaks)
- */
 class PeakReader {
     
 public: