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.misc;
025    
026    import org.ujmp.core.Matrix;
027    import org.ujmp.core.calculation.Calculation.Ret;
028    import org.ujmp.core.exceptions.MatrixException;
029    
030    public interface MiscGeneralDoubleCalculations {
031    
032            /**
033             * Subtracts the mean from the matrix.
034             * 
035             * @param returnType
036             *            Select whether a new or a linked Matrix is returned, or if the
037             *            operation is performed on the original Matrix
038             * @param dimension
039             *            The axis along which to calculate
040             * @param ignoreNaN
041             *            should missing values be ignored
042             * @return Matrix with zero mean.
043             */
044            public Matrix center(Ret returnType, int dimension, boolean ignoreNaN) throws MatrixException;
045    
046            /**
047             * Subtracts the mean from the matrix and divides by the standard deviation.
048             * 
049             * @param returnType
050             *            Select whether a new or a linked Matrix is returned, or if the
051             *            operation is performed on the original Matrix
052             * @param dimension
053             *            The axis along which to calculate
054             * @return Matrix with zero mean and unit variance.
055             */
056            public Matrix standardize(Ret returnType, int dimension) throws MatrixException;
057    
058            public Matrix normalize(Ret returnType, int dimension) throws MatrixException;
059    
060            public Matrix replaceMissingBy(Matrix matrix) throws MatrixException;
061    
062            public Matrix fadeIn(Ret ret, int dimension) throws MatrixException;
063    
064            public Matrix fadeOut(Ret ret, int dimensions) throws MatrixException;
065    
066            public Matrix appendHorizontally(Matrix m) throws MatrixException;
067    
068            public Matrix appendVertically(Matrix m) throws MatrixException;
069    
070            public Matrix append(int dimension, Matrix m) throws MatrixException;
071    
072    }