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.entrywise.rounding;
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 RoundingDoubleCalculations {
031    
032            /**
033             * Returns a matrix with all entries rounded to integer values.
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             * @return Matrix with rounded values
039             */
040            public Matrix round(Ret returnType) throws MatrixException;
041    
042            /**
043             * Returns a matrix with all entries rounded down to the next integer. The
044             * result is a new Matrix.
045             * 
046             * @param returnType
047             *            Select whether a new or a linked Matrix is returned, or if the
048             *            operation is performed on the original Matrix
049             * @return Matrix with rounded values
050             */
051            public Matrix floor(Ret returnType) throws MatrixException;
052    
053            /**
054             * Returns a matrix with all entries rounded up to the next integer. The
055             * result is a new Matrix.
056             * 
057             * @param returnType
058             *            Select whether a new or a linked Matrix is returned, or if the
059             *            operation is performed on the original Matrix
060             * @return Matrix with rounded values
061             */
062            public Matrix ceil(Ret returnType) throws MatrixException;
063    
064    }