jMEF.Parameter Class Reference

Inheritance diagram for jMEF.Parameter:

List of all members.

Public Types
enum	TYPE { SOURCE_PARAMETER, NATURAL_PARAMETER, EXPECTATION_PARAMETER }
	Type of the parameters: source parameters, natural parameters, or expectation parameters. More...
Public Member Functions
	Parameter ()
	Class constructor.
abstract Parameter	Plus (Parameter q)
	Adds (not in place) the current parameter p to the parameter q.
abstract Parameter	Minus (Parameter q)
	Subtracts (not in place) the parameter q to the current parameter p.
abstract Parameter	Times (double lambda)
	Multiplies (not in place) the current parameter p by a real number .
abstract double	InnerProduct (Parameter q)
	Computes the inner product (real number) between the current parameter p and the parameter q.
abstract Parameter	clone ()
	Creates and returns a copy of the instance.
abstract int	getDimension ()
	Returns the dimension of the parameters.
Public Attributes
TYPE	type
	Type of the parameters.

---

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 Parameter class implements a parameter object. Parameters can be a vector (class PVector), a matrix (class PMatrix), or both (class PVectorMatrix). The Parameter class is an abstract class.

---

Member Enumeration Documentation

enum jMEF::Parameter::TYPE

Type of the parameters: source parameters, natural parameters, or expectation parameters.

Enumerator:

SOURCE_PARAMETER
NATURAL_PARAMETER
EXPECTATION_PARAMETER

---

Constructor & Destructor Documentation

jMEF.Parameter.Parameter

(

)

Class constructor.

By default, a parameter object corresponds to source parameters.

---

Member Function Documentation

abstract Parameter jMEF.Parameter.clone

(

)

[pure virtual]

Creates and returns a copy of the instance.

Returns:

a clone of the instance.

Implemented in jMEF.PMatrix, jMEF.PVector, and jMEF.PVectorMatrix.

abstract int jMEF.Parameter.getDimension

(

)

[pure virtual]

Returns the dimension of the parameters.

Returns:

parameters' dimension.

Implemented in jMEF.PMatrix, jMEF.PVector, and jMEF.PVectorMatrix.

abstract double jMEF.Parameter.InnerProduct

(

Parameter

q

)

[pure virtual]

Computes the inner product (real number) between the current parameter p and the parameter q.

Parameters:

q

parameter

Returns:

Implemented in jMEF.PMatrix, jMEF.PVector, and jMEF.PVectorMatrix.

abstract Parameter jMEF.Parameter.Minus

(

Parameter

q

)

[pure virtual]

Subtracts (not in place) the parameter q to the current parameter p.

Parameters:

q

parameter

Returns:

p-q

Implemented in jMEF.PMatrix, jMEF.PVector, and jMEF.PVectorMatrix.

abstract Parameter jMEF.Parameter.Plus

(

Parameter

q

)

[pure virtual]

Adds (not in place) the current parameter p to the parameter q.

Parameters:

q

parameter

Returns:

p+q

Implemented in jMEF.PMatrix, jMEF.PVector, and jMEF.PVectorMatrix.

abstract Parameter jMEF.Parameter.Times

(

double

lambda

)

[pure virtual]

Multiplies (not in place) the current parameter p by a real number .

Parameters:

lambda

value

Returns:

Implemented in jMEF.PMatrix, jMEF.PVector, and jMEF.PVectorMatrix.

---

Member Data Documentation

TYPE jMEF.Parameter.type

Type of the parameters.

---

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

• Parameter.java