From c5b13d0d6093e961df5eb279865f40c66004047b Mon Sep 17 00:00:00 2001
From: William F Godoy <williamfgc@yahoo.com>
Date: Thu, 13 Apr 2017 14:56:37 -0400
Subject: [PATCH] Moving templates implementations to tcc
Changed BP1Writer.h by BPWriter.tcc in unique "public" header BP1.h
---
include/utilities/format/bp1/BP1.h | 3 +-
include/utilities/format/bp1/BP1Writer.h | 96 +++-------
include/utilities/format/bp1/BP1Writer.tcc | 158 +++++++++++++++-
source/utilities/format/bp1/BP1Writer.cpp | 207 +--------------------
4 files changed, 192 insertions(+), 272 deletions(-)
diff --git a/include/utilities/format/bp1/BP1.h b/include/utilities/format/bp1/BP1.h
index d1b394088..361fa1887 100644
--- a/include/utilities/format/bp1/BP1.h
+++ b/include/utilities/format/bp1/BP1.h
@@ -13,6 +13,7 @@
#include "utilities/format/bp1/BP1Aggregator.h"
#include "utilities/format/bp1/BP1Structs.h"
-#include "utilities/format/bp1/BP1Writer.h"
+//#include "utilities/format/bp1/BP1Writer.h"
+#include "utilities/format/bp1/BP1Writer.tcc"
#endif /* BP1_H_ */
diff --git a/include/utilities/format/bp1/BP1Writer.h b/include/utilities/format/bp1/BP1Writer.h
index c0e67e3d6..0fca73c4a 100644
--- a/include/utilities/format/bp1/BP1Writer.h
+++ b/include/utilities/format/bp1/BP1Writer.h
@@ -279,76 +279,14 @@ private:
capsule::STLVector &buffer) const noexcept;
};
-#define declare_template_instantiation(T) \
- extern template std::size_t BP1Writer::GetVariableIndexSize( \
- const Variable<T> &variable) const noexcept; \
- \
- extern template void BP1Writer::WriteVariablePayload( \
- const Variable<T> &variable, capsule::STLVector &heap, \
- const unsigned int nthreads) const noexcept; \
- \
- extern template void BP1Writer::WriteBoundsRecord( \
- const bool isScalar, const Stats<T> &stats, std::vector<char> &buffer, \
- std::uint8_t &characteristicsCounter, const bool addLength) \
- const noexcept; \
- \
- extern template void BP1Writer::WriteCharacteristicRecord( \
- const std::uint8_t characteristicID, const T &value, \
- std::vector<char> &buffer, std::uint8_t &characteristicsCounter, \
- const bool addLength) const noexcept;
-
-ADIOS_FOREACH_TYPE_1ARG(declare_template_instantiation)
-#undef declare_template_instantiation
-
-// SEPARATE PRIMITIVE FROM COMPLEX OVERLOADS
-// PRIMITIVE
-#define declare_template_instantiation(T) \
- extern template void BP1Writer::WriteVariableMetadata( \
- const Variable<T> &variable, capsule::STLVector &heap, \
- BP1MetadataSet &metadataSet) const noexcept; \
- \
- extern template BP1Writer::Stats<T> BP1Writer::GetStats( \
- const Variable<T> &variable) const noexcept;
-
-ADIOS_FOREACH_PRIMITIVE_TYPE_1ARG(declare_template_instantiation)
-#undef declare_template_instantiation
-
-// COMPLEX
-#define declare_template_instantiation(T) \
- extern template void BP1Writer::WriteVariableMetadata( \
- const Variable<std::complex<T>> &variable, capsule::STLVector &heap, \
- BP1MetadataSet &metadataSet) const noexcept; \
- \
- extern template BP1Writer::Stats<T> BP1Writer::GetStats( \
- const Variable<std::complex<T>> &variable) const noexcept;
-
-ADIOS_FOREACH_COMPLEX_TYPE_1ARG(declare_template_instantiation)
-#undef declare_template_instantiation
-
-// Explicit declaration of the template methods
//#define declare_template_instantiation(T) \
-//// extern template std::size_t BP1Writer::GetVariableIndexSize( \
-//// const Variable<T> &variable) const noexcept;
-// ADIOS_FOREACH_TYPE_1ARG(declare_template_instantiation)
-//#undef declare_template_instantiation
-// extern template void BP1Writer::WriteVariableMetadata( \
-// const Variable<T> &variable, capsule::STLVector &heap, \
-// BP1MetadataSet &metadataSet) const noexcept; \
-// \
-// extern template void BP1Writer::WriteVariableMetadata( \
-// const Variable<std::complex<T>> &variable, capsule::STLVector &heap, \
-// BP1MetadataSet &metadataSet) const noexcept; \
+// extern template std::size_t BP1Writer::GetVariableIndexSize( \
+// const Variable<T> &variable) const noexcept; \
// \
// extern template void BP1Writer::WriteVariablePayload( \
// const Variable<T> &variable, capsule::STLVector &heap, \
// const unsigned int nthreads) const noexcept; \
// \
-// extern template Stats<T> BP1Writer::GetStats(const Variable<T> &variable) \
-// const noexcept; \
-// \
-// extern template Stats<T> BP1Writer::GetStats( \
-// const Variable<std::complex<T>> &variable) const noexcept; \
-// \
// extern template void BP1Writer::WriteBoundsRecord( \
// const bool isScalar, const Stats<T> &stats, std::vector<char> &buffer, \
// std::uint8_t &characteristicsCounter, const bool addLength) \
@@ -358,10 +296,38 @@ ADIOS_FOREACH_COMPLEX_TYPE_1ARG(declare_template_instantiation)
// const std::uint8_t characteristicID, const T &value, \
// std::vector<char> &buffer, std::uint8_t &characteristicsCounter, \
// const bool addLength) const noexcept;
+//
+// ADIOS_FOREACH_TYPE_1ARG(declare_template_instantiation)
+//#undef declare_template_instantiation
+//
+//// SEPARATE PRIMITIVE FROM COMPLEX OVERLOADS
+//// PRIMITIVE
+//#define declare_template_instantiation(T) \
+// extern template void BP1Writer::WriteVariableMetadata( \
+// const Variable<T> &variable, capsule::STLVector &heap, \
+// BP1MetadataSet &metadataSet) const noexcept; \
+// \
+// extern template BP1Writer::Stats<T> BP1Writer::GetStats( \
+// const Variable<T> &variable) const noexcept;
+//
+// ADIOS_FOREACH_PRIMITIVE_TYPE_1ARG(declare_template_instantiation)
+//#undef declare_template_instantiation
+//
+//// COMPLEX
+//#define declare_template_instantiation(T) \
+// extern template void BP1Writer::WriteVariableMetadata( \
+// const Variable<std::complex<T>> &variable, capsule::STLVector &heap, \
+// BP1MetadataSet &metadataSet) const noexcept; \
+// \
+// extern template BP1Writer::Stats<T> BP1Writer::GetStats( \
+// const Variable<std::complex<T>> &variable) const noexcept;
+//
+// ADIOS_FOREACH_COMPLEX_TYPE_1ARG(declare_template_instantiation)
+//#undef declare_template_instantiation
} // end namespace format
} // end namespace adios
-#include "utilities/format/bp1/BP1Writer.tcc"
+//#include "utilities/format/bp1/BP1Writer.tcc"
#endif /* BP1WRITER_H_ */
diff --git a/include/utilities/format/bp1/BP1Writer.tcc b/include/utilities/format/bp1/BP1Writer.tcc
index 9741e9015..73a30f6e6 100644
--- a/include/utilities/format/bp1/BP1Writer.tcc
+++ b/include/utilities/format/bp1/BP1Writer.tcc
@@ -8,14 +8,170 @@
* Author: wfg
*/
-#include "BP1Writer.h"
+#include "utilities/format/bp1/BP1Writer.h"
namespace adios
{
namespace format
{
+// PUBLIC
+template <class T>
+std::size_t BP1Writer::GetVariableIndexSize(const Variable<T> &variable) const
+ noexcept
+{
+ // size_t indexSize = varEntryLength + memberID + lengthGroupName +
+ // groupName + lengthVariableName + lengthOfPath + path + datatype
+ std::size_t indexSize = 23; // without characteristics
+ indexSize += variable.m_Name.size();
+
+ // characteristics 3 and 4, check variable number of dimensions
+ const std::size_t dimensions =
+ variable.DimensionsSize(); // commas in CSV + 1
+ indexSize += 28 * dimensions; // 28 bytes per dimension
+ indexSize += 1; // id
+
+ // characteristics, offset + payload offset in data
+ indexSize += 2 * (1 + 8);
+ // characteristic 0, if scalar add value, for now only allowing string
+ if (dimensions == 1)
+ {
+ indexSize += sizeof(T);
+ indexSize += 1; // id
+ // must have an if here
+ indexSize += 2 + variable.m_Name.size();
+ indexSize += 1; // id
+ }
+
+ // characteristic statistics
+ if (m_Verbosity == 0) // default, only min and max
+ {
+ indexSize += 2 * (sizeof(T) + 1);
+ indexSize += 1 + 1; // id
+ }
+
+ return indexSize + 12; // extra 12 bytes in case of attributes
+ // need to add transform characteristics
+}
+
+template <class T>
+void BP1Writer::WriteVariableMetadata(const Variable<T> &variable,
+ capsule::STLVector &heap,
+ BP1MetadataSet &metadataSet) const
+ noexcept
+{
+ Stats<T> stats = GetStats(variable);
+ WriteVariableMetadataCommon(variable, stats, heap, metadataSet);
+}
+
+template <class T>
+void BP1Writer::WriteVariableMetadata(const Variable<std::complex<T>> &variable,
+ capsule::STLVector &heap,
+ BP1MetadataSet &metadataSet) const
+ noexcept
+{
+ Stats<T> stats = GetStats(variable);
+ WriteVariableMetadataCommon(variable, stats, heap, metadataSet);
+}
+
+template <class T>
+void BP1Writer::WriteVariablePayload(const Variable<T> &variable,
+ capsule::STLVector &heap,
+ const unsigned int nthreads) const noexcept
+{
+ // EXPENSIVE part, might want to use threads if large, serial for now
+ InsertToBuffer(heap.m_Data, variable.m_AppValues, variable.TotalSize());
+ heap.m_DataAbsolutePosition += variable.PayLoadSize();
+}
+
// PRIVATE
+template <class T>
+BP1Writer::Stats<T> BP1Writer::GetStats(const Variable<T> &variable) const
+ noexcept
+{
+ Stats<T> stats;
+ const std::size_t valuesSize = variable.TotalSize();
+
+ if (m_Verbosity == 0)
+ {
+ if (valuesSize >= 10000000) // ten million? this needs actual results
+ // //we can make decisions for threads
+ // based on valuesSize
+ GetMinMax(variable.m_AppValues, valuesSize, stats.Min, stats.Max,
+ m_Threads); // here we can add cores from constructor
+ else
+ GetMinMax(variable.m_AppValues, valuesSize, stats.Min, stats.Max);
+ }
+ return stats;
+}
+
+template <class T>
+BP1Writer::Stats<T>
+BP1Writer::GetStats(const Variable<std::complex<T>> &variable) const noexcept
+{
+ Stats<T> stats;
+ const std::size_t valuesSize = variable.TotalSize();
+
+ if (m_Verbosity == 0)
+ {
+ // ten million? this needs actual results
+ // to make decisions for threads usage
+ if (valuesSize >= 10000000)
+ {
+ GetMinMax(variable.m_AppValues, valuesSize, stats.Min, stats.Max,
+ m_Threads);
+ }
+ else
+ {
+ GetMinMax(variable.m_AppValues, valuesSize, stats.Min, stats.Max);
+ }
+ }
+ return stats;
+}
+
+template <class T>
+void BP1Writer::WriteBoundsRecord(const bool isScalar, const Stats<T> &stats,
+ std::vector<char> &buffer,
+ std::uint8_t &characteristicsCounter,
+ const bool addLength) const noexcept
+{
+ if (isScalar == true)
+ {
+ WriteCharacteristicRecord(characteristic_value, stats.Min, buffer,
+ characteristicsCounter,
+ addLength); // stats.min = stats.max = value
+ return;
+ }
+
+ if (m_Verbosity == 0) // default verbose
+ {
+ WriteCharacteristicRecord(characteristic_min, stats.Min, buffer,
+ characteristicsCounter, addLength);
+ WriteCharacteristicRecord(characteristic_max, stats.Max, buffer,
+ characteristicsCounter, addLength);
+ }
+}
+
+template <class T>
+void BP1Writer::WriteCharacteristicRecord(const std::uint8_t characteristicID,
+ const T &value,
+ std::vector<char> &buffer,
+ std::uint8_t &characteristicsCounter,
+ const bool addLength) const noexcept
+{
+ const std::uint8_t id = characteristicID;
+ InsertToBuffer(buffer, &id);
+
+ if (addLength == true)
+ {
+ const std::uint16_t lengthOfCharacteristic = sizeof(T); // id
+ InsertToBuffer(buffer, &lengthOfCharacteristic);
+ }
+
+ InsertToBuffer(buffer, &value);
+ ++characteristicsCounter;
+}
+
template <class T, class U>
void BP1Writer::WriteVariableMetadataCommon(const Variable<T> &variable,
Stats<U> &stats,
diff --git a/source/utilities/format/bp1/BP1Writer.cpp b/source/utilities/format/bp1/BP1Writer.cpp
index 191d25bc8..a586274ec 100644
--- a/source/utilities/format/bp1/BP1Writer.cpp
+++ b/source/utilities/format/bp1/BP1Writer.cpp
@@ -13,7 +13,8 @@
#include <vector>
/// \endcond
-#include "utilities/format/bp1/BP1Writer.h"
+//#include "utilities/format/bp1/BP1Writer.h"
+#include "utilities/format/bp1/BP1Writer.tcc"
namespace adios
{
@@ -417,209 +418,5 @@ void BP1Writer::FlattenMetadata(BP1MetadataSet &metadataSet,
metadataSet.Log.TotalBytes.push_back(heap.m_DataAbsolutePosition);
}
-// TEMPLATES
-template <class T>
-std::size_t BP1Writer::GetVariableIndexSize(const Variable<T> &variable) const
- noexcept
-{
- // size_t indexSize = varEntryLength + memberID + lengthGroupName +
- // groupName + lengthVariableName + lengthOfPath + path + datatype
- std::size_t indexSize = 23; // without characteristics
- indexSize += variable.m_Name.size();
-
- // characteristics 3 and 4, check variable number of dimensions
- const std::size_t dimensions =
- variable.DimensionsSize(); // commas in CSV + 1
- indexSize += 28 * dimensions; // 28 bytes per dimension
- indexSize += 1; // id
-
- // characteristics, offset + payload offset in data
- indexSize += 2 * (1 + 8);
- // characteristic 0, if scalar add value, for now only allowing string
- if (dimensions == 1)
- {
- indexSize += sizeof(T);
- indexSize += 1; // id
- // must have an if here
- indexSize += 2 + variable.m_Name.size();
- indexSize += 1; // id
- }
-
- // characteristic statistics
- if (m_Verbosity == 0) // default, only min and max
- {
- indexSize += 2 * (sizeof(T) + 1);
- indexSize += 1 + 1; // id
- }
-
- return indexSize + 12; // extra 12 bytes in case of attributes
- // need to add transform characteristics
-}
-#define declare_template_instantiation(T) \
- template std::size_t BP1Writer::GetVariableIndexSize( \
- const Variable<T> &variable) const noexcept;
-ADIOS_FOREACH_TYPE_1ARG(declare_template_instantiation)
-#undef declare_template_instantiation
-
-template <class T>
-void BP1Writer::WriteVariableMetadata(const Variable<T> &variable,
- capsule::STLVector &heap,
- BP1MetadataSet &metadataSet) const
- noexcept
-{
- Stats<T> stats = GetStats(variable);
- WriteVariableMetadataCommon(variable, stats, heap, metadataSet);
-}
-#define declare_template_instantiation(T) \
- template void BP1Writer::WriteVariableMetadata( \
- const Variable<T> &variable, capsule::STLVector &heap, \
- BP1MetadataSet &metadataSet) const noexcept;
-ADIOS_FOREACH_PRIMITIVE_TYPE_1ARG(declare_template_instantiation)
-#undef declare_template_instantiation
-
-template <class T>
-void BP1Writer::WriteVariableMetadata(const Variable<std::complex<T>> &variable,
- capsule::STLVector &heap,
- BP1MetadataSet &metadataSet) const
- noexcept
-{
- Stats<T> stats = GetStats(variable);
- WriteVariableMetadataCommon(variable, stats, heap, metadataSet);
-}
-#define declare_template_instantiation(T) \
- template void BP1Writer::WriteVariableMetadata( \
- const Variable<std::complex<T>> &variable, capsule::STLVector &heap, \
- BP1MetadataSet &metadataSet) const noexcept;
-ADIOS_FOREACH_COMPLEX_TYPE_1ARG(declare_template_instantiation)
-#undef declare_template_instantiation
-
-template <class T>
-void BP1Writer::WriteVariablePayload(const Variable<T> &variable,
- capsule::STLVector &heap,
- const unsigned int nthreads) const noexcept
-{
- // EXPENSIVE part, might want to use threads if large, serial for now
- InsertToBuffer(heap.m_Data, variable.m_AppValues, variable.TotalSize());
- heap.m_DataAbsolutePosition += variable.PayLoadSize();
-}
-#define declare_template_instantiation(T) \
- template void BP1Writer::WriteVariablePayload( \
- const Variable<T> &variable, capsule::STLVector &heap, \
- const unsigned int nthreads) const noexcept;
-ADIOS_FOREACH_TYPE_1ARG(declare_template_instantiation)
-#undef declare_template_instantiation
-
-// PRIVATE TEMPLATES BELOW
-template <class T>
-BP1Writer::Stats<T> BP1Writer::GetStats(const Variable<T> &variable) const
- noexcept
-{
- Stats<T> stats;
- const std::size_t valuesSize = variable.TotalSize();
-
- if (m_Verbosity == 0)
- {
- if (valuesSize >= 10000000) // ten million? this needs actual results
- // //we can make decisions for threads
- // based on valuesSize
- GetMinMax(variable.m_AppValues, valuesSize, stats.Min, stats.Max,
- m_Threads); // here we can add cores from constructor
- else
- GetMinMax(variable.m_AppValues, valuesSize, stats.Min, stats.Max);
- }
- return stats;
-}
-#define declare_template_instantiation(T) \
- template BP1Writer::Stats<T> BP1Writer::GetStats( \
- const Variable<T> &variable) const noexcept;
-ADIOS_FOREACH_PRIMITIVE_TYPE_1ARG(declare_template_instantiation)
-#undef declare_template_instantiation
-
-template <class T>
-BP1Writer::Stats<T>
-BP1Writer::GetStats(const Variable<std::complex<T>> &variable) const noexcept
-{
- Stats<T> stats;
- const std::size_t valuesSize = variable.TotalSize();
-
- if (m_Verbosity == 0)
- {
- // ten million? this needs actual results
- // to make decisions for threads usage
- if (valuesSize >= 10000000)
- {
- GetMinMax(variable.m_AppValues, valuesSize, stats.Min, stats.Max,
- m_Threads);
- }
- else
- {
- GetMinMax(variable.m_AppValues, valuesSize, stats.Min, stats.Max);
- }
- }
- return stats;
-}
-#define declare_template_instantiation(T) \
- template BP1Writer::Stats<T> BP1Writer::GetStats( \
- const Variable<std::complex<T>> &variable) const noexcept;
-ADIOS_FOREACH_COMPLEX_TYPE_1ARG(declare_template_instantiation)
-#undef declare_template_instantiation
-
-template <class T>
-void BP1Writer::WriteBoundsRecord(const bool isScalar, const Stats<T> &stats,
- std::vector<char> &buffer,
- std::uint8_t &characteristicsCounter,
- const bool addLength) const noexcept
-{
- if (isScalar == true)
- {
- WriteCharacteristicRecord(characteristic_value, stats.Min, buffer,
- characteristicsCounter,
- addLength); // stats.min = stats.max = value
- return;
- }
-
- if (m_Verbosity == 0) // default verbose
- {
- WriteCharacteristicRecord(characteristic_min, stats.Min, buffer,
- characteristicsCounter, addLength);
- WriteCharacteristicRecord(characteristic_max, stats.Max, buffer,
- characteristicsCounter, addLength);
- }
-}
-#define declare_template_instantiation(T) \
- template void BP1Writer::WriteBoundsRecord( \
- const bool isScalar, const Stats<T> &stats, std::vector<char> &buffer, \
- std::uint8_t &characteristicsCounter, const bool addLength) \
- const noexcept;
-ADIOS_FOREACH_TYPE_1ARG(declare_template_instantiation)
-#undef declare_template_instantiation
-
-template <class T>
-void BP1Writer::WriteCharacteristicRecord(const std::uint8_t characteristicID,
- const T &value,
- std::vector<char> &buffer,
- std::uint8_t &characteristicsCounter,
- const bool addLength) const noexcept
-{
- const std::uint8_t id = characteristicID;
- InsertToBuffer(buffer, &id);
-
- if (addLength == true)
- {
- const std::uint16_t lengthOfCharacteristic = sizeof(T); // id
- InsertToBuffer(buffer, &lengthOfCharacteristic);
- }
-
- InsertToBuffer(buffer, &value);
- ++characteristicsCounter;
-}
-#define define_template_instantiation(T) \
- template void BP1Writer::WriteCharacteristicRecord( \
- const std::uint8_t characteristicID, const T &value, \
- std::vector<char> &buffer, std::uint8_t &characteristicsCounter, \
- const bool addLength) const noexcept;
-ADIOS_FOREACH_TYPE_1ARG(define_template_instantiation)
-#undef define_template_instatiation
-
} // end namespace format
} // end namespace adios
--
GitLab