Click or drag to resize

Ranker Class

Dynamic rank calculator. Gives ranks for series acourding to their last values.
Inheritance Hierarchy
System.Object
  FinAnalysis.Base.HistoryMultipleDataQueue<Double>
    FinAnalysis.Base.BasePortfolio<Double>
      FinAnalysis.Base.BasePortfolioIndicator<Double>
        FinAnalysis.Base.BaseSimplePortfolioIndicator<Double>
          FinAnalysis.Ranging.Ranker

Namespace:  FinAnalysis.Ranging
Assembly:  FinAnalysis (in FinAnalysis.dll) Version: 2.1.13-cc97e13414b71fde928e8f3a546ac1daf26f295f
Syntax
C#
public class Ranker : BaseSimplePortfolioIndicator<double>

The Ranker type exposes the following members.

Constructors
  NameDescription
Public methodRanker()
Default constructor.
Public methodRanker(Int32, Int32, Boolean)
Create new instance of ranker.
Public methodRanker(Int32, TimeSpan, Boolean)
Create new instance of ranker.
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 HistoryMultipleDataQueue<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 HistoryMultipleDataQueue<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 BasePortfolio<T>.)
Public propertyHistoryCount
Count of indicators values in indicator history.
(Inherited from BasePortfolio<T>.)
Public propertyHistoryTimeManaged
Indicates whether indicator safe it's history on time period or store specified values count.
(Inherited from BasePortfolio<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 BasePortfolio<T>.)
Public propertyIndicatorNeedDateTime
Equal true if user have to specify DateTime in Add method.
(Inherited from BasePortfolio<T>.)
Public propertyItem[DateTime, Int32]
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 HistoryMultipleDataQueue<T>.)
Public propertyItem[Int32, Int32]
Get data which was store "index" steps ago.
(Inherited from HistoryMultipleDataQueue<T>.)
Public propertyLast
Get last data element stored in container. Note: if there is not elements in queue it returns DefaltValue.
(Inherited from HistoryMultipleDataQueue<T>.)
Public propertyLastDateTime
Get last data element DateTime stored in container. Note: if there is not elements in queue it returns DefaltDateTime.
(Inherited from HistoryMultipleDataQueue<T>.)
Public propertyRanks
Ranks assigned to time series.
Public propertyReady
Ready flag is set if and only if queue contain something.
(Inherited from BasePortfolio<T>.)
Public propertyStable
Flag is set if and only if indicators values is stable.
(Inherited from BasePortfolio<T>.)
Public propertyValidationStrategy
Indicate what we must do with invalid input values.
(Inherited from BasePortfolio<T>.)
Public propertyValue
Returns value of indicator. For indicators which has more than one value, it returns a slice.
(Inherited from BasePortfolio<T>.)
Top
Methods
  NameDescription
Public methodAdd(Double[])
Add multiple values 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 BaseSimplePortfolioIndicator<T>.)
Public methodAdd(Double[], DateTime)
Add multiple values 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 BaseSimplePortfolioIndicator<T>.)
Public methodAdd(Int32, Double)
Add single value of specific time series 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 BaseSimplePortfolioIndicator<T>.)
Public methodAdd(Int32, Double, DateTime)
Add single value of specific time series 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 BaseSimplePortfolioIndicator<T>.)
Public methodClone
Makes full copy of this instance.
(Inherited from BasePortfolio<T>.)
Public methodCopyTo(Object)
Sets internal state to destination object.
(Inherited from BasePortfolio<T>.)
Public methodCopyTo(Object, IL_Clone)
Gets internal state from source object.
(Inherited from BasePortfolio<T>.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodFixTime
Notify indicator that all data for specifed time was added. Use this method with add by index.
(Inherited from BaseSimplePortfolioIndicator<T>.)
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 HistoryMultipleDataQueue<T>.)
Public methodGetTimeByIndex
Return time associated with specified point.
(Inherited from HistoryMultipleDataQueue<T>.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodSetOnPopDelegate
Set delegate that will be invoked every time a new element is dequeued.
(Inherited from HistoryMultipleDataQueue<T>.)
Public methodSetOnPushDelegate
Set delegate that will be invoked every time a new element is enqueued.
(Inherited from HistoryMultipleDataQueue<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 HistoryMultipleDataQueue<T>.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also