| 1 | /*
 | 
|---|
| 2 |  * VectorInterface.hpp
 | 
|---|
| 3 |  *
 | 
|---|
| 4 |  *  Created on: Jul 29, 2010
 | 
|---|
| 5 |  *      Author: heber
 | 
|---|
| 6 |  */
 | 
|---|
| 7 | 
 | 
|---|
| 8 | #ifndef VECTORINTERFACE_HPP_
 | 
|---|
| 9 | #define VECTORINTERFACE_HPP_
 | 
|---|
| 10 | 
 | 
|---|
| 11 | // include config.h
 | 
|---|
| 12 | #ifdef HAVE_CONFIG_H
 | 
|---|
| 13 | #include <config.h>
 | 
|---|
| 14 | #endif
 | 
|---|
| 15 | 
 | 
|---|
| 16 | 
 | 
|---|
| 17 | #include <cstring>
 | 
|---|
| 18 | #include <iostream>
 | 
|---|
| 19 | 
 | 
|---|
| 20 | class Vector;
 | 
|---|
| 21 | 
 | 
|---|
| 22 | /** Contains all functions of the class Vector as virtual definitions, to give any
 | 
|---|
| 23 |  * class derived from it the interface of a Vector, i.e. Vector-like abilities
 | 
|---|
| 24 |  * (i.e. the scaffold design pattern).
 | 
|---|
| 25 |  */
 | 
|---|
| 26 | class VectorInterface  {
 | 
|---|
| 27 | public:
 | 
|---|
| 28 | 
 | 
|---|
| 29 |   // Accessors ussually come in pairs... and sometimes even more than that
 | 
|---|
| 30 |   virtual const double& operator[](size_t i) const = 0;
 | 
|---|
| 31 |   virtual const double& at(size_t i) const = 0;
 | 
|---|
| 32 |   virtual void set(size_t i, const double value) = 0;
 | 
|---|
| 33 |   virtual const Vector& getPosition() const = 0;
 | 
|---|
| 34 | 
 | 
|---|
| 35 |   // Assignment operator
 | 
|---|
| 36 |   virtual void setPosition(const Vector& _vector) = 0;
 | 
|---|
| 37 | 
 | 
|---|
| 38 |   // operators for mathematical operations
 | 
|---|
| 39 |   virtual const VectorInterface& operator+=(const Vector& b) = 0;
 | 
|---|
| 40 |   virtual const VectorInterface& operator-=(const Vector& b) = 0;
 | 
|---|
| 41 |   virtual Vector const operator+(const Vector& b) const = 0;
 | 
|---|
| 42 |   virtual Vector const operator-(const Vector& b) const = 0;
 | 
|---|
| 43 | 
 | 
|---|
| 44 |   virtual void Zero() = 0;
 | 
|---|
| 45 |   virtual void One(const double one) = 0;
 | 
|---|
| 46 |   virtual void LinearCombinationOfVectors(const Vector &x1, const Vector &x2, const Vector &x3, const double * const factors) = 0;
 | 
|---|
| 47 | 
 | 
|---|
| 48 |   virtual double distance(const Vector &point) const = 0;
 | 
|---|
| 49 |   virtual double DistanceSquared(const Vector &y) const = 0;
 | 
|---|
| 50 |   virtual double distance(const VectorInterface &_atom) const = 0;
 | 
|---|
| 51 |   virtual double DistanceSquared(const VectorInterface &_atom) const = 0;
 | 
|---|
| 52 | 
 | 
|---|
| 53 |   virtual void ScaleAll(const double *factor) = 0;
 | 
|---|
| 54 |   virtual void ScaleAll(const Vector &factor) = 0;
 | 
|---|
| 55 |   virtual void Scale(const double factor) = 0;
 | 
|---|
| 56 | 
 | 
|---|
| 57 |   virtual std::ostream & operator << (std::ostream &ost) const = 0;
 | 
|---|
| 58 | 
 | 
|---|
| 59 | protected:
 | 
|---|
| 60 |   /** Constructor and destructor are protected as VectorInterface should never
 | 
|---|
| 61 |    * be instantiated by itself but only as a derived class.
 | 
|---|
| 62 |    */
 | 
|---|
| 63 |   VectorInterface();
 | 
|---|
| 64 |   ~VectorInterface();
 | 
|---|
| 65 | };
 | 
|---|
| 66 | 
 | 
|---|
| 67 | #endif /* VECTORINTERFACE_HPP_ */
 | 
|---|