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.hyperbolic; 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 HyperbolicDoubleCalculations { 031 032 // sinh, cosh, tanh, cotanh, sech, cosech 033 // asinh, acosh, atanh, acotanh, asech, acosech 034 035 /** 036 * Calculates the hyperbolic sinus of all entries in the matrix. 037 * 038 * @param returnType 039 * Select whether a new or a linked Matrix is returned, or if the 040 * operation is performed on the original Matrix 041 * @return Matrix with hyperbolic sinus values 042 */ 043 public Matrix sinh(Ret returnType) throws MatrixException; 044 045 /** 046 * Calculates the hyperbolic cosinus of all entries in the matrix. 047 * 048 * @param returnType 049 * Select whether a new or a linked Matrix is returned, or if the 050 * operation is performed on the original Matrix 051 * @return Matrix with hyperbolic cosinus values 052 */ 053 public Matrix cosh(Ret returnType) throws MatrixException; 054 055 /** 056 * Calculates the hyperbolic tangens of all entries in the matrix. 057 * 058 * @param returnType 059 * Select whether a new or a linked Matrix is returned, or if the 060 * operation is performed on the original Matrix 061 * @return Matrix with hyperbolic tangens values 062 */ 063 public Matrix tanh(Ret returnType) throws MatrixException; 064 065 }