var_fixed_general_matrix.h

/* Copyright (C) 2003-2005  Martin Förg
 
 * This library 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 2.1 of the License, or (at your option) any later version.
 * 
 * This library 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 this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Contact:
 *   martin.o.foerg@googlemail.com
 *
 */
 
#ifndef var_fixed_general_matrix_h
#define var_fixed_general_matrix_h
 
#include "types.h"
#include "range.h"
#include <vector>
#include <cstdlib>
#include <stdexcept>
 
namespace fmatvec {
 
  template <int N, class AT> class Matrix<General,Var,Fixed<N>,AT> {
 
    public:
      static constexpr bool isVector {false};
      using value_type = AT;
      using shape_type = General;
 
 
    protected:
 
      int M{0};
 
      AT *ele;
 
      template <class Type, class Row, class Col> inline Matrix<General,Var,Fixed<N>,AT>& copy(const Matrix<Type,Row,Col,AT> &A);
 
 
    public:
 
      explicit Matrix() :  ele(nullptr) { }
 
      explicit Matrix(int m, Noinit) : M(m), ele(new AT[M*N]) { }
      explicit Matrix(int m, Init ini=INIT, const AT &a=AT()) : M(m), ele(new AT[M*N]) { init(a); }
#ifndef SWIG
      explicit Matrix(int m, Eye ini, const AT &a=1) : M(m), ele(new AT[M*N]) { init(ini,a); }
#endif
      explicit Matrix(int m, int n, Noinit) : M(m), ele(new AT[M*N]) { FMATVEC_ASSERT(n==N, AT); }
      explicit Matrix(int m, int n, Init ini=INIT, const AT &a=AT()) : M(m), ele(new AT[M*N]) {  FMATVEC_ASSERT(n==N, AT); init(a); }
#ifndef SWIG
      explicit Matrix(int m, int n, Eye ini, const AT &a=1) : M(m), ele(new AT[M*N]) {  FMATVEC_ASSERT(n==N, AT); init(ini,a); }
#endif
 
      // move
      Matrix(Matrix<General,Var,Fixed<N>,AT> &&src)  noexcept {
        M=src.M;
        src.M=0;
        ele=src.ele;
        src.ele=nullptr;
      }
      Matrix<General,Var,Fixed<N>,AT>& operator=(Matrix<General,Var,Fixed<N>,AT> &&src)  noexcept {
        FMATVEC_ASSERT(M == src.rows(), AT);
        src.M=0;
        delete[]ele;
        ele=src.ele;
        src.ele=nullptr;
        return *this;
      }
 
      Matrix(const Matrix<General,Var,Fixed<N>,AT> &A) : M(A.M), ele(new AT[M*N]) {
    copy(A);
      }
 
      template<class Row, class Col>
      Matrix(const Matrix<General,Row,Col,AT> &A) : M(A.rows()), ele(new AT[M*N]) {
    FMATVEC_ASSERT(A.cols() == N, AT); 
    copy(A);
      }
 
      template<class Type, class Row, class Col>
      explicit Matrix(const Matrix<Type,Row,Col,AT> &A) : M(A.rows()), ele(new AT[M*N]) {
    FMATVEC_ASSERT(A.cols() == N, AT); 
    copy(A);
      }
 
      Matrix(const std::string &strs);
      Matrix(const char *strs);
 
      using iterator = AT *;
      using const_iterator = const AT *;
      iterator begin() { return &ele[0]; }
      iterator end() { return &ele[M*N]; }
      const_iterator begin() const { return &ele[0]; }
      const_iterator end() const { return &ele[M*N]; }
 
      ~Matrix() {
    delete[] ele;
      }
 
      Matrix<General,Var,Fixed<N>,AT>& resize(int m, Noinit) {
    delete[] ele;
    M = m;
    ele = new AT[M*N];
        return *this;
      }
 
      Matrix<General,Var,Fixed<N>,AT>& resize(int m, Init ini=INIT, const AT &a=AT()) { return resize(m,Noinit()).init(a); }
 
#ifndef SWIG
      Matrix<General,Var,Fixed<N>,AT>& resize(int m, Eye ini, const AT &a=1) { return resize(m,Noinit()).init(ini,a); }
#endif
 
      void resize(int m, int n) {
        if(n!=N)
          throw std::runtime_error("A var-fixed matrix can only be resized in the first dimension.");
        resize(m);
      }
 
      inline Matrix<General,Var,Fixed<N>,AT>& operator=(const Matrix<General,Var,Fixed<N>,AT> &A) {
        FMATVEC_ASSERT(M == A.rows(), AT);
        return copy(A);
      }
 
      template <class Type, class Row, class Col>
      inline Matrix<General,Var,Fixed<N>,AT>& operator=(const Matrix<Type,Row,Col,AT> &A) {
        FMATVEC_ASSERT(N == A.cols(), AT); 
        FMATVEC_ASSERT(M == A.rows(), AT);
        return copy(A);
      }
 
      template <class Type, class Row, class Col>
      inline Matrix<General,Var,Fixed<N>,AT>& operator<<=(const Matrix<Type,Row,Col,AT> &A) {
        FMATVEC_ASSERT(N == A.cols(), AT);
        if(M!=A.rows()) resize(A.rows(),NONINIT);
        return copy(A);
      }
      // move
      inline Matrix<General,Var,Fixed<N>,AT>& operator<<=(Matrix<General,Var,Fixed<N>,AT> &&src) {
        FMATVEC_ASSERT(N == src.cols(), AT);
        M=src.M;
        src.M=0;
        delete[]ele;
        ele=src.ele;
        src.ele=nullptr;
        return *this;
      }
 
      AT& operator()(int i, int j) {
    FMATVEC_ASSERT(i>=0, AT);
    FMATVEC_ASSERT(j>=0, AT);
    FMATVEC_ASSERT(i<M, AT);
    FMATVEC_ASSERT(j<N, AT);
 
    return e(i,j);
      }
 
      const AT& operator()(int i, int j) const {
    FMATVEC_ASSERT(i>=0, AT);
    FMATVEC_ASSERT(j>=0, AT);
    FMATVEC_ASSERT(i<M, AT);
    FMATVEC_ASSERT(j<N, AT);
 
    return e(i,j);
      }
 
      AT& e(int i, int j) {
    return ele[i*N+j];
      }
 
      const AT& e(int i, int j) const {
    return ele[i*N+j];
      }
 
      AT& e(int i) {
    return ele[i];
      }
 
      const AT& e(int i) const {
    return ele[i];
      }
 
      AT* operator()() {return ele;}
 
      const AT* operator()() const {return ele;}
 
      constexpr int rows() const {return M;}
 
      constexpr int cols() const {return N;}
 
      int ldim() const {return N;}
 
      CBLAS_TRANSPOSE blasTrans() const {
        return CblasNoTrans;
      }
 
      CBLAS_ORDER blasOrder() const {
        return CblasRowMajor;
      }
 
#ifndef SWIG
      inline const Matrix<General,Var,Var,AT> operator()(const Range<Var,Var> &I, const Range<Var,Var> &J) const;
#endif
 
      inline const RowVector<Fixed<N>,AT> row(int i) const;
      inline const Vector<Var,AT> col(int j) const;
 
      inline Matrix<General,Var,Fixed<N>,AT>& init(const AT &val=AT()); 
      inline Matrix<General,Var,Fixed<N>,AT>& init(Init, const AT &a=AT()) { return init(a); }
#ifndef SWIG
      inline Matrix<General,Var,Fixed<N>,AT>& init(Eye, const AT &val=1);
#endif
      inline Matrix<General,Var,Fixed<N>,AT>& init(Noinit, const AT &a=AT()) { return *this; }
 
      explicit inline operator std::vector<std::vector<AT>>() const;
 
      explicit inline Matrix(const std::vector<std::vector<AT>> &m);
 
//      /*! \brief Cast to AT.
//       *
//       * \return The AT representation of the matrix
//       * */
//      explicit operator AT() const {
//        FMATVEC_ASSERT(M==1, AT);
//        FMATVEC_ASSERT(N==1, AT);
//        return ele[0];
//      }
//
//      /*! \brief AT Constructor.
//       * Constructs and initializes a matrix with a AT object.
//       * \param x The AT the matrix will be initialized with.
//       * */
//      explicit Matrix(const AT &x) : M(1), ele(new AT[1]) {
//        FMATVEC_ASSERT(N==1, AT);
//        ele[0] = x;
//      }
 
      inline const Matrix<General,Fixed<N>,Var,AT> T() const;
 
      template<class Row> inline void set(int j, const Vector<Row,AT> &x);
 
      template<class Col> inline void set(int i, const RowVector<Col,AT> &x);
 
      template<class Type, class Row, class Col> inline void set(const Range<Var,Var> &I, const Range<Var,Var> &J, const Matrix<Type,Row,Col,AT> &A);
 
      template<class Row> inline void add(int j, const Vector<Row,AT> &x);
 
      template<class Col> inline void add(int i, const RowVector<Col,AT> &x);
 
      template<class Type, class Row, class Col> inline void add(const Range<Var,Var> &I, const Range<Var,Var> &J, const Matrix<Type,Row,Col,AT> &A);
  };
 
