Array2D.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 ARRAY2D_H
#define ARRAY2D_H
 
#include <meteoio/IOExceptions.h>
#include <meteoio/IOUtils.h>
 
#include <vector>
#include <limits>
#include <iostream>
#include <numeric>
#include <algorithm>
 
//forward declaration
namespace mio { template <class T> class Array2D; }
#include <meteoio/dataClasses/Array3D.h>
 
namespace mio {
template <class T> class Array2DProxy {
        public:
                friend class Array2D<T>;
                T& operator[](const size_t& j) {
                        return array2D(anx, j);
                }
 
        private:
                Array2DProxy(Array2D<T>& i_array2D, const size_t& i_anx) : array2D(i_array2D), anx(i_anx){}
                Array2D<T>& array2D;
                const size_t anx;
};
 
template<class T> class Array2D {
        public:
                Array2D();
 
                Array2D(const size_t& anx, const size_t& any);
 
                Array2D(const size_t& anx, const size_t& any, const T& init);
 
                Array2D(const Array2D<T>& i_array2D, const size_t& i_nx, const size_t& i_ny,
                        const size_t& i_ncols, const size_t& i_nrows);
 
                Array2D(const Array3D<T>& array3D, const size_t& depth);
 
                void subset(const Array2D<T>& i_array2D, const size_t& i_nx, const size_t& i_ny,
                            const size_t& i_ncols, const size_t& i_nrows);
 
                void fill(const Array2D<T>& i_array2D, const size_t& i_nx, const size_t& i_ny,
                          const size_t& i_ncols, const size_t& i_nrows);
 
                void fill(const Array2D<T>& i_array2D, const size_t& i_nx, const size_t& i_ny);
 
                void setKeepNodata(const bool i_keep_nodata);
 
                bool getKeepNodata() const;
 
                void resize(const size_t& anx, const size_t& any);
                void resize(const size_t& anx, const size_t& any, const T& init);
                void size(size_t& anx, size_t& any) const;
                size_t size() const;
                size_t getNx() const;
                size_t getNy() const;
 
                void clear();
                bool empty() const;
 
                T getMin() const;
                T getMax() const;
                T getMean() const;
                size_t getCount() const;
                const Array2D<T> getAbs() const;
                void abs();
 
                const std::string toString() const;
                template<class P> friend std::ostream& operator<<(std::ostream& os, const Array2D<P>& array);
                template<class P> friend std::istream& operator>>(std::istream& is, Array2D<P>& array);
 
                bool checkEpsilonEquality(const Array2D<double>& rhs, const double& epsilon) const;
                static bool checkEpsilonEquality(const Array2D<double>& rhs1, const Array2D<double>& rhs2, const double& epsilon);
 
                T& operator ()(const size_t& x, const size_t& y);
                const T operator ()(const size_t& x, const size_t& y) const;
                T& operator ()(const size_t& i);
                const T operator ()(const size_t& i) const;
                Array2DProxy<T> operator[](const size_t& i);
 
                Array2D<T>& operator =(const T& value);
 
                Array2D<T>& operator+=(const T& rhs);
                const Array2D<T> operator+(const T& rhs) const;
                Array2D<T>& operator+=(const Array2D<T>& rhs);
                const Array2D<T> operator+(const Array2D<T>& rhs) const;
 
                Array2D<T>& operator-=(const T& rhs);
                const Array2D<T> operator-(const T& rhs) const;
                Array2D<T>& operator-=(const Array2D<T>& rhs);
                const Array2D<T> operator-(const Array2D<T>& rhs) const;
 
                Array2D<T>& operator*=(const T& rhs);
                const Array2D<T> operator*(const T& rhs) const;
                Array2D<T>& operator*=(const Array2D<T>& rhs);
                const Array2D<T> operator*(const Array2D<T>& rhs) const;
 
                Array2D<T>& operator/=(const T& rhs);
                const Array2D<T> operator/(const T& rhs) const;
                Array2D<T>& operator/=(const Array2D<T>& rhs);
                const Array2D<T> operator/(const Array2D<T>& rhs) const;
 
                bool operator==(const Array2D<T>&) const; 
                bool operator!=(const Array2D<T>&) const; 
 
        protected:
                std::vector<T> vecData;
                size_t nx;
                size_t ny;
                bool keep_nodata;
};
 
template<class T> inline T& Array2D<T>::operator()(const size_t& i) {
#ifndef NOSAFECHECKS
        return vecData.at(i);
#else
        return vecData[i];
#endif
}
 
template<class T> inline const T Array2D<T>::operator()(const size_t& i) const {
#ifndef NOSAFECHECKS
        return vecData.at(i);
#else
        return vecData[i];
#endif
}
template<class T> inline T& Array2D<T>::operator()(const size_t& x, const size_t& y) {
#ifndef NOSAFECHECKS
        if ((x >= nx) || (y >= ny)) {
                std::stringstream ss;
                ss << "Trying to access array(" << x << "," << y << ")";
                ss << " while array is (" << nx << "," << ny << ")";
                throw IndexOutOfBoundsException(ss.str(), AT);
        }
#endif
        //ROW-MAJOR alignment of the vector: fully C-compatible memory layout
        return vecData[x + y*nx];
}
 
template<class T> inline const T Array2D<T>::operator()(const size_t& x, const size_t& y) const {
#ifndef NOSAFECHECKS
        if ((x >= nx) || (y >= ny)) {
                std::stringstream ss;
                ss << "Trying to access array(" << x << "," << y << ")";
                ss << " while array is (" << nx << "," << ny << ")";
                throw IndexOutOfBoundsException(ss.str(), AT);
        }
#endif
        return vecData[x + y*nx];
}
 
template<class T> Array2DProxy<T> Array2D<T>::operator[](const size_t& i) {
        return Array2DProxy<T>(*this, i);
}
 
template<class T> Array2D<T>::Array2D() : vecData(), nx(0), ny(0), keep_nodata(true)
{
}
 
template<class T> Array2D<T>::Array2D(const Array2D<T>& i_array2D, const size_t& i_nx, const size_t& i_ny,
                                      const size_t& i_ncols, const size_t& i_nrows) :
                                      vecData(i_ncols*i_nrows), nx(i_ncols), ny(i_nrows), keep_nodata(true)
{
        subset(i_array2D, i_nx, i_ny, i_ncols, i_nrows);
}
 
template<class T> Array2D<T>::Array2D(const Array3D<T>& array3D, const size_t& depth)
                             : vecData(array3D.getNx()*array3D.getNy()), nx(array3D.getNx()), ny(array3D.getNy()), keep_nodata(array3D.getKeepNodata())
{
        //copy plane in the correct position
        for (size_t jj=0; jj<ny; jj++) {
                for (size_t ii=0; ii<nx; ii++) {
                        operator()(ii,jj) = array3D(ii, jj, depth);
                }
        }
}
 
template<class T> void Array2D<T>::subset(const Array2D<T>& i_array2D, const size_t& i_nx, const size_t& i_ny,
                                          const size_t& i_ncols, const size_t& i_nrows)
{
        if (((i_nx+i_ncols) > i_array2D.nx) || ((i_ny+i_nrows) > i_array2D.ny)) {
                std::stringstream ss;
                ss << "Trying to cut an array of size (" << i_array2D.nx << "," << i_array2D.ny << ") ";
                ss << "to size (" << i_ncols << "," << i_nrows << ") starting at (" << i_nx << "," << i_ny << ")";
                throw IndexOutOfBoundsException(ss.str(), AT);
        }
 
        if ((i_ncols == 0) || (i_nrows == 0)) //the plane to copy has to make sense
                throw IndexOutOfBoundsException("Trying to cut an array into a null sized array!", AT);
 
        resize(i_ncols, i_nrows); //create new Array2D object
        //Copy by value subspace
        for (size_t jj=0; jj<ny; jj++) {
                for (size_t ii=0; ii<nx; ii++) {
                        operator()(ii,jj) = i_array2D(i_nx+ii, i_ny+jj);
                }
        }
}
 
template<class T> void Array2D<T>::fill(const Array2D<T>& i_array2D, const size_t& i_nx, const size_t& i_ny)
{
        size_t i_ncols, i_nrows;
        i_array2D.size(i_ncols, i_nrows);
        fill(i_array2D, i_nx, i_ny, i_ncols, i_nrows);
}
 
template<class T> void Array2D<T>::fill(const Array2D<T>& i_array2D, const size_t& i_nx, const size_t& i_ny,
                                        const size_t& i_ncols, const size_t& i_nrows)
{
        if (((i_nx+i_ncols) > nx) || ((i_ny+i_nrows) > ny)) {
                std::stringstream ss;
                ss << "Filling an array of size (" << nx << "," << ny << ") ";
                ss << "with an array of size (" << i_ncols << "," << i_nrows << ") ";
                ss << "starting at (" << i_nx << "," << i_ny << ")";
                throw IndexOutOfBoundsException(ss.str(), AT);
        }
 
        if ((i_ncols == 0) || (i_nrows == 0)) //the plane to copy has to make sense
                throw IndexOutOfBoundsException("Filling an array with a null sized array!", AT);
 
        for (size_t jj=i_ny; jj<(i_ny+i_nrows); jj++) {
                const size_t iy = jj-i_ny;
                for (size_t ii=i_nx; ii<(i_nx+i_ncols); ii++) {
                        const size_t ix = ii-i_nx;
                        operator()(ii,jj) = i_array2D(ix, iy);
                }
        }
}
 
template<class T> Array2D<T>::Array2D(const size_t& anx, const size_t& any, const T& init) :
                  vecData(anx*any, init), nx(anx), ny(any), keep_nodata(true) {}
 
template<class T> Array2D<T>::Array2D(const size_t& anx, const size_t& any) :
                  vecData(anx*any), nx(anx), ny(any), keep_nodata(true) {}
 
template<class T> void Array2D<T>::setKeepNodata(const bool i_keep_nodata) {
        keep_nodata = i_keep_nodata;
}
 
template<class T> bool Array2D<T>::getKeepNodata() const {
        return keep_nodata;
}
 
template<class T> void Array2D<T>::resize(const size_t& anx, const size_t& any) {
        clear(); //we won't be able to "rescue" old values, so we reset the whole vector
        vecData.resize(anx*any);
        nx = anx;
        ny = any;
}
 
template<class T> void Array2D<T>::resize(const size_t& anx, const size_t& any, const T& init) {
        clear(); //we won't be able to "rescue" old values, so we reset the whole vector
        vecData.resize(anx*any, init);
        nx = anx;
        ny = any;
}
 
template<class T> void Array2D<T>::size(size_t& anx, size_t& any) const {
        anx=nx;
        any=ny;
}
 
template<class T> size_t Array2D<T>::size() const {
        return nx*ny;
}
 
template<class T> size_t Array2D<T>::getNx() const {
        return nx;
}
 
template<class T> size_t Array2D<T>::getNy() const {
        return ny;
}
 
template<class T> void Array2D<T>::clear() {
        vecData.clear();
        nx=ny=0;
}
 
template<class T> bool Array2D<T>::empty() const {
        return (nx==0 && ny==0);
}
 
template<class T> const std::string Array2D<T>::toString() const {
        std::ostringstream os;
        os << "<array2d>\n";
        for (size_t jj=0; jj<ny; jj++) {
                const size_t jnx = jj*nx;
                for (size_t ii=0; ii<nx; ii++) {
                        os << vecData[ii+jnx] << " "; //COLUMN-MAJOR alignment
                }
                os << "\n";
        }
        os << "</array2d>\n";
        return os.str();
}
 
template<class P> std::ostream& operator<<(std::ostream& os, const Array2D<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.ny), sizeof(array.ny));
        os.write(reinterpret_cast<const char*>(&array.vecData[0]), static_cast<std::streamsize>(array.nx*array.ny*sizeof(P)));
        return os;
}
 
