DoubleRestrictor.java

/*
 * Created on 2007/02/02
 * Copyright (C) 2007 Koga Laboratory. All rights reserved.
 *
 */
package org.mklab.tool.control.system.sink;

import java.util.ArrayList;
import java.util.List;

import org.mklab.nfc.matrix.DoubleMatrix;
import org.mklab.nfc.nleq.NonLinearEquationSolver;
import org.mklab.nfc.ode.DoublePiecewiseContinuousAlgebraicSystem;
import org.mklab.nfc.ode.EquationSolver;
import org.mklab.nfc.ode.PiecewiseUtil;
import org.mklab.nfc.ode.SolverStopException;
import org.mklab.tool.control.system.parameter.Parameter;
import org.mklab.tool.control.system.parameter.ParameterUpdator;
import org.mklab.tool.control.system.parameter.StringExternalizable;


/**
 * 信号の値を制限するクラスです。 指定された値の範囲を超えるとシミュレーションを停止します。 計算を停止する例外を発生します。
 * 
 * @author koga
 * @version $Revision: 1.31 $, 2007/02/02
 */
public class DoubleRestrictor extends DoubleContinuousSink implements DoublePiecewiseContinuousAlgebraicSystem, ParameterUpdator, StringExternalizable {

  /** 許容範囲 */
  @Parameter(name = "range", description = "Restrictor.1", update = true, internationalization = true)
  private DoubleMatrix range = new DoubleMatrix(new double[] {Double.NEGATIVE_INFINITY, Double.POSITIVE_INFINITY});

  /** 制限される信号のリスト(1番から始まる) */
  private int[] restrictedSignals;

  /**
   * 新しく生成された<code>Restrictor</code>オブジェクトを初期化します。
   */
  public DoubleRestrictor() {
    super();
  }

  //  /**
  //   * 新しく生成された<code>Stopper</code>オブジェクトを初期化します。
  //   * @param size 信号の数
  //   */
  //  public Restrictor(final int size) {
  //    super(size);
  //    setupRange(Math.max(1, size));
  //  }

  /**
   * 許容範囲を設定します。
   * 
   * @param size 信号の数
   */
  private void setupRange(final int size) {
    final DoubleMatrix rangeMatrix = new DoubleMatrix(size, 2);
    for (int i = 1; i <= size; i++) {
      rangeMatrix.setElement(i, 1, Double.NEGATIVE_INFINITY);
      rangeMatrix.setElement(i, 2, Double.POSITIVE_INFINITY);
    }
    setRange(rangeMatrix);
  }

