DoubleNormalRandomSource.java

/*
 * Created on 2008/06/02
 * Copyright (C) 2008 Koga Laboratory. All rights reserved.
 *
 */
package org.mklab.tool.control.system.source;

import org.mklab.nfc.matrix.DoubleMatrix;
import org.mklab.tool.control.system.parameter.Parameter;
import org.mklab.tool.control.system.parameter.ParameterUpdator;
import org.mklab.tool.control.system.parameter.StringExternalizable;


/**
 * 平均(デフォルト:0)から分散(デフォルト:1)の正規分布の乱数を生成するシステムを表わすクラスです。
 * 
 * @author koga
 * @version $Revision: 1.4 $, 2008/06/02
 */
public class DoubleNormalRandomSource extends DoubleContinuousSource implements ParameterUpdator, StringExternalizable {

  /** 平均 */
  @Parameter(name = "mean", description = "NormalRandomSource.2", update = true, internationalization = true)
  private double mean = 0.0;

  /** 分散 */
  @Parameter(name = "variance", description = "NormalRandomSource.3", update = true, internationalization = true)
  private double variance = 1.0;

  /** 乱数のシード */
  @Parameter(name = "seed", description = "NormalRandomSource.1", update = true, internationalization = true)
  private long seed = 0L;

  /** 乱数生成クラス */
  private java.util.Random random = new java.util.Random(this.seed);

  /**
   * 新しく生成された<code>UniformRandomSource</code>オブジェクトを初期化します。
   */
  public DoubleNormalRandomSource() {
    super(1);
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public DoubleMatrix outputEquation( final double t) {
    final double y = this.random.nextGaussian() * Math.sqrt(this.variance) + this.mean;
    return new DoubleMatrix(new double[] {y});
  }

  /**
   * @see org.mklab.tool.control.system.continuous.BaseContinuousStaticSystem#initialize()
   */
  @Override
  public void initialize() {
    super.initialize();
    this.random.setSeed(this.seed);
  }

  /**
   * @see org.mklab.tool.control.system.parameter.ParameterUpdator#updateWith(java.lang.String)
   */
  public boolean updateWith(String parameter) {
    if (parameter.equals("seed")) { //$NON-NLS-1$
      this.random.setSeed(this.seed);
      return true;
    }

    return false;
  }

  /**
   * @see org.mklab.tool.control.system.parameter.StringExternalizable#getString(java.lang.String)
   */
  @Override
  public String getString(String key) {
    return Messages.getString(key);
  }
}