FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoVectorP Class Reference

#include <Vector.h>

Inherits FdoPtr< FdoVector >.

Inheritance diagram for FdoVectorP:

[legend]
List of all members.

Detailed Description

FdoVectorP is a FdoPtr on FdoVector, provided for convenience. It also provides vector arithmetic and comparison operators.

Definition at line 198 of file Vector.h.


Public Member Functions

FDO_API_COMMON FdoVectorP (FdoVector *src)
 Vector FdoPtr copy constructor.
FDO_API_COMMON FdoVectorP (const FdoVectorP &src)
 Vector FdoPtr copy constructor.
FDO_API_COMMON FdoVectorP ()
 Vector FdoPtr default constructor.
FDO_API_COMMON FdoBoolean operator!= (const FdoVectorP vec2) const
 Compare two vectors for difference. The vectors are differnt if one of their elements is differnt. If one vector is shorter than the other then it is treated as if it were padded with zeros to the length of the other vector.
FDO_API_COMMON const FdoVectorP operator+ (const FdoVectorP vec2) const
 Adds two vectors, by adding each individual element. The output vector has the same length as the longer of the input vectors. If one input vector is shorter than the other, it is treated as if it is padded with zeros.
FDO_API_COMMON FdoVectorP operator+= (const FdoVectorP vec2)
 Adds a vector, to this vector, by adding each individual element. The output vector has the same length as the longer of the input vectors. If one input vector is shorter than the other, it is treated as if it is padded with zeros.
FDO_API_COMMON const FdoVectorP operator- (const FdoVectorP vec2) const
 Subtracts two vectors, by subtracting each individual element. The output vector has the same length as the longer of the input vectors. If one input vector is shorter than the other, it is treated as if it is padded with zeros.
FDO_API_COMMON FdoVectorP operator-= (const FdoVectorP vec2)
 Subtracts a vector, from this vector, by subtracting each individual element. The output vector has the same length as the longer of the input vectors. If one input vector is shorter than the other, it is treated as if it is padded with zeros.
FDO_API_COMMON FdoBoolean operator< (const FdoVectorP vec2) const
 Checks if this vector is less than a second vector. Comparison is done by comparing the first element in each vector. If they are equal, then the second element is check and so on until a differing element is found. If one vector is shorter than the other then it is treated as if it were padded with zeros to the length of the other vector.
FDO_API_COMMON FdoBoolean operator<= (const FdoVectorP vec2) const
 Checks if this vector is less than or equal to a second vector. Comparison is done by comparing the first element in each vector. If they are equal, then the second element is check and so on until a differing element is found. If one vector is shorter than the other then it is treated as if it were padded with zeros to the length of the other vector.
FDO_API_COMMON FdoVectoroperator= (FdoVector *src)
 Copies a vector.
FDO_API_COMMON FdoBoolean operator== (const FdoVectorP vec2) const
 Compare two vectors for equality. The vectors are equal if all of their elements are equal. If one vector is shorter than the other then it is treated as if it were padded with zeros to the length of the other vector.
FDO_API_COMMON FdoBoolean operator> (const FdoVectorP vec2) const
 Checks if this vector is greater than a second vector. Comparison is done by comparing the first element in each vector. If they are equal, then the second element is check and so on until a differing element is found. If one vector is shorter than the other then it is treated as if it were padded with zeros to the length of the other vector.
FDO_API_COMMON FdoBoolean operator>= (const FdoVectorP vec2) const
 Checks if this vector is greater or equal to a second vector. Comparison is done by comparing the first element in each vector. If they are equal, then the second element is check and so on until a differing element is found. If one vector is shorter than the other then it is treated as if it were padded with zeros to the length of the other vector.
FDO_API_COMMON ~FdoVectorP ()
 Vector FdoPtr destructor.

Protected Member Functions

FdoBoolean Compare (const FdoVectorP vec2, FdoBoolean lt, FdoBoolean eq, FdoBoolean gt) const
 General function to do the vector comparisons.

Constructor & Destructor Documentation

FDO_API_COMMON FdoVectorP::FdoVectorP  )  [inline]
 

Vector FdoPtr default constructor.

Returns:
Returns FdoVectorP

Definition at line 207 of file Vector.h.

References FDO_API_COMMON.

FDO_API_COMMON FdoVectorP::FdoVectorP const FdoVectorP src  )  [inline]
 

Vector FdoPtr copy constructor.

Parameters:
src Input the source vector as a FdoPtr
Returns:
Returns FdoVectorP

Definition at line 218 of file Vector.h.

References FDO_API_COMMON.

FDO_API_COMMON FdoVectorP::FdoVectorP FdoVector src  )  [inline]
 

Vector FdoPtr copy constructor.

Parameters:
src Input the source vector as an object pointer
Returns:
Returns FdoVectorP

Definition at line 231 of file Vector.h.

References FDO_API_COMMON.

