DoubleBiasFunction.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.DoubleMatrix;
import org.mklab.tool.control.system.continuous.DoubleBaseContinuousStaticSystem;
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
 */
public class DoubleBiasFunction extends DoubleBaseContinuousStaticSystem implements StringExternalizable {

  /** バイアス */
  @Parameter(name = "bias", description = "BiasFunction.1", internationalization = true)
  private DoubleMatrix bias = new DoubleMatrix(1, 1);

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

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

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

  /**
   * バイアスを返します。
   * 
   * @return バイアス
   */
  public DoubleMatrix 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;
    }
    DoubleBiasFunction castedObj = (DoubleBiasFunction)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 DoubleBiasFunction clone() {
    DoubleBiasFunction inst = (DoubleBiasFunction)super.clone();
    inst.bias = this.bias == null ? null : inst.bias.createClone();
    return inst;
  }
}