public class NonStrictTest extends Sink
This actor compares the inputs against the value specified by the correctValues parameter. That parameter is an ArrayToken, where each element of the array is of the same type as the input. On each firing where the input is present, the value of the input is compared against the next token in the correctValues parameter. If it matches, the firing succeeds. If it doesn't match, then an exception is thrown. After matching each of the value in the correctValues parameter, subsequent iterations always succeed, so the actor can be used as a "power-up" test for a model, checking the first few iterations against some known results.
Unlike the Test actor, NonStrictTest does not support a multiport input, only single port inputs are supported. This also differs from Test in that it ignores absent inputs, and it checks the inputs in the postfire() method rather than the fire() method.
This actor accepts any type of data on its input port, therefore it
doesn't declare a type, but lets the type resolution algorithm find
the least fixed point. If backward type inference is enabled, and
no input type has been declared, the input is constrained to be
equal to BaseType.GENERAL. This will result in upstream
ports resolving to the most general type rather than the most specific.
If the input is a DoubleToken or ComplexToken, then the comparison passes if the value is close to what it should be, within the specified tolerance (which defaults to 10-9). During training, if a correct value is greater than 10 orders of magnitude than the tolerance, then the tolerance is changed to a value 9 orders of magnitude less than the correct value. This helps avoid comparisons beyond the precision of a Java double.
If the parameter trainingMode is true, then instead of performing the test, this actor collects the inputs into the correctValues parameter. Thus, to use this actor, you can place it in a model, set trainingMode to true to collect the reference data, then set trainingMode to false. Any subsequent run of the actor will throw an exception if the input data does not match the training data. The value of the reference token is set in the wrapup() method. The trainingMode parameter is a shared parameter, meaning that if you change it for any one instance of this actor in the model, then it will be changed for all instances.
Test| Yellow (cxh) |
| Yellow (cxh) |
Entity.ContainedObjectsIterator| Modifier and Type | Field and Description |
|---|---|
protected boolean |
_firedOnce
Set to true if fire() is called once.
|
protected boolean |
_initialized
Set to true when initialized() is called.
|
protected int |
_iteration
Count of iterations.
|
protected int |
_numberOfInputTokensSeen
Number of input tokens seen by this actor in the fire method.
|
protected double |
_tolerance
A double that is read from the tolerance parameter
specifying how close the input has to be to the value
given by correctValues.
|
protected java.util.List |
_trainingTokens
List to store tokens for training mode.
|
Parameter |
correctValues
A matrix specifying what the input should be.
|
Parameter |
requireAllCorrectValues
If true, and the number of tokens seen in wrapup() is not
equal to or greater than the number of elements in the
correctValues array, then throw an exception.
|
Parameter |
tolerance
A double specifying how close the input has to be to the value
given by correctValues.
|
static java.lang.String |
TRAINING_MODE_ERROR_MESSAGE
Exception message that is used if we are running under
the nightly build and the trainingMode parameter is true.
|
SharedParameter |
trainingMode
If true, then do not check inputs, but rather collect them into
the correctValues array.
|
_typesValid_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKSCOMPLETED, NOT_READY, STOP_ITERATING| Constructor and Description |
|---|
NonStrictTest(CompositeEntity container,
java.lang.String name)
Construct an actor with an input multiport.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
_checkRangeOfTolerance(Token newValue)
Check that the difference in exponents between the
input and the tolerance is not greater than the precision
of a Double.
|
protected java.util.Set<Inequality> |
_customTypeConstraints()
Set the input port to be greater than or equal to
BaseType.GENERAL in case backward type inference is
enabled and the input port has no type declared. |
protected static boolean |
_isCloseToIfNilArrayElement(Token token1,
Token token2,
double epsilon)
Test whether the value of this token is close to the first argument,
where "close" means that the distance between them is less than
or equal to the second argument.
|
protected static boolean |
_isCloseToIfNilRecordElement(Token token1,
Token token2,
double epsilon)
Test whether the value of this token is close to the first argument,
where "close" means that the distance between them is less than
or equal to the second argument.
|
void |
attributeChanged(Attribute attribute)
If the attribute being changed is tolerance, then check
that it is increasing and nonnegative.
|
java.lang.Object |
clone(Workspace workspace)
Override the base class to set type constraints.
|
void |
fire()
Call super.fire() and set _firedOnce to true.
|
void |
initialize()
Override the base class to set the iteration counter to zero.
|
boolean |
postfire()
Read one token from each input channel and compare against
the value specified in correctValues.
|
void |
wrapup()
If trainingMode is true, then take the collected
training tokens and store them as an array in correctValues.
|
_containedTypeConstraints, _defaultTypeConstraints, _fireAt, _fireAt, attributeTypeChanged, clone, isBackwardTypeInferenceEnabled, newPort, typeConstraintList, typeConstraints_actorFiring, _actorFiring, _declareDelayDependency, addActorFiringListener, addInitializable, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, prefire, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, stopFire, terminate_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, setName_addPort, _description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeDeleted, attributeList, attributeList, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, notifyOfNameChange, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, validateSettables, workspaceequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitcreateReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortListisFireFunctional, isStrict, iterate, prefire, stop, stopFire, terminateaddInitializable, preinitialize, removeInitializabledescription, getContainer, getDisplayName, getFullName, getName, getName, setNamegetDerivedLevel, getDerivedList, propagateValuepublic Parameter correctValues
public Parameter tolerance
public Parameter requireAllCorrectValues
public SharedParameter trainingMode
public static final java.lang.String TRAINING_MODE_ERROR_MESSAGE
protected int _numberOfInputTokensSeen
protected double _tolerance
protected int _iteration
protected java.util.List _trainingTokens
protected boolean _firedOnce
protected boolean _initialized
public NonStrictTest(CompositeEntity container, java.lang.String name) throws NameDuplicationException, IllegalActionException
container - The container.name - The name of this actor.IllegalActionException - If the entity cannot be contained
by the proposed container.NameDuplicationException - If the container already has an
actor with this name.public java.lang.Object clone(Workspace workspace) throws java.lang.CloneNotSupportedException
clone in class TypedAtomicActorworkspace - The workspace for the new object.java.lang.CloneNotSupportedException - If a derived class contains
an attribute that cannot be cloned.NamedObj.exportMoML(Writer, int, String),
NamedObj.setDeferringChangeRequests(boolean)public void attributeChanged(Attribute attribute) throws IllegalActionException
attributeChanged in class NamedObjattribute - The attribute that changed.IllegalActionException - If the indexes vector is not
increasing and nonnegative, or the indexes is not a row vector.public void fire()
throws IllegalActionException
fire in interface Executablefire in class AtomicActor<TypedIOPort>IllegalActionException - If thrown by the baseclass._firedOncepublic void initialize()
throws IllegalActionException
initialize in interface Initializableinitialize in class AtomicActor<TypedIOPort>IllegalActionException - If the base class throws it or
if we are running under the test suite and the trainingMode
parameter is set to true.MessageHandler.isRunningNightlyBuild()public boolean postfire()
throws IllegalActionException
postfire in interface Executablepostfire in class AtomicActor<TypedIOPort>IllegalActionException - If an input does not match
the required value or if the width of the input is not 1.public void wrapup()
throws IllegalActionException
wrapup in interface Initializablewrapup in class AtomicActor<TypedIOPort>IllegalActionException - If initialized() was called
and fire() was not called or if the number of inputs tokens seen
is not greater than or equal to the number of elements in the
correctValues array.protected void _checkRangeOfTolerance(Token newValue) throws IllegalActionException
newValue - The token to be tested. DoubleTokens
are tested, other tokens are ignored.IllegalActionException - If thrown while reading the
tolerance parameter.protected java.util.Set<Inequality> _customTypeConstraints()
BaseType.GENERAL in case backward type inference is
enabled and the input port has no type declared._customTypeConstraints in class TypedAtomicActorprotected static boolean _isCloseToIfNilArrayElement(Token token1, Token token2, double epsilon) throws IllegalActionException
ArrayToken._isCloseTo(Token, double)
in that if corresponding elements are both nil tokens, then
those two elements are considered "close", see
Token.NIL.token1 - The first array token to compare.token2 - The second array token to compare.epsilon - The value that we use to determine whether two
tokens are close.IllegalActionException - If the elements do not support
this comparison.protected static boolean _isCloseToIfNilRecordElement(Token token1, Token token2, double epsilon) throws IllegalActionException
RecordToken._isCloseTo(Token, double)
in that if corresponding elements are both nil tokens, then
those two elements are considered "close", see
Token.NIL.token1 - The first array token to compare.token2 - The second array token to compare.epsilon - The value that we use to determine whether two
tokens are close.IllegalActionException - If the elements do not support
this comparison.