HG_REPOSITORIES/LPP/SciQLOP_Repos/SciQLop Files · core/include/Data/ArrayData.h

Makes clear() and size() methods compatible with two-dimensional ArrayData

Alexandre Leroux - - Load All Authors

File last commit:

r502:49305aa35689


                r502:49305aa35689

Download file

             ArrayData.h
        
                    189 lines
            
             | 5.9 KiB
            
                | text/x-c
            
             |
                CLexer
            
             / core / include / Data / ArrayData.h
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Alexandre Leroux
    
Creates ArrayData (struct that holds data as a vector of double)

              r124
            
      #ifndef SCIQLOP_ARRAYDATA_H

      #define SCIQLOP_ARRAYDATA_H

        perrinel
    
Add current progression for thread fix

              r364
            
      #include <QReadLocker>

      #include <QReadWriteLock>

        Alexandre Leroux
    
Creates ArrayData (struct that holds data as a vector of double)

              r124
            
      #include <QVector>

        Alexandre Leroux
    
Makes a Data series be sorted (2)...

              r450
            
      #include <memory>

        Alexandre Leroux
    
Creates ArrayData (struct that holds data as a vector of double)

              r124
            
      /**

       * @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

        Alexandre Leroux
    
Creates ctor for two-dimensional ArrayData

              r501
            
       * template-parameter. In a case of a two-dimensional dataset, each dataset component has the same

       * number of values

        Alexandre Leroux
    
Creates ArrayData (struct that holds data as a vector of double)

              r124
            
       *

       * @tparam Dim the dimension of the ArrayData (one or two)

       * @sa IDataSeries

       */

      template <int Dim>

      class ArrayData {

      public:

        Alexandre Leroux
    
Creates constructor for ScalarSeries that directly takes vectors...

              r392
            
          /**

           * 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(QVector<double> data) : m_Data{1, QVector<double>{}}

          {

              m_Data[0] = std::move(data);

          }

        Alexandre Leroux
    
Creates ctor for two-dimensional ArrayData

              r501
            
          /**

           * Ctor for a two-dimensional ArrayData. The number of components (number of vectors) must be

           * greater than 2 and each component must have the same number of values

           * @param data the data the ArrayData will hold

           * @throws std::invalid_argument if the number of components is less than 2

           * @remarks if the number of values is not the same for each component, no value is set

           */

          template <int D = Dim, typename = std::enable_if_t<D == 2> >

          explicit ArrayData(QVector<QVector<double> > data)

          {

              auto nbComponents = data.size();

              if (nbComponents < 2) {

                  throw std::invalid_argument{

                      QString{"A multidimensional ArrayData must have at least 2 components (found: %1"}

                          .arg(data.size())

                          .toStdString()};

              }

              auto nbValues = data.front().size();

              if (std::all_of(data.cbegin(), data.cend(), [nbValues](const auto &component) {

                      return component.size() == nbValues;

                  })) {

                  m_Data = std::move(data);

              }

              else {

                  m_Data = QVector<QVector<double> >{nbComponents, QVector<double>{}};

              }

          }

        Alexandre Leroux
    
Review fixes

              r372
            
          /// Copy ctor

        perrinel
    
Add current progression for thread fix

              r364
            
          explicit ArrayData(const ArrayData &other)

          {

        Alexandre Leroux
    
Review fixes

              r372
            
              QReadLocker otherLocker{&other.m_Lock};

        perrinel
    
Add current progression for thread fix

              r364
            
              m_Data = other.m_Data;

          }

        Alexandre Leroux
    
Makes a Data series be sorted (2)...

              r450
            
          /**

           * @return the data at a specified index

           * @remarks index must be a valid position

           * @remarks this method is only available for a unidimensional ArrayData

           */

          template <int D = Dim, typename = std::enable_if_t<D == 1> >

          double at(int index) const noexcept

          {

              QReadLocker locker{&m_Lock};

              return m_Data[0].at(index);

          }

        Alexandre Leroux
    
Creates ArrayData (struct that holds data as a vector of double)

              r124
            
          /**

           * Sets a data at a specified index. The index has to be valid to be effective

           * @param index the index to which the data will be set

           * @param data the data to set

           * @remarks this method is only available for a unidimensional ArrayData

           */

          template <int D = Dim, typename = std::enable_if_t<D == 1> >

          void setData(int index, double data) noexcept

          {

        Alexandre Leroux
    
Review fixes

              r372
            
              QWriteLocker locker{&m_Lock};

        Alexandre Leroux
    
Creates ArrayData (struct that holds data as a vector of double)

              r124
            
              if (index >= 0 && index < m_Data.at(0).size()) {

                  m_Data[0].replace(index, data);

              }

          }

          /**

           * @return the data as a vector

           * @remarks this method is only available for a unidimensional ArrayData

           */

          template <int D = Dim, typename = std::enable_if_t<D == 1> >

        perrinel
    
Add current progression for thread fix

              r364
            
          QVector<double> data() const noexcept

        Alexandre Leroux
    
Creates ArrayData (struct that holds data as a vector of double)

              r124
            
          {

        Alexandre Leroux
    
Review fixes

              r372
            
              QReadLocker locker{&m_Lock};

        perrinel
    
Update ArrayData to make it better

              r294
            
              return m_Data[0];

        Alexandre Leroux
    
Creates ArrayData (struct that holds data as a vector of double)

              r124
            
          }

        perrinel
    
Add merge API and implement it for the DataSeries

              r233
            
          /**

        Alexandre Leroux
    
Makes a Data series be sorted (1)

              r449
            
           * @return the data as a vector, as a const reference

        perrinel
    
Add merge API and implement it for the DataSeries

              r233
            
           * @remarks this method is only available for a unidimensional ArrayData

           */

          template <int D = Dim, typename = std::enable_if_t<D == 1> >

        Alexandre Leroux
    
Makes a Data series be sorted (1)

              r449
            
          const QVector<double> &cdata() const noexcept

        perrinel
    
Add merge API and implement it for the DataSeries

              r233
            
          {

        Alexandre Leroux
    
Review fixes

              r372
            
              QReadLocker locker{&m_Lock};

        Alexandre Leroux
    
Makes a Data series be sorted (1)

              r449
            
              return m_Data.at(0);

        perrinel
    
Add merge API and implement it for the DataSeries

              r233
            
          }

        Alexandre Leroux
    
Handles merge of two data series

              r451
            
          /**

           * Merges into the array data an other array data

           * @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

           * @remarks this method is only available for a unidimensional ArrayData

           */

        perrinel
    
Add merge API and implement it for the DataSeries

              r233
            
          template <int D = Dim, typename = std::enable_if_t<D == 1> >

        Alexandre Leroux
    
Handles merge of two data series

              r451
            
          void add(const ArrayData<1> &other, bool prepend = false)

        perrinel
    
Add merge API and implement it for the DataSeries

              r233
            
          {

        Alexandre Leroux
    
Review fixes

              r372
            
              QWriteLocker locker{&m_Lock};

        perrinel
    
Add merge API and implement it for the DataSeries

              r233
            
              if (!m_Data.empty()) {

        Alexandre Leroux
    
Handles merge of two data series

              r451
            
                  QReadLocker otherLocker{&other.m_Lock};

                  if (prepend) {

                      const auto &otherData = other.data();

                      const auto otherDataSize = otherData.size();

                      auto &data = m_Data[0];

                      data.insert(data.begin(), otherDataSize, 0.);

                      for (auto i = 0; i < otherDataSize; ++i) {

                          data.replace(i, otherData.at(i));

                      }

                  }

                  else {

                      m_Data[0] += other.data();

                  }

        perrinel
    
Add merge API and implement it for the DataSeries

              r233
            
              }

          }

        Alexandre Leroux
    
Makes clear() and size() methods compatible with two-dimensional ArrayData

              r502
            
          /// @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

        perrinel
    
Add current progression for thread fix

              r364
            
          int size() const

        perrinel
    
Add merge API and implement it for the DataSeries

              r233
            
          {

        Alexandre Leroux
    
Review fixes

              r372
            
              QReadLocker locker{&m_Lock};

        perrinel
    
Add merge API and implement it for the DataSeries

              r233
            
              return m_Data[0].size();

          }

        Alexandre Leroux
    
Makes a Data series be sorted (2)...

              r450
            
          template <int D = Dim, typename = std::enable_if_t<D == 1> >

          std::shared_ptr<ArrayData<Dim> > sort(const std::vector<int> sortPermutation)

          {

              QReadLocker locker{&m_Lock};

              const auto &data = m_Data.at(0);

              // Inits result

              auto sortedData = QVector<double>{};

              sortedData.resize(data.size());

              std::transform(sortPermutation.cbegin(), sortPermutation.cend(), sortedData.begin(),

                             [&data](int i) { return data[i]; });

              return std::make_shared<ArrayData<Dim> >(std::move(sortedData));

          }

        Alexandre Leroux
    
Correction on ArrayData::clear() method

              r454
            
        perrinel
    
Add current progression for thread fix

              r364
            
          void clear()

          {

        Alexandre Leroux
    
Review fixes

              r372
            
              QWriteLocker locker{&m_Lock};

        perrinel
    
Add current progression for thread fix

              r364
            
        Alexandre Leroux
    
Makes clear() and size() methods compatible with two-dimensional ArrayData

              r502
            
              auto nbComponents = m_Data.size();

              for (auto i = 0; i < nbComponents; ++i) {

                  m_Data[i].clear();

              }

          }

        perrinel
    
Add merge API and implement it for the DataSeries

              r233
            
        Alexandre Leroux
    
Creates ArrayData (struct that holds data as a vector of double)

              r124
            
      private:

          QVector<QVector<double> > m_Data;

        perrinel
    
Add current progression for thread fix

              r364
            
          mutable QReadWriteLock m_Lock;

        Alexandre Leroux
    
Creates ArrayData (struct that holds data as a vector of double)

              r124
            
      };

      #endif // SCIQLOP_ARRAYDATA_H

	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

