TupleThreeD Class Reference

The purpose of this class is to provide operations on three domain objects. More...

#include <TupleThreeD.h>

List of all members.

Public Member Functions

 TupleThreeD ()
 Ctor.
 TupleThreeD (double x, double y, double z)
 Ctor.
 TupleThreeD (const TupleThreeD &rhs)
 Copy ctor.
virtual ~TupleThreeD ()
 Dtor.
TupleThreeDoperator= (const TupleThreeD &rhs)
 Assignment operator.
bool operator== (const TupleThreeD &rhs) const
 Equality operator.
bool operator!= (const TupleThreeD &rhs) const
 Inequality operator.
const TupleThreeDvalue (double x, double y, double z)
 Specify a value directly.
const TupleThreeDvalue (double a[3])
 Specify a value directly.
const TupleThreeDvalue () const
 Give the value of this object.
double X () const
 Give the value of the x domain.
double Y () const
 Give the value of the y domain.
double Z () const
 Give the value of the z domain.
double operator * (const TupleThreeD &rhs) const
 Dot product operator.
const TupleThreeDoperator+ (const TupleThreeD &rhs) const
 Addition operator.
const TupleThreeDoperator- (const TupleThreeD &rhs) const
 Subtraction operator.


Detailed Description

The purpose of this class is to provide operations on three domain objects.

Definition at line 10 of file TupleThreeD.h.


Constructor & Destructor Documentation

TupleThreeD::TupleThreeD (  ) 

Ctor.

TupleThreeD::TupleThreeD ( double  x,
double  y,
double  z 
)

Ctor.

Parameters:
x The initial x domain value.
y The initial y domain value.
z The initial z domain value.

TupleThreeD::TupleThreeD ( const TupleThreeD rhs  ) 

Copy ctor.

Parameters:
rhs The reference object.

virtual TupleThreeD::~TupleThreeD (  )  [virtual]

Dtor.


Member Function Documentation

TupleThreeD& TupleThreeD::operator= ( const TupleThreeD rhs  ) 

Assignment operator.

Parameters:
rhs The reference object.
Returns:
The value of this object.

bool TupleThreeD::operator== ( const TupleThreeD rhs  )  const

Equality operator.

Parameters:
rhs The reference object.
Returns:
If this object and the reference object are equal then true.

bool TupleThreeD::operator!= ( const TupleThreeD rhs  )  const

Inequality operator.

Parameters:
rhs The reference object.
Returns:
If this object and the reference object are equal then true.

const TupleThreeD& TupleThreeD::value ( double  x,
double  y,
double  z 
)

Specify a value directly.

Parameters:
x The value of the x domain.
y The value of the y domain.
z The value of the z domain.
Returns:
The new value of this object.

const TupleThreeD& TupleThreeD::value ( double  a[3]  ) 

Specify a value directly.

Parameters:
a The value (x, y, z).
Returns:
The new value of this object.

const TupleThreeD& TupleThreeD::value (  )  const

Give the value of this object.

Returns:
The new value of this object.

double TupleThreeD::X (  )  const

Give the value of the x domain.

Returns:
X domain.

double TupleThreeD::Y (  )  const

Give the value of the y domain.

Returns:
Y domain.

double TupleThreeD::Z (  )  const

Give the value of the z domain.

Returns:
Z domain.

double TupleThreeD::operator * ( const TupleThreeD rhs  )  const

Dot product operator.

Parameters:
rhs The argument to be multiplied with this object.
Returns:
The product scalar.

const TupleThreeD& TupleThreeD::operator+ ( const TupleThreeD rhs  )  const

Addition operator.

Parameters:
rhs The argument to be added with this object.
Returns:
The result vector.

const TupleThreeD& TupleThreeD::operator- ( const TupleThreeD rhs  )  const

Subtraction operator.

Parameters:
rhs The argument to be subtracted from this object.
Returns:
The result vector.


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