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;
025    
026    import org.ujmp.core.doublematrix.factory.DefaultDenseDoubleMatrixFactory;
027    import org.ujmp.core.doublematrix.factory.DoubleMatrixFactory;
028    import org.ujmp.core.exceptions.MatrixException;
029    import org.ujmp.core.genericmatrix.GenericMatrix;
030    
031    public interface DoubleMatrix extends GenericMatrix<Double> {
032    
033            public static DoubleMatrixFactory factory = new DefaultDenseDoubleMatrixFactory();
034    
035            /**
036             * Returns a double representation of an entry in the matrix. The stored
037             * value will be converted to a double as good as possible.
038             * 
039             * @param coordinates
040             *            location of the entry
041             * @return a double representation of the entry
042             * @throws MatrixException
043             */
044            public double getDouble(long... coordinates) throws MatrixException;
045    
046            /**
047             * Sets an entry in the matrix to a double value. If the matrix cannot store
048             * double values, the value will be represented as good as possible.
049             * 
050             * @param value
051             *            double value
052             * @param coordinates
053             *            location of the entry
054             * @throws MatrixException
055             */
056            public void setDouble(double value, long... coordinates) throws MatrixException;
057    
058            public DoubleMatrixFactory getFactory();
059    }