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.trigonometric;
025    
026    import org.ujmp.core.Matrix;
027    import org.ujmp.core.calculation.Calculation.Ret;
028    import org.ujmp.core.exceptions.MatrixException;
029    
030    /**
031     * This interface lists all trigonometric functions that can be calculated on a
032     * Matrix.
033     */
034    public interface TrigonometricDoubleCalculations {
035    
036            // sin, cos, tan, cot, sec, cosec
037            // asin, acos, atan, acot, asec, acosec
038    
039            /**
040             * Calculates the sinus of all entries in the matrix.
041             * 
042             * @param returnType
043             *            Select whether a new or a linked Matrix is returned, or if the
044             *            operation is performed on the original Matrix
045             * @return Matrix with sinus values
046             */
047            public Matrix sin(Ret returnType) throws MatrixException;
048    
049            /**
050             * Calculates the cosinus of all entries in the matrix.
051             * 
052             * @param returnType
053             *            Select whether a new or a linked Matrix is returned, or if the
054             *            operation is performed on the original Matrix
055             * @return Matrix with cosinus values
056             */
057            public Matrix cos(Ret returnType) throws MatrixException;
058    
059            /**
060             * Calculates the tangens of all entries in the matrix.
061             * 
062             * @param returnType
063             *            Select whether a new or a linked Matrix is returned, or if the
064             *            operation is performed on the original Matrix
065             * @return Matrix with tangens values
066             */
067            public Matrix tan(Ret returnType) throws MatrixException;
068    
069    }