SumOfSquares (PULsE 1.98 API)

java.lang.Object
- pulse.util.UpwardsNavigable
- - pulse.util.Group
  - - pulse.util.Accessible
    - - pulse.util.PropertyHolder
      - pulse.search.statistics.Statistic
        
        pulse.search.statistics.ResidualStatistic
        
        pulse.search.statistics.OptimiserStatistic
        
        pulse.search.statistics.SumOfSquares

All Implemented Interfaces:

Serializable, Descriptive, Reflexive

Direct Known Subclasses:

RangePenalisedLeastSquares, RegularisedLeastSquares
```
public class SumOfSquares
extends OptimiserStatistic
```
The standard optimality criterion of the L2 norm condition, or simply ordinary least squares.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

SumOfSquares()

SumOfSquares(SumOfSquares sos)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`OptimiserStatistic`	`copy()`
`void`	`evaluate(GeneralTask t)`	Calculates the sum of squared deviations using `curve` as reference.
`String`	`getDescriptor()`	If not null, will return the prefix, otherwise calls the superclass method.
`double`	`variance()`

Methods inherited from class pulse.search.statistics.OptimiserStatistic
getSelectedOptimiserDescriptor, setSelectedOptimiserDescriptor

Methods inherited from class pulse.search.statistics.ResidualStatistic
calculateResiduals, calculateResiduals, calculateResiduals, equals, getResiduals, getStatistic, getTimeSequence, hashCode, residualsArray, set, setStatistic

Methods inherited from class pulse.util.PropertyHolder
addListener, areDetailsHidden, data, describe, firePropertyChanged, 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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SumOfSquares
```
public SumOfSquares()
```
  - SumOfSquares
```
public SumOfSquares(SumOfSquares sos)
```
- Method Detail
  - evaluate
```
public void evaluate(GeneralTask t)
```
    Calculates the sum of squared deviations using curve as reference.
    This calculates $\sum_{i = i_{1}}^{i_{2}} (\overset{⏞}{T} (t_{i}) - T (t_{i})^{r e f})^{2}$ , where $T_{i}^{r e f}$ is the temperature value corresponding to the time at index i for the reference curve. Note that the time $t_{i}$ corresponds to the reference's time list, which generally does not match to that of this heating curve. The $\overset{⏞}{T} (t_{i})$ is the interpolated value.
    
    Specified by:
    
    evaluate in class Statistic
    
    Parameters:
    
    t - The task containing the reference and calculated curves
    
    See Also:
    
    calculateResiduals()
  - getDescriptor
```
public String getDescriptor()
```
    Description copied from class: PropertyHolder
    
    If not null, will return the prefix, otherwise calls the superclass method.
    
    Overrides:
    
    getDescriptor in class PropertyHolder
    
    Returns:
    
    the descriptor
    
    See Also:
    
    Group.getSimpleName()
  - variance
```
public double variance()
```
    Specified by:
    
    variance in class OptimiserStatistic
  - copy
```
public OptimiserStatistic copy()
```
    Specified by:
    
    copy in class OptimiserStatistic