/*
 * Copyright (C) 2008-2015 by Holger Arndt
 *
 * This file is part of the Universal Java Matrix Package (UJMP).
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership and licensing.
 *
 * UJMP is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * UJMP is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with UJMP; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA  02110-1301  USA
 */

package org.ujmp.core;

import java.io.File;
import java.io.IOException;
import java.net.UnknownHostException;

import org.ujmp.core.annotation.HasMetaData;
import org.ujmp.core.calculation.CanPerformCalculations;
import org.ujmp.core.calculation.DivideMatrix;
import org.ujmp.core.calculation.DivideMatrixCalculation;
import org.ujmp.core.calculation.DivideScalar;
import org.ujmp.core.calculation.DivideScalarCalculation;
import org.ujmp.core.calculation.MinusMatrix;
import org.ujmp.core.calculation.MinusMatrixCalculation;
import org.ujmp.core.calculation.MinusScalar;
import org.ujmp.core.calculation.MinusScalarCalculation;
import org.ujmp.core.calculation.Mtimes;
import org.ujmp.core.calculation.MtimesCalculation;
import org.ujmp.core.calculation.PlusMatrix;
import org.ujmp.core.calculation.PlusMatrixCalculation;
import org.ujmp.core.calculation.PlusScalar;
import org.ujmp.core.calculation.PlusScalarCalculation;
import org.ujmp.core.calculation.TimesMatrix;
import org.ujmp.core.calculation.TimesMatrixCalculation;
import org.ujmp.core.calculation.TimesScalar;
import org.ujmp.core.calculation.TimesScalarCalculation;
import org.ujmp.core.calculation.Transpose;
import org.ujmp.core.calculation.TransposeCalculation;
import org.ujmp.core.doublematrix.calculation.general.decomposition.Chol;
import org.ujmp.core.doublematrix.calculation.general.decomposition.Eig;
import org.ujmp.core.doublematrix.calculation.general.decomposition.Inv;
import org.ujmp.core.doublematrix.calculation.general.decomposition.LU;
import org.ujmp.core.doublematrix.calculation.general.decomposition.QR;
import org.ujmp.core.doublematrix.calculation.general.decomposition.SVD;
import org.ujmp.core.doublematrix.calculation.general.decomposition.Solve;
import org.ujmp.core.export.destinationselector.MatrixExportDestinationSelector;
import org.ujmp.core.importer.sourceselector.MatrixImportSourceSelector;
import org.ujmp.core.interfaces.Conversions;
import org.ujmp.core.interfaces.CoordinateFunctions;
import org.ujmp.core.interfaces.CoreObject;
import org.ujmp.core.interfaces.DistanceMeasures;
import org.ujmp.core.interfaces.ExtendedMatrixProperties;
import org.ujmp.core.interfaces.GettersAndSetters;
import org.ujmp.core.matrix.factory.DefaultDenseMatrixFactory;

/**
 * Matrix is the main class for storing any type of data. You have
 * to choose the suitable implementation for your needs, e.g.
 * DefaultDenseDoubleMatrix2D to store double values or
 * DefaultGenericMatrix if you want to specify the object type.
 * 
 * @author Holger Arndt
 */
public interface Matrix extends BaseMatrix, CoreObject, CoordinateFunctions, GettersAndSetters,
		CanPerformCalculations, DistanceMeasures, Comparable, HasMetaData, Conversions,
		ExtendedMatrixProperties {

	/**
	 * A factory for creating matrices.
	 */
	public static final DefaultDenseMatrixFactory Factory = new DefaultDenseMatrixFactory();

	public static TransposeCalculation transpose = Transpose.MATRIX;

	public static PlusMatrixCalculation plusMatrix = PlusMatrix.MATRIX;

	public static MinusMatrixCalculation minusMatrix = MinusMatrix.MATRIX;

	public static TimesMatrixCalculation timesMatrix = TimesMatrix.MATRIX;

	public static DivideMatrixCalculation divideMatrix = DivideMatrix.MATRIX;

	public static PlusScalarCalculation plusScalar = PlusScalar.MATRIX;

	public static MinusScalarCalculation minusScalar = MinusScalar.MATRIX;

	public static TimesScalarCalculation timesScalar = TimesScalar.MATRIX;

	public static DivideScalarCalculation divideScalar = DivideScalar.MATRIX;

	public static MtimesCalculation mtimes = Mtimes.MATRIX;

	public static SVD svd = org.ujmp.core.doublematrix.calculation.general.decomposition.SVD.INSTANCE;

	public static LU lu = org.ujmp.core.doublematrix.calculation.general.decomposition.LU.INSTANCE;

	public static QR qr = org.ujmp.core.doublematrix.calculation.general.decomposition.QR.INSTANCE;

	public static Inv inv = Inv.INSTANCE;

	public static Solve solve = Solve.INSTANCE;

	public static Chol chol = Chol.INSTANCE;

	public static Eig eig = Eig.INSTANCE;

	public Matrix clone();

	public MatrixExportDestinationSelector exportTo();

	public MatrixImportSourceSelector importFrom();

	public void share(String hostname, int port) throws UnknownHostException, IOException;

	public void share(int port) throws IOException;

	public void fireValueChanged();

	public void fireValueChanged(Coordinates coordinates, Object object);

	public void fireValueChanged(Coordinates start, Coordinates end);

	public void save(File file) throws IOException;

	public void save(String filename) throws IOException;

	public String toHtml();

}