Click or drag to resize

RootMeanSquare Class

Get root mean square estimation. https://en.wikipedia.org/wiki/Root_mean_square
Inheritance Hierarchy
System.Object
  FinAnalysis.Base.HistoryDataQueue<Double>
    FinAnalysis.Base.BaseIndicator<Double>
      FinAnalysis.Base.BaseInstrumentIndicator<Double>
        FinAnalysis.Base.BaseSimpleIndicator<Double>
          FinAnalysis.TA.RootMeanSquare

Namespace:  FinAnalysis.TA
Assembly:  FinAnalysis (in FinAnalysis.dll) Version: 2.1.13-cc97e13414b71fde928e8f3a546ac1daf26f295f
Syntax
C#
public class RootMeanSquare : BaseSimpleIndicator<double>, 
	IAverager

The RootMeanSquare type exposes the following members.

Constructors
  NameDescription
Public methodRootMeanSquare()
Creates new instance of technical indicator with default settings.
Public methodRootMeanSquare(Int32)
Creates new instance of technical indicator with point window.
Public methodRootMeanSquare(TimeSpan)
Creates new instance of technical indicator with time window.
Public methodRootMeanSquare(Int32, Boolean)
Creates new instance of technical indicator with point window.
Public methodRootMeanSquare(TimeSpan, Boolean)
Creates new instance of technical indicator with time window.
Top
Properties
  NameDescription
Public propertyFirst
Get first(oldest) data element stored in container. Note: if there is not elements in queue it returns DefaltValue.
(Inherited from HistoryDataQueue<T>.)
Public propertyFirstDateTime
Get first(oldest) data element DateTime stored in container. Note: if there is not elements in queue it returns DefaltDateTime.
(Inherited from HistoryDataQueue<T>.)
Public propertyHistoryCapacity
Set or Get indicator's history capacity. Do not set capacity for indicator if you already add data to it. If indicators HistoryTimeManaged flag is set, this value equal to volume of buffers. If indicators HistoryTimeManaged flag is not set, than indicator store exact HistoryCapacity its values.
(Inherited from BaseIndicator<T>.)
Public propertyHistoryCount
Count of indicators values in indicator history.
(Inherited from BaseIndicator<T>.)
Public propertyHistoryTimeManaged
Indicates whether indicator safe it's history on time period or store specified values count.
(Inherited from BaseIndicator<T>.)
Public propertyHistoryTimePeriod
Set or Get time period, how long indicator save it's value. Do not set history period for indicator if you already add data to it. If you specify indicators HistoryTimePeriod, then indicators HistoryTimeManaged flag will be set. Indicator try to store all of its values on specified HistoryTimePeriod.
(Inherited from BaseIndicator<T>.)
Public propertyIndicatorNeedDateTime
Equal true if user have to specify DateTime in Add method.
(Inherited from BaseIndicator<T>.)
Public propertyItem[DateTime]
Return historically latest element with smaller or equal DateTime. Note: do not try to use this method if you didn't specify DateTime to data elements.
(Inherited from HistoryDataQueue<T>.)
Public propertyItem[Int32]
Get data which was store "index" steps ago.
(Inherited from HistoryDataQueue<T>.)
Public propertyLast
Get last data element stored in container. Note: if there is not elements in queue it returns DefaltValue.
(Inherited from HistoryDataQueue<T>.)
Public propertyLastDateTime
Get last data element DateTime stored in container. Note: if there is no elements in the queue it returns DefaultDateTime.
(Inherited from HistoryDataQueue<T>.)
Public propertyPrevious
Get previous data element stored in container. Note: if there is such not elements in queue it returns DefaltValue.
(Inherited from HistoryDataQueue<T>.)
Public propertyReady
Ready flag is set if and only if queue contain something.
(Inherited from BaseIndicator<T>.)
Public propertyResamplingFactor
Set this parameter if you whant to compress data series. It means that if you set this flag, then indicator will calculate it's values on ResamplingFactor-greater steps.
(Inherited from BaseInstrumentIndicator<T>.)
Public propertyResamplingMethod
Get or Specify resampling Method. LastElement - mean that we use for calculation values equals to last value on resampling period, ArithmeticMean - mean that we use for calculation values equals to arithmetic mean of values on resampling period,
(Inherited from BaseInstrumentIndicator<T>.)
Public propertyRMS
Indicator value.
Public propertyStable
Flag is set if and only if indicators values is stable.
(Inherited from BaseIndicator<T>.)
Public propertyTradeSignal
Trade signal.
(Inherited from BaseInstrumentIndicator<T>.)
Public propertyTradeSignalType
Characterize indicator trade signal values range and meaning.
(Inherited from BaseInstrumentIndicator<T>.)
Public propertyValidationStrategy
Indicate what we must do with invalid input values.
(Inherited from BaseIndicator<T>.)
Public propertyValue
Returns value of indicator. For indicators which has more than one value, it returns a slice.
(Inherited from BaseIndicator<T>.)
Public propertyValueDelayPointPeriod
Set Delay (in points) for indicators Value.
(Inherited from BaseIndicator<T>.)
Public propertyValueDelayTimePeriod
Set Delay (in timespan) for indicators Value.
(Inherited from BaseIndicator<T>.)
Top
Methods
  NameDescription
Public methodAdd(Double)
Add value to indicator. Note: Do Not use methods with and without DateTime for same instance. Also do not call this method for indicators which need datetime for calculation it's value. To determine do you need to specify DateTime, see IndicatorNeedDateTime flag.
(Inherited from BaseSimpleIndicator<T>.)
Public methodAdd(Double, DateTime)
Add value to indicator. Note: Do Not use methods with and without DateTime for same instance. Note: if you specify time = DefaultTime then method ignore this parameter and call add with out time. To determine do you need to specify DateTime, see IndicatorNeedDateTime flag.
(Inherited from BaseSimpleIndicator<T>.)
Public methodClone
Makes full copy of this instance.
(Inherited from BaseIndicator<T>.)
Public methodCopyTo(Object)
Sets internal state to destination object.
(Inherited from BaseIndicator<T>.)
Public methodCopyTo(Object, IL_Clone)
Gets internal state from source object.
(Inherited from BaseIndicator<T>.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetIndexByTime
Get offset index of element by element time. If there no element with such time, we return latest element with time smaller than specified. If we can't find valid index, we return -1.
(Inherited from HistoryDataQueue<T>.)
Public methodGetTimeByIndex
Return time associated with specified point.
(Inherited from HistoryDataQueue<T>.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodOfflineComputation(Double[],T[])
Performs offline computation using all data for period simultaneously. In some cases can be faster and/or use less memory than online (step-by-step) computation. Note: Indicator cannot be used before and after calling this method.
(Inherited from BaseSimpleIndicator<T>.)
Public methodOfflineComputation(Double[],DateTime[],T[])
Performs offline computation using all data for period simultaneously. In some cases can be faster and/or use less memory than online (step-by-step) computation. Note: Indicator cannot be used before and after calling this method.
(Inherited from BaseSimpleIndicator<T>.)
Public methodSetOnPopDelegate
Set delegate that will be invoked every time a new element is dequeued.
(Inherited from HistoryDataQueue<T>.)
Public methodSetOnPushDelegate
Set delegate that will be invoked every time a new element is enqueued.
(Inherited from HistoryDataQueue<T>.)
Public methodSetQueueListener
Set listener to queue capacity. Queue will call OnPop method every time, when queue drop some element. And OnPush method, when queue store element. Do not use listener with single element queue. Queue support any number of listeners.
(Inherited from HistoryDataQueue<T>.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also