Merge branch 'release_1_1_0'

Author: teubert

.clang-format

@@ -0,0 +1,60 @@
+BasedOnStyle: LLVM
+IndentWidth: 4
+---
+Language: Cpp
+AccessModifierOffset: -4
+AlignAfterOpenBracket: Align
+AlignConsecutiveAssignments: true
+AlignConsecutiveDeclarations: false
+AlignEscapedNewlines: DontAlign
+AlignOperands: true
+AlignTrailingComments: false
+AllowAllParametersOfDeclarationOnNextLine: false
+AllowShortBlocksOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: Empty
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: true
+BinPackArguments: false
+BinPackParameters: false
+BraceWrapping:
+    AfterClass: false
+    AfterControlStatement: false
+    AfterEnum: false
+    AfterFunction: false
+    AfterNamespace: false
+    AfterStruct: false
+    AfterUnion: false
+    BeforeCatch: true
+    BeforeElse: true
+    IndentBraces: false
+    SplitEmptyFunction: false
+    SplitEmptyRecord: true
+    SplitEmptyNamespace: true
+BreakBeforeBinaryOperators: None
+BreakBeforeBraces: Custom
+BreakBeforeInheritanceComma: false
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializers: BeforeColon
+ColumnLimit: 100
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: true
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+FixNamespaceComments: false
+IndentCaseLabels: false
+KeepEmptyLinesAtTheStartOfBlocks: false
+NamespaceIndentation: All
+PenaltyBreakBeforeFirstCallParameter: 160
+PenaltyReturnTypeOnItsOwnLine: 80
+PointerAlignment: Left
+ReflowComments: true
+SortIncludes: true
+SortUsingDeclarations: true
+TabWidth: 4
+UseTab: Never
+...

CMakeLists.txt

@@ -13,6 +13,11 @@ set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY_RELEASE ${CMAKE_BINARY_DIR})
 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY_RELEASE ${CMAKE_BINARY_DIR})
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_RELEASE ${CMAKE_BINARY_DIR})
 
+#	Build option for enabling compiler and linker flags for gathering coverage data
+#	In command line, set option this way:
+#	cmake -DCoverage=ON <build folder>
+option(Coverage "Coverage" OFF)
+
 if(${CMAKE_CXX_COMPILER_ID} STREQUAL "Clang")
 	# -g:                Produce debugging information
 	# -O3:               Optimize as much as possible while remaning standards compliant
@@ -63,6 +68,13 @@ elseif(${CMAKE_CXX_COMPILER_ID} STREQUAL "GNU")
 	set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wcast-qual -Wextra -Wfloat-equal")
 	set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wformat -Wold-style-cast -Wpedantic -Wshadow")
 	set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wsign-conversion -Wswitch-default -Wno-unknown-pragmas")
+
+if(Coverage)
+		#	If coverage option enabled, set compiler and linker flags to gather coverage data
+		set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fprofile-arcs -ftest-coverage")
+		set(CMAKE_EXE_LINKER_FLAGS "-lgcov")
+endif()
+
 	set(CMAKE_CXX_FLAGS_DEBUG "-g -Og -Winline")
 	set(CMAKE_CXX_FLAGS_RELEASE "-O3 -Werror")
 elseif(${CMAKE_CXX_COMPILER_ID} STREQUAL "MSVC")

Test/BenchmarkPrognoser/BenchmarkPrognoser.cpp

@@ -6,165 +6,38 @@
  *   BenchmarkPrognoser class.
  *
  *   @author    Micah Ricks
- *   @version   0.1.0
+ *   @version   1.1.0
  *
  *
- *      Contact: Micah Ricks ([email protected])
+ *      Contact: Christopher Teubert ([email protected])
  *      Created: January 31, 2017
  *
- *   @copyright Copyright (c) 2017 United States Government as represented by
+ *   @copyright Copyright (c) 2018 United States Government as represented by
  *     the Administrator of the National Aeronautics and Space Administration.
  *     All Rights Reserved.
  */
 
