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.general.misc;
025    
026    import org.ujmp.core.Coordinates;
027    import org.ujmp.core.Matrix;
028    import org.ujmp.core.doublematrix.calculation.AbstractDoubleCalculation;
029    import org.ujmp.core.exceptions.MatrixException;
030    
031    public class FadeOut extends AbstractDoubleCalculation {
032            private static final long serialVersionUID = -2366094848097068297L;
033    
034            public FadeOut(int dimension, Matrix matrix) {
035                    super(dimension, matrix);
036            }
037    
038            
039            public double getDouble(long... coordinates) throws MatrixException {
040                    double factor = 0.0;
041                    switch (getDimension()) {
042                    case Matrix.COLUMN:
043                            factor = 1.0 - (double) coordinates[COLUMN]
044                                            / (double) (getSource().getColumnCount() - 1);
045                            break;
046                    case Matrix.ROW:
047                            factor = 1.0 - (double) coordinates[ROW] / (double) (getSource().getRowCount() - 1);
048                            break;
049                    default:
050                            factor = 1.0 - (double) Coordinates.product(coordinates)
051                                            / (double) (getSource().getRowCount() - 1);
052                            break;
053                    }
054                    return getSource().getAsDouble(coordinates) * factor;
055            }
056    }