Detailed Description

This class implements a 3 element column vector.

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

Definition at line 65 of file FGColumnVector3.h.

#include <FGColumnVector3.h>

Public Member Functions
	FGColumnVector3 (const double X, const double Y, const double Z)
	Initialization by given values.

	FGColumnVector3 (const FGColumnVector3 &v)
	Copy constructor.

	FGColumnVector3 (void)
	Default initializer.

	~FGColumnVector3 (void)
	Destructor.

std::string	Dump (const std::string &delimeter) const
	Prints the contents of the vector.

double &	Entry (const unsigned int idx)
	Write access the entries of the vector.

double	Entry (const unsigned int idx) const
	Read access the entries of the vector.

void	InitMatrix (const double a)

void	InitMatrix (const double a, const double b, const double c)

void	InitMatrix (void)

double	Magnitude (const int idx1, const int idx2) const
	Length of the vector in a coordinate axis plane.

double	Magnitude (void) const
	Length of the vector.

FGColumnVector3 &	Normalize (void)
	Normalize.

bool	operator!= (const FGColumnVector3 &b) const
	Comparison operator.

double &	operator() (const unsigned int idx)
	Write access the entries of the vector.

double	operator() (const unsigned int idx) const
	Read access the entries of the vector.

FGColumnVector3	operator* (const double scalar) const
	Multiplication by a scalar.

FGColumnVector3	operator* (const FGColumnVector3 &V) const
	Cross product multiplication.

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.

FGColumnVector3 &	operator/= (const double scalar)
	Scale by a 1/scalar.

FGColumnVector3 &	operator= (const FGColumnVector3 &b)
	Assignment operator.

FGColumnVector3 &	operator= (std::initializer_list< double > lv)
	Assignment operator.

bool	operator== (const FGColumnVector3 &b) const
	Comparison operator.

Constructor & Destructor Documentation

◆ FGColumnVector3() [1/3]

FGColumnVector3 ( void )

Default initializer.

Create a zero vector.

Definition at line 55 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 77 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 86 of file FGColumnVector3.h.

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

◆ ~FGColumnVector3()

~FGColumnVector3 ( void )

inline

Destructor.

Definition at line 93 of file FGColumnVector3.h.

93{ }

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 63 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();
}

◆ Entry() [1/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 127 of file FGColumnVector3.h.

127{ return data[idx-1]; }

◆ Entry() [2/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 117 of file FGColumnVector3.h.

117{ return data[idx-1]; }

◆ InitMatrix() [1/3]

void InitMatrix ( const double a )

inline

Definition at line 232 of file FGColumnVector3.h.

232{ data[0] = data[1] = data[2] = a; }

◆ InitMatrix() [2/3]

void InitMatrix	(	const double	a,
		const double	b,
		const double	c
	)

inline

Definition at line 233 of file FGColumnVector3.h.

                                                                  {
    data[0]=a; data[1]=b; data[2]=c;
  }

◆ InitMatrix() [3/3]

void InitMatrix ( void )

inline

Definition at line 231 of file FGColumnVector3.h.

231{ data[0] = data[1] = data[2] = 0.0; }

◆ Magnitude() [1/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 128 of file FGColumnVector3.cpp.

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

◆ Magnitude() [2/2]

double Magnitude ( void ) const

Length of the vector.

Compute and return the euclidean norm of this vector.

Definition at line 109 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:

◆ 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 116 of file FGColumnVector3.cpp.

{
  double Mag = Magnitude();
 
  if (Mag != 0.0)
    operator*=( 1.0/Mag );
 
  return *this;
}

Here is the call graph for this function:

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 165 of file FGColumnVector3.h.

165{ return ! operator==(b); }

JSBSim::FGColumnVector3::operator==

bool operator==(const FGColumnVector3 &b) const

Comparison operator.

Definition FGColumnVector3.h:158

◆ operator()() [1/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 107 of file FGColumnVector3.h.

107{ return data[idx-1]; }

◆ operator()() [2/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 100 of file FGColumnVector3.h.

100{ 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 171 of file FGColumnVector3.h.

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

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 186 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] );
  }

◆ operator*=()

FGColumnVector3 & operator*= ( const double scalar )

inline

Scale by a scalar.

Definition at line 221 of file FGColumnVector3.h.

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

Here is the caller graph for this function:

◆ operator+()

FGColumnVector3 operator+ ( const FGColumnVector3 & B ) const

inline

Addition operator.

Definition at line 193 of file FGColumnVector3.h.

                                                            {
    return FGColumnVector3( data[0] + B.data[0], data[1] + B.data[1],
                            data[2] + B.data[2] );
  }

◆ operator+=()

FGColumnVector3 & operator+= ( const FGColumnVector3 & B )

inline

Add an other vector.

Definition at line 213 of file FGColumnVector3.h.

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

◆ operator-()

FGColumnVector3 operator- ( const FGColumnVector3 & B ) const

inline

Subtraction operator.

Definition at line 199 of file FGColumnVector3.h.

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

◆ operator-=()

FGColumnVector3 & operator-= ( const FGColumnVector3 & B )

inline

Subtract an other vector.

Definition at line 205 of file FGColumnVector3.h.

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

◆ 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 82 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 call graph for this function:

◆ operator/=()

FGColumnVector3 & operator/= ( const double scalar )

Scale by a 1/scalar.

Definition at line 95 of file FGColumnVector3.cpp.

{
  if (scalar != 0.0)
    operator*=( 1.0/scalar );
  else
    cerr << "Attempt to divide by zero in method \
      FGColumnVector3::operator/=(const double scalar), \
      object " << data[0] << " , " << data[1] << " , " << data[2] << endl;
 
  return *this;
}

Here is the call graph for this function:

◆ operator=() [1/2]

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 137 of file FGColumnVector3.h.

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

◆ operator=() [2/2]

FGColumnVector3 & operator= ( std::initializer_list< double > lv )

inline

Assignment operator.

Parameters

lv	initializer list of at most 3 values (i.e. {x, y, Z}) Copy the content of the list into *this.

Definition at line 147 of file FGColumnVector3.h.

                                                             {
    double *v = data;
    for(auto &x : lv)
      *(v++) = x;
 
    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 158 of file FGColumnVector3.h.

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

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

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

◆ FGColumnVector3() [1/3]

◆ FGColumnVector3() [2/3]

◆ FGColumnVector3() [3/3]

◆ ~FGColumnVector3()

Member Function Documentation

◆ Dump()

◆ Entry() [1/2]

◆ Entry() [2/2]

◆ InitMatrix() [1/3]

◆ InitMatrix() [2/3]

◆ InitMatrix() [3/3]

◆ Magnitude() [1/2]

◆ Magnitude() [2/2]

◆ Normalize()

◆ operator!=()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator/()

◆ operator/=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()