Alexandre Leroux Creates ArrayData (struct that holds data as a vector of double)	r124	#ifndef SCIQLOP_ARRAYDATA_H
		#define SCIQLOP_ARRAYDATA_H

perrinel Add current progression for thread fix	r364	#include <QReadLocker>
		#include <QReadWriteLock>
Alexandre Leroux Creates ArrayData (struct that holds data as a vector of double)	r124	#include <QVector>
Alexandre Leroux Makes a Data series be sorted (2)...	r450
		#include <memory>

Alexandre Leroux Creates ArrayData (struct that holds data as a vector of double)	r124	/**
		* @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
Alexandre Leroux Creates ctor for two-dimensional ArrayData	r501	* template-parameter. In a case of a two-dimensional dataset, each dataset component has the same
		* number of values
Alexandre Leroux Creates ArrayData (struct that holds data as a vector of double)	r124	*
		* @tparam Dim the dimension of the ArrayData (one or two)
		* @sa IDataSeries
		*/
		template <int Dim>
		class ArrayData {
		public:
Alexandre Leroux Creates constructor for ScalarSeries that directly takes vectors...	r392	/**
		* 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(QVector<double> data) : m_Data{1, QVector<double>{}}
		{
		m_Data[0] = std::move(data);
		}

Alexandre Leroux Creates ctor for two-dimensional ArrayData	r501	/**
		* Ctor for a two-dimensional ArrayData. The number of components (number of vectors) must be
		* greater than 2 and each component must have the same number of values
		* @param data the data the ArrayData will hold
		* @throws std::invalid_argument if the number of components is less than 2
		* @remarks if the number of values is not the same for each component, no value is set
		*/
		template <int D = Dim, typename = std::enable_if_t<D == 2> >
		explicit ArrayData(QVector<QVector<double> > data)
		{
		auto nbComponents = data.size();
		if (nbComponents < 2) {
		throw std::invalid_argument{
		QString{"A multidimensional ArrayData must have at least 2 components (found: %1"}
		.arg(data.size())
		.toStdString()};
		}

		auto nbValues = data.front().size();
		if (std::all_of(data.cbegin(), data.cend(), [nbValues](const auto &component) {
		return component.size() == nbValues;
		})) {
		m_Data = std::move(data);
		}
		else {
		m_Data = QVector<QVector<double> >{nbComponents, QVector<double>{}};
		}
		}

Alexandre Leroux Review fixes	r372	/// Copy ctor
perrinel Add current progression for thread fix	r364	explicit ArrayData(const ArrayData &other)
		{
Alexandre Leroux Review fixes	r372	QReadLocker otherLocker{&other.m_Lock};
perrinel Add current progression for thread fix	r364	m_Data = other.m_Data;
		}

Alexandre Leroux Makes a Data series be sorted (2)...	r450	/**
		* @return the data at a specified index
		* @remarks index must be a valid position
		* @remarks this method is only available for a unidimensional ArrayData
		*/
		template <int D = Dim, typename = std::enable_if_t<D == 1> >
		double at(int index) const noexcept
		{
		QReadLocker locker{&m_Lock};
		return m_Data[0].at(index);
		}

Alexandre Leroux Creates ArrayData (struct that holds data as a vector of double)	r124	/**
		* Sets a data at a specified index. The index has to be valid to be effective
		* @param index the index to which the data will be set
		* @param data the data to set
		* @remarks this method is only available for a unidimensional ArrayData
		*/
		template <int D = Dim, typename = std::enable_if_t<D == 1> >
		void setData(int index, double data) noexcept
		{
Alexandre Leroux Review fixes	r372	QWriteLocker locker{&m_Lock};
Alexandre Leroux Creates ArrayData (struct that holds data as a vector of double)	r124	if (index >= 0 && index < m_Data.at(0).size()) {
		m_Data[0].replace(index, data);
		}
		}

		/**
		* @return the data as a vector
		* @remarks this method is only available for a unidimensional ArrayData
		*/
		template <int D = Dim, typename = std::enable_if_t<D == 1> >
perrinel Add current progression for thread fix	r364	QVector<double> data() const noexcept
Alexandre Leroux Creates ArrayData (struct that holds data as a vector of double)	r124	{
Alexandre Leroux Review fixes	r372	QReadLocker locker{&m_Lock};
perrinel Update ArrayData to make it better	r294	return m_Data[0];
Alexandre Leroux Creates ArrayData (struct that holds data as a vector of double)	r124	}

perrinel Add merge API and implement it for the DataSeries	r233	/**
Alexandre Leroux Makes a Data series be sorted (1)	r449	* @return the data as a vector, as a const reference
perrinel Add merge API and implement it for the DataSeries	r233	* @remarks this method is only available for a unidimensional ArrayData
		*/
		template <int D = Dim, typename = std::enable_if_t<D == 1> >
Alexandre Leroux Makes a Data series be sorted (1)	r449	const QVector<double> &cdata() const noexcept
perrinel Add merge API and implement it for the DataSeries	r233	{
Alexandre Leroux Review fixes	r372	QReadLocker locker{&m_Lock};
Alexandre Leroux Makes a Data series be sorted (1)	r449	return m_Data.at(0);
perrinel Add merge API and implement it for the DataSeries	r233	}

Alexandre Leroux Handles merge of two data series	r451	/**
		* Merges into the array data an other array data
		* @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
		* @remarks this method is only available for a unidimensional ArrayData
		*/
perrinel Add merge API and implement it for the DataSeries	r233	template <int D = Dim, typename = std::enable_if_t<D == 1> >
Alexandre Leroux Handles merge of two data series	r451	void add(const ArrayData<1> &other, bool prepend = false)
perrinel Add merge API and implement it for the DataSeries	r233	{
Alexandre Leroux Review fixes	r372	QWriteLocker locker{&m_Lock};
perrinel Add merge API and implement it for the DataSeries	r233	if (!m_Data.empty()) {
Alexandre Leroux Handles merge of two data series	r451	QReadLocker otherLocker{&other.m_Lock};

		if (prepend) {
		const auto &otherData = other.data();
		const auto otherDataSize = otherData.size();

		auto &data = m_Data[0];
		data.insert(data.begin(), otherDataSize, 0.);

		for (auto i = 0; i < otherDataSize; ++i) {
		data.replace(i, otherData.at(i));
		}
		}
		else {
		m_Data[0] += other.data();
		}
perrinel Add merge API and implement it for the DataSeries	r233	}
		}

Alexandre Leroux Makes clear() and size() methods compatible with two-dimensional ArrayData	r502	/// @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
perrinel Add current progression for thread fix	r364	int size() const
perrinel Add merge API and implement it for the DataSeries	r233	{
Alexandre Leroux Review fixes	r372	QReadLocker locker{&m_Lock};
perrinel Add merge API and implement it for the DataSeries	r233	return m_Data[0].size();
		}

Alexandre Leroux Makes a Data series be sorted (2)...	r450	template <int D = Dim, typename = std::enable_if_t<D == 1> >
		std::shared_ptr<ArrayData<Dim> > sort(const std::vector<int> sortPermutation)
		{
		QReadLocker locker{&m_Lock};

		const auto &data = m_Data.at(0);

		// Inits result
		auto sortedData = QVector<double>{};
		sortedData.resize(data.size());

		std::transform(sortPermutation.cbegin(), sortPermutation.cend(), sortedData.begin(),
		[&data](int i) { return data[i]; });

		return std::make_shared<ArrayData<Dim> >(std::move(sortedData));
		}
Alexandre Leroux Correction on ArrayData::clear() method	r454
perrinel Add current progression for thread fix	r364	void clear()
		{
Alexandre Leroux Review fixes	r372	QWriteLocker locker{&m_Lock};
perrinel Add current progression for thread fix	r364
Alexandre Leroux Makes clear() and size() methods compatible with two-dimensional ArrayData	r502	auto nbComponents = m_Data.size();
		for (auto i = 0; i < nbComponents; ++i) {
		m_Data[i].clear();
		}
		}
perrinel Add merge API and implement it for the DataSeries	r233
Alexandre Leroux Creates ArrayData (struct that holds data as a vector of double)	r124	private:
		QVector<QVector<double> > m_Data;
perrinel Add current progression for thread fix	r364	mutable QReadWriteLock m_Lock;
Alexandre Leroux Creates ArrayData (struct that holds data as a vector of double)	r124	};

		#endif // SCIQLOP_ARRAYDATA_H