/* An interpolator for a specified array of indexes and values.
Copyright (c) 1998-2009 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
*/
//////////////////////////////////////////////////////////////////////////
//// Interpolator
package ptolemy.backtrack.automatic.ptolemy.actor.lib;
import java.lang.Object;
import ptolemy.actor.lib.SequenceSource;
import ptolemy.backtrack.Checkpoint;
import ptolemy.backtrack.Rollbackable;
import ptolemy.backtrack.automatic.ptolemy.math.Interpolation;
import ptolemy.backtrack.util.CheckpointRecord;
import ptolemy.backtrack.util.FieldRecord;
import ptolemy.data.ArrayToken;
import ptolemy.data.DoubleToken;
import ptolemy.data.IntToken;
import ptolemy.data.expr.Parameter;
import ptolemy.data.type.ArrayType;
import ptolemy.data.type.BaseType;
import ptolemy.kernel.CompositeEntity;
import ptolemy.kernel.util.Attribute;
import ptolemy.kernel.util.IllegalActionException;
import ptolemy.kernel.util.NameDuplicationException;
import ptolemy.kernel.util.Workspace;
/**
* <p>Produce an interpolation based on the parameters.
* This class uses the Interpolation class in the math package to compute
* the interpolation.
* The <i>values</i> parameter specifies a sequence of values
* to produce at the output. The <i>indexes</i> parameter specifies
* when those values should be produced.
* The values and indexes parameters must both contain
* arrays, and have equal lengths or an exception will be thrown.
* The <i>indexes</i> array must be increasing and non-negative.
* The values are periodic if the <i>period</i> parameter contains a
* positive value. In this case, the period must be greater than the
* largest index, and values within the index range 0 to (period-1) are
* repeated indefinitely. If the period is zero, the values are not
* periodic, and the values outside the range of the indexes are
* considered to be 0.0. The <i>order</i> parameter
* specifies which order of interpolation to apply whenever the
* iteration count does not match an index in <i>indexes</i>.
* The Interpolation class currently supports zero, first, and third
* order interpolations. The default parameter are those set in the
* Interpolation class.</p>
* <p>
* This actor counts iterations. Whenever the iteration count matches an entry
* in the <i>indexes</i> array, the corresponding entry (at the same position)
* in the <i>values</i> array is produced at the output. Whenever the iteration
* count does not match a value in the <i>indexes</i> array, an interpolation
* of the values is produced at the output.</p>
* <p>
* Output type is DoubleToken.</p>
* @author Sarah Packman, Yuhong Xiong
* @version $Id$
* @since Ptolemy II 0.3
* @Pt.ProposedRating Yellow (yuhong)
* @Pt.AcceptedRating Yellow (yuhong)
* @see ptolemy.math.Interpolation
*/
public class Interpolator extends SequenceSource implements Rollbackable {
protected transient Checkpoint $CHECKPOINT = new Checkpoint(this);
// Initialize the parameters with the default settings of the
// Interpolation class. This is not required for this class to
// function. But since these parameters are public, other objects
// in the system may use them.
// Call this so that we don't have to copy its code here...
// set values parameter
///////////////////////////////////////////////////////////////////
//// public variables ////
/**
* The indexes at which the specified values will be produced.
* This parameter is an array of integers, with default value {0, 1}.
*/
public Parameter indexes;
/**
* The order of interpolation for non-index iterations.
* This parameter must contain an IntToken.
*/
public Parameter order;
/**
* The period of the reference values.
* This parameter must contain an IntToken.
*/
public Parameter period;
/**
* The values that will be produced at the specified indexes.
* This parameter is an array, with default value {1.0, 0.0}.
*/
public Parameter values;
///////////////////////////////////////////////////////////////////
//// public methods ////
// Check nondecreasing property.
///////////////////////////////////////////////////////////////////
//// private variables ////
// Cache of indexes array value.
// Cache of values array value.
private transient int[] _indexes;
private int _iterationCount = 0;
private Interpolation _interpolation;
private transient double[] _values;
/**
* Construct an actor with the specified container and name.
* @param container The container.
* @param name The name of this actor.
* @exception IllegalActionException If the entity cannot be contained
* by the proposed container.
* @exception NameDuplicationException If the container already has an
* actor with this name.
*/
public Interpolator(CompositeEntity container, String name) throws NameDuplicationException, IllegalActionException {
super(container, name);
$ASSIGN$_interpolation(new Interpolation());
indexes = new Parameter(this, "indexes");
indexes.setExpression("{0, 1}");
indexes.setTypeEquals(new ArrayType(BaseType.INT));
attributeChanged(indexes);
values = new Parameter(this, "values");
values.setExpression("{1.0, 0.0}");
values.setTypeEquals(new ArrayType(BaseType.DOUBLE));
int defOrder = _interpolation.getOrder();
IntToken defOrderToken = new IntToken(defOrder);
order = new Parameter(this, "order", defOrderToken);
order.setTypeEquals(BaseType.INT);
int defPeriod = _interpolation.getPeriod();
IntToken defPeriodToken = new IntToken(defPeriod);
period = new Parameter(this, "period", defPeriodToken);
period.setTypeEquals(BaseType.INT);
output.setTypeEquals(BaseType.DOUBLE);
}
/**
* Check the validity of the parameter.
* @param attribute The attribute that changed.
* @exception IllegalActionException If the argument is the
* <i>values</i> parameter and it does not contain an one dimensional
* array; or the argument is the <i>indexes</i> parameter and it does
* not contain an one dimensional array or is not increasing and
* non-negative; or the argument is the <i>period</i> parameter and is
* negative; or the argument is the <i>order</i> parameter and the order
* is not supported by the Interpolation class.
*/
public void attributeChanged(Attribute attribute) throws IllegalActionException {
if (attribute == values) {
ArrayToken valuesValue = (ArrayToken)values.getToken();
$ASSIGN$_values(new double[valuesValue.length()]);
for (int i = 0; i < valuesValue.length(); i++) {
$ASSIGN$_values(i, ((DoubleToken)valuesValue.getElement(i)).doubleValue());
}
_interpolation.setValues($BACKUP$_values());
} else if (attribute == indexes) {
ArrayToken indexesValue = (ArrayToken)indexes.getToken();
$ASSIGN$_indexes(new int[indexesValue.length()]);
int previous = 0;
for (int i = 0; i < indexesValue.length(); i++) {
$ASSIGN$_indexes(i, ((IntToken)indexesValue.getElement(i)).intValue());
if (_indexes[i] < previous) {
throw new IllegalActionException(this, "Value of indexes is not nondecreasing " + "and nonnegative.");
}
previous = _indexes[i];
}
_interpolation.setIndexes($BACKUP$_indexes());
} else if (attribute == period) {
int newPeriod = ((IntToken)period.getToken()).intValue();
_interpolation.setPeriod(newPeriod);
} else if (attribute == order) {
int newOrder = ((IntToken)order.getToken()).intValue();
_interpolation.setOrder(newOrder);
} else {
super.attributeChanged(attribute);
}
}
/**
* Clone the actor into the specified workspace. This calls the
* base class and then initializes private variables.
* public members to the parameters of the new actor.
* @param workspace The workspace for the new object.
* @return A new actor.
* @exception CloneNotSupportedException If a derived class contains
* an attribute that cannot be cloned.
*/
public Object clone(Workspace workspace) throws CloneNotSupportedException {
Interpolator newObject = (Interpolator)super.clone(workspace);
newObject.$ASSIGN$_indexes(new int[_indexes.length]);
System.arraycopy($BACKUP$_indexes(), 0, newObject.$BACKUP$_indexes(), 0, _indexes.length);
newObject.$ASSIGN$_interpolation(new Interpolation());
if (_values == null) {
newObject.$ASSIGN$_values(null);
} else {
newObject.$ASSIGN$_values(new double[_values.length]);
System.arraycopy($BACKUP$_values(), 0, newObject.$BACKUP$_values(), 0, _values.length);
}
return newObject;
}
/**
* Output the value at the current iteration count. The output is
* one of the reference values if the iteration count matches one
* of the indexes, or is interpolated otherwise.
* @exception IllegalActionException If the <i>values</i> and
* <i>indexes</i> parameters do not contain arrays of the same length,
* or the period is not 0 and not greater than the largest index.
*/
public void fire() throws IllegalActionException {
super.fire();
double result = _interpolation.interpolate(_iterationCount);
output.send(0, new DoubleToken(result));
}
/**
* Set the iteration count to zero.
* @exception IllegalActionException If the super class throws it.
*/
public void initialize() throws IllegalActionException {
super.initialize();
$ASSIGN$_iterationCount(0);
}
/**
* Update the iteration counter, then call the super class method.
* @return A boolean returned by the super class method.
* @exception IllegalActionException If the super class throws it.
*/
public boolean postfire() throws IllegalActionException {
$ASSIGN$SPECIAL$_iterationCount(13, _iterationCount);
return super.postfire();
}
private final int[] $ASSIGN$_indexes(int[] newValue) {
if ($CHECKPOINT != null && $CHECKPOINT.getTimestamp() > 0) {
$RECORD$_indexes.add(null, _indexes, $CHECKPOINT.getTimestamp());
}
return _indexes = newValue;
}
private final int $ASSIGN$_indexes(int index0, int newValue) {
if ($CHECKPOINT != null && $CHECKPOINT.getTimestamp() > 0) {
$RECORD$_indexes.add(new int[] {
index0
}, _indexes[index0], $CHECKPOINT.getTimestamp());
}
return _indexes[index0] = newValue;
}
private final int[] $BACKUP$_indexes() {
$RECORD$_indexes.backup(null, _indexes, $CHECKPOINT.getTimestamp());
return _indexes;
}
private final int $ASSIGN$_iterationCount(int newValue) {
if ($CHECKPOINT != null && $CHECKPOINT.getTimestamp() > 0) {
$RECORD$_iterationCount.add(null, _iterationCount, $CHECKPOINT.getTimestamp());
}
return _iterationCount = newValue;
}
private final int $ASSIGN$SPECIAL$_iterationCount(int operator, long newValue) {
if ($CHECKPOINT != null && $CHECKPOINT.getTimestamp() > 0) {
$RECORD$_iterationCount.add(null, _iterationCount, $CHECKPOINT.getTimestamp());
}
switch (operator) {
case 0:
return _iterationCount += newValue;
case 1:
return _iterationCount -= newValue;
case 2:
return _iterationCount *= newValue;
case 3:
return _iterationCount /= newValue;
case 4:
return _iterationCount &= newValue;
case 5:
return _iterationCount |= newValue;
case 6:
return _iterationCount ^= newValue;
case 7:
return _iterationCount %= newValue;
case 8:
return _iterationCount <<= newValue;
case 9:
return _iterationCount >>= newValue;
case 10:
return _iterationCount >>>= newValue;
case 11:
return _iterationCount++;
case 12:
return _iterationCount--;
case 13:
return ++_iterationCount;
case 14:
return --_iterationCount;
default:
return _iterationCount;
}
}
private final Interpolation $ASSIGN$_interpolation(Interpolation newValue) {
if ($CHECKPOINT != null && $CHECKPOINT.getTimestamp() > 0) {
$RECORD$_interpolation.add(null, _interpolation, $CHECKPOINT.getTimestamp());
}
if (newValue != null && $CHECKPOINT != newValue.$GET$CHECKPOINT()) {
newValue.$SET$CHECKPOINT($CHECKPOINT);
}
return _interpolation = newValue;
}
private final double[] $ASSIGN$_values(double[] newValue) {
if ($CHECKPOINT != null && $CHECKPOINT.getTimestamp() > 0) {
$RECORD$_values.add(null, _values, $CHECKPOINT.getTimestamp());
}
return _values = newValue;
}
private final double $ASSIGN$_values(int index0, double newValue) {
if ($CHECKPOINT != null && $CHECKPOINT.getTimestamp() > 0) {
$RECORD$_values.add(new int[] {
index0
}, _values[index0], $CHECKPOINT.getTimestamp());
}
return _values[index0] = newValue;
}
private final double[] $BACKUP$_values() {
$RECORD$_values.backup(null, _values, $CHECKPOINT.getTimestamp());
return _values;
}
public void $COMMIT(long timestamp) {
FieldRecord.commit($RECORDS, timestamp, $RECORD$$CHECKPOINT.getTopTimestamp());
$RECORD$$CHECKPOINT.commit(timestamp);
}
public void $RESTORE(long timestamp, boolean trim) {
_indexes = (int[])$RECORD$_indexes.restore(_indexes, timestamp, trim);
_iterationCount = $RECORD$_iterationCount.restore(_iterationCount, timestamp, trim);
_interpolation = (Interpolation)$RECORD$_interpolation.restore(_interpolation, timestamp, trim);
_values = (double[])$RECORD$_values.restore(_values, timestamp, trim);
if (timestamp <= $RECORD$$CHECKPOINT.getTopTimestamp()) {
$CHECKPOINT = $RECORD$$CHECKPOINT.restore($CHECKPOINT, this, timestamp, trim);
FieldRecord.popState($RECORDS);
$RESTORE(timestamp, trim);
}
}
public final Checkpoint $GET$CHECKPOINT() {
return $CHECKPOINT;
}
public final Object $SET$CHECKPOINT(Checkpoint checkpoint) {
if ($CHECKPOINT != checkpoint) {
Checkpoint oldCheckpoint = $CHECKPOINT;
if (checkpoint != null) {
$RECORD$$CHECKPOINT.add($CHECKPOINT, checkpoint.getTimestamp());
FieldRecord.pushState($RECORDS);
}
$CHECKPOINT = checkpoint;
oldCheckpoint.setCheckpoint(checkpoint);
checkpoint.addObject(this);
}
return this;
}
protected transient CheckpointRecord $RECORD$$CHECKPOINT = new CheckpointRecord();
private transient FieldRecord $RECORD$_indexes = new FieldRecord(1);
private transient FieldRecord $RECORD$_iterationCount = new FieldRecord(0);
private transient FieldRecord $RECORD$_interpolation = new FieldRecord(0);
private transient FieldRecord $RECORD$_values = new FieldRecord(1);
private transient FieldRecord[] $RECORDS = new FieldRecord[] {
$RECORD$_indexes,
$RECORD$_iterationCount,
$RECORD$_interpolation,
$RECORD$_values
};
}