Class: TechnicalAnalysis::Fi

Inherits:
Indicator show all
Defined in:
lib/technical_analysis/indicators/fi.rb

Overview

Force Index

Class Method Summary collapse

Methods inherited from Indicator

find, roster

Class Method Details

.calculate(data) ⇒ Array<FiValue>

Calculates the force index (FI) for the data en.wikipedia.org/wiki/Force_index

Parameters:

  • data (Array) —

    Array of hashes with keys (:date_time, :close, :volume)

Returns:

  • (Array<FiValue>) —

    An array of FiValue instances



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/technical_analysis/indicators/fi.rb', line 52

def self.calculate(data)
  Validation.validate_numeric_data(data, :close, :volume)
  Validation.validate_length(data, min_data_size({}))
  Validation.validate_date_time_key(data)

  data = data.sort_by { |row| row[:date_time] }

  output = []
  prev_price = data.shift

  data.each do |v|
    fi = ((v[:close] - prev_price[:close]) * v[:volume])

    output << FiValue.new(date_time: v[:date_time], fi: fi)

    prev_price = v
  end

  output.sort_by(&:date_time).reverse
end

.indicator_name ⇒ String

Returns the name of the technical indicator

Returns:

  • (String) —

    A string of the name of the technical indicator



15
16
17
 
# File 'lib/technical_analysis/indicators/fi.rb', line 15

def self.indicator_name
  "Force Index"
end

.indicator_symbol ⇒ String

Returns the symbol of the technical indicator

Returns:

  • (String) —

    A string of the symbol of the technical indicator



8
9
10
 
# File 'lib/technical_analysis/indicators/fi.rb', line 8

def self.indicator_symbol
  "fi"
end

.min_data_size(**params) ⇒ Integer

Calculates the minimum number of observations needed to calculate the technical indicator

Parameters:

  • options (Hash) —

    The options for the technical indicator

Returns:

  • (Integer) —

    Returns the minimum number of observations needed to calculate the technical indicator based on the options provided



42
43
44
 
# File 'lib/technical_analysis/indicators/fi.rb', line 42

def self.min_data_size(**params)
  2
end

.valid_options ⇒ Array

Returns an array of valid keys for options for this technical indicator

Returns:

  • (Array) —

    An array of keys as symbols for valid options for this technical indicator



22
23
24
 
# File 'lib/technical_analysis/indicators/fi.rb', line 22

def self.valid_options
  []
end

.validate_options(options) ⇒ Boolean

Validates the provided options for this technical indicator

Parameters:

  • options (Hash) —

    The options for the technical indicator to be validated

Returns:

  • (Boolean) —

    Returns true if options are valid or raises a ValidationError if they’re not



31
32
33
34
 
# File 'lib/technical_analysis/indicators/fi.rb', line 31

def self.validate_options(options)
  return true if options == {}
  raise Validation::ValidationError.new "This indicator doesn't accept any options."
end