- #include <stdio.h>
- #include <stdlib.h>
- #include <cstddef>
+#include <stdio.h>
 
- #include <memory>
- #include <vector>
-
- #include "Benchmark.h"
- #include "SharedLib.h"
- #include "BenchmarkPrognoser.h"
- #include "ObserverFactory.h"
- #include "PredictorFactory.h"
- #include "PrognosticsModelFactory.h"
- #include "UData.h"
- #include "CommManager.h"
- #include "GSAPConfigMap.h"
+#include "BenchmarkTimer.h"
+#include "BenchmarkPrognoser.h"
+#include "GSAPConfigMap.h"
 
 namespace PCOE {
     // Configuration Keys
-    const std::string MODEL_KEY = "model";
-    const std::string OBSERVER_KEY = "observer";
-    const std::string PREDICTOR_KEY = "predictor";
-    const std::string EVENT_KEY = "Model.event";
-    const std::string NUMSAMPLES_KEY = "Predictor.numSamples";
-    const std::string HORIZON_KEY = "Predictor.horizon";
-    const std::string PREDICTEDOUTPUTS_KEY = "Model.predictedOutputs";
-    const std::string INPUTS_KEY = "inputs";
-    const std::string OUTPUTS_KEY = "outputs";
-    Benchmark benchmark1,benchmark2;
-    unsigned long long const INIT_TIME=0;
-
-    BenchmarkPrognoser::BenchmarkPrognoser(GSAPConfigMap & configMap) : CommonPrognoser(configMap), initialized(false) {
-        // Check for required config parameters
-        configMap.checkRequiredParams({ MODEL_KEY,OBSERVER_KEY,PREDICTOR_KEY,EVENT_KEY,NUMSAMPLES_KEY,HORIZON_KEY,PREDICTEDOUTPUTS_KEY,INPUTS_KEY,OUTPUTS_KEY });
-        /// TODO(CT): Move Model, Predictor subkeys into Model/Predictor constructor
-
-        // Create Model
-        log.WriteLine(LOG_DEBUG, moduleName, "Creating Model");
-        PrognosticsModelFactory & pProgModelFactory = PrognosticsModelFactory::instance();
-        model = std::unique_ptr<PrognosticsModel>(pProgModelFactory.Create(configMap[MODEL_KEY][0], configMap));
-
-        // Create Observer
-        log.WriteLine(LOG_DEBUG, moduleName, "Creating Observer");
-        ObserverFactory & pObserverFactory = ObserverFactory::instance();
-        observer = std::unique_ptr<Observer>(pObserverFactory.Create(configMap[OBSERVER_KEY][0], configMap));
-
-        // Create Predictor
-        log.WriteLine(LOG_DEBUG, moduleName, "Creating Predictor");
-        PredictorFactory & pPredictorFactory = PredictorFactory::instance();
-        predictor = std::unique_ptr<Predictor>(pPredictorFactory.Create(configMap[PREDICTOR_KEY][0], configMap));
 
-        // Set model for observer and predictor
-        observer->setModel(model.get());
-        predictor->setModel(model.get());
+    BenchmarkPrognoser::BenchmarkPrognoser(GSAPConfigMap & configMap) : ModelBasedPrognoser(configMap) {
 
-        // Set configuration parameters
-        unsigned int numSamples = static_cast<unsigned int>(std::stoul(configMap[NUMSAMPLES_KEY][0]));
-        unsigned int horizon = static_cast<unsigned int>(std::stoul(configMap[HORIZON_KEY][0]));
-        std::string event = configMap[EVENT_KEY][0];
-        std::vector<std::string> predictedOutputs = configMap[PREDICTEDOUTPUTS_KEY];
-
-        // Set inputs and outputs
-        inputs = configMap[INPUTS_KEY];
-        outputs = configMap[OUTPUTS_KEY];
-
-        // Create progdata
-        results.setUncertainty(UType::Samples);             // @todo(MD): do not force samples representation
-        results.addEvent(event);                            // @todo(MD): do not assume only a single event
-        results.addSystemTrajectories(predictedOutputs);    // predicted outputs
-        results.setPredictions(1, horizon);                 // interval, number of predictions
-        results.setupOccurrence(numSamples);
-        results.events[event].timeOfEvent.npoints(numSamples);
-        results.sysTrajectories.setNSamples(numSamples);
     }
 
     void BenchmarkPrognoser::step() {
-
-        //init time in nanoseconds
-         if(benchmark2.begin != INIT_TIME)
-          {
-            benchmark2.nanosecondsEnd();
-            benchmark2.findElapsedTime();
-
-          }
-         benchmark1.nanosecondsBegin();
-
-        static double initialTime = comm.getValue(outputs[0]).getTime() / 1.0e3;
-
-        // Get new relative time (convert to seconds)
-        // @todo(MD): Add config for time units so conversion is not hard-coded
-        double newT = comm.getValue(outputs[0]).getTime() / 1.0e3 - initialTime;
-
-        // Fill in input and output data
-        log.WriteLine(LOG_DEBUG, moduleName, "Getting data in step");
-        std::vector<double> u(model->getNumInputs());
-        std::vector<double> z(model->getNumOutputs());
-        for (unsigned int i = 0; i < model->getNumInputs(); i++) {
-            u[i] = comm.getValue(inputs[i]);
-        }
-        for (unsigned int i = 0; i < model->getNumOutputs(); i++) {
-            z[i] = comm.getValue(outputs[i]);
-        }
-
-        // If this is the first step, will want to initialize the observer and the predictor
-        if (!initialized) {
-            log.WriteLine(LOG_DEBUG, moduleName, "Initializing BenchmarkPrognoser");
-            std::vector<double> x(model->getNumStates());
-            model->initialize(x, u, z);
-            observer->initialize(newT, x, u);
-            initialized = true;
-            lastTime = newT;
-        } else {
-            // If time has not advanced, skip this step
-            if (newT <= lastTime) {
-                log.WriteLine(LOG_TRACE, moduleName, "Skipping step because time did not advance.");
-
-            benchmark1.nanosecondsEnd();
-            benchmark1.findElapsedTime();
-            benchmark2.nanosecondsBegin();
-                return;
-            }
-
-            // Run observer
-            log.WriteLine(LOG_DEBUG, moduleName, "Running Observer Step");
-            observer->step(newT, u, z);
-            log.WriteLine(LOG_DEBUG, moduleName, "Done Running Observer Step");
-
-            // Run predictor
-            log.WriteLine(LOG_DEBUG, moduleName, "Running Prediction Step");
-            // Set up state
-            std::vector<UData> stateEst = observer->getStateEstimate();
-            predictor->predict(newT, stateEst, results);
-            log.WriteLine(LOG_DEBUG, moduleName, "Done Running Prediction Step");
-
-            // Set lastTime
-            lastTime = newT;
-
-        }
+        benchmark1.start();
+        ModelBasedPrognoser::step();
+        benchmark1.stop();
     }
 
-//destructor
-BenchmarkPrognoser::~BenchmarkPrognoser() {
-  benchmark1.clearFile();
-  benchmark1.printTemp();
-  benchmark1.printScreen();
-  benchmark2.printScreen();
-  benchmark1.writeFile();
-  benchmark2.writeFile();
-}
-
-}
+    // destructor
+    BenchmarkPrognoser::~BenchmarkPrognoser() {
+        printf("Runtime: [%lld, %lld, %lld] ns\n", benchmark1.getMinStepTime()/nanoseconds(1), benchmark1.getAveStepTime()/nanoseconds(1), benchmark1.getMaxStepTime()/nanoseconds(1));
+    }
+}   // namespace PCOE

