#ifndef SCIQLOP_DATASERIES_H #define SCIQLOP_DATASERIES_H #include "CoreGlobal.h" #include #include #include #include #include #include #include // 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 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::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 > xAxisData() override { return m_XAxisData; } const std::shared_ptr > xAxisData() const { return m_XAxisData; } /// @sa IDataSeries::xAxisUnit() Unit xAxisUnit() const override { return m_XAxisUnit; } /// @return the values dataset std::shared_ptr > valuesData() { return m_ValuesData; } const std::shared_ptr > 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)) { 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 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; }); auto upperIt = std::upper_bound(begin, end, max, [](const auto &value, const auto &itValue) { return itValue.x() == value; }); 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 > xAxisData, const Unit &xAxisUnit, std::shared_ptr > 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 &other) : m_XAxisData{std::make_shared >(*other.m_XAxisData)}, m_XAxisUnit{other.m_XAxisUnit}, m_ValuesData{std::make_shared >(*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 DataSeries &operator=(DataSeries 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()); m_XAxisData = m_XAxisData->sort(permutation); m_ValuesData = m_ValuesData->sort(permutation); } std::shared_ptr > m_XAxisData; Unit m_XAxisUnit; std::shared_ptr > m_ValuesData; Unit m_ValuesUnit; QReadWriteLock m_Lock; }; #endif // SCIQLOP_DATASERIES_H