vector.h

Go to the documentation of this file.

/*
 * Copyright (c) 2009-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 __H__UG__CPU_ALGEBRA__VECTOR__
#define __H__UG__CPU_ALGEBRA__VECTOR__
 
#include "sparsematrix.h"
 
#include "../common/template_expressions.h"
#include "../common/operations.h"
#include "common/util/smart_pointer.h"
#include <vector>
//#include "../vector_interface/ivector.h"
 
namespace ug{
//              Vector
 
 
template <typename TValueType>
class Vector //: public IVector
{
public:
  typedef TValueType value_type;
  //typedef subvector<value_type> subvector_type;
  typedef Vector<TValueType> vector_type;
 
//  IVECTOR_TO_VEC_FUNCTIONS(vector_type)
 
  Vector();
 
  Vector(size_t size);
 
  virtual ~Vector();
 
  Vector(const vector_type & v)
  {
    m_capacity = 0;
    m_size = 0; values = NULL;
    create(v.m_size);
    operator =(v);
  }
 
public:
  void create(size_t size);
  void create(const Vector &v);
  
  SmartPtr<vector_type> clone() const;
 
  SmartPtr<vector_type> clone_without_values() const;
 
  void resize_sloppy(size_t newSize, bool bCopyValues=true);  
  
  void resize_exactly(size_t newSize, bool bCopyValues=true); 
  
  void reserve_exactly(size_t newCapacity, bool bCopyValues);
  
  void reserve_sloppy(size_t newCapacity, bool bCopyValues=true);
  
  void resize(size_t newSize, bool bCopyValues=true)
  {
    resize_exactly(newSize, bCopyValues);
  }
  void reserve(size_t newCapacity, bool bCopyValues=true)
  {
    reserve_exactly(newCapacity, bCopyValues);
  }
  
  size_t capacity() const
  {
    return m_capacity;
  }
 
  inline value_type &operator [] (size_t i);
  inline const value_type &operator [] (size_t i) const;
 
 
  double dotprod(const Vector &w); //const;
 
  // deprecated, use x.T() * y.
  //inline double operator *(const Vector &w); ///< shortcut for .dotprod(w)
 
  //double energynorm2(const SparseMatrix &A) const;
  /*double energynorm(const SparseMatrix &A) const
  {
    return sqrt(energynorm2(A));
  }*/
 
  double operator = (double d);
  void set(double d) { operator = (d);}
  void set_random(double from, double to);
 
  template <typename V> void add(const V& u);
  template <typename V> void set(const V& u);
  template <typename V> void get(V& u) const;
 
 
  void add(const value_type *u, const size_t *indices, size_t nr);
  void set(const value_type *u, const size_t *indices, size_t nr);
  void get(value_type *u, const size_t *indices, size_t nr) const;
 
 
  //template<typename T> inline void apply(Operation_type op, const T &t);
 
  inline void operator = (const Vector &v);
  inline void operator += (const Vector &v);
  inline void operator -= (const Vector &v);
 
  inline void operator *= (const number &a)
  {
    for(size_t i=0; i<size(); i++) values[i] *= a;
  }
 
  inline double norm() const;
 
  inline double maxnorm() const;
 
  size_t size() const { return m_size; }
 
 
public: // output functions
  void print(const char * const text = NULL) const;
  void p() {print(); } 
 
  friend std::ostream &operator<<(std::ostream &output, const Vector &v)
  {
    output << "Vector " <<  "[" << v.m_size << "]";
    return output;
  }
 
  size_t defragment() { return true; }
 
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(); }*/
 
protected:
 
  virtual vector_type* virtual_clone() const;
 
 
  virtual vector_type* virtual_clone_without_values() const;
 
private:
  void destroy();
 
  size_t m_size;      
  size_t m_capacity;    
  value_type *values;   
 
  //mutable vector_mode dist_mode;
};
 
// end group cpu_algebra
 
} // namespace ug
 
#include "vector_impl.h"
 
#endif