VectorMutable.h

#ifndef _theplu_yat_utility_vector_mutable_
#define _theplu_yat_utility_vector_mutable_

// $Id: VectorMutable.h 3661 2017-07-14 01:10:35Z peter $

/*
  Copyright (C) 2003 Daniel Dalevi, Peter Johansson
  Copyright (C) 2004 Jari Häkkinen, Peter Johansson
  Copyright (C) 2005 Jari Häkkinen, Peter Johansson, Markus Ringnér
  Copyright (C) 2006 Jari Häkkinen, Markus Ringnér
  Copyright (C) 2007 Jari Häkkinen, Peter Johansson, Markus Ringnér
  Copyright (C) 2008, 2009 Jari Häkkinen, Peter Johansson
  Copyright (C) 2012, 2016, 2017 Peter Johansson

  This file is part of the yat library, http://dev.thep.lu.se/trac/yat

  The yat library is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 3 of the
  License, or (at your option) any later version.

  The yat 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
  General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with yat. If not, see <http://www.gnu.org/licenses/>.
*/

#include "VectorBase.h"
#include "VectorExpression.h"
#include "StrideIterator.h"

#include <gsl/gsl_vector.h>

#include <cstddef> // size_t

namespace theplu {
namespace yat {
namespace utility {

  class matrix;
  class Vector;

  class VectorMutable : public VectorBase
  {
  public:
    typedef double& reference;

    typedef StrideIterator<double*> iterator;

    VectorMutable(void);

    VectorMutable(gsl_vector*);

    VectorMutable(const gsl_vector*);

    virtual ~VectorMutable(void);

    void all(double value);

    iterator begin(void);

    // to allow overload from base class
    using VectorBase::begin;

    void div(const VectorBase& other);

    iterator end(void);

    // to allow overload from base class
    using VectorBase::end;

    gsl_vector* gsl_vector_p(void);

    using VectorBase::gsl_vector_p;

    virtual bool isview(void) const=0;

    void mul(const VectorBase& other);

    void reverse(void);

    void swap(size_t i, size_t j);

    double& operator()(size_t i);

    // to allow overload from base class
    using VectorBase::operator();

    const VectorMutable& operator+=(const VectorBase&);

    template<class T>
    VectorMutable& operator+=(const VectorExpression<T>& rhs)
    {
      *this = *this + rhs;
      return *this;
    }

    const VectorMutable& operator+=(double d);

    const VectorMutable& operator-=(const VectorBase&);

    template<class T>
    VectorMutable& operator-=(const VectorExpression<T>& rhs)
    {
      *this = *this - rhs;
      return *this;
    }

    const VectorMutable& operator-=(double d);

    const VectorMutable& operator*=(double d);

    const VectorMutable& operator=(const VectorMutable&);

    const VectorMutable& operator=(const VectorBase&);

    template<class T>
    VectorMutable& operator=(const VectorExpression<T>& rhs)
    {
      assign(rhs.gsl_vector_p());
      return *this;
    }

  protected:
    gsl_vector* vec_;

  private:
    virtual const VectorMutable& assign(const VectorBase& rhs)=0;
    virtual const VectorMutable& assign(const gsl_vector* rhs)=0;
  };

  void shuffle(VectorMutable& invec);

  void sort(VectorMutable& vec);

}}} // of namespace utility, yat, and theplu

#endif