edu.udo.cs.yale.generator
Class ConstantGenerator

java.lang.Object
  edu.udo.cs.yale.generator.FeatureGenerator
      edu.udo.cs.yale.generator.ConstantGenerator

public class ConstantGenerator
extends FeatureGenerator

Generates a constant attribute. The format is "const[value]()" for the FeatureGenerationOperator operator.

Version:

$Id: ConstantGenerator.java,v 2.11 2006/03/27 13:21:58 ingomierswa Exp $

Author:

Ingo Mierswa

Field Summary

private double	constant
private java.lang.String	constantString
static java.lang.String	FUNCTION_NAME

Fields inherited from class edu.udo.cs.yale.generator.FeatureGenerator

resultAttributes, SELECTION_MODE_ALL, SELECTION_MODE_RESTRICTIVE

Constructor Summary

ConstantGenerator()

ConstantGenerator(double constant)

Method Summary

void	generate(DataRow data) Generates the new attribute values for the example e and returns the new attribute values as doubles.
java.lang.String	getFunction() Sets the function name.
Attribute[]	getInputAttributes() Returns an array of Attributes where the length is the arity of the generator, [i] is the attribute type of the i-th argument.
java.util.List<Attribute[]>	getInputCandidates(ExampleSet exampleSet, int maxDepth, java.lang.String[] functions) Returns all compatible input attribute arrays for this generator from the given example set as list.
Attribute[]	getOutputAttributes(ExampleTable input) Returns the generated attributes types.
FeatureGenerator	newInstance() Subclasses must implement this method so that a new instance of this generator class is returned.
void	setArguments(Attribute[] args) Sets the arguments (indices) used in future generate(...)
void	setFunction(java.lang.String functionName) Sets the function name.
java.lang.String	toString()

Methods inherited from class edu.udo.cs.yale.generator.FeatureGenerator

argumentsSet, checkCompatibility, createGeneratorForFunction, equals, generateAll, getArgument, getExampleTable, getSelectionMode, selectGenerator, setExampleTable, setSelectionMode

Methods inherited from class java.lang.Object

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

Field Detail

FUNCTION_NAME

public static final java.lang.String FUNCTION_NAME

See Also:

Constant Field Values

constant

private double constant

constantString

private java.lang.String constantString

Constructor Detail

ConstantGenerator

public ConstantGenerator()

ConstantGenerator

public ConstantGenerator(double constant)

Method Detail

setArguments

public void setArguments(Attribute[] args)

Description copied from class: FeatureGenerator

Sets the arguments (indices) used in future generate(...) calls and has to be called prior to any generate(...) calls. The caller of this method has to take care that:

• args.length == getInputAttributes().length, i.e. that the arity is correct.
• The types of the example attributes match the types specified by getInputAttributes().
• The true attribute indices are used (as used by the example set's example table)

Overrides:

setArguments in class FeatureGenerator

newInstance

public FeatureGenerator newInstance()

Description copied from class: FeatureGenerator

Subclasses must implement this method so that a new instance of this generator class is returned. The arguments and the example table will not be cloned and thus be null. This kind of clone is needed as generating algorithms must be able to clone generators form their pool without changing the arguments already set for the others.

Specified by:

newInstance in class FeatureGenerator

getFunction

public java.lang.String getFunction()

Description copied from class: FeatureGenerator

Sets the function name. This method is only useful if subclasses can generate more than one function. (like the BasicArithmeticOperationGenerator).

Specified by:

getFunction in class FeatureGenerator

setFunction

public void setFunction(java.lang.String functionName)

Description copied from class: FeatureGenerator

Sets the function name. This method is only useful if subclasses can generate more than one function. (like the BasicArithmeticOperationGenerator).

Specified by:

setFunction in class FeatureGenerator

getInputAttributes

public Attribute[] getInputAttributes()

Description copied from class: FeatureGenerator

Returns an array of Attributes where the length is the arity of the generator, [i] is the attribute type of the i-th argument.

Specified by:

getInputAttributes in class FeatureGenerator

getOutputAttributes

public Attribute[] getOutputAttributes(ExampleTable input)

Description copied from class: FeatureGenerator

Returns the generated attributes types.

Specified by:

getOutputAttributes in class FeatureGenerator

getInputCandidates

public java.util.List<Attribute[]> getInputCandidates(ExampleSet exampleSet,
                                                      int maxDepth,
                                                      java.lang.String[] functions)

Returns all compatible input attribute arrays for this generator from the given example set as list.

Specified by:

getInputCandidates in class FeatureGenerator

generate

public void generate(DataRow data)
              throws GenerationException

Description copied from class: FeatureGenerator

Generates the new attribute values for the example e and returns the new attribute values as doubles. e.getAttribute(getArgument(i)) is the correct way to access argument i. If the according attribute's type is VALUE_SERIES, the end index can be determined by i_end = getExampleTable().getBlockEndIndex(getArgument(i)). Thus all values of the series can be accessed using indices i through i_end.

Specified by:

generate in class FeatureGenerator

Throws:

GenerationException

toString

public java.lang.String toString()

Overrides:

toString in class FeatureGenerator