ParameterSet (LBJava 1.2.22 API)

java.lang.Object
- edu.illinois.cs.cogcomp.lbjava.IR.ASTNode
- - edu.illinois.cs.cogcomp.lbjava.IR.Expression
  - - edu.illinois.cs.cogcomp.lbjava.IR.ParameterSet

```
public class ParameterSet
extends Expression
```
Represents a set of possible parameters, used when doing parameter-tuning. The list of possible values for a parameter is stored in parameterList as an ExpressionList.
The set can be defined either as a comma-separated list of possible values, or it can be defined as a range in terms of a start value, end value, and increment factor, which can then be converted into the explicit list of possible values.
The LBJava syntax for defining the parameter set is to declare the possible values inside of double curly braces, either as an explicit list or as a range. The following two examples are equivalent:
- {{2,3,4,5}}
- {{2->5:1}}
Author:

Michael Paul

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`count` Remembers how many instances of this class have been instantiated.
`Expression`	`end` The end value for the range.
`Expression`	`increment` The factor to increment by.
`boolean`	`inRounds` `true` iff this parameter set appears inside the `rounds` clause of a `LearningClassifierExpression`.
`Expression`	`start` The start value for the range.
`Type`	`type` The most specific type for the values in this set.

Fields inherited from class edu.illinois.cs.cogcomp.lbjava.IR.Expression
parenthesized, typeCache, typeCacheFilled

Fields inherited from class edu.illinois.cs.cogcomp.lbjava.IR.ASTNode
byteOffset, line, nodeID, symbolTable

Constructor Summary

Constructors
Constructor and Description
`ParameterSet(Expression s, Expression e, Expression i)` Initializing constructor.
`ParameterSet(ExpressionList list)` Initializing constructor.
`ParameterSet(int line, int byteOffset, Expression s, Expression e, Expression i)` Full constructor.
`ParameterSet(int line, int byteOffset, ExpressionList list)` Full constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`clone()` Creates a new object with the same primitive data, and recursively creates new member data objects as well.
`void`	`convertRange()` Converts this parameter set's `start`, `end`, and `increment` expressions (which must represent `Constant`s of a `PrimitiveType` other than `boolean`) into an explicit list of values.
`boolean`	`equals(Object o)` Two parameter sets are equivalent when their constituent expressions are the same.
`Expression`	`getFirst()` Returns the first element of the list.
`String`	`getParameterName()` Returns the value of `parameterName`.
`int`	`hashCode()` A hash code based on the hash codes of the constituent expressions.
`boolean`	`isRange()` `true` iff this parameter set was specified as a range.
`ASTNodeIterator`	`iterator()` Returns an iterator used to successively access the children of this node.
`ExpressionList.ExpressionListIterator`	`listIterator()` Returns a list iterator over `parameterList`.
`void`	`runPass(Pass pass)` Ensures that the correct `run()` method is called for this type of node.
`int[]`	`toSortedIntArray()` Parses integers out of every constant in the set and returns them in a sorted array.
`Object[]`	`toStringArray()` Assuming that `convertRange()` has already been called (if necessary) and that every expression in `parameterList` is a `Constant`, this method produces an array of `String`s containing the values of the constants.
`void`	`write(StringBuffer buffer)` Writes a string representation of this `ASTNode` to the specified buffer.

Methods inherited from class edu.illinois.cs.cogcomp.lbjava.IR.Expression
containsQuantifiedVariable, getVariableTypes, senseValueChild

Methods inherited from class edu.illinois.cs.cogcomp.lbjava.IR.ASTNode
toString

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - count
```
public static int count
```
    Remembers how many instances of this class have been instantiated.
  - start
```
public Expression start
```
    The start value for the range.
  - end
```
public Expression end
```
    The end value for the range.
  - increment
```
public Expression increment
```
    The factor to increment by.
  - type
```
public Type type
```
    The most specific type for the values in this set.
  - inRounds
```
public boolean inRounds
```
    true iff this parameter set appears inside the rounds clause of a LearningClassifierExpression.
- Constructor Detail
  - ParameterSet
```
public ParameterSet(ExpressionList list)
```
    Initializing constructor. Sets the list of possible parameter values.
    
    Parameters:
    
    list - The list of possible values for the parameter
  - ParameterSet
