org.uncommons.watchmaker.swing
Class ProbabilityParameterControl

java.lang.Object
  org.uncommons.watchmaker.swing.ProbabilityParameterControl

All Implemented Interfaces:

EvolutionControl

public class ProbabilityParameterControl
extends Object
implements EvolutionControl

A GUI control that allows the user to set/update the value of a Probability parameter.

Author:

Daniel Dyer

Constructor Summary

ProbabilityParameterControl(org.uncommons.maths.random.Probability defaultValue)
Creates a control with a default range of 0..1 and a default granularity of 2 decimal places.

ProbabilityParameterControl(org.uncommons.maths.random.Probability minimum, org.uncommons.maths.random.Probability maximum, int decimalPlaces, org.uncommons.maths.random.Probability initialValue)

Method Summary

JComponent	getControl()
org.uncommons.maths.number.NumberGenerator<org.uncommons.maths.random.Probability>	getNumberGenerator() Returns a number generator that simply returns the current probability value represented by the position of the slider control.
void	reset() Resets the control to its initial configuration.
void	setDescription(String description) Provides a textual description of the purpose of the control.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProbabilityParameterControl

public ProbabilityParameterControl(org.uncommons.maths.random.Probability defaultValue)

Creates a control with a default range of 0..1 and a default granularity of 2 decimal places.

Parameters:

defaultValue - The default probability value.

ProbabilityParameterControl

public ProbabilityParameterControl(org.uncommons.maths.random.Probability minimum,
                                   org.uncommons.maths.random.Probability maximum,
                                   int decimalPlaces,
                                   org.uncommons.maths.random.Probability initialValue)

Parameters:

minimum - The minimum probability that this control will permit.

maximum - The maximum probability that this control will permit.

decimalPlaces - The granularity of the control.

initialValue - The default probability.

Method Detail

getControl

public JComponent getControl()

Specified by:

getControl in interface EvolutionControl

Returns:

The GUI component used by this control.

reset

public void reset()

Resets the control to its initial configuration.

Specified by:

reset in interface EvolutionControl

getNumberGenerator

public org.uncommons.maths.number.NumberGenerator<org.uncommons.maths.random.Probability> getNumberGenerator()

Returns a number generator that simply returns the current probability value represented by the position of the slider control.

Returns:

A number generator that can be used to control an evolutionary program.

setDescription

public void setDescription(String description)

Provides a textual description of the purpose of the control. This may be displayed somewhere on the GUI component (typically as tooltip text).

Specified by:

setDescription in interface EvolutionControl

Parameters:

description - The description of the control.