Givens.java

/*
 * $Id: Givens.java,v 1.11 2008/03/15 00:23:40 koga Exp $
 * 
 * Copyright (C) 2004 Koga Laboratory. All rights reserved.
 */
package org.mklab.tool.matrix;

import org.mklab.nfc.matrix.DoubleMatrix;
import org.mklab.nfc.matrix.misc.GivensMatrix;
import org.mklab.nfc.scalar.DoubleNumber;


/**
 * ギブンス回転行列を求めるクラスです。
 * 
 * <p> Givens rotation matrix
 * 
 * @author koga
 * @version $Revision: 1.11 $
 */
public class Givens {

  /**
   * 2×2の複素ギブンス回転行列
   * 
   * <pre><code> | c s | | x | | r | G = | | ただし G * | | = | | |-conj(s) c | | y | | 0 | </code></pre>
   * 
   * を返します。ただし、<code>c</code>は実数、<code>s</code>は複素数であり、 <code>c^2 + s^2 = 1</code>を満たす。
   * 
   * @param x 数値1
   * @param y 数値2
   * @return ギブンンス回転行列 (givens rotation matrix)
   */
  public static DoubleMatrix givens(DoubleNumber x, DoubleNumber y) {
    return GivensMatrix.create(x, y);
  }

}