HG_REPOSITORIES/LPP/SciQLOP_Repos/SciQLop Commit - r669:ae1634210b26

Updates merge() method (2)...

Alexandre Leroux -

r669:ae1634210b26

parent child

Context file:

r669:ae1634210b26

Collapse all files

core/include/Data/ArrayData.h +11 0

             #ifndef SCIQLOP_ARRAYDATA_H
             #define SCIQLOP_ARRAYDATA_H
             #include "Data/ArrayDataIterator.h"
             #include <Common/SortUtils.h>
             #include <QReadLocker>
             #include <QReadWriteLock>
             #include <QVector>
             #include <memory>
             template <int Dim>
             class ArrayData;
             using DataContainer = QVector<double>;
             namespace arraydata_detail {
             /// Struct used to sort ArrayData
             template <int Dim>
             struct Sort {
                 static std::shared_ptr<ArrayData<Dim> > sort(const DataContainer &data, int nbComponents,
                                                              const std::vector<int> &sortPermutation)
                 {
                     return std::make_shared<ArrayData<Dim> >(
                         SortUtils::sort(data, nbComponents, sortPermutation), nbComponents);
                 }
             };
             /// Specialization for uni-dimensional ArrayData
             template <>
             struct Sort<1> {
                 static std::shared_ptr<ArrayData<1> > sort(const DataContainer &data, int nbComponents,
                                                            const std::vector<int> &sortPermutation)
                 {
                     Q_UNUSED(nbComponents)
                     return std::make_shared<ArrayData<1> >(SortUtils::sort(data, 1, sortPermutation));
                 }
             };
             template <int Dim>
             class IteratorValue : public ArrayDataIteratorValue::Impl {
             public:
                 explicit IteratorValue(const DataContainer &container, int nbComponents, bool begin)
                         : m_It{begin ? container.cbegin() : container.cend()}, m_NbComponents{nbComponents}
                 {
                 }
                 IteratorValue(const IteratorValue &other) = default;
                 std::unique_ptr<ArrayDataIteratorValue::Impl> clone() const override
                 {
                     return std::make_unique<IteratorValue<Dim> >(*this);
                 }
                 bool equals(const ArrayDataIteratorValue::Impl &other) const override try {
                     const auto &otherImpl = dynamic_cast<const IteratorValue &>(other);
                     return std::tie(m_It, m_NbComponents) == std::tie(otherImpl.m_It, otherImpl.m_NbComponents);
                 }
                 catch (const std::bad_cast &) {
                     return false;
                 }
                 void next() override { std::advance(m_It, m_NbComponents); }
                 void prev() override { std::advance(m_It, -m_NbComponents); }
                 double at(int componentIndex) const override { return *(m_It + componentIndex); }
                 double first() const override { return *m_It; }
                 double min() const override
                 {
                     auto values = this->values();
                     auto end = values.cend();
                     auto it = std::min_element(values.cbegin(), end, [](const auto &v1, const auto &v2) {
                         return SortUtils::minCompareWithNaN(v1, v2);
                     });
                     return it != end ? *it : std::numeric_limits<double>::quiet_NaN();
                 }
                 double max() const override
                 {
                     auto values = this->values();
                     auto end = values.cend();
                     auto it = std::max_element(values.cbegin(), end, [](const auto &v1, const auto &v2) {
                         return SortUtils::maxCompareWithNaN(v1, v2);
                     });
                     return it != end ? *it : std::numeric_limits<double>::quiet_NaN();
                 }
                 QVector<double> values() const override
                 {
                     auto result = QVector<double>{};
                     for (auto i = 0; i < m_NbComponents; ++i) {
                         result.push_back(*(m_It + i));
                     }
                     return result;
                 }
             private:
                 DataContainer::const_iterator m_It;
                 int m_NbComponents;
             };
             } // namespace arraydata_detail
             /**
              * @brief The ArrayData class represents a dataset for a data series.
              *
              * A dataset can be unidimensional or two-dimensional. This property is determined by the Dim
              * template-parameter. In a case of a two-dimensional dataset, each dataset component has the same
              * number of values
              *
              * @tparam Dim the dimension of the ArrayData (one or two)
              * @sa IDataSeries
              */
             template <int Dim>
             class ArrayData {
             public:
                 // ///// //
                 // Ctors //
                 // ///// //
                 /**
                  * Ctor for a unidimensional ArrayData
                  * @param data the data the ArrayData will hold
                  */
                 template <int D = Dim, typename = std::enable_if_t<D == 1> >
                 explicit ArrayData(DataContainer data) : m_Data{std::move(data)}, m_NbComponents{1}
                 {
                 }
                 /**
                  * Ctor for a two-dimensional ArrayData. The number of components (number of lines) must be
                  * greater than 2 and must be a divisor of the total number of data in the vector
                  * @param data the data the ArrayData will hold
                  * @param nbComponents the number of components
                  * @throws std::invalid_argument if the number of components is less than 2 or is not a divisor
                  * of the size of the data
                  */
                 template <int D = Dim, typename = std::enable_if_t<D == 2> >
                 explicit ArrayData(DataContainer data, int nbComponents)
                         : m_Data{std::move(data)}, m_NbComponents{nbComponents}
                 {
                     if (nbComponents < 2) {
                         throw std::invalid_argument{
                             QString{"A multidimensional ArrayData must have at least 2 components (found: %1)"}
                                 .arg(nbComponents)
                                 .toStdString()};
                     }
                     if (m_Data.size() % m_NbComponents != 0) {
                         throw std::invalid_argument{QString{
                             "The number of components (%1) is inconsistent with the total number of data (%2)"}
                                                         .arg(m_Data.size(), nbComponents)
                                                         .toStdString()};
                     }
                 }
                 /// Copy ctor
                 explicit ArrayData(const ArrayData &other)
                 {
                     QReadLocker otherLocker{&other.m_Lock};
                     m_Data = other.m_Data;
                     m_NbComponents = other.m_NbComponents;
                 }
                 // /////////////// //
                 // General methods //
                 // /////////////// //
                 /**
                  * Merges into the array data an other array data. The two array datas must have the same number
                  * of components so the merge can be done
                  * @param other the array data to merge with
                  * @param prepend if true, the other array data is inserted at the beginning, otherwise it is
                  * inserted at the end
                  */
                 void add(const ArrayData<Dim> &other, bool prepend = false)
                 {
                     QWriteLocker locker{&m_Lock};
                     QReadLocker otherLocker{&other.m_Lock};
                     if (m_NbComponents != other.componentCount()) {
                         return;
                     }
                     if (prepend) {
                         auto otherDataSize = other.m_Data.size();
                         m_Data.insert(m_Data.begin(), otherDataSize, 0.);
                         for (auto i = 0; i < otherDataSize; ++i) {
                             m_Data.replace(i, other.m_Data.at(i));
                         }
                     }
                     else {
                         m_Data.append(other.m_Data);
                     }
                 }
                 void clear()
                 {
                     QWriteLocker locker{&m_Lock};
                     m_Data.clear();
                 }
                 int componentCount() const noexcept { return m_NbComponents; }
                 /// @return the size (i.e. number of values) of a single component
                 /// @remarks in a case of a two-dimensional ArrayData, each component has the same size
                 int size() const
                 {
                     QReadLocker locker{&m_Lock};
                     return m_Data.size() / m_NbComponents;
                 }
                 std::shared_ptr<ArrayData<Dim> > sort(const std::vector<int> &sortPermutation)
                 {
                     QReadLocker locker{&m_Lock};
                     return arraydata_detail::Sort<Dim>::sort(m_Data, m_NbComponents, sortPermutation);
                 }
                 // ///////// //
                 // Iterators //
                 // ///////// //
                 ArrayDataIterator cbegin() const
                 {
                     return ArrayDataIterator{ArrayDataIteratorValue{
                         std::make_unique<arraydata_detail::IteratorValue<Dim> >(m_Data, m_NbComponents, true)}};
                 }
                 ArrayDataIterator cend() const
                 {
                     return ArrayDataIterator{
                         ArrayDataIteratorValue{std::make_unique<arraydata_detail::IteratorValue<Dim> >(
                             m_Data, m_NbComponents, false)}};
                 }
+                /// Inserts at the end of the array data the values passed as a parameter. This
+                /// method is intended to be used in the context of generating a back insert iterator, or only
+                /// if it's ensured that the total size of the vector is consistent with the number of
+                /// components of the array data
+                /// @param values the values to insert
+                /// @sa http://en.cppreference.com/w/cpp/iterator/back_inserter
+                void push_back(const QVector<double> &values)
+                {
+                    Q_ASSERT(values.size() % m_NbComponents == 0);
+                    m_Data.append(values);
+                }
                 /**
                  * @return the data at a specified index
                  * @remarks index must be a valid position
                  */
                 double at(int index) const noexcept
                 {
                     QReadLocker locker{&m_Lock};
                     return m_Data.at(index);
                 }
                 // ///////////// //
                 // 1-dim methods //
                 // ///////////// //
                 /**
                  * @return the data as a vector, as a const reference
                  * @remarks this method is only available for a unidimensional ArrayData
                  */
                 template <int D = Dim, typename = std::enable_if_t<D == 1> >
                 const QVector<double> &cdata() const noexcept
                 {
                     QReadLocker locker{&m_Lock};
                     return m_Data;
                 }
             private:
                 DataContainer m_Data;
                 /// Number of components (lines). Is always 1 in a 1-dim ArrayData
                 int m_NbComponents;
                 mutable QReadWriteLock m_Lock;
             };
             #endif // SCIQLOP_ARRAYDATA_H