template<class P> std::istream& operator>>(std::istream& is, Array2D<P>& array) {
        is.read(reinterpret_cast<char*>(&array.keep_nodata), sizeof(array.keep_nodata));
        is.read(reinterpret_cast<char*>(&array.nx), sizeof(array.nx));
        is.read(reinterpret_cast<char*>(&array.ny), sizeof(array.ny));
        array.vecData.resize(array.nx*array.ny);
        is.read(reinterpret_cast<char*>(&array.vecData[0]), static_cast<std::streamsize>(array.nx*array.ny*sizeof(P))); //30 times faster than assign() or copy()
        return is;
}
 
template<class T> T Array2D<T>::getMin() const {
 
        T min = std::numeric_limits<T>::max();
 
        const size_t nxy = ny*nx;
        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 jj=0; jj<nxy; jj++) {
                        const T val = vecData[jj];
                        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 Array2D<T>::getMax() const {
 
        T max = -std::numeric_limits<T>::max();
 
        const size_t nxy = ny*nx;
        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 jj=0; jj<nxy; jj++) {
                        const T val = vecData[jj];
                        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 Array2D<T>::getMean() const {
 
        T mean = 0;
        const size_t nxy = nx*ny;
 
        if (keep_nodata==false) {
                if (nxy>0) return std::accumulate(vecData.begin(), vecData.end(), 0.) / (T)(nxy);
                else return (T)IOUtils::nodata;
        } else {
                size_t count = 0;
                for (size_t jj=0; jj<nxy; jj++) {
                        const T val = vecData[jj];
                        if (val!=IOUtils::nodata) {
                                mean += val;
                                count++;
                        }
                }
                if (count>0) return mean/(T)(count);
                else return (T)IOUtils::nodata;
        }
}
 
template<class T> size_t Array2D<T>::getCount() const
{
        const size_t nxy = nx*ny;
 
        if (keep_nodata==false) {
                return (size_t)nxy;
        } else {
                size_t count = 0;
                for (size_t ii=0; ii<nxy; ii++) {
                        if (vecData[ii]!=IOUtils::nodata) count++;
                }
                return count;
        }
}
 
template<class T> void Array2D<T>::abs() {
        if (std::numeric_limits<T>::is_signed) {
                const size_t nxy = nx*ny;
                if (keep_nodata==false) {
                        for (size_t ii=0; ii<nxy; ii++) {
                                T& val = vecData[ii];
                                if (val<0) val=-val;
                        }
                } else {
                        for (size_t ii=0; ii<nxy; ii++) {
                                T& val = vecData[ii];
                                if (val<0 && val!=IOUtils::nodata) val=-val;
                        }
                }
        }
}
 
template<class T> const Array2D<T> Array2D<T>::getAbs() const {
        Array2D<T> result(*this); //make a copy
        result.abs(); //already implemented
 
        return result;
}
 
 
//arithmetic operators
template<class T> bool Array2D<T>::checkEpsilonEquality(const Array2D<double>& rhs, const double& epsilon) const {
        if (nx!=rhs.nx || ny!=rhs.ny) return false;
 
        const size_t nxy = nx*ny;
        for (size_t jj=0; jj<nxy; jj++)
                if (IOUtils::checkEpsilonEquality(vecData[jj], rhs.vecData[jj], epsilon)==false) return false;
 
        return true;
}
 
template<class T> bool Array2D<T>::checkEpsilonEquality(const Array2D<double>& rhs1, const Array2D<double>& rhs2, const double& epsilon) { //static
        return rhs1.checkEpsilonEquality(rhs2, epsilon);
}
 
template<class T> Array2D<T>& Array2D<T>::operator=(const T& value) {
        std::fill(vecData.begin(), vecData.end(), value);
        return *this;
}
 
template<class T> Array2D<T>& Array2D<T>::operator+=(const Array2D<T>& rhs)
{
        //They have to have equal size
        if ((rhs.nx != nx) || (rhs.ny != ny)) {
                std::stringstream ss;
                ss << "Trying to add two Array2D objects with different dimensions: ";
                ss << "(" << nx << "," << ny << ") + (" << rhs.nx << "," << rhs.ny << ")";
                throw IOException(ss.str(), AT);
        }
 
        const size_t nxy = nx*ny;
        //Add to every single member of the Array2D<T>
        if (keep_nodata==false) {
                for (size_t jj=0; jj<nxy; jj++)
                        vecData[jj] += rhs(jj);
        } else {
                for (size_t jj=0; jj<nxy; jj++) {
                        if (vecData[jj]==IOUtils::nodata || rhs(jj)==IOUtils::nodata)
                                vecData[jj] = IOUtils::nodata;
                        else
                                vecData[jj] += rhs(jj);
                }
        }
 
        return *this;
}
 
template<class T> const Array2D<T> Array2D<T>::operator+(const Array2D<T>& rhs) const
{
        Array2D<T> result(*this); //make a copy
        result += rhs; //already implemented
 
        return result;
}
 
template<class T> Array2D<T>& Array2D<T>::operator+=(const T& rhs)
{
        if (rhs==0.) return *this;
        
        //Add to every single member of the Array2D<T>
        const size_t nxy = nx*ny;
 
        if (keep_nodata==false) {
                for (size_t jj=0; jj<nxy; jj++)
                        vecData[jj] += rhs;
        } else {
                for (size_t jj=0; jj<nxy; jj++) {
                        if (vecData[jj]!=IOUtils::nodata)
                                vecData[jj] += rhs;
                }
        }
 
        return *this;
}
 
template<class T> const Array2D<T> Array2D<T>::operator+(const T& rhs) const
{
        Array2D<T> result(*this);
        result += rhs; //already implemented
 
        return result;
}
 
template<class T> Array2D<T>& Array2D<T>::operator-=(const Array2D<T>& rhs)
{
        //They have to have equal size
        if ((rhs.nx != nx) || (rhs.ny != ny)){
                std::stringstream ss;
                ss << "Trying to substract two Array2D objects with different dimensions: ";
                ss << "(" << nx << "," << ny << ") - (" << rhs.nx << "," << rhs.ny << ")";
                throw IOException(ss.str(), AT);
        }
        //Substract to every single member of the Array2D<T>
        const size_t nxy = nx*ny;
 
        if (keep_nodata==false) {
                for (size_t jj=0; jj<nxy; jj++)
                        vecData[jj] -= rhs(jj);
        } else {
                for (size_t jj=0; jj<nxy; jj++) {
                        if (vecData[jj]==IOUtils::nodata || rhs(jj)==IOUtils::nodata)
                                vecData[jj] = IOUtils::nodata;
                        else
                                vecData[jj] -= rhs(jj);
                }
        }
 
        return *this;
}
 
template<class T> const Array2D<T> Array2D<T>::operator-(const Array2D<T>& rhs) const
{
        Array2D<T> result(*this); //make a copy
        result -= rhs; //already implemented
 
        return result;
}
 
template<class T> Array2D<T>& Array2D<T>::operator-=(const T& rhs)
{
        *this += -rhs;
        return *this;
}
 
template<class T> const Array2D<T> Array2D<T>::operator-(const T& rhs) const
{
        Array2D<T> result(*this);
        result += -rhs; //already implemented
 
        return result;
}
 
template<class T> Array2D<T>& Array2D<T>::operator*=(const Array2D<T>& rhs)
{
        //They have to have equal size
        if ((rhs.nx != nx) || (rhs.ny != ny)){
                std::stringstream ss;
                ss << "Trying to multiply two Array2D objects with different dimensions: ";
                ss << "(" << nx << "," << ny << ") * (" << rhs.nx << "," << rhs.ny << ")";
                throw IOException(ss.str(), AT);
        }
        //Add to every single member of the Array2D<T>
        const size_t nxy = nx*ny;
 
        if (keep_nodata==false) {
                for (size_t jj=0; jj<nxy; jj++)
                        vecData[jj] *= rhs(jj);
        } else {
                for (size_t jj=0; jj<nxy; jj++) {
                        if (vecData[jj]==IOUtils::nodata || rhs(jj)==IOUtils::nodata)
                                vecData[jj] = IOUtils::nodata;
                        else
                                vecData[jj] *= rhs(jj);
                }
        }
 
        return *this;
}
 
template<class T> const Array2D<T> Array2D<T>::operator*(const Array2D<T>& rhs) const
{
        Array2D<T> result(*this); //make a copy
        result *= rhs; //already implemented
 
        return result;
}
 
template<class T> Array2D<T>& Array2D<T>::operator*=(const T& rhs)
{
        if (rhs==1.) return *this;
        
        //Multiply to every single member of the Array2D<T>
        const size_t nxy = nx*ny;
 
        if (keep_nodata==false) {
                for (size_t jj=0; jj<nxy; jj++)
                        vecData[jj] *= rhs;
        } else {
                for (size_t jj=0; jj<nxy; jj++) {
                        if (vecData[jj]!=IOUtils::nodata)
                                vecData[jj] *= rhs;
                }
        }
 
        return *this;
}
 
template<class T> const Array2D<T> Array2D<T>::operator*(const T& rhs) const
{
        Array2D<T> result(*this);
        result *= rhs; //already implemented
 
        return result;
}
 
template<class T> Array2D<T>& Array2D<T>::operator/=(const Array2D<T>& rhs)
{
        //They have to have equal size
        if ((rhs.nx != nx) || (rhs.ny != ny)){
                std::stringstream ss;
                ss << "Trying to divide two Array2D objects with different dimensions: ";
                ss << "(" << nx << "," << ny << ") / (" << rhs.nx << "," << rhs.ny << ")";
                throw IOException(ss.str(), AT);
        }
        //Divide every single member of the Array2D<T>
        const size_t nxy = nx*ny;
 
        if (keep_nodata==false) {
                for (size_t jj=0; jj<nxy; jj++)
                        vecData[jj] /= rhs(jj);
        } else {
                for (size_t jj=0; jj<nxy; jj++) {
                        if (vecData[jj]==IOUtils::nodata || rhs(jj)==IOUtils::nodata)
                                vecData[jj] = IOUtils::nodata;
                        else
                                vecData[jj] /= rhs(jj);
                }
        }
 
        return *this;
}
 
template<class T> const Array2D<T> Array2D<T>::operator/(const Array2D<T>& rhs) const
{
        Array2D<T> result(*this); //make a copy
        result /= rhs; //already implemented
 
        return result;
}
 
template<class T> Array2D<T>& Array2D<T>::operator/=(const T& rhs)
{
        *this *= (1./rhs);
        return *this;
}
 
template<class T> const Array2D<T> Array2D<T>::operator/(const T& rhs) const
{
        Array2D<T> result(*this);
        result *= (1./rhs); //already implemented
 
        return result;
}
 
template<class T> bool Array2D<T>::operator==(const Array2D<T>& in) const {
        const size_t in_nx=in.getNx(), in_ny=in.getNy();
 
        if (nx!=in_nx || ny!=in_ny)
                return false;
 
        const size_t nxy = nx*ny;
        for (size_t jj=0; jj<nxy; jj++)
                if ( !IOUtils::checkEpsilonEquality( vecData[jj] , in.vecData[jj], 1e-6) ) return false;
 
        return true;
}
 
template<class T> bool Array2D<T>::operator!=(const Array2D<T>& in) const {
        return !(*this==in);
}
 
} //end namespace mio
 
#endif