class CDVector: public virtual CVisDVector

Vector class with double precision.

Inheritance:

Public Methods

DIVAMatrixExport void	CrossProduct ( const CDVector &v1, const CDVector &v2) Forms the cross product of two vectors.
DIVAMatrixExport void	ElementDivide (const CDVector& vector) Divide two vectors element-wise.
DIVAMatrixExport void	ElementMultiply (const CDVector& vector) Multiplies two vectors element-wise.
DIVAMatrixExport void	Eq (const double B, CDVector& C ) const Equal - compares a vector and a double.
DIVAMatrixExport void	Eq ( const CDVector& B, CDVector& C ) const Equal - compares a vector and a vector.
DIVAMatrixExport void	FromFile ( const CDString& sFilename ) Reads a vector from disk in binary format.
DIVAMatrixExport void	FromFile ( FILE *fh ) Reads a vector from disk in binary format.
DIVAMatrixExport void	FromMatlab (const CDString& sFilename, const CDString& sName) Reads a vector from disk in MatLab (.m) format.
DIVAMatrixExport void	Ge ( const CDVector& B, CDVector& C ) const Greater Than or Equal - compares a vector and a vector.
DIVAMatrixExport void	Ge (const double B, CDVector& C ) const Greater Than or Equal - compares a double and a vector.
DIVAMatrixExport void	Gt (const double B, CDVector& C ) const Greater Than - compares a double and a vector.
DIVAMatrixExport void	Gt ( const CDVector& B, CDVector& C ) const Greater Than - compares a vector and a vector.
DIVAMatrixExport void	Le ( const CDVector& B, CDVector& C ) const Less Than or Equal - compares a vector and a vector.
DIVAMatrixExport void	Le (const double B, CDVector& C ) const Less Than or Equal - compares a double and a vector.
DIVAMatrixExport void	Log () Takes the natural logarithm of each element.
DIVAMatrixExport void	Lt ( const CDVector& B, CDVector& C ) const Less Than - compares a vector and a vector.
DIVAMatrixExport void	Lt (const double B, CDVector& C ) const Less Than - compares a double and a vector.
DIVAMatrixExport double	Max () const Finds the maximum element in the vector.
DIVAMatrixExport double	Mean () const Calculates the mean value of the vector.
DIVAMatrixExport double	Min () const Finds the minimum element in the vector.
DIVAMatrixExport double	Min (int& iPos) const Finds the minimum element in the vector and its position.
DIVAMatrixExport void	Ne ( const CDVector& B, CDVector& C ) const Not Equal - compares a vector and a vector.
DIVAMatrixExport void	Ne (const double B, CDVector& C ) const Not Equal - compares a double and a vector.
DIVAMatrixExport double	Norm1 () const Calculates the one-norm (L1) of the vector.
DIVAMatrixExport double	Norm2 () const Calculates the two-norm (L2) of the vector.
DIVAMatrixExport double	NormInf () const Calculates the infinity-norm (Linf) of the vector.
DIVAMatrixExport void	Normalize2 () Normalizes the vector to unit length, using the 2-norm.
DIVAMatrixExport void	Pow (double dP) Takes the power 'dP' of each element.
DIVAMatrixExport void	Rand () Uniformly distributed random numbers.
DIVAMatrixExport void	Reverse () Reverses the vector.
DIVAMatrixExport double	Skewness () const Calculates the skewness of the vector.
DIVAMatrixExport void	Sort ( bool ascending ) Sorts the vector.
DIVAMatrixExport void	Sqr () Squares each element.
DIVAMatrixExport void	Sqrt () Takes the square root of each element.
DIVAMatrixExport double	Std () const Calculates the standard deviation of the vector.
DIVAMatrixExport double	Sum () const Calculates the sum of the vector.
DIVAMatrixExport void	ToFile ( const CDString& sFilename ) const Writes the vector to disk in binary format.
DIVAMatrixExport void	ToFile ( FILE *fh ) const Writes the vector to disk in binary format.
DIVAMatrixExport void	ToMatlab (const CDString& sFilename, const CDString& sName, const CDString& sComment, bool fAppend) const Writes the vector to disk in MatLab (.m) format.
DIVAMatrixExport CDString	ToString (const bool fNewline) const Returns a string representing the vector.
DIVAMatrixExport double	Var () const Calculates the variance of the vector.
DIVAMatrixExport CDVector&	operator= (double value) Assignment operator.
DIVAMatrixExport CDVector&	operator= (const CVisDVector &vIn) Assignment operator.
DIVAMatrixExport CDVector&	operator= (const CDVector &vIn) Assignment operator.

DIVAMatrixExport void CrossProduct( const CDVector &v1, const CDVector &v2)

Forms the cross product of two vectors and store the result in this. If the vector does have the correct size, it will be resized.

Returns:

Nothing.

Parameters:

v1 - Input vector.
v2 - Input vector.

Author:

Mikkel B. Stegmann

Version:

3-16-2001

DIVAMatrixExport void ElementDivide(const CDVector& vector)

Divide two vectors element-wise. Corresponding MatLab operator "./".

Returns:

Nothing.

Parameters:

vector - The input vector to divide this vector with.

Author:

Rune Fisker

Version:

1-5-1999

DIVAMatrixExport void ElementMultiply(const CDVector& vector)

Multiplies two vectors element-wise. Corresponding MatLab operator ".*".

Returns:

Nothing.

Parameters:

vector - The input vector to multiply this vector with.

Author:

Rune Fisker

Version:

1-5-1999

DIVAMatrixExport void Eq(const double B, CDVector& C ) const

Compares of a vector and a double and returns the result as a binary vector i.e.:

C(i) = 1 if A(i) == B C(i) = 0 else

Corresponding MatLab function EQ()

Returns:

Nothing.

Parameters:

B - Input double.
C - Output result vector.

Author:

Lars Pedersen

Version:

7-12-2000

DIVAMatrixExport void Eq( const CDVector& B, CDVector& C ) const

Compares of a vector and a vector and returns the result as a binary matrix i.e.:

C(i) = 1 if A(i) == B C(i) = 0 else

Corresponding MatLab function EQ()

Returns:

Nothing.

Parameters:

B - Input vector.
C - Output result vector.

Author:

Lars Pedersen

Version:

7-12-2000

DIVAMatrixExport void FromFile( const CDString& sFilename )

Reads a vector from disk in binary format.

Returns:

Nothing.

Parameters:

sFilename - Input file name.

Author:

Mikkel B. Stegmann

Version:

2-5-2001

DIVAMatrixExport void FromFile( FILE *fh )

Reads a vector from disk in binary format.

Returns:

Nothing.

Parameters:

fh - Open file handle (opened using fopen())

Author:

Mikkel B. Stegmann

Version:

2-5-2001

DIVAMatrixExport void FromMatlab(const CDString& sFilename, const CDString& sName)

Reads a vector from disk in MatLab (.m) format into 'this'.

Notice that this should be used for storage a (really) large vectors, due to the computational and i/o overhead induced by the simple MatLab text format.

Also, remember that MatLab can't read (.m) files with lines longer than 4096 bytes.

If no communication with MatLab is needed, but merely to/from disk functionality within a DIVA program, it is suggested to use the fast binary i/o methods ToFile() and FromFile().

Returns:

Nothing.

Parameters:

sFilename - Input file name.
sName - The name to search for (and load) inside the matlab file.

Author:

Henrik Aanęs

Version:

2-5-2001

DIVAMatrixExport void Ge(const double B, CDVector& C ) const

Compares of a double and a vector and returns the result as a binary matrix i.e.:

C(i) = 1 if A(i) >= B C(i) = 0 else

Corresponding MatLab function GE()

Returns:

Nothing.

Parameters:

B - Input double.
C - Output result vector.

Author:

Lars Pedersen

Version:

7-12-2000

DIVAMatrixExport void Ge( const CDVector& B, CDVector& C ) const

Compares of a vector and a vector and returns the result as a binary matrix i.e.:

C(i) = 1 if A(i) >= B C(i) = 0 else

Corresponding MatLab function GE()

Returns:

Nothing.

Parameters:

B - Input vector.
C - Output result vector.

Author:

Lars Pedersen

Version:

7-12-2000

DIVAMatrixExport void Gt(const double B, CDVector& C ) const

Compares of a double and a vector and returns the result as a binary matrix i.e.:

C(i) = 1 if A(i) > B C(i) = 0 else

Corresponding MatLab function GT()

Returns:

Nothing.

Parameters:

B - Input vector.
C - Output result vector.

Author:

Lars Pedersen

Version:

7-12-2000

DIVAMatrixExport void Gt( const CDVector& B, CDVector& C ) const

Compares of a vector and a vector and returns the result as a binary matrix i.e.:

C(i) = 1 if A(i) > B C(i) = 0 else

Corresponding MatLab function GT()

Returns:

Nothing.

Parameters:

B - Input vector.
C - Output result vector.

Author:

Lars Pedersen

Version:

7-12-2000

DIVAMatrixExport void Le(const double B, CDVector& C ) const

Compares of a double and a vector and returns the result as a binary matrix i.e.:

C(i) = 1 if A(i) <= B C(i) = 0 else

Corresponding MatLab function LE()

Returns:

Nothing.

Parameters:

B - Input double.
C - Output result vector.

Author:

Lars Pedersen

Version:

7-12-2000

DIVAMatrixExport void Le( const CDVector& B, CDVector& C ) const

Compares of a vector and a vector and returns the result as a binary matrix i.e.:

C(i) = 1 if A(i) <= B C(i) = 0 else

Corresponding MatLab function LE()

Returns:

Nothing.

Parameters:

B - Input vector.
C - Output result vector.

Author:

Lars Pedersen

Version:

7-12-2000

DIVAMatrixExport void Log()

Takes the natural logarithm of each element.

Returns:

Nothing.

Author:

Lars Pedersen

Version:

7-12-2000

DIVAMatrixExport void Lt(const double B, CDVector& C ) const

Compares of a double and a vector and returns the result as a binary matrix i.e.:

C(i) = 1 if A(i) < B C(i) = 0 else

Corresponding MatLab function LT()

Returns:

Nothing.

Parameters:

B - Input double.
C - Output result vector.

Author:

Lars Pedersen

Version:

7-12-2000

DIVAMatrixExport void Lt( const CDVector& B, CDVector& C ) const

Compares of a vector and a vector and returns the result as a binary matrix i.e.:

C(i) = 1 if A(i) < B C(i) = 0 else

Corresponding MatLab function LT()

Returns:

Nothing.

Parameters:

B - Input vector.
C - Output result vector.

Author:

Lars Pedersen

Version:

7-12-2000

DIVAMatrixExport double Max() const

Finds the maximum element in the vector.

Returns:

The maximum value of the elements.

Author:

Rune Fisker

Version:

3-5-1999

DIVAMatrixExport double Mean() const

Calculates the mean value of the vector.

Returns:

The mean value.

Author:

Rune Fisker

Version:

3-5-1999

DIVAMatrixExport double Min() const

Finds the minimum element in the vector.

Returns:

The minimum value of the elements.

Author:

Rune Fisker

Version:

3-5-1999

DIVAMatrixExport double Min(int& iPos) const

Finds the minimum element in the vector and its position.

Returns:

The minimum value of the elements and its position.

Author:

Rune Fisker

Version:

1-9-1999

DIVAMatrixExport void Ne(const double B, CDVector& C ) const

Compares of a double and a vector and returns the result as a binary matrix i.e.:

C(i) = 1 if A(i) != B C(i) = 0 else

Corresponding MatLab function NE()

Returns:

Nothing.

Parameters:

B - Input double.
C - Output result vector.

Author:

Lars Pedersen

Version:

7-12-2000

DIVAMatrixExport void Ne( const CDVector& B, CDVector& C ) const

Compares of a vector and a vector and returns the result as a binary matrix i.e.:

C(i) = 1 if A(i) != B C(i) = 0 else

Corresponding MatLab function NE()

Returns:

Nothing.

Parameters:

B - Input vector.
C - Output result vector.

Author:

Lars Pedersen

Version:

7-12-2000

DIVAMatrixExport double Norm1() const

Calculates the one-norm (L1) of the vector. Also known as the city block metric.

L1(v) = |x_1| + |x_2| .. + |x_n|

Returns:

The L1 norm.

Author:

Mikkel B. Stegmann

Version:

2-5-2001

DIVAMatrixExport double Norm2() const

Calculates the two-norm (L2) of the vector. Also known as the Euclidean length.

L2(v) = sqrt( x_1^2 + x_2^2 .. + x_n^2 )

Returns:

The L2 norm.

Author:

Mikkel B. Stegmann

Version:

2-5-2001

DIVAMatrixExport double NormInf() const

Calculates the infinity-norm (Linf) of the vector. Also known as the Chebyshev Norm.

Linf(v) = max( |x_1|, |x_2| ... , |x_n| )

Returns:

The L2 norm.

Author:

Mikkel B. Stegmann

Version:

2-5-2001

DIVAMatrixExport void Normalize2()

Normalizes the vector to unit length, using the 2-norm.

Returns:

Nothing.

Author:

Mikkel B. Stegmann

Version:

2-5-2001

DIVAMatrixExport void Pow(double dP)

Takes the power 'dP' of each element.

Returns:

Nothing.

Parameters:

dP - The exponent.

Author:

Rune Fisker

Version:

1-5-1999

DIVAMatrixExport void Rand()

Inserts uniformly distributed random numbers in the range [0;1].

Returns:

Nothing.

Author:

Mikkel B. Stegmann

Version:

3-9-2001

DIVAMatrixExport void Reverse()

Reverses the vector.

Returns:

Nothing.

Author:

Mikkel B. Stegmann

Version:

3-5-2000

DIVAMatrixExport double Skewness() const

Calculates the skewness the vector.

Returns:

The skewness.

Author:

Rune Fisker

Version:

3-5-1999

DIVAMatrixExport void Sort( bool ascending )

Sorts the vector in either ascending (default) or descending order. Implemented using the standard quicksort, qsort().

Returns:

Nothing.

Parameters:

ascending - If true (default) the vector is sorted in ascending order. If false its sorted in descending order.

Author:

Mikkel B. Stegmann

Version:

2-2-2001

DIVAMatrixExport void Sqr()

Squares each element.

Returns:

Nothing.

Author:

Rune Fisker

Version:

1-5-1999

DIVAMatrixExport void Sqrt()

Takes the square root of each element.

Returns:

Nothing.

Author:

Rune Fisker

Version:

1-5-1999

DIVAMatrixExport double Std() const

Calculates the standard deviation the vector.

Returns:

The skewness.

Author:

Rune Fisker

Version:

3-5-1999

DIVAMatrixExport double Sum() const

Calculates the sum of the vector.

Returns:

The sum.

Author:

Rune Fisker

Version:

3-5-1999

DIVAMatrixExport void ToFile( const CDString& sFilename ) const

Writes the vector to disk in binary format. Use 'readbin.m' to load such a file into MatLab (placed in the diva/matlab dir).

Returns:

Nothing.

Parameters:

sFilename - Output file name.

Author:

Mikkel B. Stegmann

Version:

2-5-2001

DIVAMatrixExport void ToFile( FILE *fh ) const

Writes the vector to disk in binary format. Use 'readbin.m' to load such a file into MatLab (placed in the diva/matlab dir).

Returns:

Nothing.

Parameters:

fh - Open file handle (opened using fopen())

Author:

Mikkel B. Stegmann

Version:

2-5-2001

DIVAMatrixExport void ToMatlab(const CDString& sFilename, const CDString& sName, const CDString& sComment, bool fAppend) const

Writes the vector to disk in MatLab (.m) format. To read the vector into MatLab write e.g. 'my_vector.m' at the MatLab prompt.

Notice that this should be used for storage a (really) large vectors, due to the computational and i/o overhead induced by the simple MatLab text format.

Also, remember that MatLab can't read (.m) files with lines longer than 4096 bytes.

If no communication with MatLab is needed, but merely to/from disk functionality within a DIVA program, it is suggested to use the fast binary i/o methods ToFile() and FromFile().

Returns:

Nothing.

Parameters:

sFilename - Output file name. Should have the extension '.m'.
sName - Name of destination matlab variable.
sComment - Optional comment inside the file.
fAppend - If true, the vector is appended to the file 'sFilename'.

Author:

Henrik Aanęs

Version:

2-5-2001

DIVAMatrixExport CDString ToString(const bool fNewline) const

Returns a string representing the vector.

Returns:

The output string.

Parameters:

fNewline - If true, the string is terminated with a new line.

Author:

Rune Fisker

Version:

1-5-1999

DIVAMatrixExport double Var() const

Calculates the variance the vector.

Returns:

The variance.

Author:

Rune Fisker

Version:

3-5-1999

DIVAMatrixExport CDVector& operator=(const CVisDVector &vIn)

Assignment operator.

Returns:

This.

Parameters:

vIn - Input vector.

Author:

Rune Fisker

Version:

2-5-2001

DIVAMatrixExport CDVector& operator=(const CDVector &vIn)

Assignment operator.

Returns:

This.

Parameters:

vIn - Input vector.

Author:

Rune Fisker

Version:

2-5-2001

DIVAMatrixExport CDVector& operator=(double value)

Assignment operator. Sets all element to the input value.

Returns:

This.

Parameters:

vIn - Input double.

Author:

Rune Fisker

Version:

2-5-2001

This class has no child classes.

Author:

Rune Fisker, Mikkel B. Stegmann, Henrik Aanęs, Lars Pedersen et al.

Version:

2-5-2001

See Also:

CDMatrix