FDO_API_COMMON FdoVectorP::~FdoVectorP  )  [inline]
 

Vector FdoPtr destructor.

Definition at line 238 of file Vector.h.

References FDO_API_COMMON.


Member Function Documentation

FdoBoolean FdoVectorP::Compare const FdoVectorP  vec2,
FdoBoolean  lt,
FdoBoolean  eq,
FdoBoolean  gt
const [protected]
 

General function to do the vector comparisons.

FDO_API_COMMON FdoBoolean FdoVectorP::operator!= const FdoVectorP  vec2  )  const
 

Compare two vectors for difference. The vectors are differnt if one of their elements is differnt. If one vector is shorter than the other then it is treated as if it were padded with zeros to the length of the other vector.

Parameters:
vec2 Input vector to compare this vector
Returns:
Returns true if the two vectors are different.

FDO_API_COMMON const FdoVectorP FdoVectorP::operator+ const FdoVectorP  vec2  )  const
 

Adds two vectors, by adding each individual element. The output vector has the same length as the longer of the input vectors. If one input vector is shorter than the other, it is treated as if it is padded with zeros.

Parameters:
vec2 Input vector to add to this vector
Returns:
Returns the sum of the two input vectors

FDO_API_COMMON FdoVectorP FdoVectorP::operator+= const FdoVectorP  vec2  ) 
 

Adds a vector, to this vector, by adding each individual element. The output vector has the same length as the longer of the input vectors. If one input vector is shorter than the other, it is treated as if it is padded with zeros.

Parameters:
vec2 Input vector to add to this vector
Returns:
Returns the sum of the two input vectors

FDO_API_COMMON const FdoVectorP FdoVectorP::operator- const FdoVectorP  vec2  )  const
 

Subtracts two vectors, by subtracting each individual element. The output vector has the same length as the longer of the input vectors. If one input vector is shorter than the other, it is treated as if it is padded with zeros.

Parameters:
vec2 Input vector to subtract from this vector
Returns:
Returns the difference of the two input vectors

FDO_API_COMMON FdoVectorP FdoVectorP::operator-= const FdoVectorP  vec2  ) 
 

Subtracts a vector, from this vector, by subtracting each individual element. The output vector has the same length as the longer of the input vectors. If one input vector is shorter than the other, it is treated as if it is padded with zeros.

Parameters:
vec2 Input vector to subtract from this vector
Returns:
Returns the difference of the two input vectors

FDO_API_COMMON FdoBoolean FdoVectorP::operator< const FdoVectorP  vec2  )  const
 

Checks if this vector is less than a second vector. Comparison is done by comparing the first element in each vector. If they are equal, then the second element is check and so on until a differing element is found. If one vector is shorter than the other then it is treated as if it were padded with zeros to the length of the other vector.

Parameters:
vec2 Input vector to compare this vector
Returns:
Returns true if this vector is less than vec2.

FDO_API_COMMON FdoBoolean FdoVectorP::operator<= const FdoVectorP  vec2  )  const
 

Checks if this vector is less than or equal to a second vector. Comparison is done by comparing the first element in each vector. If they are equal, then the second element is check and so on until a differing element is found. If one vector is shorter than the other then it is treated as if it were padded with zeros to the length of the other vector.

Parameters:
vec2 Input vector to compare this vector
Returns:
Returns true if this vector is less than or equal vec2.

FDO_API_COMMON FdoVector* FdoVectorP::operator= FdoVector src  ) 
 

Copies a vector.

Parameters:
src Input the source vector
Returns:
Returns a new copy of the input vector

Reimplemented from FdoPtr< FdoVector >.

FDO_API_COMMON FdoBoolean FdoVectorP::operator== const FdoVectorP  vec2  )  const
 

Compare two vectors for equality. The vectors are equal if all of their elements are equal. If one vector is shorter than the other then it is treated as if it were padded with zeros to the length of the other vector.

Parameters:
vec2 Input vector to compare this vector
Returns:
Returns true if the two vectors are identical.

FDO_API_COMMON FdoBoolean FdoVectorP::operator> const FdoVectorP  vec2  )  const
 

Checks if this vector is greater than a second vector. Comparison is done by comparing the first element in each vector. If they are equal, then the second element is check and so on until a differing element is found. If one vector is shorter than the other then it is treated as if it were padded with zeros to the length of the other vector.

Parameters:
vec2 Input vector to compare this vector
Returns:
Returns true if this vector is greater than vec2.

FDO_API_COMMON FdoBoolean FdoVectorP::operator>= const FdoVectorP  vec2  )  const
 

Checks if this vector is greater or equal to a second vector. Comparison is done by comparing the first element in each vector. If they are equal, then the second element is check and so on until a differing element is found. If one vector is shorter than the other then it is treated as if it were padded with zeros to the length of the other vector.

Parameters:
vec2 Input vector to compare this vector
Returns:
Returns true if this vector is greater or equal vec2.

The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.