  /**
   * 新しく生成された<code>Stopper</code>オブジェクトを初期化します。
   * 
   * @param range 許容範囲 [[min1, max1][min2, max2]...[minN, maxN]]
   */
  public DoubleRestrictor(final DoubleMatrix range) {
    super(range.getRowSize());
    setRange(range);
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public DoubleMatrix outputEquation( final double t, final DoubleMatrix u) throws SolverStopException {
    // 方程式のソルバーが仮の値で計算しているか判定します
    final boolean solverTrial = EquationSolver.isTrial() || NonLinearEquationSolver.isTrial();

    if (solverTrial == false) {
      final DoubleMatrix realU = u;

      for (int i = 1; i <= this.restrictedSignals.length; i++) {
        final int number = this.restrictedSignals[i - 1];

        if (this.range.getDoubleElement(i, 1) <= realU.getDoubleElement(number) && realU.getDoubleElement(number) <= this.range.getDoubleElement(i, 2)) {
          continue;
        }

        // 入力が許容範囲を越えるとシミュレーションを停止する
        throw new SolverStopException(Messages.getString("Restrictor.0")); //$NON-NLS-1$
      }
    }

    return new DoubleMatrix(getInputSize(), 1);
  }

  /**
   * 許容範囲を設定します。
   * 
   * @param range 許容範囲
   */
  public void setRange(final DoubleMatrix range) {
    final int size = range.getRowSize();
    final int[] restrictedNumber = new int[size];
    for (int i = 0; i < size; i++) {
      restrictedNumber[i] = i + 1;
    }

    setRange(range, restrictedNumber);
  }

  /**
   * 許容範囲を設定します。
   * 
   * @param range 許容範囲
   * @param restrictedSignal 制限される信号のリスト(1番から始まる)
   */
  public void setRange(final DoubleMatrix range, final int[] restrictedSignal) {
    this.range = range.createClone();
    this.restrictedSignals = cloneIntArray(restrictedSignal);

    final int size = range.getRowSize();

    if (getInputSize() != size) {
      super.setInputSize(size);
    }
    if (getOutputSize() != size) {
      super.setOutputSize(size);
    }
  }

  private int[] cloneIntArray(int[] array) {
    final int[] clone = new int[array.length];
    System.arraycopy(array, 0, clone, 0, array.length);
    return clone;
  }

  /**
   * 許容範囲を返します。
   * 
   * @return 許容範囲
   */
  public DoubleMatrix getRange() {
    return this.range.createClone();
  }

  /**
   * @see org.mklab.tool.control.system.parameter.ParameterUpdator#updateWith(java.lang.String)
   */
  public boolean updateWith(final String parameter) {
    if (parameter.equals("range")) { //$NON-NLS-1$
      setRange(this.range);
      return true;
    }
    return false;
  }

  /**
   * @see org.mklab.tool.control.system.parameter.StringExternalizable#getString(java.lang.String)
   */
  public String getString(String key) {
    return Messages.getString(key);
  }

  /**
   * @see org.mklab.tool.control.system.sink.ContinuousSink#setInputSize(int)
   */
  @Override
  public void setInputSize(final int inputSize) {
    super.setInputSize(inputSize);
    if (inputSize == -1) {
      return;
    }

    if (this.range == null || this.range.getRowSize() != inputSize) {
      setupRange(inputSize);
    }
  }

  /**
   * @see org.mklab.tool.control.system.sink.ContinuousSink#setOutputSize(int)
   */
  @Override
  public void setOutputSize(final int outputSize) {
    super.setOutputSize(outputSize);

    if (outputSize == -1) {
      return;
    }

    if (this.range == null || this.range.getRowSize() != outputSize) {
      setupRange(outputSize);
    }
  }

  /**
   * {@inheritDoc}
   */
  @SuppressWarnings("boxing")
  public double getDiscontinuousPoint(double t1, DoubleMatrix u1, double t2, DoubleMatrix u2) {
    final List<Integer> pieces1 = getPiece(t1, u1);
    final List<Integer> pieces2 = getPiece(t2, u2);
    if (pieces1.equals(pieces2)) {
      return Double.NaN;
    }

    final int number = PiecewiseUtil.getDistinctPiece(pieces1, pieces2);
    final int piece1 = pieces1.get(number - 1);
    final int piece2 = pieces2.get(number - 1);

    final double uu1 = u1.getDoubleElement(number);
    final double uu2 = u2.getDoubleElement(number);

    final boolean fromOneToTwo = piece1 == 1 && piece2 == 2;
    final boolean fromTwoToOne = piece1 == 2 && piece2 == 1;

    final double maximum = this.range.getDoubleElement(number, 2);
    final double minimum = this.range.getDoubleElement(number, 1);

    if (fromOneToTwo || fromTwoToOne) {
      return t1 + (maximum - uu1) / (uu2 - uu1) * (t2 - t1);
    }

    final boolean fromOneToZero = piece1 == 1 && piece2 == 0;
    final boolean fromZeroToOne = piece1 == 0 && piece2 == 1;

    if (fromOneToZero || fromZeroToOne) {
      return t1 + (uu1 - minimum) / (uu1 - uu2) * (t2 - t1);
    }

    assert false : "never reached"; //$NON-NLS-1$

    return (t1 + t2) / 2;
  }

  /**
   * {@inheritDoc}
   */
  @SuppressWarnings("boxing")
  public List<Integer> getPiece( double t, DoubleMatrix u) {
    final int size = u.getRowSize();
    final List<Integer> pieces = new ArrayList<>(size);

    for (int i = 1; i <= size; i++) {
      final double uu = u.getDoubleElement(i);

      final double minimum = this.range.getDoubleElement(i, 1);
      final double maximum = this.range.getDoubleElement(i, 2);

      if (uu < minimum) {
        pieces.add(0);
      } else {
        if (uu < maximum) {
          pieces.add(1);
        } else {
          pieces.add(2);
        }
      }
    }

    return pieces;
  }

  /**
   * @see org.mklab.tool.control.system.SystemOperator#equals(java.lang.Object)
   */
  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (!super.equals(o)) {
      return false;
    }
    if (o == null) {
      return false;
    }
    if (o.getClass() != getClass()) {
      return false;
    }
    DoubleRestrictor castedObj = (DoubleRestrictor)o;
    return ((this.range == null ? castedObj.range == null : this.range.equals(castedObj.range)) && java.util.Arrays.equals(this.restrictedSignals, castedObj.restrictedSignals));
  }

  /**
   * @see org.mklab.tool.control.system.SystemOperator#hashCode()
   */
  @Override
  public int hashCode() {
    int hashCode = super.hashCode();
    hashCode = 31 * hashCode + (this.range == null ? 0 : this.range.hashCode());
    for (int i0 = 0; this.restrictedSignals != null && i0 < this.restrictedSignals.length; i0++) {
      hashCode = 31 * hashCode + this.restrictedSignals[i0];
    }
    return hashCode;
  }
}