BiasFunction.java

/*
 * $Id: BiasFunction.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 BiasFunction<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 = "bias", description = "BiasFunction.1", internationalization = true)
  private RM bias = this.sunit.createZeroGrid(1, 1);

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

  /**
   * {@inheritDoc}
   */
  @Override
  public RM outputEquation( final RS t, final RM u) {
    return u.add(this.bias);
  }

  /**
   * バイアスを設定します。
   * 
   * @param bias バイアス
   */
  public void setBias(final RM bias) {
    this.bias = bias;
    setInputSize(bias.getRowSize());
  }

  /**
   * バイアスを返します。
   * 
   * @return バイアス
   */
  public RM getBias() {
    return this.bias;
  }

  /**
   * @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 opponent) {
    if (this == opponent) {
      return true;
    }
    if (!super.equals(opponent)) {
      return false;
    }
    if (opponent == null) {
      return false;
    }
    if (opponent.getClass() != getClass()) {
      return false;
    }
    BiasFunction<RS,RM,CS,CM> castedObj = (BiasFunction<RS,RM,CS,CM>)opponent;
    return ((this.bias == null ? castedObj.bias == null : this.bias.equals(castedObj.bias)));
  }

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

  /**
   * @see org.mklab.tool.control.system.SystemOperator#clone()
   */
  @Override
  public BiasFunction<RS,RM,CS,CM> clone() {
    BiasFunction<RS,RM,CS,CM> inst = (BiasFunction<RS,RM,CS,CM>)super.clone();
    inst.bias = this.bias == null ? null : inst.bias.createClone();
    return inst;
  }
}