Class: Array

Inherits:
Object
  • Object
show all
Defined in:
lib/tonal/extensions.rb

Instance Method Summary collapse

Instance Method Details

#best_fitting_edo(min_edo: 5, max_edo: 72) ⇒ Array

Returns with the EDO and its error best fitting the given ratios contained in self.

Examples:

[3/2r].best_fitting_edo) => [53, 0.07]
[7/4r, 3/2r].best_fitting_edo => [41, 3.46]

Parameters:

  • min_edo (Integer) (defaults to: 5) —

    the mininum edo to search

  • max_edo (Integer) (defaults to: 72) —

    the maximum edo to search

Returns:

  • (Array) —

    with the EDO and its error best fitting the given ratios contained in self



437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/tonal/extensions.rb', line 437

def best_fitting_edo(min_edo: 5, max_edo: 72)
  (min_edo..max_edo).map do |edo|
    step_size = 1200.0 / edo

    total_error_for_edo = to_cents.map do |r_cents|
      quantized = (r_cents / step_size).round * step_size
      (r_cents - quantized).abs
    end.sum

    [edo, total_error_for_edo.round(2)]
  end.min_by{|_, error| error}
end

#denominators ⇒ Array Also known as: consequents

Returns of denominators of elements of self.

Examples:

[Tonal::Ratio.new(3,2), Tonal::Ratio.new(5,4)].denominators => [2, 4]

Returns:

  • (Array) —

    of denominators of elements of self



388
 
# File 'lib/tonal/extensions.rb', line 388

def denominators = self.map(&:denominator)

#denominize ⇒ Array

Returns an array of ratios with equalized denominators.

Examples:

[4/3r, 3/2r].denominize => [(8/6), (9/6)]

Returns:

  • (Array) —

    an array of ratios with equalized denominators



395
396
397
398
 
# File 'lib/tonal/extensions.rb', line 395

def denominize
  l = denominators.lcm
  map{|r| Tonal::Ratio.new(l / r.denominator * r.numerator, l)}
end

#lcm ⇒ Integer

Returns least common multiple of integer elements of self.

Examples:

[3, 2, 7].lcm => 42

Returns:

  • (Integer) —

    least common multiple of integer elements of self



375
 
# File 'lib/tonal/extensions.rb', line 375

def lcm = self.reduce(1, :lcm)

#mean ⇒ Float

Returns the mean of the elements of self.

Examples:

[1, 2].mean => 1.5

Returns:

  • (Float) —

    the mean of the elements of self



421
 
# File 'lib/tonal/extensions.rb', line 421

def mean = self.sum / self.count.to_f

#modulo_translate(lower = 0, upper) ⇒ Array

Returns translated modularly.

Examples:

[-6.617469071022061, 4.755369851099594, 7.588140911919945, -6.49706614430203].modulo_translate(-3, 5)
=> [1.382530928977939, 4.755369851099594,-0.411859088080055,  1.50293385569797]

Parameters:

  • lower (defaults to: 0) —

    the lower bound of the modulo range

  • upper —

    the upper bound of the modulo range

Returns:

  • (Array) —

    translated modularly



481
482
483
484
485
486
 
# File 'lib/tonal/extensions.rb', line 481

def modulo_translate(lower=0, upper)
  range = (upper - lower) == 0 ? 1 : upper - lower
  map do |value|
    (value - lower) % range + lower
  end
end

#numerators ⇒ Array Also known as: antecedents

Returns of numerators of elements of self.

Examples:

[3/2r, 5/4r].numerators => [3, 5]

Returns:

  • (Array) —

    of numerators of elements of self



381
 
# File 'lib/tonal/extensions.rb', line 381

def numerators = self.map(&:numerator)

#ratio_from_prime_divisions(reduced: false) ⇒ Tonal::Ratio

Returns ratio reconstructed from the result of a prime factor decomposition.

Examples:

[[[3, 1]], [[2, 1]]].ratio_from_prime_divisions => (3/2)

Parameters:

  • reduced (Boolean) (defaults to: false) —

    if a reduced or unreduced ratio is returned

Returns:

  • (Tonal::Ratio) —

    ratio reconstructed from the result of a prime factor decomposition



428
 
# File 'lib/tonal/extensions.rb', line 428

def ratio_from_prime_divisions(reduced: false) = reduced ? Tonal::ReducedRatio.new(Prime.int_from_prime_division(self.first), Prime.int_from_prime_division(self.last)) : Tonal::Ratio.new(Prime.int_from_prime_division(self.first), Prime.int_from_prime_division(self.last))

#rescale(new_min = 0, new_max) ⇒ Array

Returns rescaled by new minimum and new maximum.