Test/BenchmarkPrognoser/BenchmarkPrognoser.h

@@ -1,54 +1,43 @@
 /**  Benchmark Prognoser - Header
-*   @class     BenchmarkPrognoser BenchmarkPrognoser.h
-*
-*   @brief     Benchmark Prognoser Class
-*
-*   BenchmarkPrognoser class.
-*
-*   @author    Micah Ricks
-*   @version   0.1.0
-*
-*
-*      Contact: Micah Ricks ([email protected])
-*      Created: March 16, 2016
-*
-*   @copyright Copyright (c) 2017 United States Government as represented by
-*     the Administrator of the National Aeronautics and Space Administration.
-*     All Rights Reserved.
-*/
-
+ *   @class     BenchmarkPrognoser BenchmarkPrognoser.h
+ *
+ *   @brief     Benchmark Prognoser Class
+ *
+ *   BenchmarkPrognoser class.
+ *
+ *   @author    Micah Ricks
+ *   @version   1.1.0
+ *
+ *
+ *      Contact: Christopher Teubert ([email protected])
+ *      Created: March 16, 2016
+ *
+ *   @copyright Copyright (c) 2018 United States Government as represented by
+ *     the Administrator of the National Aeronautics and Space Administration.
+ *     All Rights Reserved.
+ */
 #ifndef PCOE_BENCHMARKPROGNOSER_H
 #define PCOE_BENCHMARKPROGNOSER_H
 
