HG_REPOSITORIES/LPP/SciQLOP_Repos/SciQLop Commit - r586:70ca5d366d01

Fixes subData() method and adds unit tests

Alexandre Leroux -

r586:70ca5d366d01

parent child

Context file:

r586:70ca5d366d01

Collapse all files

core/include/Data/DataSeries.h +2 -2

             #ifndef SCIQLOP_DATASERIES_H
             #define SCIQLOP_DATASERIES_H
             #include "CoreGlobal.h"
             #include <Common/SortUtils.h>
             #include <Data/ArrayData.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;
             }
             /**
              * @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 {
             public:
                 class IteratorValue {
                 public:
                     explicit IteratorValue(const DataSeries &dataSeries, bool begin)
                             : m_XIt(begin ? dataSeries.xAxisData()->cbegin() : dataSeries.xAxisData()->cend()),
                               m_ValuesIt(begin ? dataSeries.valuesData()->cbegin()
                                                : dataSeries.valuesData()->cend())
                     {
                     }
                     double x() const { return m_XIt->at(0); }
                     double value() const { return m_ValuesIt->at(0); }
                     double value(int componentIndex) const { return m_ValuesIt->at(componentIndex); }
                     void next()
                     {
                         ++m_XIt;
                         ++m_ValuesIt;
                     }
                     bool operator==(const IteratorValue &other) const
                     {
                         return std::tie(m_XIt, m_ValuesIt) == std::tie(other.m_XIt, other.m_ValuesIt);
                     }
                 private:
                     ArrayData<1>::Iterator m_XIt;
                     typename ArrayData<Dim>::Iterator m_ValuesIt;
                 };
                 class Iterator {
                 public:
                     using iterator_category = std::forward_iterator_tag;
                     using value_type = const IteratorValue;
                     using difference_type = std::ptrdiff_t;
                     using pointer = value_type *;
                     using reference = value_type &;
                     Iterator(const DataSeries &dataSeries, bool begin) : m_CurrentValue{dataSeries, begin} {}
                     virtual ~Iterator() noexcept = default;
                     Iterator(const Iterator &) = default;
                     Iterator(Iterator &&) = default;
                     Iterator &operator=(const Iterator &) = default;
                     Iterator &operator=(Iterator &&) = default;
                     Iterator &operator++()
                     {
                         m_CurrentValue.next();
                         return *this;
                     }
                     pointer operator->() const { return &m_CurrentValue; }
                     reference operator*() const { return m_CurrentValue; }
                     bool operator==(const Iterator &other) const
                     {
                         return m_CurrentValue == other.m_CurrentValue;
                     }
                     bool operator!=(const Iterator &other) const { return !(*this == other); }
                 private:
                     IteratorValue m_CurrentValue;
                 };
                 /// @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();
                 }
                 /// 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)) {
                         const auto &otherXAxisData = other->xAxisData()->cdata();
                         const auto &xAxisData = m_XAxisData->cdata();
                         // As data series are sorted, we can improve performances of merge, by call the sort
                         // method only if the two data series overlap.
                         if (!otherXAxisData.empty()) {
                             auto firstValue = otherXAxisData.front();
                             auto lastValue = otherXAxisData.back();
                             auto xAxisDataBegin = xAxisData.cbegin();
                             auto xAxisDataEnd = xAxisData.cend();
                             bool prepend;
                             bool sortNeeded;
                             if (std::lower_bound(xAxisDataBegin, xAxisDataEnd, firstValue) == xAxisDataEnd) {
                                 // Other data series if after data series
                                 prepend = false;
                                 sortNeeded = false;
                             }
                             else if (std::upper_bound(xAxisDataBegin, xAxisDataEnd, lastValue)
                                      == xAxisDataBegin) {
                                 // Other data series if before data series
                                 prepend = true;
                                 sortNeeded = false;
                             }
                             else {
                                 // The two data series overlap
                                 prepend = false;
                                 sortNeeded = true;
                             }
                             // Makes the merge
                             m_XAxisData->add(*other->xAxisData(), prepend);
                             m_ValuesData->add(*other->valuesData(), prepend);
                             if (sortNeeded) {
                                 sort();
                             }
                         }
                         // Clears the other data series
                         other->clear();
                     }
                     else {
                         qCWarning(LOG_DataSeries())
                             << QObject::tr("Detection of a type of IDataSeries we cannot merge with !");
                     }
                     unlock();
                     dataSeries->unlock();
                 }
                 // ///////// //
                 // Iterators //
                 // ///////// //
                 Iterator cbegin() const { return Iterator{*this, true}; }
                 Iterator cend() const { return Iterator{*this, false}; }
                 std::pair<Iterator, Iterator> subData(double min, double max) const
                 {
                     if (min > max) {
                         std::swap(min, max);
                     }
                     auto begin = cbegin();
                     auto end = cend();
                     auto lowerIt
                         = std::lower_bound(begin, end, min, [](const auto &itValue, const auto &value) {
-                              return itValue.x() == value;
+                              return itValue.x() < value;
                           });
                     auto upperIt
                         = std::upper_bound(begin, end, max, [](const auto &value, const auto &itValue) {
-                              return itValue.x() == value;
+                              return value < itValue.x();
                           });
                     return std::make_pair(lowerIt, upperIt);
                 }
                 // /////// //
                 // Mutexes //
                 // /////// //
                 virtual void lockRead() { m_Lock.lockForRead(); }
                 virtual void lockWrite() { m_Lock.lockForWrite(); }
                 virtual void unlock() { m_Lock.unlock(); }
             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

core/tests/Data/TestDataSeries.cpp +68 0

             #include "Data/DataSeries.h"
             #include "Data/ScalarSeries.h"
             #include <QObject>
             #include <QtTest>
             Q_DECLARE_METATYPE(std::shared_ptr<ScalarSeries>)
             class TestDataSeries : public QObject {
                 Q_OBJECT
             private slots:
                 /// Input test data
                 /// @sa testCtor()
                 void testCtor_data();
                 /// Tests construction of a data series
                 void testCtor();
                 /// Input test data
                 /// @sa testMerge()
                 void testMerge_data();
                 /// Tests merge of two data series
                 void testMerge();
+                /// Input test data
+                /// @sa testSubdata()
+                void testSubdata_data();
+                /// Tests get subdata of two data series
+                void testSubdata();
             };
             void TestDataSeries::testCtor_data()
             {
                 // ////////////// //
                 // Test structure //
                 // ////////////// //
                 // x-axis data
                 QTest::addColumn<QVector<double> >("xAxisData");
                 // values data
                 QTest::addColumn<QVector<double> >("valuesData");
                 // expected x-axis data
                 QTest::addColumn<QVector<double> >("expectedXAxisData");
                 // expected values data
                 QTest::addColumn<QVector<double> >("expectedValuesData");
                 // ////////// //
                 // Test cases //
                 // ////////// //
                 QTest::newRow("invalidData (different sizes of vectors)")
                     << QVector<double>{1., 2., 3., 4., 5.} << QVector<double>{100., 200., 300.}
                     << QVector<double>{} << QVector<double>{};
                 QTest::newRow("sortedData") << QVector<double>{1., 2., 3., 4., 5.}
                                             << QVector<double>{100., 200., 300., 400., 500.}
                                             << QVector<double>{1., 2., 3., 4., 5.}
                                             << QVector<double>{100., 200., 300., 400., 500.};
                 QTest::newRow("unsortedData") << QVector<double>{5., 4., 3., 2., 1.}
                                               << QVector<double>{100., 200., 300., 400., 500.}
                                               << QVector<double>{1., 2., 3., 4., 5.}
                                               << QVector<double>{500., 400., 300., 200., 100.};
                 QTest::newRow("unsortedData2")
                     << QVector<double>{1., 4., 3., 5., 2.} << QVector<double>{100., 200., 300., 400., 500.}
                     << QVector<double>{1., 2., 3., 4., 5.} << QVector<double>{100., 500., 300., 200., 400.};
             }
             void TestDataSeries::testCtor()
             {
                 // Creates series
                 QFETCH(QVector<double>, xAxisData);
                 QFETCH(QVector<double>, valuesData);
                 auto series = std::make_shared<ScalarSeries>(std::move(xAxisData), std::move(valuesData),
                                                              Unit{}, Unit{});
                 // Validates results : we check that the data series is sorted on its x-axis data
                 QFETCH(QVector<double>, expectedXAxisData);
                 QFETCH(QVector<double>, expectedValuesData);
                 auto seriesXAxisData = series->xAxisData()->data();
                 auto seriesValuesData = series->valuesData()->data();
                 QVERIFY(
                     std::equal(expectedXAxisData.cbegin(), expectedXAxisData.cend(), seriesXAxisData.cbegin()));
                 QVERIFY(std::equal(expectedValuesData.cbegin(), expectedValuesData.cend(),
                                    seriesValuesData.cbegin()));
             }
             namespace {
             std::shared_ptr<ScalarSeries> createSeries(QVector<double> xAxisData, QVector<double> valuesData)
             {
                 return std::make_shared<ScalarSeries>(std::move(xAxisData), std::move(valuesData), Unit{},
                                                       Unit{});
             }
             } // namespace
             void TestDataSeries::testMerge_data()
             {
                 // ////////////// //
                 // Test structure //
                 // ////////////// //
                 // Data series to merge
                 QTest::addColumn<std::shared_ptr<ScalarSeries> >("dataSeries");
                 QTest::addColumn<std::shared_ptr<ScalarSeries> >("dataSeries2");
                 // Expected values in the first data series after merge
                 QTest::addColumn<QVector<double> >("expectedXAxisData");
                 QTest::addColumn<QVector<double> >("expectedValuesData");
                 // ////////// //
                 // Test cases //
                 // ////////// //
                 QTest::newRow("sortedMerge")
                     << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
                     << createSeries({6., 7., 8., 9., 10.}, {600., 700., 800., 900., 1000.})
                     << QVector<double>{1., 2., 3., 4., 5., 6., 7., 8., 9., 10.}
                     << QVector<double>{100., 200., 300., 400., 500., 600., 700., 800., 900., 1000.};
                 QTest::newRow("unsortedMerge")
                     << createSeries({6., 7., 8., 9., 10.}, {600., 700., 800., 900., 1000.})
                     << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
                     << QVector<double>{1., 2., 3., 4., 5., 6., 7., 8., 9., 10.}
                     << QVector<double>{100., 200., 300., 400., 500., 600., 700., 800., 900., 1000.};
                 QTest::newRow("unsortedMerge2")
                     << createSeries({1., 2., 8., 9., 10}, {100., 200., 300., 400., 500.})
                     << createSeries({3., 4., 5., 6., 7.}, {600., 700., 800., 900., 1000.})
                     << QVector<double>{1., 2., 3., 4., 5., 6., 7., 8., 9., 10.}
                     << QVector<double>{100., 200., 600., 700., 800., 900., 1000., 300., 400., 500.};
                 QTest::newRow("unsortedMerge3")
                     << createSeries({3., 5., 8., 7., 2}, {100., 200., 300., 400., 500.})
                     << createSeries({6., 4., 9., 10., 1.}, {600., 700., 800., 900., 1000.})
                     << QVector<double>{1., 2., 3., 4., 5., 6., 7., 8., 9., 10.}
                     << QVector<double>{1000., 500., 100., 700., 200., 600., 400., 300., 800., 900.};
             }
             void TestDataSeries::testMerge()
             {
                 // Merges series
                 QFETCH(std::shared_ptr<ScalarSeries>, dataSeries);
                 QFETCH(std::shared_ptr<ScalarSeries>, dataSeries2);
                 dataSeries->merge(dataSeries2.get());
                 // Validates results : we check that the merge is valid and the data series is sorted on its
                 // x-axis data
                 QFETCH(QVector<double>, expectedXAxisData);
                 QFETCH(QVector<double>, expectedValuesData);
                 auto seriesXAxisData = dataSeries->xAxisData()->data();
                 auto seriesValuesData = dataSeries->valuesData()->data();
                 QVERIFY(
                     std::equal(expectedXAxisData.cbegin(), expectedXAxisData.cend(), seriesXAxisData.cbegin()));
                 QVERIFY(std::equal(expectedValuesData.cbegin(), expectedValuesData.cend(),
                                    seriesValuesData.cbegin()));
             }
+            void TestDataSeries::testSubdata_data()
+            {
+                // ////////////// //
+                // Test structure //
+                // ////////////// //
+                // Data series to get subdata
+                QTest::addColumn<std::shared_ptr<ScalarSeries> >("dataSeries");
+                // Min/max values
+                QTest::addColumn<double>("min");
+                QTest::addColumn<double>("max");
+                // Expected values after subdata
+                QTest::addColumn<QVector<double> >("expectedXAxisData");
+                QTest::addColumn<QVector<double> >("expectedValuesData");
+                // ////////// //
+                // Test cases //
+                // ////////// //
+                QTest::newRow("subData1") << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
+                                          << -1. << 3.2 << QVector<double>{1., 2., 3.}
+                                          << QVector<double>{100., 200., 300.};
+                QTest::newRow("subData2") << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
+                                          << 1. << 4. << QVector<double>{1., 2., 3., 4.}
+                                          << QVector<double>{100., 200., 300., 400.};
+                QTest::newRow("subData3") << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
+                                          << 1. << 3.9 << QVector<double>{1., 2., 3.}
+                                          << QVector<double>{100., 200., 300.};
+                QTest::newRow("subData4") << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
+                                          << 0. << 0.9 << QVector<double>{} << QVector<double>{};
+                QTest::newRow("subData5") << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
+                                          << 0. << 1. << QVector<double>{1.} << QVector<double>{100.};
+                QTest::newRow("subData6") << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
+                                          << 2.1 << 6. << QVector<double>{3., 4., 5.}
+                                          << QVector<double>{300., 400., 500.};
+                QTest::newRow("subData7") << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
+                                          << 6. << 9. << QVector<double>{} << QVector<double>{};
+                QTest::newRow("subData8") << createSeries({1., 2., 3., 4., 5.}, {100., 200., 300., 400., 500.})
+                                          << 5. << 9. << QVector<double>{5.} << QVector<double>{500.};
+            }
+            void TestDataSeries::testSubdata()
+            {
+                QFETCH(std::shared_ptr<ScalarSeries>, dataSeries);
+                QFETCH(double, min);
+                QFETCH(double, max);
+                QFETCH(QVector<double>, expectedXAxisData);
+                QFETCH(QVector<double>, expectedValuesData);
+                auto bounds = dataSeries->subData(min, max);
+                QVERIFY(std::equal(bounds.first, bounds.second, expectedXAxisData.cbegin(),
+                                   expectedXAxisData.cend(),
+                                   [](const auto &it, const auto &expectedX) { return it.x() == expectedX; }));
+                QVERIFY(std::equal(
+                    bounds.first, bounds.second, expectedValuesData.cbegin(), expectedValuesData.cend(),
+                    [](const auto &it, const auto &expectedVal) { return it.value() == expectedVal; }));
+            }
             QTEST_MAIN(TestDataSeries)
             #include "TestDataSeries.moc"

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