com.github.dakusui.jcunit.generators.IPO2TupleGenerator Maven / Gradle / Ivy

Go to download
package com.github.dakusui.jcunit.generators;

import com.github.dakusui.jcunit.core.Checks;
import com.github.dakusui.jcunit.core.ParamType;
import com.github.dakusui.jcunit.core.Utils;
import com.github.dakusui.jcunit.core.factor.Factor;
import com.github.dakusui.jcunit.core.factor.Factors;
import com.github.dakusui.jcunit.core.tuples.Tuple;
import com.github.dakusui.jcunit.generators.ipo2.IPO2;
import com.github.dakusui.jcunit.generators.ipo2.optimizers.GreedyIPO2Optimizer;

import java.util.List;

public class IPO2TupleGenerator extends TupleGeneratorBase {
  List tests;

  /**
   * {@inheritDoc}
   */
  @Override
  public Tuple getTuple(int tupleId) {
    return this.tests.get(tupleId);
  }

  /**
   * processedParameters[0] must be an int value greater than 1 and less than or
   * equal to the number of factors, if given.
   * If no parameter is given, it defaults to 2.
   * 
   * If more than 1 parameter is given, this method will throw an {@code IllegalArgumentException}.
   */
  @Override
  protected long initializeTuples(
          Object[] processedParameters) {
    // Since the processed parameters are already validated by ParamType mechanism,
    // we can simply cast and assign the first element to an integer variable without checking.
    int strength = ((Number) processedParameters[0]).intValue();
    Factors factors = this.getFactors();
    Checks.checktest(factors.size() >= 2,
            "There must be 2 or more factors, but only %d (%s) given.",
            factors.size(),
            Utils.join(",", new Utils.Formatter() {
                      @Override
                      public String format(Factor elem) {
                        return elem.name;
                      }
                    },
                    factors.asFactorList().toArray(new Factor[factors.size()])
            ));
    Checks.checktest(factors.size() >= strength,
            "The strength must be greater than 1 and less than %d, but %d was given.",
            factors.size(),
            strength);
    Checks.checktest(strength >= 2,
            "The strength must be greater than 1 and less than %d, but %d was given.",
            factors.size(),
            strength);
    IPO2 ipo2 = new IPO2(
            this.getFactors(),
            strength,
            this.getConstraintManager(),
            new GreedyIPO2Optimizer());
    ////
    // Wire constraint manager.
    this.getConstraintManager().addObserver(ipo2);
    ////
    // Perform IPO algorithm.
    ipo2.ipo();
    this.tests = ipo2.getResult();
    return this.tests.size();
  }

  @Override
  public ParamType[] parameterTypes() {
    return new ParamType[]{ParamType.Int.withDefaultValue(2)};
  }
}