Class: RubyTechnicalAnalysis::RateOfChange

Inherits:
Indicator
  • Object
show all
Defined in:
lib/ruby_technical_analysis/indicators/rate_of_change.rb

Overview

Rate Of Change

Find more information at: www.fidelity.com/learning-center/trading-investing/technical-analysis/technical-indicator-guide/roc

Instance Attribute Summary collapse

Attributes inherited from Indicator

#series

Instance Method Summary collapse

Methods inherited from Indicator

call

Constructor Details

#initialize(series: [], period: 30) ⇒ RateOfChange

Returns a new instance of RateOfChange.

Parameters:

  • series (Array) (defaults to: []) —

    An array of prices, typically closing prices

  • period (Integer) (defaults to: 30) —

    The number of periods to use in the calculation



10
11
12
13
14
 
# File 'lib/ruby_technical_analysis/indicators/rate_of_change.rb', line 10

def initialize(series: [], period: 30)
  @period = period

  super(series: series)
end

Instance Attribute Details

#period ⇒ Object (readonly)

Returns the value of attribute period.



6
7
8
 
# File 'lib/ruby_technical_analysis/indicators/rate_of_change.rb', line 6

def period
  @period
end

Instance Method Details

#call ⇒ Float

Returns The current ROC value.

Returns:

  • (Float) —

    The current ROC value



17
18
19
 
# File 'lib/ruby_technical_analysis/indicators/rate_of_change.rb', line 17

def call
  calculate_roc
end

#valid? ⇒ Boolean

Returns Whether or not the object is valid.

Returns:

  • (Boolean) —

    Whether or not the object is valid



22
23
24
 
# File 'lib/ruby_technical_analysis/indicators/rate_of_change.rb', line 22

def valid?
  period + 1 <= series.length
end