001 /* 002 * Copyright (C) 2008-2010 by Holger Arndt 003 * 004 * This file is part of the Universal Java Matrix Package (UJMP). 005 * See the NOTICE file distributed with this work for additional 006 * information regarding copyright ownership and licensing. 007 * 008 * UJMP is free software; you can redistribute it and/or modify 009 * it under the terms of the GNU Lesser General Public License as 010 * published by the Free Software Foundation; either version 2 011 * of the License, or (at your option) any later version. 012 * 013 * UJMP is distributed in the hope that it will be useful, 014 * but WITHOUT ANY WARRANTY; without even the implied warranty of 015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 016 * GNU Lesser General Public License for more details. 017 * 018 * You should have received a copy of the GNU Lesser General Public 019 * License along with UJMP; if not, write to the 020 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, 021 * Boston, MA 02110-1301 USA 022 */ 023 024 package org.ujmp.core.doublematrix.calculation.general.statistical; 025 026 import org.ujmp.core.Matrix; 027 import org.ujmp.core.annotation.Annotation; 028 import org.ujmp.core.annotation.DefaultAnnotation; 029 import org.ujmp.core.doublematrix.calculation.AbstractDoubleCalculation; 030 import org.ujmp.core.exceptions.MatrixException; 031 032 public class Std extends AbstractDoubleCalculation { 033 private static final long serialVersionUID = 6318655294298955306L; 034 035 private Matrix variance = null; 036 037 private boolean ignoreNaN = false; 038 039 public Std(int dimension, boolean ignoreNaN, Matrix matrix) { 040 super(dimension, matrix); 041 this.ignoreNaN = ignoreNaN; 042 Annotation aold = matrix.getAnnotation(); 043 if (aold != null) { 044 Annotation a = new DefaultAnnotation(getSize()); 045 a.setMatrixAnnotation(aold.getMatrixAnnotation()); 046 if (dimension == ROW) { 047 a.setDimensionMatrix(ROW, aold.getDimensionMatrix(ROW)); 048 } else if (dimension == COLUMN) { 049 a.setDimensionMatrix(COLUMN, aold.getDimensionMatrix(COLUMN)); 050 } 051 setAnnotation(a); 052 } 053 } 054 055 public double getDouble(long... coordinates) throws MatrixException { 056 if (variance == null) { 057 variance = new Var(getDimension(), ignoreNaN, getSource()).calcNew(); 058 } 059 return Math.sqrt(variance.getAsDouble(coordinates)); 060 } 061 062 public long[] getSize() { 063 switch (getDimension()) { 064 case ROW: 065 return new long[] { 1, getSource().getSize()[COLUMN] }; 066 case COLUMN: 067 return new long[] { getSource().getSize()[ROW], 1 }; 068 case ALL: 069 return new long[] { 1, 1 }; 070 } 071 return null; 072 } 073 074 }