vector_interface.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2015:  G-CSC, Goethe University Frankfurt
 * Author: Martin Rupp
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * This program 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.
 */
 
#ifndef VECTOR_INTERFACE_H_
#define VECTOR_INTERFACE_H_
 
template <typename TValueType>
class Vector
{
public:
  typedef TValueType value_type;
  //typedef subvector<value_type> subvector_type;
  typedef Vector<TValueType> vector_type;
  typedef size_t size_type;
 
public:
  Vector();
 
  Vector(size_t _length);
 
  ~Vector();
 
  Vector(const vector_type & v);
 
public:
  bool resize(size_t new_length, bool bCopyValues=true);
 
  inline value_type &operator [] (size_t i);
  inline const value_type &operator [] (size_t i) const;
 
  template <typename V> bool add(const V& u);
  template <typename V> bool set(const V& u);
  template <typename V> bool get(V& u) const;
 
 
  double dotprod(const Vector &w); //const;
 
 
  //double energynorm2(const SparseMatrix &A) const;
  /*double energynorm(const SparseMatrix &A) const
  {
    return sqrt(energynorm2(A));
  }*/
 
  double operator = (double d);
  bool set(double d);
  bool set_random(double from, double to);
 
 
  void operator = (const Vector &v);
  void operator += (const Vector &v);
  void operator -= (const Vector &v);
 
  bool operator *= (const number &a);
 
  inline double norm() const;
 
  size_t size();
  void defragment();
 
public:
  /*size_t begin_index() { return 0;}
  size_t end_index() { return size();}
 
  value_type *begin() { return values + begin_index(); }
  value_type *end() { return values + end_index(); }*/
};
 
template<typename TValueType>
bool CloneVector(Vector<TValueType> &dest, const Vector<TValueType> src)
{
  // clone stuff like
  dest.resize(src.size());
}
 
#endif /* VECTOR_INTERFACE_H_ */