Class: Indicator::AutoGen::StochF

Inherits:
Base
  • Object
show all
Defined in:
lib/indicator/auto_gen/stoch_f.rb

Overview

Ta-Lib function mapping class Function: ‘STOCHF’ Description: ‘Stochastic Fast’ This file has been autogenerated - Do Not Edit.

Instance Attribute Summary collapse

Attributes inherited from Base

#name

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

inherited, #map_ohlcv

Methods included from DataMapper

#default_getter, #default_getter=, #map

Constructor Details

#initialize(*args) ⇒ StochF

Returns a new instance of StochF.



13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/indicator/auto_gen/stoch_f.rb', line 13

def initialize(*args)
  if args.first.is_a? Hash
    h = args.first
    @fast_k_period = h[:fast_k_period] || 5
    @fast_d_period = h[:fast_d_period] || 3
    @fast_d_ma = h[:fast_d_ma] || 0
  else
    @fast_k_period = args[0] || 5 
    @fast_d_period = args[1] || 3 
    @fast_d_ma = args[2] || 0 
  end
  
  @func = TaLib::Function.new("STOCHF")
end

Instance Attribute Details

#fast_d_ma ⇒ Object

Fast-D MA <MA Type>



11
12
13
 
# File 'lib/indicator/auto_gen/stoch_f.rb', line 11

def fast_d_ma
  @fast_d_ma
end

#fast_d_period ⇒ Object

Fast-D Period <Integer>



9
10
11
 
# File 'lib/indicator/auto_gen/stoch_f.rb', line 9

def fast_d_period
  @fast_d_period
end

#fast_k_period ⇒ Object

Fast-K Period <Integer>



7
8
9
 
# File 'lib/indicator/auto_gen/stoch_f.rb', line 7

def fast_k_period
  @fast_k_period
end

Class Method Details

.arguments ⇒ Object

The list of arguments



34
35
36
 
# File 'lib/indicator/auto_gen/stoch_f.rb', line 34

def self.arguments
  [ :fast_k_period, :fast_d_period, :fast_d_ma ]
end

.inputs ⇒ Object

The minimum set of inputs required



39
40
41
 
# File 'lib/indicator/auto_gen/stoch_f.rb', line 39

def self.inputs
  [ :high, :low, :close ]
end

.outputs ⇒ Object

The outputs generated by this function



44
45
46
 
# File 'lib/indicator/auto_gen/stoch_f.rb', line 44

def self.outputs
  [ :out_fast_k, :out_fast_d ]
end

.price_input? ⇒ Boolean

Is price data required as an input

Returns:

  • (Boolean) 


29
30
31
 
# File 'lib/indicator/auto_gen/stoch_f.rb', line 29

def self.price_input?
  true
end

Instance Method Details

#run(*args) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/indicator/auto_gen/stoch_f.rb', line 48

def run(*args)
  o, h, l, c, v, len = map_ohlcv(self.class.inputs, *args)
  @func.in_price(0, o, h, l, c, v, nil)

  @func.opt_int(0, @fast_k_period)
  @func.opt_int(1, @fast_d_period)
  @func.opt_int(2, @fast_d_ma)

  out_fast_k = Array.new(len)
  @func.out_real(0, out_fast_k)
  out_fast_d = Array.new(len)
  @func.out_real(1, out_fast_d)

  @func.call(0, len - 1)

{:out_fast_k => out_fast_k,
  :out_fast_d => out_fast_d}
end