Class: HeadMusic::Style::Guidelines::MinimumThreshold

Inherits:
Annotation
  • Object
show all
Defined in:
lib/head_music/style/guidelines/minimum_threshold.rb

Overview

Base class for guidelines that flag a voice for falling short of a minimum count. Subclasses supply the actual count being measured against the minimum.

Direct Known Subclasses

MinimumMelodicIntervals, MinimumNotes

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

This class inherits a constructor from HeadMusic::Style::Annotation

Class Method Details

.default_gate? ⇒ Boolean

Returns:

  • (Boolean) 


11
12
13
 
# File 'lib/head_music/style/guidelines/minimum_threshold.rb', line 11

def self.default_gate?
  true
end

.with(minimum, **options) ⇒ Object 



7
8
9
 
# File 'lib/head_music/style/guidelines/minimum_threshold.rb', line 7

def self.with(minimum, **options)
  super(minimum: minimum, **options)
end

Instance Method Details

#actual_count ⇒ Object (private)

Raises:

  • (NotImplementedError) 


21
22
23
 
# File 'lib/head_music/style/guidelines/minimum_threshold.rb', line 21

def actual_count
  raise NotImplementedError
end

#deficiency_mark ⇒ Object (private) 



33
34
35
36
37
 
# File 'lib/head_music/style/guidelines/minimum_threshold.rb', line 33

def deficiency_mark
  return unless actual_count < minimum

  HeadMusic::Style::Mark.for_all(placements, fitness: actual_count.to_f / minimum)
end

#minimum ⇒ Object (private) 



17
18
19
 
# File 'lib/head_music/style/guidelines/minimum_threshold.rb', line 17

def minimum
  options.fetch(:minimum)
end

#no_placements_mark ⇒ Object (private) 



25
26
27
28
29
30
31
 
# File 'lib/head_music/style/guidelines/minimum_threshold.rb', line 25

def no_placements_mark
  HeadMusic::Style::Mark.new(
    HeadMusic::Content::Position.new(composition, "1:1"),
    HeadMusic::Content::Position.new(composition, "2:1"),
    fitness: 0
  )
end