Quantizer.java

/*
 * $Id: Quantizer.java,v 1.15 2008/07/15 15:27:15 koga Exp $
 *
 * 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: 1.15 $
  * @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 Quantizer<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 = "interval", description = "Quantizer.1", internationalization = true)
  private RS interval;

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

  /**
   * 新しく生成された<code>Saturation</code>オブジェクトを初期化します。
   * 
   * @param interval 量子化間隔
   * @param sunit unit of scalar
   */
  public Quantizer(final RS interval, RS sunit) {
    super(-1, -1, sunit);
    setAutoSize(true);
    setHasDirectFeedthrough(true);
    setInterval(interval);
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public RM outputEquation( final RS t, final RM u) {
    return u.divide(this.interval).fixElementWise().multiply(this.interval);
  }

  /**
   * 量子化間隔を設定します。
   * 
   * @param interval 量子化間隔
   */
  public void setInterval(final RS interval) {
    this.interval = interval;
  }

  /**
   * 量子化間隔を返します。
   * 
   * @return 量子化間隔
   */
  public RS getInterval() {
    return this.interval;
  }

  /**
   * {@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, 1).divide(this.interval);
      final int piece;
      if (uu.isGreaterThanOrEquals(0)) {
        piece = (int)uu.floor().toDouble();
      } else {
        piece = (int)uu.ceil().toDouble();
      }
      pieces.add(piece);
    }

    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);

    int nextPiece;
    if (piece1 < piece2) {
      if (piece1 < 0) {
        nextPiece = piece1;
      } else {
        nextPiece = piece1 + 1;
      }
    } else {
      if (piece1 <= 0) {
        nextPiece = piece1 - 1;
      } else {
        nextPiece = piece1;
      }
    }

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

    final RS nextLevel = this.interval.multiply(nextPiece);

    return t1.add(nextLevel.subtract(uu1).divide(uu2.subtract(uu1)).multiply(t2.subtract(t1)));
  }

  /**
   * @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);
  }
}