core/include/Data/DataSeries.h +20 0

             #ifndef SCIQLOP_DATASERIES_H
             #define SCIQLOP_DATASERIES_H
             #include "CoreGlobal.h"
             #include <Common/SortUtils.h>
             #include <Data/ArrayData.h>
             #include <Data/DataSeriesMergeHelper.h>
             #include <Data/IDataSeries.h>
             #include <QLoggingCategory>
             #include <QReadLocker>
             #include <QReadWriteLock>
             #include <memory>
             // We don't use the Qt macro since the log is used in the header file, which causes multiple log
             // definitions with inheritance. Inline method is used instead
             inline const QLoggingCategory &LOG_DataSeries()
             {
                 static const QLoggingCategory category{"DataSeries"};
                 return category;
             }
             template <int Dim>
             class DataSeries;
             namespace dataseries_detail {
             template <int Dim>
             class IteratorValue : public DataSeriesIteratorValue::Impl {
             public:
                 explicit IteratorValue(const DataSeries<Dim> &dataSeries, bool begin)
                         : m_XIt(begin ? dataSeries.xAxisData()->cbegin() : dataSeries.xAxisData()->cend()),
                           m_ValuesIt(begin ? dataSeries.valuesData()->cbegin()
                                            : dataSeries.valuesData()->cend())
                 {
                 }
                 IteratorValue(const IteratorValue &other) = default;
                 std::unique_ptr<DataSeriesIteratorValue::Impl> clone() const override
                 {
                     return std::make_unique<IteratorValue<Dim> >(*this);
                 }
                 bool equals(const DataSeriesIteratorValue::Impl &other) const override try {
                     const auto &otherImpl = dynamic_cast<const IteratorValue &>(other);
                     return std::tie(m_XIt, m_ValuesIt) == std::tie(otherImpl.m_XIt, otherImpl.m_ValuesIt);
                 }
                 catch (const std::bad_cast &) {
                     return false;
                 }
                 void next() override
                 {
                     ++m_XIt;
                     ++m_ValuesIt;
                 }
                 void prev() override
                 {
                     --m_XIt;
                     --m_ValuesIt;
                 }
                 double x() const override { return m_XIt->at(0); }
                 double value() const override { return m_ValuesIt->at(0); }
                 double value(int componentIndex) const override { return m_ValuesIt->at(componentIndex); }
                 double minValue() const override { return m_ValuesIt->min(); }
                 double maxValue() const override { return m_ValuesIt->max(); }
                 QVector<double> values() const override { return m_ValuesIt->values(); }
             private:
                 ArrayDataIterator m_XIt;
                 ArrayDataIterator m_ValuesIt;
             };
             } // namespace dataseries_detail
             /**
              * @brief The DataSeries class is the base (abstract) implementation of IDataSeries.
              *
              * It proposes to set a dimension for the values data.
              *
              * A DataSeries is always sorted on its x-axis data.
              *
              * @tparam Dim The dimension of the values data
              *
              */
             template <int Dim>
             class SCIQLOP_CORE_EXPORT DataSeries : public IDataSeries {
                 friend class DataSeriesMergeHelper;
             public:
+                /// Tag needed to define the push_back() method
+                /// @sa push_back()
+                using value_type = DataSeriesIteratorValue;
                 /// @sa IDataSeries::xAxisData()
                 std::shared_ptr<ArrayData<1> > xAxisData() override { return m_XAxisData; }
                 const std::shared_ptr<ArrayData<1> > xAxisData() const { return m_XAxisData; }
                 /// @sa IDataSeries::xAxisUnit()
                 Unit xAxisUnit() const override { return m_XAxisUnit; }
                 /// @return the values dataset
                 std::shared_ptr<ArrayData<Dim> > valuesData() { return m_ValuesData; }
                 const std::shared_ptr<ArrayData<Dim> > valuesData() const { return m_ValuesData; }
                 /// @sa IDataSeries::valuesUnit()
                 Unit valuesUnit() const override { return m_ValuesUnit; }
                 SqpRange range() const override
                 {
                     if (!m_XAxisData->cdata().isEmpty()) {
                         return SqpRange{m_XAxisData->cdata().first(), m_XAxisData->cdata().last()};
                     }
                     return SqpRange{};
                 }
                 void clear()
                 {
                     m_XAxisData->clear();
                     m_ValuesData->clear();
                 }
                 bool isEmpty() const noexcept { return m_XAxisData->size() == 0; }
                 /// Merges into the data series an other data series
                 /// @remarks the data series to merge with is cleared after the operation
                 void merge(IDataSeries *dataSeries) override
                 {
                     dataSeries->lockWrite();
                     lockWrite();
                     if (auto other = dynamic_cast<DataSeries<Dim> *>(dataSeries)) {
                         DataSeriesMergeHelper::merge(*other, *this);
                     }
                     else {
                         qCWarning(LOG_DataSeries())
                             << QObject::tr("Detection of a type of IDataSeries we cannot merge with !");
                     }
                     unlock();
                     dataSeries->unlock();
                 }
                 // ///////// //
                 // Iterators //
                 // ///////// //
                 DataSeriesIterator cbegin() const override
                 {
                     return DataSeriesIterator{DataSeriesIteratorValue{
                         std::make_unique<dataseries_detail::IteratorValue<Dim> >(*this, true)}};
                 }
                 DataSeriesIterator cend() const override
                 {
                     return DataSeriesIterator{DataSeriesIteratorValue{
                         std::make_unique<dataseries_detail::IteratorValue<Dim> >(*this, false)}};
                 }
                 /// @sa IDataSeries::minXAxisData()
                 DataSeriesIterator minXAxisData(double minXAxisData) const override
                 {
                     return std::lower_bound(
                         cbegin(), cend(), minXAxisData,
                         [](const auto &itValue, const auto &value) { return itValue.x() < value; });
                 }
                 /// @sa IDataSeries::maxXAxisData()
                 DataSeriesIterator maxXAxisData(double maxXAxisData) const override
                 {
                     // Gets the first element that greater than max value
                     auto it = std::upper_bound(
                         cbegin(), cend(), maxXAxisData,
                         [](const auto &value, const auto &itValue) { return value < itValue.x(); });
                     return it == cbegin() ? cend() : --it;
                 }
                 std::pair<DataSeriesIterator, DataSeriesIterator> xAxisRange(double minXAxisData,
                                                                              double maxXAxisData) const override
                 {
                     if (minXAxisData > maxXAxisData) {
                         std::swap(minXAxisData, maxXAxisData);
                     }
                     auto begin = cbegin();
                     auto end = cend();
                     auto lowerIt = std::lower_bound(
                         begin, end, minXAxisData,
                         [](const auto &itValue, const auto &value) { return itValue.x() < value; });
                     auto upperIt = std::upper_bound(
                         begin, end, maxXAxisData,
                         [](const auto &value, const auto &itValue) { return value < itValue.x(); });
                     return std::make_pair(lowerIt, upperIt);
                 }
                 std::pair<DataSeriesIterator, DataSeriesIterator>
                 valuesBounds(double minXAxisData, double maxXAxisData) const override
                 {
                     // Places iterators to the correct x-axis range
                     auto xAxisRangeIts = xAxisRange(minXAxisData, maxXAxisData);
                     // Returns end iterators if the range is empty
                     if (xAxisRangeIts.first == xAxisRangeIts.second) {
                         return std::make_pair(cend(), cend());
                     }
                     // Gets the iterator on the min of all values data
                     auto minIt = std::min_element(
                         xAxisRangeIts.first, xAxisRangeIts.second, [](const auto &it1, const auto &it2) {
                             return SortUtils::minCompareWithNaN(it1.minValue(), it2.minValue());
                         });
                     // Gets the iterator on the max of all values data
                     auto maxIt = std::max_element(
                         xAxisRangeIts.first, xAxisRangeIts.second, [](const auto &it1, const auto &it2) {
                             return SortUtils::maxCompareWithNaN(it1.maxValue(), it2.maxValue());
                         });
                     return std::make_pair(minIt, maxIt);
                 }
                 // /////// //
                 // Mutexes //
                 // /////// //
                 virtual void lockRead() { m_Lock.lockForRead(); }
                 virtual void lockWrite() { m_Lock.lockForWrite(); }
                 virtual void unlock() { m_Lock.unlock(); }
+                // ///// //
+                // Other //
+                // ///// //
+                /// Inserts at the end of the data series the value of the iterator passed as a parameter. This
+                /// method is intended to be used in the context of generating a back insert iterator
+                /// @param iteratorValue the iterator value containing the values to insert
+                /// @sa http://en.cppreference.com/w/cpp/iterator/back_inserter
+                /// @sa merge()
+                /// @sa value_type
+                void push_back(const value_type &iteratorValue)
+                {
+                    m_XAxisData->push_back(QVector<double>{iteratorValue.x()});
+                    m_ValuesData->push_back(iteratorValue.values());
+                }
             protected:
                 /// Protected ctor (DataSeries is abstract). The vectors must have the same size, otherwise a
                 /// DataSeries with no values will be created.
                 /// @remarks data series is automatically sorted on its x-axis data
                 explicit DataSeries(std::shared_ptr<ArrayData<1> > xAxisData, const Unit &xAxisUnit,
                                     std::shared_ptr<ArrayData<Dim> > valuesData, const Unit &valuesUnit)
                         : m_XAxisData{xAxisData},
                           m_XAxisUnit{xAxisUnit},
                           m_ValuesData{valuesData},
                           m_ValuesUnit{valuesUnit}
                 {
                     if (m_XAxisData->size() != m_ValuesData->size()) {
                         clear();
                     }
                     // Sorts data if it's not the case
                     const auto &xAxisCData = m_XAxisData->cdata();
                     if (!std::is_sorted(xAxisCData.cbegin(), xAxisCData.cend())) {
                         sort();
                     }
                 }
                 /// Copy ctor
                 explicit DataSeries(const DataSeries<Dim> &other)
                         : m_XAxisData{std::make_shared<ArrayData<1> >(*other.m_XAxisData)},
                           m_XAxisUnit{other.m_XAxisUnit},
                           m_ValuesData{std::make_shared<ArrayData<Dim> >(*other.m_ValuesData)},
                           m_ValuesUnit{other.m_ValuesUnit}
                 {
                     // Since a series is ordered from its construction and is always ordered, it is not
                     // necessary to call the sort method here ('other' is sorted)
                 }
                 /// Assignment operator
                 template <int D>
                 DataSeries &operator=(DataSeries<D> other)
                 {
                     std::swap(m_XAxisData, other.m_XAxisData);
                     std::swap(m_XAxisUnit, other.m_XAxisUnit);
                     std::swap(m_ValuesData, other.m_ValuesData);
                     std::swap(m_ValuesUnit, other.m_ValuesUnit);
                     return *this;
                 }
             private:
                 /**
                  * Sorts data series on its x-axis data
                  */
                 void sort() noexcept
                 {
                     auto permutation = SortUtils::sortPermutation(*m_XAxisData, std::less<double>());
                     m_XAxisData = m_XAxisData->sort(permutation);
                     m_ValuesData = m_ValuesData->sort(permutation);
                 }
                 std::shared_ptr<ArrayData<1> > m_XAxisData;
                 Unit m_XAxisUnit;
                 std::shared_ptr<ArrayData<Dim> > m_ValuesData;
                 Unit m_ValuesUnit;
                 QReadWriteLock m_Lock;
             };
             #endif // SCIQLOP_DATASERIES_H

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages