jMEF.PVectorMatrix Class Reference

Inheritance diagram for jMEF.PVectorMatrix:

jMEF.Parameter

List of all members.

Public Member Functions

 PVectorMatrix (int dim)
 Class constructor.
PVectorMatrix Plus (Parameter v2m2)
 Adds (not in place) the current vector-matrix $ (v_1, m_1) $ to the vector-matrix $ (v_2, m_2) $.
PVectorMatrix Minus (Parameter v2m2)
 Subtracts (not in place) the vector-matrix $ (v_2, m_2) $ to the current vector-matrix $ (v_1, m_1) $.
PVectorMatrix Times (double lambda)
 Multiplies (not in place) the current vector-matrix $ (v,m) $ by a real number $ \lambda $.
double InnerProduct (Parameter v2m2)
 Computes the inner product (real number) between the current vector-matrix $ ( v_1 , m_1 ) $ and the vector-matrix $ ( v_2 , m_2 ) $.
String toString ()
 Method toString.
Parameter clone ()
 Creates and returns a copy of the instance.
int getDimension ()
 Returns parameters' dimension.

Static Public Member Functions

static PVectorMatrix RandomDistribution (int dim)
 Generates a random vector-matrix $ (v,m) $ such as $ m $ is a positive definite matrix.
static boolean equals (PVectorMatrix v1m1, PVectorMatrix v2m2)
 Verifies if two vector-matrices $ (v_1 , m_1) $ and $ (v_2 , m_2) $ are similar.

Public Attributes

PVector v
 Vector parameter.
PMatrix M
 Matrix parameter.
int dim
 Dimension of the matrix-vector.

Detailed Description

Author:
Vincent Garcia

Frank Nielsen

Version:
1.0

License

See file LICENSE.txt

Description

A statistical distribution is parameterized by a set of values (parameters). The PVectorMatrix class implements a parameter object. Parameters are represented as a mixed type vector-matrix.

Constructor & Destructor Documentation

jMEF.PVectorMatrix.PVectorMatrix ( int  dim  ) 

Class constructor.

Parameters:
dim dimension of the matrix

Member Function Documentation

Parameter jMEF.PVectorMatrix.clone (  )  [virtual]

Creates and returns a copy of the instance.

Returns:
a clone of the instance.

Implements jMEF.Parameter.

static boolean jMEF.PVectorMatrix.equals ( PVectorMatrix  v1m1,
PVectorMatrix  v2m2 
) [static]

Verifies if two vector-matrices $ (v_1 , m_1) $ and $ (v_2 , m_2) $ are similar.

Parameters:
v1m1 vector-matrix $ (v_1, m_1) $
v2m2 vector-matrix $ (v_2, m_2) $
Returns:
true if $ v_1 = v_2 $ and $ m_1 = m_2 $, false otherwise

int jMEF.PVectorMatrix.getDimension (  )  [virtual]

Returns parameters' dimension.

Returns:
parameters' dimension.

Implements jMEF.Parameter.

double jMEF.PVectorMatrix.InnerProduct ( Parameter  v2m2  )  [virtual]

Computes the inner product (real number) between the current vector-matrix $ ( v_1 , m_1 ) $ and the vector-matrix $ ( v_2 , m_2 ) $.

Parameters:
v2m2 vector-matrix $ (v_2, m_2) $
Returns:
$ \langle v_1,v_2 \rangle + \langle m_1,m_2 \rangle $

Implements jMEF.Parameter.

PVectorMatrix jMEF.PVectorMatrix.Minus ( Parameter  v2m2  )  [virtual]

Subtracts (not in place) the vector-matrix $ (v_2, m_2) $ to the current vector-matrix $ (v_1, m_1) $.

Parameters:
v2m2 vector-matrix $ (v_2, m_2) $
Returns:
$ ( v_1 - v_2, m_1 - m_2 ) $

Implements jMEF.Parameter.

PVectorMatrix jMEF.PVectorMatrix.Plus ( Parameter  v2m2  )  [virtual]

Adds (not in place) the current vector-matrix $ (v_1, m_1) $ to the vector-matrix $ (v_2, m_2) $.

Parameters:
v2m2 vector-matrix $ (v_2, m_2) $
Returns:
$ ( v_1 + v_2, m_1 + m_2 ) $

Implements jMEF.Parameter.

static PVectorMatrix jMEF.PVectorMatrix.RandomDistribution ( int  dim  )  [static]

Generates a random vector-matrix $ (v,m) $ such as $ m $ is a positive definite matrix.

Parameters:
dim dimension of the matrix
Returns:
random vector-matrix $ ( v , m ) $

PVectorMatrix jMEF.PVectorMatrix.Times ( double  lambda  )  [virtual]

Multiplies (not in place) the current vector-matrix $ (v,m) $ by a real number $ \lambda $.

Parameters:
lambda value $ \lambda $
Returns:
$ ( \lambda v , \lambda m ) $

Implements jMEF.Parameter.

String jMEF.PVectorMatrix.toString (  ) 

Method toString.

Returns:
value of the vector-matrix as a string

Member Data Documentation

int jMEF.PVectorMatrix.dim

Dimension of the matrix-vector.

PMatrix jMEF.PVectorMatrix.M

Matrix parameter.

PVector jMEF.PVectorMatrix.v

Vector parameter.

The documentation for this class was generated from the following file:
Generated on Mon Nov 23 15:46:26 2009 for jMEF by  doxygen 1.5.9