TrigonometricFunction.java

/*
 * $Id: TrigonometricFunction.java,v 1.13 2008/07/16 03:51:37 koga Exp $
 *
 * Copyright (C) 2004 Koga Laboratory. All rights reserved.
 *
 */

package org.mklab.tool.control.system.math;

import org.mklab.nfc.matrix.ComplexNumericalMatrix;
import org.mklab.nfc.matrix.RealNumericalMatrix;
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 Laboratory
 * @version $Revision: 1.13 $, 2004/11/12
  * @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 TrigonometricFunction<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 StringExternalizable {

  /** 三角関数の種類 */
  @Parameter(name = "functionType", description = "TrigonometricFunction.1", internationalization = true)
  private TrigonometricFunctionType type;

  /**
   * 新しく生成された<code>TrigonometricFunction</code>オブジェクトを初期化します。
   * 
   * @param type 三角関数の種類
   * @param sunit unit of scalar
   */
  public TrigonometricFunction(final TrigonometricFunctionType type, RS sunit) {
    super(-1, -1, sunit);
    this.type = type;
    setAutoSize(true);
    setHasDirectFeedthrough(true);
  }

  
  /**
   * 新しく生成された<code>TrigonometricFunction</code>オブジェクトを初期化します。
   * @param sunit unit of scalar
   */
  public TrigonometricFunction(RS sunit) {
    this(TrigonometricFunctionType.SIN, sunit);
  }

  /**
   * @see org.mklab.tool.control.system.SystemOperator#toString()
   */
  @Override
  public String toString() {
    return this.type.toString();
  }

  /**
   * 関数の式を返します。
   * 
   * @return 関数の式
   */
  public String getFunction() {
    return this.type.getFunction();
  }

  /**
   * 三角関数の種類を取得します。
   * 
   * @return 三角関数の種類
   */
  public TrigonometricFunctionType getType() {
    return this.type;
  }

  /**
   * 三角関数の種類を設定します。
   * 
   * @param type 三角関数の種類
   */
  public void setType(TrigonometricFunctionType type) {
    this.type = type;
  }


  /**
   * {@inheritDoc}
   */
  @Override
  public RM outputEquation( final RS t, final RM u) {
    switch (this.type) {
      case SIN:
        return u.sinElementWise();
      case COS:
        return u.cosElementWise();
      case TAN:
        return u.tanElementWise();
      case ASIN:
        return u.asinElementWise();
      case ACOS:
        return u.acosElementWise();
      case ATAN:
        return u.atanElementWise();
      case ATAN2:
        final int size = u.getRowSize();
        final RM u1 = u.getSubVector(1, size / 2);
        final RM u2 = u.getSubVector(size / 2 + 1, size);
        return u1.atan2ElementWise(u2);
      case SINH:
        return u.sinhElementWise();
      case COSH:
        return u.coshElementWise();
      case TANH:
        return u.tanhElementWise();
      case ASINH:
        return u.asinhElementWise();
      case ACOSH:
        return u.acoshElementWise();
      case ATANH:
        return u.atanhElementWise();
      default:
        assert false : "never reached"; //$NON-NLS-1$
    }

    return this.sunit.createZeroGrid(u.getRowSize(), 1);
  }

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

    if (this.type == TrigonometricFunctionType.ATAN2) {
      super.setOutputSize(size / 2);
    } else {
      super.setOutputSize(size);
    }
  }

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

    if (this.type == TrigonometricFunctionType.ATAN2) {
      super.setInputSize(size * 2);
    } else {
      super.setInputSize(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;
    }
    TrigonometricFunction<RS,RM,CS,CM> castedObj = (TrigonometricFunction<RS,RM,CS,CM>)o;
    return ((this.type == null ? castedObj.type == null : this.type.equals(castedObj.type)));
  }

  /**
   * @see org.mklab.tool.control.system.SystemOperator#hashCode()
   */
  @Override
  public int hashCode() {
    int hashCode = super.hashCode();
    hashCode = 31 * hashCode + (this.type == null ? 0 : this.type.hashCode());
    return hashCode;
  }
}