001 /* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2007, by Object Refinery Limited and Contributors.
006 *
007 * Project Info: http://www.jfree.org/jfreechart/index.html
008 *
009 * This library is free software; you can redistribute it and/or modify it
010 * under the terms of the GNU Lesser General Public License as published by
011 * the Free Software Foundation; either version 2.1 of the License, or
012 * (at your option) any later version.
013 *
014 * This library is distributed in the hope that it will be useful, but
015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
017 * License for more details.
018 *
019 * You should have received a copy of the GNU Lesser General Public
020 * License along with this library; if not, write to the Free Software
021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
022 * USA.
023 *
024 * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
025 * in the United States and other countries.]
026 *
027 * ---------------------------
028 * NormalizedMatrixSeries.java
029 * ---------------------------
030 * (C) Copyright 2003-2007, by Barak Naveh and Contributors.
031 *
032 * Original Author: Barak Naveh;
033 * Contributor(s): David Gilbert (for Object Refinery Limited);
034 *
035 * Changes
036 * -------
037 * 10-Jul-2003 : Version 1 contributed by Barak Naveh (DG);
038 * 02-Feb-2007 : Removed author tags all over JFreeChart sources (DG);
039 *
040 */
041
042 package org.jfree.data.xy;
043
044
045 /**
046 * Represents a dense normalized matrix M[i,j] where each Mij item of the
047 * matrix has a value (default is 0). When a matrix item is observed using
048 * <code>getItem</code> method, it is normalized, that is, divided by the
049 * total sum of all items. It can be also be scaled by setting a scale factor.
050 */
051 public class NormalizedMatrixSeries extends MatrixSeries {
052
053 /** The default scale factor. */
054 public static final double DEFAULT_SCALE_FACTOR = 1.0;
055
056 /**
057 * A factor that multiplies each item in this series when observed using
058 * getItem method.
059 */
060 private double m_scaleFactor = DEFAULT_SCALE_FACTOR;
061
062 /** The sum of all items in this matrix */
063 private double m_totalSum;
064
065 /**
066 * Constructor for NormalizedMatrixSeries.
067 *
068 * @param name the series name.
069 * @param rows the number of rows.
070 * @param columns the number of columns.
071 */
072 public NormalizedMatrixSeries(String name, int rows, int columns) {
073 super(name, rows, columns);
074
075 /*
076 * we assum super is always initialized to all-zero matrix, so the
077 * total sum should be 0 upon initialization. However, we set it to
078 * Double.MIN_VALUE to get the same effect and yet avoid division by 0
079 * upon initialization.
080 */
081 this.m_totalSum = Double.MIN_VALUE;
082 }
083
084 /**
085 * Returns an item.
086 *
087 * @param itemIndex the index.
088 *
089 * @return The value.
090 *
091 * @see org.jfree.data.xy.MatrixSeries#getItem(int)
092 */
093 public Number getItem(int itemIndex) {
094 int i = getItemRow(itemIndex);
095 int j = getItemColumn(itemIndex);
096
097 double mij = get(i, j) * this.m_scaleFactor;
098 Number n = new Double(mij / this.m_totalSum);
099
100 return n;
101 }
102
103 /**
104 * Sets the factor that multiplies each item in this series when observed
105 * using getItem mehtod.
106 *
107 * @param factor new factor to set.
108 *
109 * @see #DEFAULT_SCALE_FACTOR
110 */
111 public void setScaleFactor(double factor) {
112 this.m_scaleFactor = factor;
113 // FIXME: this should generate a series change event
114 }
115
116
117 /**
118 * Returns the factor that multiplies each item in this series when
119 * observed using getItem mehtod.
120 *
121 * @return The factor
122 */
123 public double getScaleFactor() {
124 return this.m_scaleFactor;
125 }
126
127
128 /**
129 * Updates the value of the specified item in this matrix series.
130 *
131 * @param i the row of the item.
132 * @param j the column of the item.
133 * @param mij the new value for the item.
134 *
135 * @see #get(int, int)
136 */
137 public void update(int i, int j, double mij) {
138 this.m_totalSum -= get(i, j);
139 this.m_totalSum += mij;
140
141 super.update(i, j, mij);
142 }
143
144 /**
145 * @see org.jfree.data.xy.MatrixSeries#zeroAll()
146 */
147 public void zeroAll() {
148 this.m_totalSum = 0;
149 super.zeroAll();
150 }
151 }