BeamSearch (illinois-cogcomp-nlp 3.1.29 API)

java.lang.Object
- edu.illinois.cs.cogcomp.infer.ilp.BeamSearch

All Implemented Interfaces:: ILPSolver

public class BeamSearch
extends Object
implements ILPSolver

Author:: Vivek Srikumar

Field Summary
- Fields inherited from interface edu.illinois.cs.cogcomp.infer.ilp.ILPSolver
  VERBOSITY_HIGH, VERBOSITY_LOW, VERBOSITY_NONE

Constructor Summary

Constructors
Constructor and Description

BeamSearch(int beamSize)

Constructors
Constructor and Description
`BeamSearch(int beamSize)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`addBooleanVariable(double arg0)` Adds a new Boolean variable (an integer variable constrained to take either the value 0 or the value 1) with the specified coefficient in the objective function to the problem.
`int[]`	`addDiscreteVariable(double[] arg0)` Adds a general, multi-valued discrete variable, which is implemented as a set of Boolean variables, one per value of the discrete variable, with exactly one of those variables set `true` at any given time.
`void`	`addEqualityConstraint(int[] arg0, double[] arg1, double arg2)` Adds a new fixed constraint to the problem.
`void`	`addGreaterThanConstraint(int[] arg0, double[] arg1, double arg2)` Adds a new lower bounded constraint to the problem.
`int`	`addIntegerVariable(double arg0)` Adds a new Integer variable with the specified coefficient in the objective function to the problem.
`void`	`addLessThanConstraint(int[] arg0, double[] arg1, double arg2)` Adds a new upper bounded constraint to the problem.
`int`	`addRealVariable(double arg0)` Adds a new Real variable with the specified coefficient in the objective function to the problem.
`boolean`	`getBooleanValue(int arg0)` When the problem has been solved, use this method to retrieve the value of any Boolean inference variable.
`int`	`getIntegerValue(int arg0)` When the problem has been solved, use this method to retrieve the value of any Integer inference variable.
`double`	`getRealValue(int arg0)` When the problem has been solved, use this method to retrieve the value of any Real inference variable.
`boolean`	`isSolved()` Tests whether the problem represented by this `ILPSolver` instance has been solved already.
`double`	`objectiveCoeff(int index)` The coefficient of the variable in the objective function.
`double`	`objectiveValue()` When the problem has been solved, use this method to retrieve the value of the objective function at the solution.
`void`	`reset()` This method clears the all constraints and variables out of the ILP solver's problem representation, bringing the `ILPSolver` instance back to the state it was in when first constructed.
`void`	`setMaximize(boolean arg0)` Sets the direction of the objective function.
`boolean`	`solve()` Solves the ILP problem, saving the solution internally.
`void`	`write(StringBuffer arg0)` Creates a textual representation of the ILP problem in an algebraic notation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BeamSearch
```
public BeamSearch(int beamSize)
```
- Method Detail
  - addBooleanVariable
```
public int addBooleanVariable(double arg0)
```
    Description copied from interface: ILPSolver
    
    Adds a new Boolean variable (an integer variable constrained to take either the value 0 or the value 1) with the specified coefficient in the objective function to the problem.
    
    Specified by:
    
    addBooleanVariable in interface ILPSolver
    
    Parameters:
    
    arg0 - The objective function coefficient for the new Boolean variable.
    
    Returns:
    
    The indexes of the created variable.
  - addRealVariable
```
public int addRealVariable(double arg0)
```
    Description copied from interface: ILPSolver
    
    Adds a new Real variable with the specified coefficient in the objective function to the problem.
    
    Specified by:
    
    addRealVariable in interface ILPSolver
    
    Parameters:
    
    arg0 - The objective function coefficient for the new Real variable.
    
    Returns:
    
    The indexes of the created variable.
  - addIntegerVariable
```
public int addIntegerVariable(double arg0)
```
    Description copied from interface: ILPSolver
    
    Adds a new Integer variable with the specified coefficient in the objective function to the problem.
    
    Specified by:
    
    addIntegerVariable in interface ILPSolver
    
    Parameters:
    
    arg0 - The objective function coefficient for the new Integer variable.
    
    Returns:
    
    The indexes of the created variable.
  - addDiscreteVariable
```
public int[] addDiscreteVariable(double[] arg0)
```
    Description copied from interface: ILPSolver
    
    Adds a general, multi-valued discrete variable, which is implemented as a set of Boolean variables, one per value of the discrete variable, with exactly one of those variables set true at any given time.
    
    Specified by:
    
    addDiscreteVariable in interface ILPSolver
    
    Parameters:
    
    arg0 - The objective function coefficients for the new Boolean variables.
    
    Returns:
    
    The indexes of the newly created variables.
  - addEqualityConstraint
```
public void addEqualityConstraint(int[] arg0,
                                  double[] arg1,
                                  double arg2)
```
    Description copied from interface: ILPSolver
    
    Adds a new fixed constraint to the problem. The two array arguments must be the same length, as their elements correspond to each other. Variables whose coefficients are zero need not be mentioned. Variables that are mentioned must have previously been added via ILPSolver.addBooleanVariable(double) or ILPSolver.addDiscreteVariable(double[]). The resulting constraint has the form:
    x_i * a = b
    where x_i represents the inference variables whose indexes are contained in the array i and * represents dot product.
    
    Specified by:
    
    addEqualityConstraint in interface ILPSolver
    
    Parameters:
    
    arg0 - The indexes of the variables with non-zero coefficients.
    
    arg1 - The coefficients of the variables with the given indexes.
    
    arg2 - The new constraint will enforce equality with this constant.
  - addGreaterThanConstraint
```
public void addGreaterThanConstraint(int[] arg0,
                                     double[] arg1,
                                     double arg2)
