com.steema.teechart.functions
Class StdDeviation

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

public class StdDeviation
extends Function

Title: StdDeviation class

Description: Standard Deviation 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
StdDeviation()
           
StdDeviation(IBaseChart c)
           
 
Method Summary
 double calculate(Series s, int firstIndex, int lastIndex)
          Performs function operation on SourceSeries series.
 double calculateMany(java.util.Vector sourceSeries, int valueIndex)
          Performs function operation on list of series (SourceSeriesList).
 boolean getComplete()
          Enables complete StdDeviation of input Series.
 java.lang.String getDescription()
          Gets descriptive text.
 void setComplete(boolean value)
          Enables complete StdDeviation of input Series.
 
Methods inherited from class com.steema.teechart.functions.Function
addFunctionXY, addPoints, calculateAllPoints, calculateByPeriod, calculatePeriod, 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

StdDeviation

public StdDeviation()

StdDeviation

public StdDeviation(IBaseChart c)
Method Detail

getComplete

public boolean getComplete()
Enables complete StdDeviation of input Series.
Default value: false

Returns:
boolean

setComplete

public void setComplete(boolean value)
Enables complete StdDeviation of input Series.
Default value: false

Parameters:
value - boolean

calculate

public double calculate(Series s,
                        int firstIndex,
                        int lastIndex)
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 Function
Parameters:
s - Series
firstIndex - int
lastIndex - int
Returns:
double

calculateMany

public double calculateMany(java.util.Vector sourceSeries,
                            int valueIndex)
Performs function operation on list of series (SourceSeriesList).
The ValueIndex parameter defines ValueIndex of point in each Series in list.
You can override CalculateMany function to perform customized calculation on list of SourceSeries.

Overrides:
calculateMany in class Function
Parameters:
sourceSeries - ArrayList
valueIndex - int
Returns:
double

getDescription

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

Overrides:
getDescription in class Function
Returns:
String