  template <int N, class AT> 
    Matrix<General,Var,Fixed<N>,AT>::Matrix(const std::string &strs) :  ele(0) {
      std::istringstream iss(strs);
      iss>>*this;
 
      // check end of stream
      iss>>std::ws;
      if(!iss.eof())
        throw std::runtime_error("Input not fully read.");
    }
  template <int N, class AT> Matrix<General,Var,Fixed<N>,AT>::Matrix(const char * strs) :
    Matrix<General,Var,Fixed<N>,AT>::Matrix(std::string(strs)) {}
 
  template <int N, class AT>
    inline Matrix<General,Var,Fixed<N>,AT>&  Matrix<General,Var,Fixed<N>,AT>::init(const AT &val) {
      #if __GNUC__ >= 10
        // gcc >= 11 triggers a false positive on this code due to init(val) calls from ctor setting M=0
        #pragma GCC diagnostic push
        #pragma GCC diagnostic ignored "-Warray-bounds"
        #pragma GCC diagnostic ignored "-Wstringop-overflow"
      #endif
      for(int i=0; i<M*N; i++) 
        e(i) = val;
      #if __GNUC__ >= 10
        #pragma GCC diagnostic pop
      #endif
      return *this;
    }
 
  template <int N, class AT>
    inline Matrix<General,Var,Fixed<N>,AT>&  Matrix<General,Var,Fixed<N>,AT>::init(Eye eye, const AT &val) {
      for(int i=0; i<M; i++)
        for(int j=0; j<N; j++)
          e(i,j) = (i==j) ? val : 0;
      return *this;
    }
 
