fixed_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 fixed_vector_h
#define fixed_vector_h
 
#include "fixed_general_matrix.h"
#include <vector>
#include <cstring>
#include <stdexcept>
 
namespace fmatvec {
 
  template <int M, class AT>
  class Vector<Fixed<M>,AT> : public Matrix<General,Fixed<M>,Fixed<1>,AT> {
    using Matrix<General,Fixed<M>,Fixed<1>,AT>::ele;
 
    public:
    static constexpr bool isVector {true};
 
    using iterator = AT *;
    using const_iterator = const AT *;
 
    using value_type = AT;
 
 
    protected:
 
    template<class Row> inline Vector<Fixed<M>,AT>& copy(const Vector<Row,AT> &x);
 
    
    public:
 
      explicit Vector(Noinit ini) : Matrix<General,Fixed<M>,Fixed<1>,AT>(ini) { }
      explicit Vector(Init ini=INIT, const AT &a=AT()) : Matrix<General,Fixed<M>,Fixed<1>,AT>(ini,a) { }
      explicit Vector(int m, Noinit ini) : Matrix<General,Fixed<M>,Fixed<1>,AT>(ini) { FMATVEC_ASSERT(m==M, AT); }
      explicit Vector(int m, Init ini=INIT, const AT &a=AT()) : Matrix<General,Fixed<M>,Fixed<1>,AT>(ini,a) { FMATVEC_ASSERT(m==M, AT); }
 
      Vector(const Vector<Fixed<M>,AT> &x) = default;
 
      template<class Row>
      Vector(const Vector<Row,AT> &A) : Matrix<General,Fixed<M>,Fixed<1>,AT>(A) {
      }
 
      template<class Type, class Row, class Col>
      explicit Vector(const Matrix<Type,Row,Col,AT> &A) : Matrix<General,Fixed<M>,Fixed<1>,AT>(A) {
      }
 
      Vector(const char *str) : Matrix<General,Fixed<M>,Fixed<1>,AT>(str) {
      }
 
      inline Vector<Fixed<M>,AT>& operator=(const Vector<Fixed<M>,AT> &x) = default;
 
      template <class Row>
      inline Vector<Fixed<M>,AT>& operator=(const Vector<Row,AT> &x) {
        FMATVEC_ASSERT(x.size() == M, AT);
        return copy(x);
      }
 
      template <class Row>
      inline Vector<Fixed<M>,AT>& operator<<=(const Vector<Row,AT> &x) { return operator=(x); }
 
      template <class AT2>
      operator Vector<Fixed<M>,AT2>() const {
        Vector<Fixed<M>,AT2> ret;
        for(size_t i=0; i<M; ++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][0]; }
      iterator end() { return &ele[M-1][1]; }
      const_iterator begin() const { return &ele[0][0]; }
      const_iterator end() const { return &ele[M-1][1]; }
      const_iterator cbegin() const noexcept { return &ele[0][0]; }
      const_iterator cend() const noexcept { return &ele[M-1][1]; }
 
      AT& e(int i) {
    return ele[i][0];
      }
 
      const AT& e(int i) const {
    return ele[i][0];
      }
 
      inline Vector<Fixed<M>,AT>& init(const AT& val=AT());
      inline Vector<Fixed<M>,AT>& init(Init, const AT& a=AT()) { return init(a); }
      inline Vector<Fixed<M>,AT>& init(Noinit, const AT& a=AT()) { return *this; }
 
      constexpr int size() const {return M;}
 
      void resize(int m) {
        if(m!=M)
          throw std::runtime_error("A fixed vector cannot be resized.");
      }
 
      int inc() const {return 1;}
 
      template <int M1, int M2>
      inline const Vector<Fixed<M2-M1+1>,AT> operator()(const Range<Fixed<M1>,Fixed<M2>> &I) const;
 
      using Matrix<General,Fixed<M>,Fixed<1>,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 ele[0][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,Fixed<M>,Fixed<1>,AT>(x) { }
 
      inline const RowVector<Fixed<M>,AT> T() const;
 
      template<class Type, class Row, class Col>
      inline void set(const Range<Var,Var> &I, const Matrix<Type,Row,Col,AT> &A);
  };
 
  template <int M, class AT>
    inline Vector<Fixed<M>,AT>& Vector<Fixed<M>,AT>::init(const AT &val) {
      for(int i=0; i<M; i++) 
    e(i) = val; 
      return *this;
    }
 
  template <int M, class AT> template <int M1, int M2>
    inline const Vector<Fixed<M2-M1+1>,AT> Vector<Fixed<M>,AT>::operator()(const Range<Fixed<M1>,Fixed<M2>> &I) const {
      FMATVEC_ASSERT(M2<M, AT);
      Vector<Fixed<M2-M1+1>,AT> x(NONINIT);
 
      for(int i=0; i<x.size(); i++) 
        x.e(i) = e(M1+i);
 
      return x;
    }
 
  template <int M, class AT>
    inline const RowVector<Fixed<M>,AT> Vector<Fixed<M>,AT>::T() const {
      RowVector<Fixed<M>,AT> x(NONINIT);
      for(int i=0; i<M; i++)
    x.e(i) = e(i);
      return x;
    }
 
  template <int M, class AT>
   inline Vector<Fixed<M>,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 <int M, class AT>
    inline Vector<Fixed<M>,AT>::Vector(const std::vector<AT> &v) : Matrix<General,Fixed<M>,Fixed<1>,AT>(NONINIT) {
      for(int i=0; i<size(); ++i)
        e(i) = v[i];
    }
 
 
  template <int M, class AT> template<class Row>
    inline Vector<Fixed<M>,AT>& Vector<Fixed<M>,AT>::copy(const Vector<Row,AT> &x) {
      for(int i=0; i<M; i++)
    e(i) = x.e(i);
      return *this;
    }
 
 
  template<int M, class AT> template<class Type, class Row, class Col>
  inline void Vector<Fixed<M>,AT>::set(const Range<Var,Var> &I, const Matrix<Type,Row,Col,AT> &A) {
      Matrix<General,Fixed<M>,Fixed<1>,AT>::set(I, Range<Var,Var>(0,0), A);
  }
 
}
 
#endif