vector.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 vector_h
#define vector_h
 
#include "general_matrix.h"
#include <vector>
#include <cstring>
 
namespace fmatvec {
 
  template <class AT> class Vector<Ref,AT> : public Matrix<General,Ref,Ref,AT> {
    using Matrix<General,Ref,Ref,AT>::m;
    using Matrix<General,Ref,Ref,AT>::n;
    using Matrix<General,Ref,Ref,AT>::lda;
    using Matrix<General,Ref,Ref,AT>::ele;
    using Matrix<General,Ref,Ref,AT>::memory;
    using Matrix<General,Ref,Ref,AT>::elePtr;
 
    public:
    static constexpr bool isVector {true};
 
    using iterator = AT *;
    using const_iterator = const AT *;
 
    using value_type = AT;
 
 
    friend class RowVector<Ref,AT>;
 
    protected:
 
    template<class Row> inline Vector<Ref,AT>& copy(const Vector<Row,AT> &x);
 
    AT* elePtr(int i) {
      return ele+i;
    }
 
    const AT* elePtr(int i) const {
      return ele+i;
    }
 
    
    public:
 
      explicit Vector() : Matrix<General,Ref,Ref,AT>() { n=1; }
 
      explicit Vector(int m, Noinit ini) : Matrix<General,Ref,Ref,AT>(m,1,ini) { } 
      explicit Vector(int m, Init ini=INIT, const AT &a=AT()) : Matrix<General,Ref,Ref,AT>(m,1,ini,a) { } 
 
      Vector(const Vector<Ref,AT> &x) : Matrix<General,Ref,Ref,AT>(x) {
      }
 
      template<class Row>
      Vector(const Vector<Row,AT> &x) : Matrix<General,Ref,Ref,AT>(x) {
      }
 
      template<class Type, class Row, class Col>
      explicit Vector(const Matrix<Type,Row,Col,AT> &x) : Matrix<General,Ref,Ref,AT>(x) {
    FMATVEC_ASSERT(x.cols()==1, AT);
      }
 
      explicit Vector(int m, AT* ele) : Matrix<General,Ref,Ref,AT>(m,1,ele) { 
      }
 
      Vector(const char *str) : Matrix<General,Ref,Ref,AT>(str) {
    FMATVEC_ASSERT(n==1, AT);
      }
 
      Vector<Ref,AT>& resize(int m, Noinit) {
        Matrix<General,Ref,Ref,AT>::resize(m,1,Noinit());
        return *this;
      }
 
      Vector<Ref,AT>& resize(int m, Init ini=INIT, const AT &a=AT()) {
        Matrix<General,Ref,Ref,AT>::resize(m,1,ini,a);
        return *this;
      }
 
      inline Vector<Ref,AT>& operator=(const Vector<Ref,AT> &x) {
        FMATVEC_ASSERT(m == x.size(), AT);
        return copy(x);
      }
 
      template <class Row>
      inline Vector<Ref,AT>& operator=(const Vector<Row,AT> &x) {
        FMATVEC_ASSERT(m == x.size(), AT);
        return copy(x);
      }
 
      inline Vector<Ref,AT>& operator&=(Vector<Ref,AT> &x) {
        m = x.m; 
        n = 1;
        memory = x.memory;
        ele = x.ele;
        lda = x.lda;
        return *this;
      }
 
      inline Vector<Ref,AT>& operator&=(Matrix<General,Ref,Ref,AT> &A) {
        FMATVEC_ASSERT(A.cols() == 1, AT);
        m = A.rows(); 
        n = 1;
        memory = A.memory;
        ele = A.ele;
        lda = A.lda;
        return *this;
      }
 
      template <class Row>
      inline Vector<Ref,AT>& operator<<=(const Vector<Row,AT> &x) {
        if(m!=x.size()) resize(x.size(),NONINIT);
        return copy(x);
      }
 
      template <class AT2>
      operator Vector<Ref,AT2>() const {
        Vector<Ref,AT2> ret(size());
        for(size_t i=0; i<size(); ++i)
          ret(i) = (*this)(i);
        return ret;
      }
 
      AT& operator()(int i) {
 
    FMATVEC_ASSERT(i>=0, AT);
    FMATVEC_ASSERT(i<m, AT);
 
    return e(i);
      }
 
      const AT& operator()(int i) const {
 
    FMATVEC_ASSERT(i>=0, AT);
    FMATVEC_ASSERT(i<m, AT);
 
    return e(i);
      }
 
      iterator begin() { return &ele[0]; }
      iterator end() { return &ele[m]; }
      const_iterator begin() const { return &ele[0]; }
      const_iterator end() const { return &ele[m]; }
      const_iterator cbegin() const noexcept { return &ele[0]; }
      const_iterator cend() const noexcept { return &ele[m]; }
 
      AT& e(int i) {
    return ele[i];
      }
 
      const AT& e(int i) const {
    return ele[i];
      }
 
      inline Vector<Ref,AT>& init(const AT& val=AT()); 
      inline Vector<Ref,AT>& init(Init, const AT& a=AT()) { return init(a); }
      inline Vector<Ref,AT>& init(Noinit, const AT& a=AT()) { return *this; }
 
      int size() const {return m;}
 
      int inc() const {return 1;}
 
      inline const Vector<Ref,AT> operator()(const Range<Var,Var> &I) const;
 
      AT* operator()() { return Matrix<General, Ref, Ref, AT>::operator()(); }
      const AT* operator()() const { return Matrix<General, Ref, Ref, AT>::operator()(); }
 
      explicit inline operator std::vector<AT>() const;
 
      explicit inline Vector(const std::vector<AT> &v);
 
//      /*! \brief Cast to AT.
//       *
//       * \return The AT representation of the vector
//       * */
//      explicit operator AT() const {
//        FMATVEC_ASSERT(m==1, AT);
//        return e(0);
//      }
//
//      /*! \brief AT Constructor.
//       * Constructs and initializes a vector with a AT object.
//       * \param x The AT the vector will be initialized with.
//       * */
//      explicit Vector(const AT &x) : Matrix<General,Ref,Ref,AT>(x) { }
 
      template<class Row> inline void set(const Range<Var,Var> &I, const Vector<Row,AT> &x);
 
      template<class Row> inline void add(const Range<Var,Var> &I, const Vector<Row,AT> &x);
 
      inline const Vector<Ref,AT> operator()(const Indices &I) const;
 
      template<class Row> inline void set(const Indices &I, const Vector<Row,AT> &x);
 
      inline void ref(Vector<Ref,AT> &x, const Range<Var,Var> &I);
 
      inline void ref(Matrix<General,Ref,Ref,AT> &A, int j);
 
      inline void ref(Matrix<General,Ref,Ref,AT> &A, const Range<Var,Var> &I, int j);
 
      const RowVector<Ref,AT> T() const;
  };
 
