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: * $Id: NormalizedMatrixSeries.java,v 1.3.2.3 2007/02/02 15:14:53 mungady Exp $
036: *
037: * Changes
038: * -------
039: * 10-Jul-2003 : Version 1 contributed by Barak Naveh (DG);
040: * 02-Feb-2007 : Removed author tags all over JFreeChart sources (DG);
041: *
042: */
043:
044: package org.jfree.data.xy;
045:
046: /**
047: * Represents a dense normalized matrix M[i,j] where each Mij item of the
048: * matrix has a value (default is 0). When a matrix item is observed using
049: * <code>getItem</code> method, it is normalized, that is, divided by the
050: * total sum of all items. It can be also be scaled by setting a scale factor.
051: */
052: public class NormalizedMatrixSeries extends MatrixSeries {
053:
054: /** The default scale factor. */
055: public static final double DEFAULT_SCALE_FACTOR = 1.0;
056:
057: /**
058: * A factor that multiplies each item in this series when observed using
059: * getItem method.
060: */
061: private double m_scaleFactor = DEFAULT_SCALE_FACTOR;
062:
063: /** The sum of all items in this matrix */
064: private double m_totalSum;
065:
066: /**
067: * Constructor for NormalizedMatrixSeries.
068: *
069: * @param name the series name.
070: * @param rows the number of rows.
071: * @param columns the number of columns.
072: */
073: public NormalizedMatrixSeries(String name, int rows, int columns) {
074: super (name, rows, columns);
075:
076: /*
077: * we assum super is always initialized to all-zero matrix, so the
078: * total sum should be 0 upon initialization. However, we set it to
079: * Double.MIN_VALUE to get the same effect and yet avoid division by 0
080: * upon initialization.
081: */
082: this .m_totalSum = Double.MIN_VALUE;
083: }
084:
085: /**
086: * Returns an item.
087: *
088: * @param itemIndex the index.
089: *
090: * @return The value.
091: *
092: * @see org.jfree.data.xy.MatrixSeries#getItem(int)
093: */
094: public Number getItem(int itemIndex) {
095: int i = getItemRow(itemIndex);
096: int j = getItemColumn(itemIndex);
097:
098: double mij = get(i, j) * this .m_scaleFactor;
099: Number n = new Double(mij / this .m_totalSum);
100:
101: return n;
102: }
103:
104: /**
105: * Sets the factor that multiplies each item in this series when observed
106: * using getItem mehtod.
107: *
108: * @param factor new factor to set.
109: *
110: * @see #DEFAULT_SCALE_FACTOR
111: */
112: public void setScaleFactor(double factor) {
113: this .m_scaleFactor = factor;
114: // FIXME: this should generate a series change event
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: * @see org.jfree.data.xy.MatrixSeries#update(int, int, double)
129: */
130: public void update(int i, int j, double mij) {
131: this .m_totalSum -= get(i, j);
132: this .m_totalSum += mij;
133:
134: super .update(i, j, mij);
135: }
136:
137: /**
138: * @see org.jfree.data.xy.MatrixSeries#zeroAll()
139: */
140: public void zeroAll() {
141: this .m_totalSum = 0;
142: super.zeroAll();
143: }
144: }
|