edu.udo.cs.yale.operator.meta
Class ParameterSet

java.lang.Object
  edu.udo.cs.yale.operator.AbstractIOObject
      edu.udo.cs.yale.operator.ResultObjectAdapter
          edu.udo.cs.yale.operator.meta.ParameterSet

All Implemented Interfaces:

IOObject, ResultObject, Saveable, java.io.Serializable

public class ParameterSet
extends ResultObjectAdapter
implements Saveable, java.io.Serializable

A set of parameters generated by a ParameterOptimizationOperator.

Version:

$Id: ParameterSet.java,v 1.10 2006/08/03 14:39:34 ingomierswa Exp $

Author:

Simon Fischer, Ingo Mierswa

See Also:

Serialized Form

Nested Class Summary

private static class

ParameterSet.ParameterValue The best value of a parameter of an operator.

Field Summary

private java.util.List<ParameterSet.ParameterValue>	parameterValues
private PerformanceVector	performance
private static long	serialVersionUID

Constructor Summary

private	ParameterSet() Private constructor for the read() method.
	ParameterSet(Operator[] operators, java.lang.String[] parameters, java.lang.String[] values, PerformanceVector value) Constructs a new ParameterSet.

Method Summary

void	applyAll(Experiment experiment, java.util.Map nameMap) Applies all parameters in the set to their operators.
java.lang.String	getExtension() Returns the default extension in file choosers.
java.lang.String	getFileDescription() Returns the file description used in file choosers.
java.lang.String	getName() The default implementation returns the classname without package.
java.lang.String	getParameterString()
PerformanceVector	getPerformance() Returns the performance of this parameter set.
static ParameterSet	read(java.io.BufferedReader reader) Reads a parameter set from a file.
void	save(java.io.File file) Writes the object into the given file.
java.lang.String	toString()
void	write(java.io.PrintWriter writer)

Methods inherited from class edu.udo.cs.yale.operator.ResultObjectAdapter

addAction, getActions, getVisualisationComponent, toHTML, toResultString

Methods inherited from class edu.udo.cs.yale.operator.AbstractIOObject

copy, read, read, read, write, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.udo.cs.yale.operator.IOObject

copy, write, write

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

parameterValues

private java.util.List<ParameterSet.ParameterValue> parameterValues

performance

private PerformanceVector performance

Constructor Detail

ParameterSet

private ParameterSet()

Private constructor for the read() method.

ParameterSet

public ParameterSet(Operator[] operators,
                    java.lang.String[] parameters,
                    java.lang.String[] values,
                    PerformanceVector value)

Constructs a new ParameterSet. The three arrays must have equal length. For each i, the ParameterSet specifies the value values[i] for the parameter parameters[i] of the operator named operators[i].

Method Detail

getName

public java.lang.String getName()

Description copied from class: ResultObjectAdapter

The default implementation returns the classname without package.

Specified by:

getName in interface ResultObject

Overrides:

getName in class ResultObjectAdapter

getParameterString

public java.lang.String getParameterString()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getPerformance

public PerformanceVector getPerformance()

Returns the performance of this parameter set. Attension: This may be null if the ParameterSet was read from a file.

applyAll

public void applyAll(Experiment experiment,
                     java.util.Map nameMap)

Applies all parameters in the set to their operators. The entries in the nameMap can be used if the names of the operators in two experiments (one parameter optimisation experiment and one application experiment) are not the same. Each entry in nameMap maps the name read from the file to the name of the operator in the experiment.

save

public void save(java.io.File file)
          throws java.io.IOException

Description copied from interface: Saveable

Writes the object into the given file.

Specified by:

save in interface Saveable

Throws:

java.io.IOException

getExtension

public java.lang.String getExtension()

Description copied from interface: Saveable

Returns the default extension in file choosers.

Specified by:

getExtension in interface Saveable

getFileDescription

public java.lang.String getFileDescription()

Description copied from interface: Saveable

Returns the file description used in file choosers.

Specified by:

getFileDescription in interface Saveable

write

public void write(java.io.PrintWriter writer)

read

public static ParameterSet read(java.io.BufferedReader reader)
                         throws java.io.IOException

Reads a parameter set from a file.

Throws:

java.io.IOException