Median.java

/*
 * $Id: Median.java,v 1.20 2008/04/06 02:16:45 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.scalar.DoubleNumber;


/**
 * 中間値(メジアン)を求めるクラスです。
 * 
 * <p>Median value for all elements
 * 
 * @author koga
 * @version $Revision: 1.20 $
 */
public class Median {

  /**
   * <code>x</code> の全ての成分のメジアンを返します。
   * 
   * @param x 対象となる行列
   * @return 中間値(メジアン) (median)
   */
  public static DoubleNumber median(DoubleMatrix x) {
    return x.median();
  }

  /**
   * xが行列ならば、列毎のメジアンを成分とする行ベクトルを返します。
   * 
   * @param x 対象となる行列
   * @return 中間値(メジアン) (median vector)
   */
  public static DoubleMatrix medianColumnWise(DoubleMatrix x) {
    return x.medianColumnWise();
  }

  /**
   * <code>x</code> が行列ならば、行毎のメジアンを成分とする 列ベクトルを返します。
   * 
   * @param x 対象となる行列
   * @return 中間値(メジアン) (median vector)
   */
  public static DoubleMatrix medianRowWise(DoubleMatrix x) {
    return x.medianRowWise();
  }

}