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.intmatrix;
025    
026    import org.ujmp.core.exceptions.MatrixException;
027    import org.ujmp.core.genericmatrix.GenericMatrix;
028    
029    public interface IntMatrix extends GenericMatrix<Integer> {
030    
031            /**
032             * Returns an int representation of an entry in the matrix. The stored value
033             * will be converted to an int as good as possible.
034             * 
035             * @param coordinates
036             *            location of the entry
037             * @return an int representation of the entry
038             * @throws MatrixException
039             */
040            public int getInt(long... coordinates) throws MatrixException;
041    
042            /**
043             * Sets an entry in the matrix to an int value. If the matrix cannot store
044             * int values, the value will be represented as good as possible.
045             * 
046             * @param value
047             *            int value
048             * @param coordinates
049             *            location of the entry
050             * @throws MatrixException
051             */
052            public void setInt(int value, long... coordinates) throws MatrixException;
053    
054    }