  template <class AT>
    inline Vector<Ref,AT>& Vector<Ref,AT>::init(const AT &val) {
      for(int i=0; i<m; i++)
        e(i) = val;
      return *this;
    }
 
  template <class AT>
    inline const Vector<Ref,AT> Vector<Ref,AT>::operator()(const Range<Var,Var> &I) const {
 
      FMATVEC_ASSERT(I.end()<m, AT);
 
      Vector<Ref,AT> x(I.size(),NONINIT);
 
      for(int i=0; i<x.size(); i++)
        x.e(i) = e(I.start()+i);
 
      return x;
    }
 
  template <class AT>
    inline Vector<Ref,AT>::operator std::vector<AT>() const {
      std::vector<AT> ret(size());
      for(int i=0; i<size(); ++i)
        ret[i] = e(i);
      return ret;
    }
 
  template <class AT>
    inline Vector<Ref,AT>::Vector(const std::vector<AT> &v) : Matrix<General,Ref,Ref,AT>(v.size(),1,NONINIT) {
      for(int i=0; i<size(); ++i)
        e(i) = v[i];
    }
 
 
  template <class AT> template <class Row>
    inline Vector<Ref,AT>& Vector<Ref,AT>::copy(const Vector<Row,AT> &x) {
      for(int i=0; i<size(); i++)
        e(i) = x.e(i);
      return *this;
    }
 
  template <class AT> template<class Row>
    inline void Vector<Ref,AT>::set(const Range<Var,Var> &I, const Vector<Row,AT> &x) {
 
      FMATVEC_ASSERT(I.end()<size(), AT);
      FMATVEC_ASSERT(I.size()==x.size(), AT);
 
      for(int i=I.start(), ii=0; i<=I.end(); i++, ii++)
          e(i) = x.e(ii);
    }
 
  template <class AT> template<class Row>
    inline void Vector<Ref,AT>::add(const Range<Var,Var> &I, const Vector<Row,AT> &x) {
 
      FMATVEC_ASSERT(I.end()<size(), AT);
      FMATVEC_ASSERT(I.size()==x.size(), AT);
 
      for(int i=I.start(), ii=0; i<=I.end(); i++, ii++)
          e(i) += x.e(ii);
    }
 
  template <class AT>
    inline const Vector<Ref,AT> Vector<Ref,AT>::operator()(const Indices &I) const {
      FMATVEC_ASSERT(I.max()<size(), AT);
 
      Vector<Ref,AT> x(I.size(),NONINIT);
 
      for(int i=0; i<x.size(); i++)
    x.e(i) = e(I[i]);
 
      return x;
    }
 
  template <class AT> template <class Row>
    inline void Vector<Ref,AT>::set(const Indices &I, const Vector<Row,AT> &x) {
      FMATVEC_ASSERT(I.max()<size(), AT);
      FMATVEC_ASSERT(I.size()==x.size(), AT);
      for(int i=0; i<I.size(); i++)
    e(I[i]) = x.e(i);
    }
 
  template <class AT>
    inline void Vector<Ref,AT>::ref(Vector<Ref,AT> &x, const Range<Var,Var> &I) {
 
      FMATVEC_ASSERT(I.end()<x.size(), AT);
 
      m=I.size();
      n=1;
      memory = x.memory;
      ele = x.elePtr(I.start());
      lda = x.lda;
    }
 
  template <class AT>
    inline void Vector<Ref,AT>::ref(Matrix<General,Ref,Ref,AT> &A, int j) {
 
      FMATVEC_ASSERT(j<A.cols(), AT);
 
      m=A.rows();
      n=1;
      memory = A.memory;
      ele = A.elePtr(0,j);
      lda = A.lda;
    }
 
  template <class AT>
    inline void Vector<Ref,AT>::ref(Matrix<General,Ref,Ref,AT> &A, const Range<Var,Var> &I, int j) {
 
      FMATVEC_ASSERT(I.end()<A.rows(), AT);
      FMATVEC_ASSERT(j<A.cols(), AT);
 
      m=I.size();
      n=1;
      memory = A.memory;
      ele = A.elePtr(I.start(),j);
      lda = A.lda;
    }
 
  template <class AT>
    inline const RowVector<Ref,AT> Vector<Ref,AT>::T() const {
      RowVector<Ref,AT> x(m,NONINIT);
      for(int i=0; i<m; i++)
        x.e(i) = e(i);
      return x;
    }
 
 
}
 
#endif