Saturation.java

/*
 * $Id$
 *
 * Copyright (C) 2004 Masanobu Koga. All rights reserved.
 */
package org.mklab.tool.control.system.discontinuous;

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

import org.mklab.nfc.matrix.ComplexNumericalMatrix;
import org.mklab.nfc.matrix.RealNumericalMatrix;
import org.mklab.nfc.ode.PiecewiseContinuousAlgebraicSystem;
import org.mklab.nfc.ode.PiecewiseUtil;
import org.mklab.nfc.scalar.ComplexNumericalScalar;
import org.mklab.nfc.scalar.RealNumericalScalar;
import org.mklab.tool.control.system.continuous.BaseContinuousStaticSystem;
import org.mklab.tool.control.system.parameter.Parameter;
import org.mklab.tool.control.system.parameter.StringExternalizable;


/**
 * 飽和システムを表すクラスです。
 * 
 * @author koga
 * @version $Revision$
  * @param <RS> type of real scalar
 * @param <RM> type of real matrix
 * @param <CS> type of complex scalar
 * @param <CM> type of complex matrix
*/
public class Saturation<RS extends RealNumericalScalar<RS, RM, CS, CM>, RM extends RealNumericalMatrix<RS, RM, CS, CM>, CS extends ComplexNumericalScalar<RS, RM, CS, CM>, CM extends ComplexNumericalMatrix<RS, RM, CS, CM>> extends BaseContinuousStaticSystem<RS,RM,CS,CM> implements PiecewiseContinuousAlgebraicSystem<RS,RM,CS,CM>, StringExternalizable {

  /** 出力の最小値 */
  @Parameter(name = "minimum", description = "Saturation.1", internationalization = true)
  private RS minimum;

  /** 出力の最大値 */
  @Parameter(name = "maximum", description = "Saturation.3", internationalization = true)
  private RS maximum;

  /**
   * コンストラクター
   * @param sunit unit of scalar
   */
  public Saturation(RS sunit) {
    this(sunit.create(-1), sunit.create(1), sunit);
  }

  /**
   * 新しく生成された<code>Saturation</code>オブジェクトを初期化します。
   * 
   * @param minimum 出力の最小値
   * @param maximum 出力の最大値
   * @param sunit unit of scalar
   */
  public Saturation(final RS minimum, final RS maximum, RS sunit) {
    super(-1, -1, sunit);
    setAutoSize(true);
    setHasDirectFeedthrough(true);
    setMinimum(minimum);
    setMaximum(maximum);
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public RM outputEquation( final RS t, final RM u) {
    final int size = u.getRowSize();
    final RM y = this.sunit.createZeroGrid(size, 1);

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

      if (uu.isLessThan(this.minimum)) {
        y.setElement(i, 1, this.minimum);
      } else if (uu.isGreaterThan(this.maximum)) {
        y.setElement(i, 1, this.maximum);
      } else {
        y.setElement(i, 1, uu);
      }
    }

    return y;
  }

  /**
   * 最小値を設定します。
   * 
   * @param mininum 最小値
   */
  public void setMinimum(final RS mininum) {
    this.minimum = mininum;
  }

  /**
   * 最大値を設定します。
   * 
   * @param maximum 最大値
   */
  public void setMaximum(final RS maximum) {
    this.maximum = maximum;
  }

  /**
   * 最小値を返します。
   * 
   * @return 最小値
   */
  public RS getMinimum() {
    return this.minimum;
  }

  /**
   * 最大値を返します。
   * 
   * @return 最大値
   */
  public RS getMaximum() {
    return this.maximum;
  }

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

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

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

    return pieces;
  }

  /**
   * {@inheritDoc}
   */
  @SuppressWarnings("boxing")
  public RS getDiscontinuousPoint(final RS t1, final RM u1, final RS t2, final RM u2) {
    final List<Integer> pieces1 = getPiece(t1, u1);
    final List<Integer> pieces2 = getPiece(t2, u2);
    if (pieces1.equals(pieces2)) {
      return this.sunit.getNaN();
    }

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

    final RS uu1 = u1.getElement(number);
    final RS uu2 = u2.getElement(number);

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

    if (fromOneToTwo || fromTwoToOne) {
      return t1.add(this.maximum.subtract(uu1).divide(uu2.subtract(uu1)).multiply(t2.subtract(t1)));
    }

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

    if (fromOneToZero || fromZeroToOne) {
      return t1.add(uu1.subtract(this.minimum).divide(uu1.subtract(uu2)).multiply(t2.subtract(t1)));
    }

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

    return t1.add(t2).divide(2);
  }

  /**
   * @see org.mklab.tool.control.system.SystemOperator#setInputSize(int)
   */
  @Override
  public void setInputSize(final int size) {
    super.setInputSize(size);
    super.setOutputSize(size);
  }

  /**
   * @see org.mklab.tool.control.system.SystemOperator#setOutputSize(int)
   */
  @Override
  public void setOutputSize(final int size) {
    super.setInputSize(size);
    super.setOutputSize(size);
  }

  /**
   * @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.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;
    }
    Saturation<RS,RM,CS,CM> castedObj = (Saturation<RS,RM,CS,CM>)o;
    return ((this.minimum == castedObj.minimum) && (this.maximum == castedObj.maximum));
  }

  /**
   * @see org.mklab.tool.control.system.SystemOperator#hashCode()
   */
  @Override
  public int hashCode() {
    int hashCode = super.hashCode();
    hashCode = 31 * hashCode + (this.minimum.hashCode() ^ (this.minimum.hashCode() >>> 32));
    hashCode = 31 * hashCode + (this.maximum.hashCode() ^ (this.maximum.hashCode() >>> 32));
    return hashCode;
  }
}