  template <int N, class AT>
    inline const Matrix<General,Var,Var,AT> Matrix<General,Var,Fixed<N>,AT>::operator()(const Range<Var,Var> &I, const Range<Var,Var> &J) const {
      FMATVEC_ASSERT(I.end()<M, AT);
      FMATVEC_ASSERT(J.end()<N, AT);
      Matrix<General,Var,Var,AT> A(I.size(),J.size(),NONINIT);
 
      for(int i=0; i<A.rows(); i++) 
        for(int j=0; j<A.cols(); j++)
          A.e(i,j) = e(I.start()+i,J.start()+j);
 
      return A;
    }
 
  template <int N, class AT>
    inline const RowVector<Fixed<N>,AT> Matrix<General,Var,Fixed<N>,AT>::row(int i) const {
 
      FMATVEC_ASSERT(i>=0, AT);
      FMATVEC_ASSERT(i<M, AT);
 
      RowVector<Fixed<N>,AT> x(NONINIT);
 
      for(int j=0; j<N; j++)
        x.e(j) = e(i,j);
 
      return x;
 
    }
 
  template <int N, class AT>
    inline const Vector<Var,AT> Matrix<General,Var,Fixed<N>,AT>::col(int j) const {
 
      FMATVEC_ASSERT(j>=0, AT);
      FMATVEC_ASSERT(j<N, AT);
 
      Vector<Var,AT> x(M,NONINIT);
 
      for(int i=0; i<M; i++)
        x.e(i) = e(i,j);
 
      return x;
 
    }
 
  template <int N, class AT>
    inline const Matrix<General,Fixed<N>,Var,AT> Matrix<General,Var,Fixed<N>,AT>::T() const {
      Matrix<General,Fixed<N>,Var,AT> A(rows(),NONINIT);
      for(int i=0; i<N; i++)
        for(int j=0; j<M; j++)
          A.e(i,j) = e(j,i);
      return A;
    }
 
  template <int N, class AT> template <class Row>
    inline void Matrix<General,Var,Fixed<N>,AT>::set(int j, const Vector<Row,AT> &x) {
      FMATVEC_ASSERT(j<cols(), AT);
      FMATVEC_ASSERT(rows()==x.size(), AT);
      for(int i=0; i<rows(); i++)
        e(i,j) = x.e(i);
    }
 
