com.steema.teechart.functions
Class Correlation

java.lang.Object
  extended by com.steema.teechart.TeeBase
      extended by com.steema.teechart.functions.Function
          extended by com.steema.teechart.functions.BaseTrend
              extended by com.steema.teechart.functions.Correlation

public class Correlation
extends BaseTrend

Title: Correlation class

Description: Correlation function

Copyright (c) 2005-2013 by Steema Software SL. All Rights Reserved.

Company: Steema Software SL


Field Summary
 
Fields inherited from class com.steema.teechart.functions.Function
canUsePeriod, dPeriod, HideSourceList, noSourceRequired, series, SingleSource, updating
 
Fields inherited from class com.steema.teechart.TeeBase
chart, InternalUse
 
Constructor Summary
Correlation()
           
 
Method Summary
 double calculate(Series s, int firstIndex, int lastIndex)
          Performs function operation on SourceSeries series.
protected  void calculatePeriod(Series source, double tmpX, int firstIndex, int lastIndex)
           
 java.lang.String getDescription()
          Gets descriptive text.
 
Methods inherited from class com.steema.teechart.functions.BaseTrend
calculateAllPoints, calculateMany, calculateTrend, coefficient, getTrendStyle, setTrendStyle
 
Methods inherited from class com.steema.teechart.functions.Function
addFunctionXY, addPoints, calculateByPeriod, clear, dispose, doCalculation, getPeriod, getPeriodAlign, getPeriodStyle, getSeries, newInstance, readResolve, recalculate, setPeriod, setPeriodAlign, setPeriodStyle, setSeries, valueList
 
Methods inherited from class com.steema.teechart.TeeBase
getChart, invalidate, setBooleanProperty, setChart, setColorProperty, setDoubleProperty, setIntegerProperty, setStringProperty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Correlation

public Correlation()
Method Detail

calculate

public double calculate(Series s,
                        int firstIndex,
                        int lastIndex)
Description copied from class: Function
Performs function operation on SourceSeries series.
First and Last parameters are ValueIndex of first and last point used in calculation.
You can override Calculate function to perform customized calculation on one SourceSeries.

Overrides:
calculate in class BaseTrend
Parameters:
s - Series
firstIndex - int
lastIndex - int
Returns:
double

calculatePeriod

protected void calculatePeriod(Series source,
                               double tmpX,
                               int firstIndex,
                               int lastIndex)
Overrides:
calculatePeriod in class BaseTrend

getDescription

public java.lang.String getDescription()
Gets descriptive text.

Overrides:
getDescription in class Function
Returns:
String