Examples:

[0.47943068514319154, 0.7161083818132802, 0.19855867360591783].rescale(0,3)
=> [1.6280871600341376, 3.0, 0.0]

Parameters:

  • new_min (defaults to: 0)
  • new_max

Returns:

  • (Array) —

    rescaled by new minimum and new maximum



465
466
467
468
469
470
471
472
 
# File 'lib/tonal/extensions.rb', line 465

def rescale(new_min=0, new_max)
  old_min = min
  old_max = max

  self.map do |x|
    new_min + ((x - old_min) * (new_max - new_min)) / (old_max - old_min)
  end
end

#rpad(min_size, value = nil) ⇒ Array

Returns padded to the right up to n, with value. value default is nil.

Examples:

[3,2].rpad(3, 12) => [3, 2, 12]

Parameters:

  • min_size
  • value (defaults to: nil)

Returns:

  • (Array) —

    padded to the right up to n, with value. value default is nil



362
 
# File 'lib/tonal/extensions.rb', line 362

def rpad(min_size, value = nil) = self.dup.rpad!(min_size, value)

#rpad!(min_size, value = nil) ⇒ Array

Returns self replaced by array padded to the right up to n, with value. value default is nil.

Examples:

[3,2].rpad!(3, 12) => [3, 2, 12]

Parameters:

  • min_size
  • value (defaults to: nil)

Returns:

  • (Array) —

    self replaced by array padded to the right up to n, with value. value default is nil



351
352
353
354
 
# File 'lib/tonal/extensions.rb', line 351

def rpad!(min_size, value = nil)
  self.length > min_size ? self : (min_size - self.length).times { self << value }
  self
end

#to_cents ⇒ Array Also known as: cents

Returns of cent values for ratio or rational elements of self.

Examples:

[3/2r, 4/3r].to_cents => [701.96, 498.04]

Returns:

  • (Array) —

    of cent values for ratio or rational elements of self



404
 
# File 'lib/tonal/extensions.rb', line 404

def to_cents = self.map{|r| r.to_cents}

#to_efr(as: :ratios) ⇒ Tonal::ExtendedRatio

Examples:

[4/1r, 5/1r, 6/1r].to_efr => ExtendedRatio "4:5:6"

Parameters:

  • as (defaults to: :ratios) —

    :ratios or :partials

Returns:



499
 
# File 'lib/tonal/extensions.rb', line 499

def to_efr(as: :ratios) = as == :ratios ? Tonal::ExtendedRatio.new(ratios: self) : Tonal::ExtendedRatio.new(partials: self)

#to_interval ⇒ Tonal::Interval

Examples:

[3/2r, 4/3r].to_interval => 16/9 (4/3 / 3/2)
[5].to_interval => 5/4 (5/4 / 1/1)
[2,3,3,4].to_interval => 9/8 (3/2 / 4/3)

Returns:



415
 
# File 'lib/tonal/extensions.rb', line 415

def to_interval = Tonal::Interval.new(*self)

#to_r ⇒ Rational

Returns from first and last element of array. Ideally to be used with tuples.

Examples:

[4,3].to_r => (4/3)

Returns:

  • (Rational) —

    from first and last element of array. Ideally to be used with tuples.



492
 
# File 'lib/tonal/extensions.rb', line 492

def to_r = Rational(numerator, denominator)

#to_sefr(as: :ratios) ⇒ Tonal::SubharmonicExtendedRatio

Examples:

[4,5,6].to_sefr => SubharmonicExtendedRatio "4:5:6"

Parameters:

  • as (defaults to: :ratios) —

    :ratios or :partials

Returns:



506
 
# File 'lib/tonal/extensions.rb', line 506

def to_sefr(as: :ratios) = as == :ratios ? Tonal::SubharmonicExtendedRatio.new(ratios: self) : Tonal::SubharmonicExtendedRatio.new(partials: self)

#to_vector ⇒ Vector Also known as: vector

Returns self converted to a vector.

Examples:

[3,2].to_vector => Vector[3, 2]

Returns:

  • (Vector) —

    self converted to a vector



368
 
# File 'lib/tonal/extensions.rb', line 368

def to_vector = Vector[*self]

#translate(value) ⇒ Array

Returns translated by value.

Examples:

[0.24184760813024642, 0.49344034900361244, 0.07231824070126536].translate(-0.07231824070126536) = [0.16952936742898106, 0.4211221083023471, 0.0]

Parameters:

  • value (Numeric) —

    the value that is translating self

Returns:

  • (Array) —

    translated by value



455
 
# File 'lib/tonal/extensions.rb', line 455

def translate(value) = self.map{|e| e + value}