* Getters now return non-primitive member variables by const referenc…

…e rather than by value across the entire KTT framework * Header file include directives now use unified syntax
HiPerCoRe · Nov 11, 2018 · ff5f232 · ff5f232
1 parent 4a9f562
commit ff5f232
Show file tree

Hide file tree

Showing 122 changed files with 529 additions and 532 deletions.
diff --git a/source/api/computation_result.cpp b/source/api/computation_result.cpp
@@ -1,4 +1,4 @@
-#include "computation_result.h"
+#include <api/computation_result.h>
 
 namespace ktt
 {
@@ -37,17 +37,17 @@ uint64_t ComputationResult::getDuration() const
     return duration;
 }
 
-std::string ComputationResult::getKernelName() const
+const std::string& ComputationResult::getKernelName() const
 {
     return kernelName;
 }
 
-std::string ComputationResult::getErrorMessage() const
+const std::string& ComputationResult::getErrorMessage() const
 {
     return errorMessage;
 }
 
-std::vector<ParameterPair> ComputationResult::getConfiguration() const
+const std::vector<ParameterPair>& ComputationResult::getConfiguration() const
 {
     return configuration;
 }

diff --git a/source/api/computation_result.h b/source/api/computation_result.h
@@ -6,8 +6,8 @@
 #include <cstdint>
 #include <string>
 #include <vector>
