org.protempa.backend.asb.java

Class StateAlgorithm

java.lang.Object

org.protempa.AbstractAlgorithm

org.protempa.backend.asb.java.StateAlgorithm

All Implemented Interfaces:

Serializable, Algorithm

public final class StateAlgorithm
extends AbstractAlgorithm

Detects whether the values of a time sequence segment are above and/or below a specified value. It handles missing (null) values (see compute(org.protempa.proposition.Segment<org.protempa.proposition.PrimitiveParameter>, org.protempa.AlgorithmArguments) below), but does not handle nan yet.

Author:

Andrew Post

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StateAlgorithm(Algorithms algorithms, String id)

Method Summary

Modifier and Type	Method and Description
Value	compute(Segment<PrimitiveParameter> segment, AlgorithmArguments args) Computes whether the values of a time sequence segment are above and/or below a specified value.

Methods inherited from class org.protempa.AbstractAlgorithm

close, createDataSourceConstraint, finalize, getAdvanceRowSkipEnd, getId, getInValueType, getMaximumNumberOfValues, getMinimumNumberOfValues, getParameters, initialize, parameter, setAdvanceRowSkipEnd, setInValueType, setMaximumNumberOfValues, setMinimumNumberOfValues, setParameters, toString

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StateAlgorithm

public StateAlgorithm(Algorithms algorithms,
                      String id)

Method Detail

compute

public Value compute(Segment<PrimitiveParameter> segment,
                     AlgorithmArguments args)

Computes whether the values of a time sequence segment are above and/or below a specified value.

Specified by:

compute in interface Algorithm

Specified by:

compute in class AbstractAlgorithm

Parameters:

segment - a Segment object.

Returns:

a Value if the values of segment are above and/or below the specified thresholds, null otherwise. If any of the values of segment are null, this methods also returns null.

See Also:

org.protempa.AbstractAlgorithm#compute(org.protempa.proposition.Segment)