Array1D.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-or-later
/***********************************************************************************/
/*  Copyright 2009 WSL Institute for Snow and Avalanche Research    SLF-DAVOS      */
/***********************************************************************************/
/* This file is part of MeteoIO.
    MeteoIO is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    MeteoIO is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.
 
    You should have received a copy of the GNU Lesser General Public License
    along with MeteoIO.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef ARRAY1D_H
#define ARRAY1D_H
 
#include <vector>
#include <limits>
#include <iostream>
#include <numeric>
#include <algorithm>
 
#include <meteoio/IOUtils.h>
#include <meteoio/IOExceptions.h>
 
namespace mio {
 
template<class T> class Array1D {
        public:
                Array1D(const size_t& asize=0);
 
                Array1D(const size_t& asize, const T& init);
 
                void setKeepNodata(const bool i_keep_nodata);
 
                bool getKeepNodata();
 
                void size(size_t& nx) const;
                size_t size() const;
                size_t getNx() const;
 
                void resize(const size_t& asize);
                void resize(const size_t& asize, const T& init);
                void clear();
                bool empty() const;
 
                void insertAt(const int& index, T e);
                void removeAt(const size_t& index);
 
                T getMin() const;
                T getMax() const;
                T getMean() const;
                size_t getCount() const;
                const Array1D<T> getAbs() const;
                void abs();
 
 
                const std::string toString() const;
                template<class P> friend std::ostream& operator<<(std::ostream& os, const Array1D<P>& array);
                template<class P> friend std::istream& operator>>(std::istream& is, Array1D<P>& array);
 
                bool checkEpsilonEquality(const Array1D<double>& rhs, const double& epsilon) const;
                static bool checkEpsilonEquality(const Array1D<double>& rhs1, const Array1D<double>& rhs2, const double& epsilon);
 
                T& operator [](const size_t& index);
                const T operator [](const size_t& index) const;
                T& operator ()(const size_t& index);
                const T operator ()(const size_t& index) const;
 
                Array1D<T>& operator =(const T& value);
 
                Array1D<T>& operator+=(const T& rhs);
                const Array1D<T> operator+(const T& rhs) const;
                Array1D<T>& operator+=(const Array1D<T>& rhs);
                const Array1D<T> operator+(const Array1D<T>& rhs) const;
 
                Array1D<T>& operator-=(const T& rhs);
                const Array1D<T> operator-(const T& rhs) const;
                Array1D<T>& operator-=(const Array1D<T>& rhs);
                const Array1D<T> operator-(const Array1D<T>& rhs) const;
 
                Array1D<T>& operator*=(const T& rhs);
                const Array1D<T> operator*(const T& rhs) const;
                Array1D<T>& operator*=(const Array1D<T>& rhs);
                const Array1D<T> operator*(const Array1D<T>& rhs) const;
 
                Array1D<T>& operator/=(const T& rhs);
                const Array1D<T> operator/(const T& rhs) const;
                Array1D<T>& operator/=(const Array1D<T>& rhs);
                const Array1D<T> operator/(const Array1D<T>& rhs) const;
 
                bool operator==(const Array1D<T>&) const; 
                bool operator!=(const Array1D<T>&) const; 
 
        protected:
                std::vector<T> vecData; 
                size_t nx; 
                bool keep_nodata;
};
 
template<class T> Array1D<T>::Array1D(const size_t& asize)
                  : vecData(asize), nx(asize), keep_nodata(true)
{
        //resize(asize);
}
 
template<class T> Array1D<T>::Array1D(const size_t& asize, const T& init)
                 : vecData(asize, init), nx(asize), keep_nodata(true)
{
        //resize(asize, init);
}
 
template<class T> void Array1D<T>::setKeepNodata(const bool i_keep_nodata) {
        keep_nodata = i_keep_nodata;
}
 
template<class T> bool Array1D<T>::getKeepNodata() {
        return keep_nodata;
}
 
template<class T> void Array1D<T>::size(size_t& o_nx) const {
        o_nx = nx;
}
 
template<class T> size_t Array1D<T>::size() const {
        return nx;
}
 
template<class T> size_t Array1D<T>::getNx() const {
        return nx;
}
 
template<class T> void Array1D<T>::resize(const size_t& asize) {
        vecData.clear();
        vecData.resize(asize);
        nx = asize;
}
 
template<class T> void Array1D<T>::resize(const size_t& asize, const T& init) {
        vecData.clear();
        vecData.resize(asize, init);
        nx = asize;
}
 
template<class T> inline T& Array1D<T>::operator()(const size_t& index) {
#ifndef NOSAFECHECKS
        if (index >= nx) {
                std::stringstream ss;
                ss << "Trying to access array(" << index << ")";
                ss << " while array is (" << nx << ")";
                throw IndexOutOfBoundsException(ss.str(), AT);
        }
#endif
        return vecData[index];
}
 
template<class T> inline const T Array1D<T>::operator()(const size_t& index) const {
#ifndef NOSAFECHECKS
        if (index >= nx) {
                std::stringstream ss;
                ss << "Trying to access array(" << index << ")";
                ss << " while array is (" << nx << ")";
                throw IndexOutOfBoundsException(ss.str(), AT);
        }
#endif
        return vecData[index];
}
 
template<class T> inline T& Array1D<T>::operator [](const size_t& index) {
#ifndef NOSAFECHECKS
        return vecData.at(index);
#else
        return vecData[index];
#endif
}
 
template<class T> inline const T Array1D<T>::operator [](const size_t& index) const {
#ifndef NOSAFECHECKS
        return vecData.at(index);
#else
        return vecData[index];
#endif
}
 
template<class T> void Array1D<T>::clear() {
        vecData.clear();
        nx = 0;
}
 
template<class T> bool Array1D<T>::empty() const {
        return (nx==0);
}
 
template<class T> const std::string Array1D<T>::toString() const {
        std::stringstream os;
        os << "<array1d>\n";
        for (size_t ii=0; ii<nx; ii++) {
                os << vecData[ii] << " ";
        }
        os << "\n</array1d>\n";
        return os.str();
}
 
template<class P> std::ostream& operator<<(std::ostream& os, const Array1D<P>& array) {
        os.write(reinterpret_cast<const char*>(&array.keep_nodata), sizeof(array.keep_nodata));
        os.write(reinterpret_cast<const char*>(&array.nx), sizeof(array.nx));
        os.write(reinterpret_cast<const char*>(&array.vecData[0]), static_cast<std::streamsize>(array.nx*sizeof(P)));
        return os;
}
 
template<class P> std::istream& operator>>(std::istream& is, Array1D<P>& array) {
        is.read(reinterpret_cast<char*>(&array.keep_nodata), sizeof(array.keep_nodata));
        is.read(reinterpret_cast<char*>(&array.nx), sizeof(array.nx));
        array.vecData.resize(array.nx);
        is.read(reinterpret_cast<char*>(&array.vecData[0]), static_cast<std::streamsize>(array.nx*sizeof(P))); //30 times faster than assign() or copy()
        return is;
}
 
template<class T> void Array1D<T>::insertAt(const int& index, T e) {
        if (index < 0) {
                vecData.push_back(e);
                nx++;
        } else if ((index >= 0) && (index < (int)vecData.size())) {
                vecData.insert(vecData.begin() + index, e);
                nx++;
        } else {
                std::stringstream ss;
                ss << "Inserting an element at (" << index << ") in an array of size [" << nx << "]";
                throw IndexOutOfBoundsException(ss.str(), AT);
        }
}
 
template<class T> void Array1D<T>::removeAt(const size_t& index) {
        if (index < vecData.size()) {
                vecData.erase(vecData.begin()+index);
                nx--;
        }
}
 
template<class T> T Array1D<T>::getMin() const {
 
        T min = std::numeric_limits<T>::max();
 
        if (keep_nodata==false) {
                min = *min_element(vecData.begin(), vecData.end());
                if (min!=std::numeric_limits<T>::max()) return min;
                else return (T)IOUtils::nodata;
        } else {
                for (size_t ii=0; ii<nx; ii++) {
                        const T val = vecData[ii];
                        if (val!=IOUtils::nodata && val<min) min=val;
                }
                if (min!=std::numeric_limits<T>::max()) return min;
                else return (T)IOUtils::nodata;
        }
}
 
template<class T> T Array1D<T>::getMax() const {
 
        T max = -std::numeric_limits<T>::max();
 
        if (keep_nodata==false) {
                max = *max_element(vecData.begin(), vecData.end());
                if (max!=-std::numeric_limits<T>::max()) return max;
                else return (T)IOUtils::nodata;
        } else {
                for (size_t ii=0; ii<nx; ii++) {
                        const T val = vecData[ii];
                        if (val!=IOUtils::nodata && val>max) max=val;
                }
                if (max!=-std::numeric_limits<T>::max()) return max;
                else return (T)IOUtils::nodata;
        }
}
 
template<class T> T Array1D<T>::getMean() const {
 
        T mean = 0;
 
        if (keep_nodata==false) {
                if (nx>0) return std::accumulate(vecData.begin(), vecData.end(), 0.) / (T)(nx);
                else return (T)IOUtils::nodata;
        } else {
                size_t count = 0;
                for (size_t ii=0; ii<nx; ii++) {
                        const T val = vecData[ii];
                        if (val!=IOUtils::nodata) {
                                mean += val;
                                count++;
                        }
                }
                if (count>0) return mean/(T)(count);
                else return (T)IOUtils::nodata;
        }
}
 
template<class T> size_t Array1D<T>::getCount() const
{
        if (keep_nodata==false) {
                return (size_t)nx;
        } else {
                size_t count = 0;
                for (size_t ii=0; ii<nx; ii++) {
                        if (vecData[ii]!=IOUtils::nodata) count++;
                }
                return count;
        }
}
 
template<class T> void Array1D<T>::abs() {
        if (std::numeric_limits<T>::is_signed) {
                if (keep_nodata==false) {
                        for (size_t ii=0; ii<nx; ii++) {
                                T& val = vecData[ii];
                                if (val<0) val=-val;
                        }
                } else {
                        for (size_t ii=0; ii<nx; ii++) {
                                T& val = vecData[ii];
                                if (val<0 && val!=IOUtils::nodata) val=-val;
                        }
                }
        }
}
 
template<class T> const Array1D<T> Array1D<T>::getAbs() const {
        Array1D<T> result(*this); //make a copy
        result.abs(); //already implemented
 
        return result;
}
 
//arithmetic operators
template<class T> bool Array1D<T>::checkEpsilonEquality(const Array1D<double>& rhs, const double& epsilon) const {
        if (nx!=rhs.nx) return false;
 
        for (size_t jj=0; jj<nx; jj++)
                if (IOUtils::checkEpsilonEquality(vecData[jj], rhs.vecData[jj], epsilon)==false) return false;
 
        return true;
}
 
template<class T> bool Array1D<T>::checkEpsilonEquality(const Array1D<double>& rhs1, const Array1D<double>& rhs2, const double& epsilon) {
        return rhs1.checkEpsilonEquality(rhs2, epsilon);
}
 
template<class T> Array1D<T>& Array1D<T>::operator=(const T& value) {
        //reset every single member of the Array1D<T>
        std::fill(vecData.begin(), vecData.end(), value);
        return *this;
}
 
template<class T> Array1D<T>& Array1D<T>::operator+=(const Array1D<T>& rhs)
{
        //They have to have equal size
        if (rhs.nx != nx) {
                std::stringstream ss;
                ss << "Trying to add two Array1D objects with different dimensions: ";
                ss << "(" << nx << ") + (" << rhs.nx << ")";
                throw IOException(ss.str(), AT);
        }
 
        //Add to every single member of the Array1D<T>
        if (keep_nodata==false) {
                for (size_t ii=0; ii<nx; ii++) {
                        vecData[ii] += rhs(ii);
                }
        } else {
                for (size_t ii=0; ii<nx; ii++) {
                        if (vecData[ii]==IOUtils::nodata || rhs(ii)==IOUtils::nodata)
                                vecData[ii] = IOUtils::nodata;
                        else
                                vecData[ii] += rhs(ii);
                }
        }
 
        return *this;
}
 
template<class T> const Array1D<T> Array1D<T>::operator+(const Array1D<T>& rhs) const
{
        Array1D<T> result(*this); //make a copy
        result += rhs; //already implemented
 
        return result;
}
 
template<class T> Array1D<T>& Array1D<T>::operator+=(const T& rhs)
{
        if (rhs==0.) return *this;
        
        //Add to every single member of the Array1D<T>
        if (keep_nodata==false) {
                for (size_t ii=0; ii<nx; ii++) {
                        vecData[ii] += rhs;
                }
        } else {
                for (size_t ii=0; ii<nx; ii++) {
                        if (vecData[ii]!=IOUtils::nodata)
                                vecData[ii] += rhs;
                }
        }
 
        return *this;
}
 
template<class T> const Array1D<T> Array1D<T>::operator+(const T& rhs) const
{
        Array1D<T> result(*this);
        result += rhs; //already implemented
 
        return result;
}
 
template<class T> Array1D<T>& Array1D<T>::operator-=(const Array1D<T>& rhs)
{
        //They have to have equal size
        if (rhs.nx != nx) {
                std::stringstream ss;
                ss << "Trying to substract two Array1D objects with different dimensions: ";
                ss << "(" << nx << ") - (" << rhs.nx << ")";
                throw IOException(ss.str(), AT);
        }
 
        //Substract to every single member of the Array1D<T>
        if (keep_nodata==false) {
                for (size_t ii=0; ii<nx; ii++) {
                        vecData[ii] -= rhs(ii);
                }
        } else {
                for (size_t ii=0; ii<nx; ii++) {
                        if (vecData[ii]==IOUtils::nodata || rhs(ii)==IOUtils::nodata)
                                vecData[ii] = IOUtils::nodata;
                        else
                                vecData[ii] -= rhs(ii);
                }
        }
 
        return *this;
}
 
template<class T> const Array1D<T> Array1D<T>::operator-(const Array1D<T>& rhs) const
{
        Array1D<T> result(*this); //make a copy
        result -= rhs; //already implemented
 
        return result;
}
 
template<class T> Array1D<T>& Array1D<T>::operator-=(const T& rhs)
{
        *this += -rhs;
        return *this;
}
 
template<class T> const Array1D<T> Array1D<T>::operator-(const T& rhs) const
{
        Array1D<T> result(*this);
        result += -rhs; //already implemented
 
        return result;
}
 
template<class T> Array1D<T>& Array1D<T>::operator*=(const Array1D<T>& rhs)
{
        //They have to have equal size
        if (rhs.nx != nx){
                std::stringstream ss;
                ss << "Trying to multiply two Array1D objects with different dimensions: ";
                ss << "(" << nx << ") * (" << rhs.nx << ")";
                throw IOException(ss.str(), AT);
        }
        //Multiply every single member of the Array1D<T>
        if (keep_nodata==false) {
                for (size_t ii=0; ii<nx; ii++) {
                        vecData[ii] *= rhs(ii);
                }
        } else {
                for (size_t ii=0; ii<nx; ii++) {
                        if (vecData[ii]==IOUtils::nodata || rhs(ii)==IOUtils::nodata)
                                vecData[ii] = IOUtils::nodata;
                        else
                                vecData[ii] *= rhs(ii);
                }
        }
 
        return *this;
}
 
template<class T> const Array1D<T> Array1D<T>::operator*(const Array1D<T>& rhs) const
{
        Array1D<T> result(*this); //make a copy
        result *= rhs; //already implemented
 
        return result;
}
 
template<class T> Array1D<T>& Array1D<T>::operator*=(const T& rhs)
{
        if (rhs==1.) return *this;
        
        //Multiply every single member of the Array1D<T>
        if (keep_nodata==false) {
                for (size_t ii=0; ii<nx; ii++) {
                        vecData[ii] *= rhs;
                }
        } else {
                for (size_t ii=0; ii<nx; ii++) {
                        if (vecData[ii]!=IOUtils::nodata)
                                vecData[ii] *= rhs;
                }
        }
 
        return *this;
}
 
template<class T> const Array1D<T> Array1D<T>::operator*(const T& rhs) const
{
        Array1D<T> result(*this);
        result *= rhs; //already implemented
 
        return result;
}
 
template<class T> Array1D<T>& Array1D<T>::operator/=(const Array1D<T>& rhs)
{
        //They have to have equal size
        if (rhs.nx != nx){
                std::stringstream ss;
                ss << "Trying to divide two Array1D objects with different dimensions: ";
                ss << "(" << nx << ") / (" << rhs.nx << ")";
                throw IOException(ss.str(), AT);
        }
        //Divide every single member of the Array1D<T>
        if (keep_nodata==false) {
                for (size_t ii=0; ii<nx; ii++) {
                        vecData[ii] /= rhs(ii);
                }
        } else {
                for (size_t ii=0; ii<nx; ii++) {
                        if (vecData[ii]==IOUtils::nodata || rhs(ii)==IOUtils::nodata)
                                vecData[ii] = IOUtils::nodata;
                        else
                                vecData[ii] /= rhs(ii);
                }
        }
 
        return *this;
}
 
template<class T> const Array1D<T> Array1D<T>::operator/(const Array1D<T>& rhs) const
{
        Array1D<T> result(*this); //make a copy
        result /= rhs; //already implemented
 
        return result;
}
 
template<class T> Array1D<T>& Array1D<T>::operator/=(const T& rhs)
{
        *this *= (1./rhs);
        return *this;
}
 
template<class T> const Array1D<T> Array1D<T>::operator/(const T& rhs) const
{
        Array1D<T> result(*this);
        result *= 1./rhs; //already implemented
 
        return result;
}
 
template<class T> bool Array1D<T>::operator==(const Array1D<T>& in) const {
        const size_t in_nx = in.getNx();
 
        if (nx!=in_nx)
                return false;
 
        for (size_t jj=0; jj<nx; jj++)
                if ( !IOUtils::checkEpsilonEquality( vecData[jj] , in.vecData[jj], 1e-6) ) return false;
 
        return true;
}
 
template<class T> bool Array1D<T>::operator!=(const Array1D<T>& in) const {
        return !(*this==in);
}
 
} //end namespace mio
 
#endif