-
-#include "CommonPrognoser.h"
-#include "PrognosticsModel.h"
+#include "BenchmarkTimer.h"
+#include "ModelBasedPrognoser.h"
 #include "Observer.h"
 #include "Predictor.h"
+#include "PrognosticsModel.h"
 
 namespace PCOE {
-    class BenchmarkPrognoser : public CommonPrognoser
-    {
+    class BenchmarkPrognoser : public ModelBasedPrognoser {
     private:
-        std::unique_ptr<PrognosticsModel> model;
-        std::unique_ptr<Observer> observer;
-        std::unique_ptr<Predictor> predictor;
-        std::vector<std::string> inputs;
-        std::vector<std::string> outputs;
-        bool initialized;
-        double firstTime;
-        double lastTime;
+        BenchmarkTimer benchmark1;
 
     public:
-        /** @brief      Benchmark Prognoser Constructor
-         *  @param      config Map of config parameters from the prognoser config file
+        /**
+         * @brief Benchmark Prognoser Constructor
+         * @param config Map of config parameters from the prognoser config file
          */
-        BenchmarkPrognoser(GSAPConfigMap & config);
-        ~BenchmarkPrognoser();  //destructor
+        BenchmarkPrognoser(GSAPConfigMap& config);
+        ~BenchmarkPrognoser(); // destructor
         void step();
     };
-
-    extern bool regModelProg;
 }
-
 #endif // PCOE_BENCHMARKPROGNOSER_H

Test/BenchmarkPrognoser/main.cpp

@@ -3,7 +3,7 @@
 //  Example
 //
 //  Created by Teubert, Christopher (ARC-TI)[SGT, INC] on 5/4/16.
-//  Copyright © 2016 United States Government as represented by the Administrator of the National Aeronautics and Space Administration.  All Rights Reserved.
+//  Copyright © 2018 United States Government as represented by the Administrator of the National Aeronautics and Space Administration.  All Rights Reserved.
 //
 
 #include "ProgManager.h"
@@ -31,12 +31,6 @@
 using namespace PCOE;
 
 int main() {
-    // Specify configuration file directories
-  //  std::ofstream file;
-    //file.open("test.txt");
-    //file<<"test \n";
-    //file.close();
-
     ConfigMap::addSearchPath("../example/cfg/");
 
     // Specify Prognosers
@@ -63,6 +57,13 @@ int main() {
     pPredictorFactory.Register("MC", PredictorFactory::Create<MonteCarloPredictor>);
 
     ProgManager PM = ProgManager("bench.cfg");
-    PM.run();
+    
+    printf("Benchmarking\n");
+    PM.enable();
+    std::this_thread::sleep_for(std::chrono::seconds(3));
+    PM.start();
+    std::this_thread::sleep_for(std::chrono::minutes(1));
+    PM.stop();
+  
     return 0;
 }