FGColumnVector3 Class Reference

This class implements a 3 element column vector. More...

#include <FGColumnVector3.h>

Public Member Functions
	FGColumnVector3 (void)
	Default initializer. More...
	FGColumnVector3 (const double X, const double Y, const double Z)
	Initialization by given values. More...
	FGColumnVector3 (const FGColumnVector3 &v)
	Copy constructor. More...
	~FGColumnVector3 (void)
	Destructor.
std::string	Dump (const std::string &delimeter) const
	Prints the contents of the vector. More...
double	Entry (const unsigned int idx) const
	Read access the entries of the vector. More...
double &	Entry (const unsigned int idx)
	Write access the entries of the vector. More...
void	InitMatrix (void)
void	InitMatrix (const double a)
void	InitMatrix (const double a, const double b, const double c)
double	Magnitude (void) const
	Length of the vector. More...
double	Magnitude (const int idx1, const int idx2) const
	Length of the vector in a coordinate axis plane. More...
FGColumnVector3 &	Normalize (void)
	Normalize. More...
bool	operator!= (const FGColumnVector3 &b) const
	Comparison operator. More...
double	operator() (const unsigned int idx) const
	Read access the entries of the vector. More...
double &	operator() (const unsigned int idx)
	Write access the entries of the vector. More...
FGColumnVector3	operator* (const double scalar) const
	Multiplication by a scalar. More...
FGColumnVector3	operator* (const FGColumnVector3 &V) const
	Cross product multiplication. More...
FGColumnVector3 &	operator*= (const double scalar)
	Scale by a scalar.
FGColumnVector3	operator+ (const FGColumnVector3 &B) const
	Addition operator.
FGColumnVector3 &	operator+= (const FGColumnVector3 &B)
	Add an other vector.
FGColumnVector3	operator- (const FGColumnVector3 &B) const
	Subtraction operator.
FGColumnVector3 &	operator-= (const FGColumnVector3 &B)
	Subtract an other vector.
FGColumnVector3	operator/ (const double scalar) const
	Multiply by 1/scalar. More...
FGColumnVector3 &	operator/= (const double scalar)
	Scale by a 1/scalar.
FGColumnVector3 &	operator= (const FGColumnVector3 &b)
	Assignment operator. More...
bool	operator== (const FGColumnVector3 &b) const
	Comparison operator. More...

Detailed Description

This class implements a 3 element column vector.

Author

Jon S. Berndt, Tony Peden, et. al.

Version

Id

FGColumnVector3.h,v 1.18 2013/11/30 10:25:33 bcoconni Exp

Definition at line 70 of file FGColumnVector3.h.

Constructor & Destructor Documentation

FGColumnVector3() [1/3]

FGColumnVector3

(

void

)

Default initializer.

Create a zero vector.

Definition at line 58 of file FGColumnVector3.cpp.

{
  data[0] = data[1] = data[2] = 0.0;
  // Debug(0);
}

Here is the caller graph for this function:

FGColumnVector3() [2/3]

FGColumnVector3 ( const double  X, const double  Y, const double  Z  )

inline

Initialization by given values.

Parameters

X	value of the x-conponent.
Y	value of the y-conponent.
Z	value of the z-conponent. Create a vector from the doubles given in the arguments.

Definition at line 82 of file FGColumnVector3.h.

                                                                  {
    data[0] = X;
    data[1] = Y;
    data[2] = Z;
  }

FGColumnVector3() [3/3]

FGColumnVector3 ( const FGColumnVector3 &  v )

inline

Copy constructor.

Parameters

v	Vector which is used for initialization. Create copy of the vector given in the argument.

Definition at line 91 of file FGColumnVector3.h.

                                            {
    data[0] = v.data[0];
    data[1] = v.data[1];
    data[2] = v.data[2];
  }

Member Function Documentation

Dump()

string Dump

(

const std::string &

delimeter

)

const

Prints the contents of the vector.

Parameters

delimeter

the item separator (tab or comma)

Returns

a string with the delimeter-separated contents of the vector

Definition at line 66 of file FGColumnVector3.cpp.

{
  ostringstream buffer;
  buffer << std::setprecision(16) << data[0] << delimiter;
  buffer << std::setprecision(16) << data[1] << delimiter;
  buffer << std::setprecision(16) << data[2];
  return buffer.str();
}

Here is the caller graph for this function:

Entry() [1/2]

double Entry ( const unsigned int  idx ) const

inline

Read access the entries of the vector.

Parameters

idx

the component index. Return the value of the matrix entry at the given index. Indices are counted starting with 1. This function is just a shortcut for the double operator()(unsigned int idx) const function. It is used internally to access the elements in a more convenient way. Note that the index given in the argument is unchecked.

Definition at line 122 of file FGColumnVector3.h.

{ return data[idx-1]; }

Here is the caller graph for this function:

Entry() [2/2]

double& Entry ( const unsigned int  idx )

inline

Write access the entries of the vector.

Parameters

idx

