ResultChecker (GenOpt Code Documentation)

java.lang.Object
- genopt.db.ResultChecker

```
public class ResultChecker
extends java.lang.Object
```
Object that checks how often an objective function value has already been achieved previously.
This project was carried out at:
- Lawrence Berkeley National Laboratory (LBNL), Simulation Research Group,
and supported by
- the U.S. Department of Energy (DOE),
- the Swiss Academy of Engineering Sciences (SATW),
- the Swiss National Energy Fund (NEFF), and
- the Swiss National Science Foundation (SNSF)
GenOpt Copyright (c) 1998-2021, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). All rights reserved.
Version:

GenOpt(R) 3.1.1 (March 24, 2016)

Author:

Michael Wetter

Field Summary

Fields
Modifier and Type	Field and Description
`private int`	`ARRAYINCREMENT` Constant for increasing the array size
`private int`	`arrSiz` current size of array
`private int[]`	`cou` array with the counter of equal results
`private double[]`	`f` array with the objective function values, sorted with highest value at the 0-th position
`private static java.lang.String`	`LS` System dependent line separator
`private int`	`matVal` counter for number of matching values.
`private int`	`maxMatVal` maximum allowed number of matching values
`private int[]`	`num` array with the run number, sorted with highest value at the 0-th position
`private int`	`numMatVal` counter for total number of matching values.
`private int`	`resNum` number of results, starting with 0

Constructor Summary

Constructors
Constructor and Description

ResultChecker(int maxNumberOfMatchingResults)
Constructor

Constructors
Constructor and Description
`ResultChecker(int maxNumberOfMatchingResults)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`check()` checks whether the maximum number of matching results is reached.
`private int[]`	`getMatchingNumbers()` gets an array with the indices of all matching numbers
`int`	`getNumberOfMatchingResults()` gets the total number of matching results
`private void`	`increaseArraySize()` increases the array size
`void`	`setNewTrial(double functionValue, int runNumber)` sets a new trial
`void`	`setNumberOfMatchingResults(int maxNumberOfMatchingResults)` sets the maximal allowed number of matching results
`private void`	`setRun(double functionValue, int runNumber)` sets the new trial

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

- Field Detail
  - LS
```
private static final java.lang.String LS
```
    System dependent line separator
  - ARRAYINCREMENT
```
private final int ARRAYINCREMENT
```
    Constant for increasing the array size
    
    See Also:
    
    Constant Field Values
  - f
```
private double[] f
```
    array with the objective function values, sorted with highest value at the 0-th position
  - num
```
private int[] num
```
    array with the run number, sorted with highest value at the 0-th position
  - cou
```
private int[] cou
```
    array with the counter of equal results
  - arrSiz
```
private int arrSiz
```
    current size of array
  - resNum
```
private int resNum
```
    number of results, starting with 0
  - matVal
```
private int matVal
```
    counter for number of matching values.
    Note: i.e., {1,3,9} has matVal = 1; {1,1,2} has matVal=2; {1,1,2,2,2} has matVal=3;
  - numMatVal
```
private int numMatVal
```
    counter for total number of matching values.
    Note: i.e., {1,3,9} has numMatVal = 1; {1,1,2} has numMatVal=2; {1,1,2,2,2} has numMatVal=5;
  - maxMatVal
```
private int maxMatVal
```
    maximum allowed number of matching values
- Constructor Detail
  - ResultChecker
```
public ResultChecker(int maxNumberOfMatchingResults)
```
    Constructor
    
    Parameters:
    
    maxNumberOfMatchingResults - number how many results can be equal without an OptimizerException is thrown
- Method Detail
  - setNewTrial
```
public void setNewTrial(double functionValue,
                        int runNumber)
```
    sets a new trial
    
    Parameters:
    
    functionValue - value of the objective function
    
    runNumber - the number of the optimization run
  - check
```
public void check()
           throws OptimizerException
```
    checks whether the maximum number of matching results is reached. If so, an OptimizerException is thrown.
    
    Throws:
    
    OptimizerException - thrown if the maximum number of equal results is reached
  - setNumberOfMatchingResults
```
public void setNumberOfMatchingResults(int maxNumberOfMatchingResults)
```
    sets the maximal allowed number of matching results
    
    Parameters:
    
    maxNumberOfMatchingResults - number how many results can be equal without an OptimizerException is thrown
  - getNumberOfMatchingResults
```
public int getNumberOfMatchingResults()
```
    gets the total number of matching results
    
    Returns:
    
    the total number of matching results
  - getMatchingNumbers
```
private int[] getMatchingNumbers()
```
    gets an array with the indices of all matching numbers
    
    Returns:
    
    array with the indices of all matching numbers
  - increaseArraySize
```
private void increaseArraySize()
```
    increases the array size
  - setRun
```
private void setRun(double functionValue,
                    int runNumber)
```
    sets the new trial
    
    Parameters:
    
    functionValue - value of the objective function
    
    runNumber - the number of the optimization run

Class ResultChecker

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LS

ARRAYINCREMENT

f

num

cou

arrSiz

resNum

matVal

numMatVal

maxMatVal

Constructor Detail

ResultChecker

Method Detail

setNewTrial

check

setNumberOfMatchingResults

getNumberOfMatchingResults

getMatchingNumbers

increaseArraySize

setRun