Package jdistlib

Class MultivariateProbabilityResult

java.lang.Object

jdistlib.MultivariateProbabilityResult

public final class MultivariateProbabilityResult
extends Object

Result of a numerical multivariate probability calculation.

Field Summary

Fields

Modifier and Type	Field	Description
final double	absoluteError	Replication-based absolute error indicator.
final int	evaluations	Number of transformed-integrand evaluations.
static final int	INVALID_INPUT	Legacy integer code corresponding to MultivariateProbabilityStatus.INVALID_INPUT.
static final int	MAX_EVALUATIONS_REACHED	Legacy integer code corresponding to MultivariateProbabilityStatus.MAX_EVALUATIONS_REACHED.
final double	probability	The requested probability.
final int	status	Stable legacy status code.
static final int	SUCCESS	Legacy integer code corresponding to MultivariateProbabilityStatus.SUCCESS.

Method Summary

Modifier and Type	Method	Description
MultivariateProbabilityStatus	getStatus()	Returns the typed terminal status.
boolean	hasEstimate()	Returns whether this object contains a usable numerical estimate.
boolean	isConverged()	Alias emphasizing convergence rather than validity.
boolean	isSuccess()	Returns whether the requested numerical tolerance was met.
String	message()

Methods inherited from class java.lang.Object

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

Field Details

SUCCESS

public static final int SUCCESS

Legacy integer code corresponding to MultivariateProbabilityStatus.SUCCESS.

See Also:

• Constant Field Values

MAX_EVALUATIONS_REACHED

public static final int MAX_EVALUATIONS_REACHED

Legacy integer code corresponding to MultivariateProbabilityStatus.MAX_EVALUATIONS_REACHED.

See Also:

• Constant Field Values

INVALID_INPUT

public static final int INVALID_INPUT

Legacy integer code corresponding to MultivariateProbabilityStatus.INVALID_INPUT.

See Also:

• Constant Field Values

probability

public final double probability

The requested probability.

absoluteError

public final double absoluteError

Replication-based absolute error indicator. This is a conservative convergence heuristic, not a rigorous confidence bound.

evaluations

public final int evaluations

Number of transformed-integrand evaluations.

status

public final int status

Stable legacy status code. New code should prefer getStatus().

Method Details

isSuccess

public boolean isSuccess()

Returns whether the requested numerical tolerance was met.

isConverged

public boolean isConverged()

Alias emphasizing convergence rather than validity.

hasEstimate

public boolean hasEstimate()

Returns whether this object contains a usable numerical estimate.

getStatus

public MultivariateProbabilityStatus getStatus()

Returns the typed terminal status.

message

public String message()