Class: Tonal::Scale::Step

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Comparable
Defined in:
lib/tonal/step.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(modulo: nil, log: nil, step: nil, ratio: nil) ⇒ Step

Returns a new instance of Step.

Raises:

  • (ArgumentError) 


10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/tonal/step.rb', line 10

def initialize(modulo: nil, log: nil, step: nil, ratio: nil)
  raise ArgumentError, "modulo: required" unless modulo
  raise ArgumentError, "One of log:, step: or ratio: must be provided" unless [log, step, ratio].compact.count == 1
  @modulo = modulo.round

  if ratio
    @ratio, @log = derive_ratio_and_log(ratio: ratio)
  elsif step
    @ratio, @log = derive_ratio_and_log(step: step)
  elsif log
    @ratio, @log = derive_ratio_and_log(log: log)
  end

  @step = (modulo * @log).round
  @tempered = 2**(@step.to_f/@modulo)
end

Instance Attribute Details

#log ⇒ Object (readonly)

Returns the value of attribute log.



8
9
10
 
# File 'lib/tonal/step.rb', line 8

def log
  @log
end

#modulo ⇒ Object (readonly)

Returns the value of attribute modulo.



8
9
10
 
# File 'lib/tonal/step.rb', line 8

def modulo
  @modulo
end

#ratio ⇒ Object (readonly)

Returns the value of attribute ratio.



8
9
10
 
# File 'lib/tonal/step.rb', line 8

def ratio
  @ratio
end

#step ⇒ Object (readonly)

Returns the value of attribute step.



8
9
10
 
# File 'lib/tonal/step.rb', line 8

def step
  @step
end

#tempered ⇒ Object (readonly)

Returns the value of attribute tempered.



8
9
10
 
# File 'lib/tonal/step.rb', line 8

def tempered
  @tempered
end

Instance Method Details

#+(rhs) ⇒ Object Also known as: % 



89
90
91
 
# File 'lib/tonal/step.rb', line 89

def +(rhs)
  self.class.new(step: (rhs % modulo), modulo: modulo)
end

#<=>(rhs) ⇒ Object 



94
95
96
 
# File 'lib/tonal/step.rb', line 94

def <=>(rhs)
  rhs.kind_of?(self.class) && modulo <=> rhs.modulo && log <=> rhs.log && step <=> rhs.step
end

#convert(new_modulo) ⇒ Tonal::Scale::Step

Returns new step with the ratio mapped to the new modulo.

Examples:

Tonal::Scale::Step.new(ratio: 3/2r, modulo: 31).convert(12)
=> 7\12

Returns:



37
38
39
 
# File 'lib/tonal/step.rb', line 37

def convert(new_modulo)
  self.class.new(log: log, modulo: new_modulo)
end

#efficiency ⇒ Tonal::Cents Also known as: cents_difference

Returns the difference between the step and the ratio.

Examples:

Tonal::Scale::Step.new(ratio: 3/2r, modulo: 31).efficiency => 5.19 ยข

Returns:

  • (Tonal::Cents) —

    the difference between the step and the ratio



83
84
85
86
 
# File 'lib/tonal/step.rb', line 83

def efficiency
  # We want the efficiency from the step (self). The step is the tempered approximation of the ratio, so we want to know how far off the step is from the ratio. So we take the ratio and subtract the step.
  ratio_to_cents - step_to_cents
end

#inspect ⇒ Object Also known as: to_s 



27
28
29
 
# File 'lib/tonal/step.rb', line 27

def inspect
  "#{step}\\#{modulo}"
end

#ratio_to_cents ⇒ Tonal::Cents

Returns measure of ratio in cents.

Examples:

Tonal::Scale::Step.new(ratio: 3/2r, modulo: 31).ratio_to_cents
=> 701.96

Returns:



75
76
77
 
# File 'lib/tonal/step.rb', line 75

def ratio_to_cents
  ratio.to_cents
end

#ratio_to_r ⇒ Rational

Returns of the ratio.

Examples:

Tonal::Scale::Step.new(ratio: 3/2r, modulo: 31).ratio_to_r
=> (3/2)

Returns:

  • (Rational) —

    of the ratio



56
57
58
 
# File 'lib/tonal/step.rb', line 56

def ratio_to_r
  ratio.to_r
end

#step_to_cents ⇒ Tonal::Cents Also known as: to_cents

Returns measure of step in cents.

Examples:

Tonal::Scale::Step.new(ratio: 3/2r, modulo: 31).step_to_cents
=> 696.77

Returns:



65
66
67
 
# File 'lib/tonal/step.rb', line 65

def step_to_cents
  tempered.to_cents
end

#step_to_r ⇒ Rational Also known as: to_r

Returns of the step.

Examples:

Tonal::Scale::Step.new(ratio: 3/2r, modulo: 31).step_to_r
=> (6735213777669305/4503599627370496)

Returns:

  • (Rational) —

    of the step



46
47
48
 
# File 'lib/tonal/step.rb', line 46

def step_to_r
  tempered.to_r
end