Class StudentTPar

java.lang.Object

random.AbstractParameter

random.StudentTPar

All Implemented Interfaces:

AutoCheck, Parameter

public class StudentTPar
extends AbstractParameter
implements Parameter

This is the parameter that should be passed to the StudentT distribution.

Copyright (c) 2003
Politecnico di Milano - dipartimento di Elettronica e Informazione

Author:

Fabrizio Frontera - ffrontera@yahoo.it

Constructor Summary

Constructors

Constructor	Description
StudentTPar(double freedom)	It creates a new student T parameter with the provided degrees of freedom.
StudentTPar(Double wfreedom)

Method Summary

Modifier and Type	Method	Description
boolean	check()	It verifies if the parameter is correct.
double	getFreedom()	It returns the degrees of freedom of the student T distribution.
void	setFreedom(double freedom)	It allows the user to change the degrees of freedom of the student T distribution and verifies if it is an integer greater than zero.

Methods inherited from class AbstractParameter

setMean

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Parameter

setMean

Constructor Details

StudentTPar

public StudentTPar(double freedom)
            throws IncorrectDistributionParameterException

It creates a new student T parameter with the provided degrees of freedom.

Parameters:

freedom - double containing the degrees of freedom of the new student T distribution. It is defined as double but must be an integer greater than zero.

Throws:

IncorrectDistributionParameterException - if the degrees of freedom is not an integer greater than zero.

StudentTPar

public StudentTPar(Double wfreedom)
            throws IncorrectDistributionParameterException

Throws:

IncorrectDistributionParameterException

Method Details

check

public boolean check()

It verifies if the parameter is correct. For the student T distribution, the value of the degrees of freedom must be an integer greater than zero.

Specified by:

check in interface AutoCheck

Specified by:

check in interface Parameter

Overrides:

check in class AbstractParameter

Returns:

boolean indicating if the parameter is correct or not.

getFreedom

public double getFreedom()

It returns the degrees of freedom of the student T distribution.

Returns:

double with the degrees of freedom of the student T distribution.

setFreedom

public void setFreedom(double freedom)
                throws IncorrectDistributionParameterException

It allows the user to change the degrees of freedom of the student T distribution and verifies if it is an integer greater than zero.

Parameters:

freedom - double indicating the degrees of freedom.

Throws:

IncorrectDistributionParameterException - if the degrees of freedom is not an integer greater than zero.