CorrelationTest (PULsE 1.98 API)

java.lang.Object
- pulse.util.UpwardsNavigable
- - pulse.util.Group
  - - pulse.util.Accessible
    - - pulse.util.PropertyHolder
      - pulse.search.statistics.CorrelationTest

All Implemented Interfaces:

Serializable, Descriptive, Reflexive

Direct Known Subclasses:

EmptyCorrelationTest, PearsonCorrelation, SpearmansCorrelationTest
```
public abstract class CorrelationTest
extends PropertyHolder
implements Reflexive
```
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

CorrelationTest()

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`compareToThreshold(double value)`
`abstract double`	`evaluate(double[] x, double[] y)`
`static InstanceDescriptor<CorrelationTest>`	`getTestDescriptor()`
`static NumericProperty`	`getThreshold()`
`static CorrelationTest`	`init()`
`void`	`set(NumericPropertyKeyword type, NumericProperty property)`	An abstract method, which must be overriden to gain access over setting the values of all relevant (selected by the programmer) `NumericPropert`ies in subclasses of `Accessible`.
`static void`	`setThreshold(NumericProperty p)`

Methods inherited from class pulse.util.PropertyHolder
addListener, areDetailsHidden, data, describe, firePropertyChanged, getDescriptor, getListeners, getPrefix, ignoreSiblings, initListeners, isListedNumericType, isListedParameter, listedKeywords, listedTypes, numericData, parameterListChanged, removeListeners, setPrefix, updateProperties, updateProperty

Methods inherited from class pulse.util.Accessible
accessibleChildren, genericProperties, genericProperty, numericProperties, numericProperty, property, update, update

Methods inherited from class pulse.util.Group
access, children, contents, getSimpleName, subgroups

Methods inherited from class pulse.util.UpwardsNavigable
addHierarchyListener, getHierarchyListeners, getParent, identify, removeHierarchyListener, removeHierarchyListeners, setParent, specificAncestor, tellParent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CorrelationTest
```
public CorrelationTest()
```
- Method Detail
  - init
```
public static CorrelationTest init()
```
  - getTestDescriptor
```
public static final InstanceDescriptor<CorrelationTest> getTestDescriptor()
```
  - evaluate
```
public abstract double evaluate(double[] x,
                                double[] y)
```
  - compareToThreshold
```
public boolean compareToThreshold(double value)
```
  - getThreshold
```
public static NumericProperty getThreshold()
```
  - setThreshold
```
public static void setThreshold(NumericProperty p)
```
  - set
```
public void set(NumericPropertyKeyword type,
                NumericProperty property)
```
    Description copied from class: Accessible
    
    An abstract method, which must be overriden to gain access over setting the values of all relevant (selected by the programmer) NumericProperties in subclasses of Accessible. Typically this involves a switch statement that goes through the different options for the type and invokes different set(...) methods to update the matching NumericProperty with property.
    
    Specified by:
    
    set in class Accessible
    
    Parameters:
    
    type - the type, which must be equal by definition to property.getType().
    
    property - the property, which contains new information.