/** Actor that reads a stream of double tokens and places them into a
 Upper Triangular Matrix.

 Copyright (c) 1999-2007 The Regents of the University of California.
 All rights reserved.
 Permission is hereby granted, without written agreement and without
 license or royalty fees, to use, copy, modify, and distribute this
 software and its documentation for any purpose, provided that the above
 copyright notice and the following two paragraphs appear in all copies
 of this software.

 IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
 THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
 SUCH DAMAGE.

 THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
 PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
 CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
 ENHANCEMENTS, OR MODIFICATIONS.

 PT_COPYRIGHT_VERSION_2
 COPYRIGHTENDKEY

 */
package ptolemy.domains.pn.demo.QR;

import ptolemy.actor.lib.Transformer;
import ptolemy.data.DoubleMatrixToken;
import ptolemy.data.DoubleToken;
import ptolemy.data.IntToken;
import ptolemy.data.expr.Parameter;
import ptolemy.data.type.BaseType;
import ptolemy.kernel.CompositeEntity;
import ptolemy.kernel.util.Attribute;
import ptolemy.kernel.util.IllegalActionException;
import ptolemy.kernel.util.NameDuplicationException;

//////////////////////////////////////////////////////////////////////////
//// StreamToMatrix

/**

 Convert a stream of Double Tokens into a Matrix. The Matrix is
 considered to be an Upper triangular Matrix.
 @author Bart Kienhuis
 @version $Id: StreamToMatrix.java,v 1.2 1999/11/30 03:55:57 kienhuis
 @since Ptolemy II 0.4
 @Pt.ProposedRating Red (kienhuis)
 @Pt.AcceptedRating Red (cxh)
 Exp $
 */
public class StreamToMatrix extends Transformer {
    ///////////////////////////////////////////////////////////////////
    ////                         public methods                    ////

    /** Construct an actor with the given container and name.
     *  @param container The container.
     *  @param name The name of this actor.
     *  @exception IllegalActionException If the actor cannot be contained
     *   by the proposed container.
     *  @exception NameDuplicationException If the container already has an
     *   actor with this name.
     */
    public StreamToMatrix(CompositeEntity container, String name)
            throws IllegalActionException, NameDuplicationException {
        super(container, name);

        input.setTypeEquals(BaseType.DOUBLE);
        output.setTypeEquals(BaseType.DOUBLE_MATRIX);
        dimension = new Parameter(this, "dimension", new IntToken(6));

        // Initialize the dimension
        attributeChanged(dimension);
    }

    /** If the argument is the dimension parameter, update the
     *  the row and column values.
     *  @param attribute The attribute that changed.
     *  @exception IllegalActionException if no an integer value can
     *        be obtained from the dimension parameter.
     */
    public void attributeChanged(Attribute attribute)
            throws IllegalActionException {
        if (attribute == dimension) {
            _rows = ((IntToken) dimension.getToken()).intValue();
            _columns = ((IntToken) dimension.getToken()).intValue();
        } else {
            super.attributeChanged(attribute);
        }
    }

    /** Reads a stream of DoubleTokens and places these tokens in a
     *  Matrix. The Matrix produced is an Upper Triangular Matrix.
     *  @exception IllegalActionException If there is no director.
     */
    public void fire() throws IllegalActionException {
        super.fire();
        int runL = 0;
        double[][] image = new double[_rows][_columns];

        for (int i = 0; i < _rows; i++) {
            for (int j = 0; j < _columns; j++) {
                if (j >= runL) {
                    image[i][j] = ((DoubleToken) input.get(0)).doubleValue();
                } else {
                    image[i][j] = 0.0;
                }
            }

            runL++;
        }

        output.broadcast(new DoubleMatrixToken(image));
    }

    /** Initialize the row and column number.
     *  @exception IllegalActionException If the parent class throws it.
     */
    public void initialize() throws IllegalActionException {
        super.initialize();

        // Get the correct value from the parameters
        _rows = ((IntToken) dimension.getToken()).intValue();
        _columns = ((IntToken) dimension.getToken()).intValue();
    }

    ///////////////////////////////////////////////////////////////////
    ////                         public variables                  ////

    /** The dimension of the matrix.
     */
    public Parameter dimension;

    ///////////////////////////////////////////////////////////////////
    ////                         private variables                 ////
    private int _rows = 6;

    private int _columns = 6;
}