-#include "ktt_platform.h"
-#include "api/parameter_pair.h"
+#include <api/parameter_pair.h>
+#include <ktt_platform.h>
 
 namespace ktt
 {
@@ -52,23 +52,23 @@ class KTT_API ComputationResult
       */
     uint64_t getDuration() const;
 
-    /** @fn std::string getKernelName() const
+    /** @fn const std::string& getKernelName() const
       * Getter for kernel name.
       * @return Kernel name.
       */
-    std::string getKernelName() const;
+    const std::string& getKernelName() const;
 
-    /** @fn std::string getErrorMessage() const
+    /** @fn const std::string& getErrorMessage() const
       * Getter for error message.
       * @return If status is true, empty string. If status is false, message containing information about computation failure.
       */
-    std::string getErrorMessage() const;
+    const std::string& getErrorMessage() const;
 
-    /** @fn std::vector<ParameterPair> getConfiguration() const
+    /** @fn const std::vector<ParameterPair>& getConfiguration() const
       * Getter for tuning result configuration.
       * @return Tuning result configuration.
       */
-    std::vector<ParameterPair> getConfiguration() const;
+    const std::vector<ParameterPair>& getConfiguration() const;
 
 private:
     bool status;

diff --git a/source/api/device_info.cpp b/source/api/device_info.cpp
@@ -1,4 +1,4 @@
-#include "device_info.h"
+#include <api/device_info.h>
 
 namespace ktt
 {
@@ -13,17 +13,17 @@ DeviceIndex DeviceInfo::getId() const
     return id;
 }
 
-std::string DeviceInfo::getName() const
+const std::string& DeviceInfo::getName() const
 {
     return name;
 }
 
-std::string DeviceInfo::getVendor() const
+const std::string& DeviceInfo::getVendor() const
 {
     return vendor;
 }
 
-std::string DeviceInfo::getExtensions() const
+const std::string& DeviceInfo::getExtensions() const
 {
     return extensions;
 }

diff --git a/source/api/device_info.h b/source/api/device_info.h
@@ -6,9 +6,9 @@
 #include <cstdint>
 #include <iostream>
 #include <string>
-#include "ktt_platform.h"
-#include "ktt_types.h"
-#include "enum/device_type.h"
+#include <enum/device_type.h>
+#include <ktt_platform.h>
+#include <ktt_types.h>
 
 namespace ktt
 {
@@ -32,23 +32,23 @@ class KTT_API DeviceInfo
       */
     DeviceIndex getId() const;
 
-    /** @fn std::string getName() const
+    /** @fn const std::string& getName() const
       * Getter for name of device retrieved from compute API.
       * @return Name of device retrieved from compute API.
       */
-    std::string getName() const;
+    const std::string& getName() const;
 
-    /** @fn std::string getVendor() const
+    /** @fn const std::string& getVendor() const
       * Getter for name of device vendor retrieved from compute API.
       * @return Name of device vendor retrieved from compute API.
       */
-    std::string getVendor() const;
+    const std::string& getVendor() const;
 
-    /** @fn std::string getExtensions() const
+    /** @fn const std::string& getExtensions() const
       * Getter for list of supported device extensions retrieved from compute API.
       * @return List of supported device extensions retrieved from compute API.
       */
-    std::string getExtensions() const;
+    const std::string& getExtensions() const;
 
     /** @fn DeviceType getDeviceType() const
       * Getter for type of device. See ::DeviceType for more information.

diff --git a/source/api/dimension_vector.cpp b/source/api/dimension_vector.cpp
@@ -1,5 +1,5 @@
 #include <stdexcept>
-#include "dimension_vector.h"
+#include <api/dimension_vector.h>
 
 namespace ktt
 {

diff --git a/source/api/dimension_vector.h b/source/api/dimension_vector.h
@@ -5,9 +5,9 @@
 
 #include <iostream>
 #include <vector>
-#include "ktt_platform.h"
-#include "enum/modifier_action.h"
-#include "enum/modifier_dimension.h"
+#include <enum/modifier_action.h>
+#include <enum/modifier_dimension.h>
+#include <ktt_platform.h>
 
 namespace ktt
 {

diff --git a/source/api/output_descriptor.cpp b/source/api/output_descriptor.cpp
@@ -1,4 +1,4 @@
-#include "output_descriptor.h"
+#include <api/output_descriptor.h>
 
 namespace ktt
 {

diff --git a/source/api/output_descriptor.h b/source/api/output_descriptor.h
@@ -4,8 +4,8 @@
 #pragma once
 
 #include <cstddef>
-#include "ktt_platform.h"
-#include "ktt_types.h"
+#include <ktt_platform.h>
+#include <ktt_types.h>
 
 namespace ktt
 {

diff --git a/source/api/parameter_pair.cpp b/source/api/parameter_pair.cpp
@@ -1,4 +1,4 @@
-#include "parameter_pair.h"
+#include <api/parameter_pair.h>
 
 namespace ktt
 {
@@ -30,7 +30,7 @@ void ParameterPair::setValue(const size_t value)
     this->valueDouble = static_cast<double>(value);
 }
 
-std::string ParameterPair::getName() const
+const std::string& ParameterPair::getName() const
 {
     return name;
 }

diff --git a/source/api/parameter_pair.h b/source/api/parameter_pair.h
@@ -6,7 +6,7 @@
 #include <cstddef>
 #include <iostream>
 #include <string>
-#include "ktt_platform.h"
+#include <ktt_platform.h>
 
 namespace ktt
 {
@@ -42,11 +42,11 @@ class KTT_API ParameterPair
       */
     void setValue(const size_t value);
 
-    /** @fn std::string getName() const
+    /** @fn const std::string& getName() const
       * Returns name of a parameter.
       * @return Name of a parameter.
       */
-    std::string getName() const;
+    const std::string& getName() const;
 
     /** @fn size_t getValue() const
       * Returns integer representation of parameter value.

diff --git a/source/api/platform_info.cpp b/source/api/platform_info.cpp
@@ -1,4 +1,4 @@
-#include "platform_info.h"
+#include <api/platform_info.h>
 
 namespace ktt
 {
@@ -13,22 +13,22 @@ PlatformIndex PlatformInfo::getId() const
     return id;
 }
 
-std::string PlatformInfo::getName() const
+const std::string& PlatformInfo::getName() const
 {
     return name;
 }
 
-std::string PlatformInfo::getVendor() const
+const std::string& PlatformInfo::getVendor() const
 {
     return vendor;
 }
 
-std::string PlatformInfo::getVersion() const
+const std::string& PlatformInfo::getVersion() const
 {
     return version;
 }
 
-std::string PlatformInfo::getExtensions() const
+const std::string& PlatformInfo::getExtensions() const
 {
     return extensions;
 }

diff --git a/source/api/platform_info.h b/source/api/platform_info.h
@@ -5,8 +5,8 @@
 
 #include <iostream>
 #include <string>
-#include "ktt_platform.h"
-#include "ktt_types.h"
+#include <ktt_platform.h>
+#include <ktt_types.h>
 
 namespace ktt
 {
@@ -30,29 +30,29 @@ class KTT_API PlatformInfo
       */
     PlatformIndex getId() const;
 
-    /** @fn std::string getName() const
+    /** @fn const std::string& getName() const
       * Getter for name of platform retrieved from compute API.
       * @return Name of platform retrieved from compute API.
       */
-    std::string getName() const;
+    const std::string& getName() const;
 
-    /** @fn std::string getVendor() const
+    /** @fn const std::string& getVendor() const
       * Getter for name of platform vendor retrieved from compute API.
       * @return Name of platform vendor retrieved from compute API.
       */
-    std::string getVendor() const;
+    const std::string& getVendor() const;
 
-    /** @fn std::string getVersion() const
+    /** @fn const std::string& getVersion() const
       * Getter for platform version retrieved from compute API.
       * @return Platform version retrieved from compute API.
       */
-    std::string getVersion() const;
+    const std::string& getVersion() const;
 
-    /** @fn std::string getExtensions() const
+    /** @fn const std::string& getExtensions() const
       * Getter for list of supported platform extensions retrieved from compute API.
       * @return List of supported platform extensions retrieved from compute API.
       */
-    std::string getExtensions() const;
+    const std::string& getExtensions() const;
 
     /** @fn void setVendor(const std::string& vendor)
       * Setter for name of platform vendor.

diff --git a/source/api/reference_class.h b/source/api/reference_class.h
@@ -3,7 +3,7 @@
   */
 #pragma once
 
-#include "ktt_types.h"
+#include <ktt_types.h>
 
 namespace ktt
 {
@@ -29,7 +29,7 @@ class ReferenceClass
 
     /** @fn virtual void* getData(const ArgumentId id) = 0
       * Returns pointer to buffer containing reference output for specified kernel argument. This method will be called only after running
-      * computeResult() method. It can be called multiple times for same kernel argument. Inheriting class must provide implementation for this
+      * computeResult() method. It can be called multiple times for the same kernel argument. Inheriting class must provide implementation for this
       * method.
       * @param id Id of kernel argument for which reference output will be retrieved. This can be used by inheriting class to support validation of
       * multiple kernel arguments.

diff --git a/source/api/stop_condition/configuration_count.h b/source/api/stop_condition/configuration_count.h
@@ -4,7 +4,7 @@
 #pragma once
 
 #include <algorithm>
-#include "stop_condition.h"
+#include <api/stop_condition/stop_condition.h>
 
 namespace ktt
 {

diff --git a/source/api/stop_condition/configuration_duration.h b/source/api/stop_condition/configuration_duration.h
@@ -5,7 +5,7 @@
 
 #include <algorithm>
 #include <limits>
-#include "stop_condition.h"
+#include <api/stop_condition/stop_condition.h>
 
 namespace ktt
 {

diff --git a/source/api/stop_condition/configuration_fraction.h b/source/api/stop_condition/configuration_fraction.h
@@ -4,7 +4,7 @@
 #pragma once
 
 #include <algorithm>
-#include "stop_condition.h"
+#include <api/stop_condition/stop_condition.h>
 
 namespace ktt
 {

diff --git a/source/api/stop_condition/tuning_duration.h b/source/api/stop_condition/tuning_duration.h
@@ -5,7 +5,7 @@
 
 #include <algorithm>
 #include <chrono>
-#include "stop_condition.h"
+#include <api/stop_condition/stop_condition.h>
 
 namespace ktt
 {

diff --git a/source/api/tuning_manipulator.cpp b/source/api/tuning_manipulator.cpp
@@ -1,5 +1,5 @@
-#include "tuning_manipulator.h"
-#include "tuning_runner/manipulator_interface.h"
+#include <api/tuning_manipulator.h>
+#include <tuning_runner/manipulator_interface.h>
 
 namespace ktt
 {

diff --git a/source/api/tuning_manipulator.h b/source/api/tuning_manipulator.h
@@ -6,10 +6,10 @@
 #include <cstddef>
 #include <utility>
 #include <vector>
-#include "ktt_platform.h"
-#include "ktt_types.h"
-#include "api/dimension_vector.h"
-#include "api/parameter_pair.h"
+#include <api/dimension_vector.h>
+#include <api/parameter_pair.h>
+#include <ktt_platform.h>
+#include <ktt_types.h>
 
 namespace ktt
 {

diff --git a/source/compute_engine/compute_engine.h b/source/compute_engine/compute_engine.h
@@ -3,14 +3,14 @@
 #include <ostream>
 #include <string>
 #include <vector>
-#include "ktt_types.h"
-#include "api/device_info.h"
-#include "api/output_descriptor.h"
-#include "api/platform_info.h"
-#include "dto/kernel_result.h"
-#include "dto/kernel_runtime_data.h"
-#include "enum/global_size_type.h"
-#include "kernel_argument/kernel_argument.h"
+#include <api/device_info.h>
+#include <api/output_descriptor.h>
+#include <api/platform_info.h>
+#include <dto/kernel_result.h>
+#include <dto/kernel_runtime_data.h>
+#include <enum/global_size_type.h>
+#include <kernel_argument/kernel_argument.h>
+#include <ktt_types.h>
 
 namespace ktt
 {