```
    Description copied from interface: ILPSolver
    
    Adds a new lower bounded constraint to the problem. The two array arguments must be the same length, as their elements correspond to each other. Variables whose coefficients are zero need not be mentioned. Variables that are mentioned must have previously been added via ILPSolver.addBooleanVariable(double) or ILPSolver.addDiscreteVariable(double[]). The resulting constraint has the form:
    x_i * a >= b
    where x_i represents the inference variables whose indexes are contained in the array i and * represents dot product.
    
    Specified by:
    
    addGreaterThanConstraint in interface ILPSolver
    
    Parameters:
    
    arg0 - The indexes of the variables with non-zero coefficients.
    
    arg1 - The coefficients of the variables with the given indexes.
    
    arg2 - The lower bound for the new constraint.
  - addLessThanConstraint
```
public void addLessThanConstraint(int[] arg0,
                                  double[] arg1,
                                  double arg2)
```
    Description copied from interface: ILPSolver
    
    Adds a new upper bounded constraint to the problem. The two array arguments must be the same length, as their elements correspond to each other. Variables whose coefficients are zero need not be mentioned. Variables that are mentioned must have previously been added via ILPSolver.addBooleanVariable(double) or ILPSolver.addDiscreteVariable(double[]). The resulting constraint has the form:
    x_i * a <= b
    where x_i represents the inference variables whose indexes are contained in the array i and * represents dot product.
    
    Specified by:
    
    addLessThanConstraint in interface ILPSolver
    
    Parameters:
    
    arg0 - The indexes of the variables with non-zero coefficients.
    
    arg1 - The coefficients of the variables with the given indexes.
    
    arg2 - The upper bound for the new constraint.
  - getBooleanValue
```
public boolean getBooleanValue(int arg0)
```
    Description copied from interface: ILPSolver
    
    When the problem has been solved, use this method to retrieve the value of any Boolean inference variable. The result of this method is undefined when the problem has not yet been solved.
    
    Specified by:
    
    getBooleanValue in interface ILPSolver
    
    Parameters:
    
    arg0 - The index of the variable whose value is requested.
    
    Returns:
    
    The value of the variable.
  - getRealValue
```
public double getRealValue(int arg0)
```
    Description copied from interface: ILPSolver
    
    When the problem has been solved, use this method to retrieve the value of any Real inference variable. The result of this method is undefined when the problem has not yet been solved.
    
    Specified by:
    
    getRealValue in interface ILPSolver
    
    Parameters:
    
    arg0 - The index of the variable whose value is requested.
    
    Returns:
    
    The value of the variable.
  - getIntegerValue
```
public int getIntegerValue(int arg0)
```
    Description copied from interface: ILPSolver
    
    When the problem has been solved, use this method to retrieve the value of any Integer inference variable. The result of this method is undefined when the problem has not yet been solved.
    
    Specified by:
    
    getIntegerValue in interface ILPSolver
    
    Parameters:
    
    arg0 - The index of the variable whose value is requested.
    
    Returns:
    
    The value of the variable.
  - isSolved
```
public boolean isSolved()
```
    Description copied from interface: ILPSolver
    
    Tests whether the problem represented by this ILPSolver instance has been solved already.
    
    Specified by:
    
    isSolved in interface ILPSolver
  - objectiveValue
```
public double objectiveValue()
```
    Description copied from interface: ILPSolver
    
    When the problem has been solved, use this method to retrieve the value of the objective function at the solution. The result of this method is undefined when the problem has not yet been solved. If the problem had no feasible solutions, negative (positive, respectively) infinity will be returned if maximizing (minimizing).
    
    Specified by:
    
    objectiveValue in interface ILPSolver
    
    Returns:
    
    The value of the objective function at the solution.
  - objectiveCoeff
```
public double objectiveCoeff(int index)
```
    Description copied from interface: ILPSolver
    
    The coefficient of the variable in the objective function.
    
    Specified by:
    
    objectiveCoeff in interface ILPSolver
  - reset
```
public void reset()
```
    Description copied from interface: ILPSolver
    
    This method clears the all constraints and variables out of the ILP solver's problem representation, bringing the ILPSolver instance back to the state it was in when first constructed.
    
    Specified by:
    
    reset in interface ILPSolver
  - setMaximize
```
public void setMaximize(boolean arg0)
```
    Description copied from interface: ILPSolver
    
    Sets the direction of the objective function.
    
    Specified by:
    
    setMaximize in interface ILPSolver
    
    Parameters:
    
    arg0 - true if the objective function is to be maximized.
  - solve
```
public boolean solve()
              throws Exception
```
    Description copied from interface: ILPSolver
    
    Solves the ILP problem, saving the solution internally. This method may throw an exception if something doesn't go right.
    
    Specified by:
    
    solve in interface ILPSolver
    
    Throws:
    
    Exception
  - write
```
public void write(StringBuffer arg0)
```
    Description copied from interface: ILPSolver
    
    Creates a textual representation of the ILP problem in an algebraic notation.
    
    Specified by:
    
    write in interface ILPSolver
    
    Parameters:
    
    arg0 - The created textual representation will be appended here.

Class BeamSearch

Field Summary

Fields inherited from interface edu.illinois.cs.cogcomp.infer.ilp.ILPSolver

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BeamSearch

Method Detail

addBooleanVariable

addRealVariable

addIntegerVariable

addDiscreteVariable

addEqualityConstraint

addGreaterThanConstraint

addLessThanConstraint

getBooleanValue

getRealValue

getIntegerValue

isSolved

objectiveValue

objectiveCoeff

reset

setMaximize

solve

write