  template <int N, class AT> template <class Col>
    inline void Matrix<General,Var,Fixed<N>,AT>::set(int i, const RowVector<Col,AT> &x) {
      FMATVEC_ASSERT(i<rows(), AT);
      FMATVEC_ASSERT(cols()==x.size(), AT);
      for(int j=0; j<cols(); j++)
        e(i,j) = x.e(j);
    }
 
  template <int N, class AT> template<class Type, class Row, class Col>
    inline void Matrix<General,Var,Fixed<N>,AT>::set(const Range<Var,Var> &I, const Range<Var,Var> &J, const Matrix<Type,Row,Col,AT> &A) {
 
      FMATVEC_ASSERT(I.end()<rows(), AT);
      FMATVEC_ASSERT(J.end()<cols(), AT);
      FMATVEC_ASSERT(I.size()==A.rows(), AT);
      FMATVEC_ASSERT(J.size()==A.cols(), AT);
 
      for(int i=I.start(), ii=0; i<=I.end(); i++, ii++)
        for(int j=J.start(), jj=0; j<=J.end(); j++, jj++)
          e(i,j) = A.e(ii,jj);
    }
 
  template <int N, class AT> template <class Row>
    inline void Matrix<General,Var,Fixed<N>,AT>::add(int j, const Vector<Row,AT> &x) {
      FMATVEC_ASSERT(j<cols(), AT);
      FMATVEC_ASSERT(rows()==x.size(), AT);
      for(int i=0; i<rows(); i++)
        e(i,j) += x.e(i);
    }
 
  template <int N, class AT> template <class Col>
    inline void Matrix<General,Var,Fixed<N>,AT>::add(int i, const RowVector<Col,AT> &x) {
      FMATVEC_ASSERT(i<rows(), AT);
      FMATVEC_ASSERT(cols()==x.size(), AT);
      for(int j=0; j<cols(); j++)
        e(i,j) += x.e(j);
    }
 
  template <int N, class AT> template<class Type, class Row, class Col>
    inline void Matrix<General,Var,Fixed<N>,AT>::add(const Range<Var,Var> &I, const Range<Var,Var> &J, const Matrix<Type,Row,Col,AT> &A) {
 
      FMATVEC_ASSERT(I.end()<rows(), AT);
      FMATVEC_ASSERT(J.end()<cols(), AT);
      FMATVEC_ASSERT(I.size()==A.rows(), AT);
      FMATVEC_ASSERT(J.size()==A.cols(), AT);
 
      for(int i=I.start(), ii=0; i<=I.end(); i++, ii++)
        for(int j=J.start(), jj=0; j<=J.end(); j++, jj++)
          e(i,j) += A.e(ii,jj);
    }
 
  template <int N, class AT>
    inline Matrix<General,Var,Fixed<N>,AT>::operator std::vector<std::vector<AT>>() const {
      std::vector<std::vector<AT>> ret(rows(),std::vector<AT>(cols()));
      for(int r=0; r<rows(); r++) {
        for(int c=0; c<cols(); c++)
          ret[r][c]=e(r,c);
      }
      return ret;
    }
 
  template <int N, class AT>
    inline Matrix<General,Var,Fixed<N>,AT>::Matrix(const std::vector<std::vector<AT>> &m) : M(static_cast<int>(m.size())), ele(new AT[M*N]) {
      if((m.empty()?0:m[0].size()) != N)
        throw std::runtime_error("The input has "+std::to_string(m.empty()?0:m[0].size())+" columns but "+std::to_string(N)+" columns are required.");
      for(int r=0; r<rows(); r++) {
        if(static_cast<int>(m[r].size())!=cols())
          throw std::runtime_error("The rows of the input have different length.");
        for(int c=0; c<cols(); c++)
          e(r,c)=m[r][c];
      }
    }
 
 
  template <int N, class AT> template <class Type, class Row, class Col>
    inline Matrix<General,Var,Fixed<N>,AT>& Matrix<General,Var,Fixed<N>,AT>::copy(const Matrix<Type,Row,Col,AT> &A) {
      for(int i=0; i<M; i++) 
        for(int j=0; j<N; j++)
          e(i,j) = A.e(i,j);
      return *this;
    }
 
 
}
 
#endif