Product.java

/*
 * Created on 2007/04/30
 * Copyright (C) 2007 Koga Laboratory. All rights reserved.
 *
 */
package org.mklab.tool.control.system.math;

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

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;


/**
 * 入力の乗算・除算した結果を出力するシステムを表わすクラスです。
 * 
 * @author koga
 * @version $Revision: 1.6 $, 2007/04/30
  * @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 Product<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> {

  /** 乗算または除算の指定(乗算ならばtrue、除算ならばfalse) */
  private List<Boolean> multipliers;

  /**
   * 新しく生成された<code>Product</code>オブジェクトを初期化します。
   * @param sunit unit of scalar
   */
  @SuppressWarnings("boxing")
  public Product(RS sunit) {
    this(new ArrayList<>(Arrays.asList(new Boolean[] {true})), sunit);
  }

  /**
   * 新しく生成された<code>Product</code>オブジェクトを初期化します。
   * 
   * @param multipliers 乗算または除算の指定(乗算ならばtrue、除算ならばfalse)
   * @param sunit unit of scalar
   */
  public Product(final List<Boolean> multipliers, RS sunit) {
    super(-1, -1, sunit);
    setAutoSize(true);

    this.multipliers = new ArrayList<>(multipliers.size());
    for (final Boolean multiplier : multipliers) {
      this.multipliers.add(multiplier);
    }
  }

  /**
   * {@inheritDoc}
   */
  @SuppressWarnings("boxing")
  @Override
  public RM outputEquation( final RS t, final RM u) {
    final int outputSize = getOutputSize();
    RM y = u.getSubVector(1, outputSize);

    int offset = outputSize;
    for (final Boolean multiplier : this.multipliers) {
      final RM ui = u.getSubVector(offset + 1, offset + outputSize);
      if (multiplier) {
        y = y.multiplyElementWise(ui);
      } else {
        y = y.divideElementWise(ui);
      }

      offset += outputSize;
    }

    return y;
  }

  /**
   * 乗算または除算の指定(乗算ならばtrue、除算ならばfalse)を設定します。
   * 
   * @param multipliers 乗算または除算の指定(乗算ならばtrue、除算ならばfalse)
   */
  public void setMultipliers(final List<Boolean> multipliers) {
    this.multipliers = new ArrayList<>(multipliers.size());
    for (Boolean multiplier : multipliers) {
      this.multipliers.add(multiplier);
    }
  }

  /**
   * @see org.mklab.tool.control.system.SystemOperator#setInputSize(int)
   */
  @Override
  public void setInputSize(final int size) {
    super.setInputSize(size);
    if (this.multipliers == null) {
      super.setOutputSize(size);
    } else {
      super.setOutputSize(size / (this.multipliers.size() + 1));
    }
  }

  /**
   * @see org.mklab.tool.control.system.SystemOperator#setOutputSize(int)
   */
  @Override
  public void setOutputSize(final int size) {
    super.setOutputSize(size);
    if (this.multipliers == null) {
      super.setInputSize(size);
    } else {
      super.setInputSize(size * (this.multipliers.size() + 1));
    }
  }

  /**
   * @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;
    }
    Product<RS,RM,CS,CM> castedObj = (Product<RS,RM,CS,CM>)o;
    return ((this.multipliers == null ? castedObj.multipliers == null : this.multipliers.equals(castedObj.multipliers)));
  }

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