```
public ParameterSet(int line,
                    int byteOffset,
                    ExpressionList list)
```
    Full constructor. Sets the list of possible parameter values.
    
    Parameters:
    
    line - The line on which the source code represented by this node is found.
    
    byteOffset - The byte offset from the beginning of the source file at which the source code represented by this node is found.
    
    list - The list of possible values for the parameter.
  - ParameterSet
```
public ParameterSet(Expression s,
                    Expression e,
                    Expression i)
```
    Initializing constructor. Sets the range parameters.
    
    Parameters:
    
    s - The start value.
    
    e - The end value.
    
    i - The increment factor.
  - ParameterSet
```
public ParameterSet(int line,
                    int byteOffset,
                    Expression s,
                    Expression e,
                    Expression i)
```
    Full constructor. Sets the range parameters.
    
    Parameters:
    
    line - The line on which the source code represented by this node is found.
    
    byteOffset - The byte offset from the beginning of the source file at which the source code represented by this node is found.
    
    s - The start value.
    
    e - The end value.
    
    i - The increment factor.
- Method Detail
  - getParameterName
```
public String getParameterName()
```
    Returns the value of parameterName.
  - isRange
```
public boolean isRange()
```
    true iff this parameter set was specified as a range.
  - listIterator
```
public ExpressionList.ExpressionListIterator listIterator()
```
    Returns a list iterator over parameterList.
  - getFirst
```
public Expression getFirst()
```
    Returns the first element of the list.
  - convertRange
```
public void convertRange()
```
    Converts this parameter set's start, end, and increment expressions (which must represent Constants of a PrimitiveType other than boolean) into an explicit list of values. The type field must be set appropriately for before calling this method.
  - toSortedIntArray
```
public int[] toSortedIntArray()
```
    Parses integers out of every constant in the set and returns them in a sorted array. If this parameter set was specified as a range, it is assumed that convertRange() has already been called.
  - toStringArray
```
public Object[] toStringArray()
```
    Assuming that convertRange() has already been called (if necessary) and that every expression in parameterList is a Constant, this method produces an array of Strings containing the values of the constants. The return type of the method is Object[] so that its elements can be replaced by objects of other types, which is convenient during parameter tuning.
  - iterator
```
public ASTNodeIterator iterator()
```
    Returns an iterator used to successively access the children of this node.
    
    Specified by:
    
    iterator in class ASTNode
    
    Returns:
    
    An iterator used to successively access the children of this node.
  - equals
```
public boolean equals(Object o)
```
    Two parameter sets are equivalent when their constituent expressions are the same.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true iff this object is the same as the argument.
  - hashCode
```
public int hashCode()
```
    A hash code based on the hash codes of the constituent expressions.
    
    Overrides:
    
    hashCode in class Object
  - clone
```
public Object clone()
```
    Creates a new object with the same primitive data, and recursively creates new member data objects as well.
    
    Overrides:
    
    clone in class ASTNode
    
    Returns:
    
    The clone node.
  - runPass
```
public void runPass(Pass pass)
```
    Ensures that the correct run() method is called for this type of node.
    
    Specified by:
    
    runPass in class ASTNode
    
    Parameters:
    
    pass - The pass whose run() method should be called.
  - write
```
public void write(StringBuffer buffer)
```
    Writes a string representation of this ASTNode to the specified buffer. The representation written is parsable by the LBJava compiler, but not very readable.
    
    Specified by:
    
    write in class ASTNode
    
    Parameters:
    
    buffer - The buffer to write to.

Class ParameterSet

Field Summary

Fields inherited from class edu.illinois.cs.cogcomp.lbjava.IR.Expression

Fields inherited from class edu.illinois.cs.cogcomp.lbjava.IR.ASTNode

Constructor Summary

Method Summary

Methods inherited from class edu.illinois.cs.cogcomp.lbjava.IR.Expression

Methods inherited from class edu.illinois.cs.cogcomp.lbjava.IR.ASTNode

Methods inherited from class java.lang.Object

Field Detail

count

start

end

increment

type

inRounds

Constructor Detail

ParameterSet

ParameterSet

ParameterSet

ParameterSet

Method Detail

getParameterName

isRange

listIterator

getFirst

convertRange

toSortedIntArray

toStringArray

iterator

equals

hashCode

clone

runPass

write