Class: RubyTechnicalAnalysis::MassIndex

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

Overview

Mass Index

Find more information at: www.investopedia.com/terms/m/mass-index.asp

Instance Attribute Summary collapse

Attributes inherited from Indicator

#series

Instance Method Summary collapse

Methods inherited from Indicator

call

Constructor Details

#initialize(series: [], period: 9) ⇒ MassIndex

Returns a new instance of MassIndex.

Parameters:

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

    An array of arrays containing high and low prices, e.g. [[high, low], [high, low]]

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

    The number of periods to use in the calculation



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

def initialize(series: [], period: 9)
  @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/mass_index.rb', line 6

def period
  @period
end

Instance Method Details

#call ⇒ Float

Returns The current Mass Index value.

Returns:

  • (Float) —

    The current Mass Index value



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

def call
  calculate_mass_index
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/mass_index.rb', line 22

def valid?
  series.length >= _full_period
end