ProtoMol - an object-oriented component based framework for Molecular Dynamics simulations.
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members

ProtoMol::Vector3D Class Reference

#include <Vector3D.h>

List of all members.

Public Member Functions

 Vector3D ()
 Vector3D (Real X, Real Y, Real Z)
 Vector3D (const Vector3D &c)
Vector3D & operator= (const Vector3D &c)
Real operator[] (int index) const
Real & operator[] (int index)
Vector3D operator+ (const Vector3D &b) const
Vector3D add (const Vector3D &b) const
Vector3D operator- (const Vector3D &b) const
Vector3D subtract (const Vector3D &b) const
Real operator * (const Vector3D &b) const
Real dot (const Vector3D &b) const
Vector3D operator^ (const Vector3D &b) const
Vector3D cross (const Vector3D &b) const
Vector3D operator * (Real w) const
Vector3D multiply (Real w) const
Vector3D operator/ (Real w) const
Vector3D divide (Real w) const
Vector3D operator- () const
bool operator== (const Vector3D &b) const
bool operator!= (const Vector3D &b) const
Vector3D & operator+= (const Vector3D &b)
Vector3D & intoAdd (const Vector3D &b)
Vector3D & operator-= (const Vector3D &b)
Vector3D & intoSubtract (const Vector3D &b)
Vector3D & operator *= (Real w)
Vector3D & intoMultiply (Real w)
Vector3D & operator/= (Real w)
Vector3D & intoDivide (Real w)
Vector3D & intoWeightedAdd (Real w, const Vector3D &b)
Vector3D & intoWeightedSubtract (Real w, const Vector3D &b)
Real normSquared () const
Real norm () const
Real normalize ()
Vector3D normalized () const

Public Attributes

Real x
Real y
Real z

Friends

std::ostream & operator<< (std::ostream &OS, const Vector3D &coords)
std::istream & operator>> (std::istream &OS, Vector3D &coords)
Report::MyStreamer & operator<< (Report::MyStreamer &OS, const Vector3D &coords)

Detailed Description

Container to hold 3D vector/coordinate

Constructor & Destructor Documentation

ProtoMol::Vector3D::Vector3D (   )  [inline]
 

ProtoMol::Vector3D::Vector3D (  Real  X,
Real  Y,
Real  Z
)  [inline]
 

ProtoMol::Vector3D::Vector3D (  const Vector3D &  c  )  [inline]
 

Member Function Documentation

Vector3D ProtoMol::Vector3D::add (  const Vector3D &  b  )  const [inline]
 

Vector3D ProtoMol::Vector3D::cross (  const Vector3D &  b  )  const [inline]
 

cross product

Vector3D ProtoMol::Vector3D::divide (  Real  w  )  const [inline]
 

Real ProtoMol::Vector3D::dot (  const Vector3D &  b  )  const [inline]
 

dot product

Vector3D& ProtoMol::Vector3D::intoAdd (  const Vector3D &  b  )  [inline]
 

Vector3D& ProtoMol::Vector3D::intoDivide (  Real  w  )  [inline]
 

Vector3D& ProtoMol::Vector3D::intoMultiply (  Real  w  )  [inline]
 

Vector3D& ProtoMol::Vector3D::intoSubtract (  const Vector3D &  b  )  [inline]
 

Vector3D& ProtoMol::Vector3D::intoWeightedAdd (  Real  w,
const Vector3D &  b
)  [inline]
 

Vector3D& ProtoMol::Vector3D::intoWeightedSubtract (  Real  w,
const Vector3D &  b
)  [inline]
 

Vector3D ProtoMol::Vector3D::multiply (  Real  w  )  const [inline]
 

Real ProtoMol::Vector3D::norm (   )  const [inline]
 

Real ProtoMol::Vector3D::normalize (   )  [inline]
 

Normalize the Vector3D and return the original length.

Vector3D ProtoMol::Vector3D::normalized (   )  const [inline]
 

Return a normalized Vector3D, leave the original Vector3D unchanged.

Real ProtoMol::Vector3D::normSquared (   )  const [inline]
 

Vector3D ProtoMol::Vector3D::operator * (  Real  w  )  const [inline]
 

Real ProtoMol::Vector3D::operator * (  const Vector3D &  b  )  const [inline]
 

dot product

Vector3D& ProtoMol::Vector3D::operator *= (  Real  w  )  [inline]
 

bool ProtoMol::Vector3D::operator!= (  const Vector3D &  b  )  const [inline]
 

Vector3D ProtoMol::Vector3D::operator+ (  const Vector3D &  b  )  const [inline]
 

Vector3D& ProtoMol::Vector3D::operator+= (  const Vector3D &  b  )  [inline]
 

Vector3D ProtoMol::Vector3D::operator- (   )  const [inline]
 

Vector3D ProtoMol::Vector3D::operator- (  const Vector3D &  b  )  const [inline]
 

Vector3D& ProtoMol::Vector3D::operator-= (  const Vector3D &  b  )  [inline]
 

Vector3D ProtoMol::Vector3D::operator/ (  Real  w  )  const [inline]
 

Vector3D& ProtoMol::Vector3D::operator/= (  Real  w  )  [inline]
 

Vector3D& ProtoMol::Vector3D::operator= (  const Vector3D &  c  )  [inline]
 

bool ProtoMol::Vector3D::operator== (  const Vector3D &  b  )  const [inline]
 

Real& ProtoMol::Vector3D::operator[] (  int  index  )  [inline]
 

Index access.

Real ProtoMol::Vector3D::operator[] (  int  index  )  const [inline]
 

Index access.

Vector3D ProtoMol::Vector3D::operator^ (  const Vector3D &  b  )  const [inline]
 

cross product

Vector3D ProtoMol::Vector3D::subtract (  const Vector3D &  b  )  const [inline]
 

Friends And Related Function Documentation

Report::MyStreamer& operator<< (  Report::MyStreamer &  OS,
const Vector3D &  coords
)  [friend]
 

std::ostream& operator<< (  std::ostream &  OS,
const Vector3D &  coords
)  [friend]
 

std::istream& operator>> (  std::istream &  OS,
Vector3D &  coords
)  [friend]
 

Member Data Documentation

Real ProtoMol::Vector3D::x
 

Real ProtoMol::Vector3D::y
 

Real ProtoMol::Vector3D::z
 

The documentation for this class was generated from the following file: Last update: . GNU GENERAL PUBLIC LICENSE, copyrighted by the University of Notre Dame and the University of Bergen, Norway.