the component index. Return a reference to the vector entry at the given index. Indices are counted starting with 1. This function is just a shortcut for the double& operator()(unsigned int idx) function. It is used internally to access the elements in a more convenient way. Note that the index given in the argument is unchecked.

Definition at line 132 of file FGColumnVector3.h.

{ return data[idx-1]; }

Here is the call graph for this function:

Magnitude() [1/2]

double Magnitude

(

void

)

const

Length of the vector.

Compute and return the euclidean norm of this vector.

Definition at line 112 of file FGColumnVector3.cpp.

{
  return sqrt( data[0]*data[0] +  data[1]*data[1] +  data[2]*data[2] );
}

Here is the caller graph for this function:

Magnitude() [2/2]

double Magnitude	(	const int	idx1,
		const int	idx2
	)		const

Length of the vector in a coordinate axis plane.

Compute and return the euclidean norm of this vector projected into the coordinate axis plane idx1-idx2.

Definition at line 131 of file FGColumnVector3.cpp.

                                                                      {
  return sqrt( data[idx1-1]*data[idx1-1] +  data[idx2-1]*data[idx2-1] );
}

Normalize()

FGColumnVector3 & Normalize

(

void

)

Normalize.

Normalize the vector to have the Magnitude() == 1.0. If the vector is equal to zero it is left untouched.

Definition at line 119 of file FGColumnVector3.cpp.

{
  double Mag = Magnitude();

  if (Mag != 0.0)
    operator*=( 1.0/Mag );

  return *this;
}

Here is the caller graph for this function:

operator!=()

bool operator!= ( const FGColumnVector3 &  b ) const

inline

Comparison operator.

Parameters

b	other vector. Returns false if both vectors are exactly the same.

Definition at line 159 of file FGColumnVector3.h.

{ return ! operator==(b); }

Here is the call graph for this function:

operator()() [1/2]

double operator() ( const unsigned int  idx ) const

inline

Read access the entries of the vector.

Parameters

idx	the component index. Return the value of the matrix entry at the given index. Indices are counted starting with 1. Note that the index given in the argument is unchecked.

Definition at line 105 of file FGColumnVector3.h.

{ return data[idx-1]; }

operator()() [2/2]

double& operator() ( const unsigned int  idx )

inline

Write access the entries of the vector.

Parameters

idx	the component index. Return a reference to the vector entry at the given index. Indices are counted starting with 1. Note that the index given in the argument is unchecked.

Definition at line 112 of file FGColumnVector3.h.

{ return data[idx-1]; }

operator*() [1/2]

FGColumnVector3 operator* ( const double  scalar ) const

inline

Multiplication by a scalar.

Parameters

scalar

scalar value to multiply the vector with.

Returns

The resulting vector from the multiplication with that scalar. Multiply the vector with the scalar given in the argument.

Definition at line 165 of file FGColumnVector3.h.

                                                       {
    return FGColumnVector3(scalar*data[0], scalar*data[1], scalar*data[2]);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

operator*() [2/2]

FGColumnVector3 operator* ( const FGColumnVector3 &  V ) const

inline

Cross product multiplication.

Parameters

V	vector to multiply with.

Returns

The resulting vector from the cross product multiplication. Compute and return the cross product of the current vector with the given argument.

Definition at line 180 of file FGColumnVector3.h.

                                                            {
    return FGColumnVector3( data[1] * V.data[2] - data[2] * V.data[1],
                            data[2] * V.data[0] - data[0] * V.data[2],
                            data[0] * V.data[1] - data[1] * V.data[0] );
  }

Here is the call graph for this function:

operator/()

FGColumnVector3 operator/

(

const double

scalar

)

const

Multiply by 1/scalar.

Parameters

scalar

scalar value to devide the vector through.

Returns

The resulting vector from the division through that scalar. Multiply the vector with the 1/scalar given in the argument.

Definition at line 85 of file FGColumnVector3.cpp.

{
  if (scalar != 0.0)
    return operator*( 1.0/scalar );

  cerr << "Attempt to divide by zero in method \
    FGColumnVector3::operator/(const double scalar), \
    object " << data[0] << " , " << data[1] << " , " << data[2] << endl;
  return FGColumnVector3();
}

Here is the caller graph for this function:

operator=()

FGColumnVector3& operator= ( const FGColumnVector3 &  b )

inline

Assignment operator.

Parameters

b	source vector. Copy the content of the vector given in the argument into *this.

Definition at line 142 of file FGColumnVector3.h.

                                                       {
    data[0] = b.data[0];
    data[1] = b.data[1];
    data[2] = b.data[2];
    return *this;
  }

operator==()

bool operator== ( const FGColumnVector3 &  b ) const

inline

Comparison operator.

Parameters

b	other vector. Returns true if both vectors are exactly the same.

Definition at line 152 of file FGColumnVector3.h.

                                                  {
    return data[0] == b.data[0] && data[1] == b.data[1] && data[2] == b.data[2];
  }

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• FGColumnVector3.h
• FGColumnVector3.cpp