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.calculation;
025    
026    import org.ujmp.core.booleanmatrix.calculation.BooleanCalculations;
027    import org.ujmp.core.doublematrix.calculation.DoubleCalculations;
028    import org.ujmp.core.intmatrix.calculation.IntCalculations;
029    import org.ujmp.core.objectmatrix.calculation.ObjectCalculations;
030    import org.ujmp.core.stringmatrix.calculation.StringCalculations;
031    
032    /**
033     * <p>
034     * This interface declares many methods for performing calculations on a matrix.
035     * Generally, there are three types of calculations:
036     * <ul>
037     * <li>Standard calculations such as <code>sum</code> or <code>plus</code>.</li>
038     * <li>Advanced calculations.</li>
039     * <li>Own implementations of calculations.</li>
040     * </ul>
041     * </p>
042     * 
043     * </p> Standard calculations are very easy to use, since these calculations can
044     * be directly used by calling the methods explicitely. E.g. for calculating the
045     * mean of a matrix, the method <code>mean</code> can be used. More advanced
046     * calculations are available by using the <code>calc</code> methods. The
047     * calculation to call can be either given by a String (containing the name of
048     * the calculation) or the corresponding enum from {@link Calculcation.Calc}.
049     * </p>
050     * 
051     * <p>
052     * Own calculations can be implemented by implementing the interface
053     * {@link Calculation} and using the the method <code>calc<code>.
054     * </p>
055     * 
056     * 
057     * 
058     * @see Calculation.Calc for available calculations
059     * @author Holger Arndt
060     * 
061     */
062    public interface CanPerformCalculations extends DoubleCalculations, BooleanCalculations,
063                    IntCalculations, StringCalculations, ObjectCalculations {
064    
065    }