music_set_theory 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebde4ba3edcbccaba9146b39ee39fbe29757cb5283924768c953a517782e09f8
-  data.tar.gz: be3cfa795e830ce5f5f0534eb3f62368127dfa70e3abcb5055815dc63cad822c
+  metadata.gz: 2b66a2a0c031f2d15f603607c3ce78762a0f3e738f63d968c917fd7872618721
+  data.tar.gz: 505349cc9f85f8ecaaa890090522153a35e34c452707fb54f3d4112de5317a06
 SHA512:
-  metadata.gz: d03972156c15ecc210b0fcb02df239e743e96e6b22f415d3ec153e4769b9e07d44b5bd721b5c5417ef91e836d1c4fa847e7d5c4abfb28840ab4a87d064d2cc8a
-  data.tar.gz: 697638e92311f8f085c4d82537169c6a80fe38df64224df8ab597b77f86c22626c36f69cd47c393454ad3260ae575d155c27b61cc00dd019ef08acd9b1add1af
+  metadata.gz: 456d90f4f7e2b1c263381554d4587a2052285822d357af26417362dc8b0fc7d4386a18dc15f60b0ed03f883209f0ca20cfbd65adf079007b83a9439b2539cedb
+  data.tar.gz: 192520afd4ac5954fc1b933b4560061f7958d8a809036b08443fb44ed73a2f4eabf5a655377af2bb9d24c0e25fc33b56255c854e78e15b5af4976cd7fb4a5b9d

data/examples/mst_temperament.rb

@@ -24,19 +24,19 @@ nseqtype_dict.each {|k, v|
   dict = v
   puts pad2+"name_dict (#{dict.name_dict.keys.size}):"
   dict.name_dict.each_with_index {|(k, v), i|
-    puts pad2+pad+"(#{i+1}) #{k}: #{v}"
+    puts pad2+pad+"(#{i+1}) #{k}:#{v}"
   }
   puts
 
   puts pad2+"abbr_dict (#{dict.abbr_dict.keys.size}):"
   dict.abbr_dict.each_with_index {|(k, v), i|
-    puts pad2+pad+"(#{i+1}) #{k}: #{v}"
+    puts pad2+pad+"(#{i+1}) #{k}:#{v}"
   }
   puts
 
   puts pad2+"seqpos_dict (#{dict.seqpos_dict.keys.size}):"
   dict.seqpos_dict.each_with_index {|(k, v), i|
-    puts pad2+pad+"(#{i+1}) #{k}: #{v}"
+    puts pad2+pad+"(#{i+1}) #{k}:#{v}"
   }
 
   puts '-'*40

data/lib/music_set_theory/chord_generator.rb

@@ -47,7 +47,7 @@ require_relative "./temperament"
 require_relative "./scales"
 require_relative "./chords"
 
-require 'romannumerals'
+require 'romanumerals'
 
 
 # import copy, codecs
@@ -57,6 +57,10 @@ require 'romannumerals'
 # from .scales import MajorScale, MelMinorScale, HarmMinorScale,\
 #     HarmMajorScale;
 # from .chords import CHORDTYPE_DICT;
+require_relative "musutility"
+require_relative "temperament"
+require_relative "scales"
+require_relative "chords"
 
 
 #
@@ -142,8 +146,9 @@ module MusicSetTheory
 #    >>> print int_to_roman(1999)
 #    MCMXCIX
 #    """
-  def int_to_roman(input)
-    raise "#{input} must be greater than zero." if input <= 0
+  def int_to_roman( input )
+    raise ArgumentError, "#{input} must be greater than zero." if input <= 0
+    raise TypeError, "Input must be an integer." unless input.is_a? Integer
 
     input.to_roman
   end
@@ -166,12 +171,28 @@ module MusicSetTheory
 
     attr_accessor :full_name, :key, :full_notes, :table_title, :rows
     def initialize( full_name, key, full_notes, table_title )
-      self.full_name    = full_name;
-      self.key          = key;
-      self.full_notes   = full_notes;
-      self.table_title  = table_title;
-      self.rows         = [];
+      self.full_name    = full_name
+      self.key          = key
+      self.full_notes   = full_notes
+      self.table_title  = table_title
+      self.rows         = []
     end
+
+    def to_a
+      tmp = []
+      tmp << [ self.full_name, self.key, self.full_notes, self.table_title, ]
+
+      #
+      self.rows.map{|r|
+        # tmp << r.to_a
+        # tmp += r.to_a
+        tmp << r.to_a
+      }
+
+      ret = tmp
+      ret
+    end
+
   end
 
   # Represents different rows (triads, 7ths, 9ths) in tabular
@@ -180,8 +201,18 @@ module MusicSetTheory
   class ScaleChordRow
     attr_accessor :chord_type, :notes
     def initialize( chord_type )
-      self.chord_type = chord_type;
-      self.notes = [];
+      self.chord_type = chord_type
+      self.notes = []
+    end
+
+    def to_a
+      # ret = "#{self.chord_type}:#{self.notes}"
+      tmp = []
+      self.notes.each do |nt|
+        tmp << [self.chord_type,] + nt.to_a
+      end
+      ret = tmp
+      ret
     end
   end
 
@@ -189,9 +220,13 @@ module MusicSetTheory
   class ScaleChordCell
     attr_accessor :chordname_1, :chordname_2, :notes
     def initialize( chordname_1, chordname_2, notes )
-      self.chordname_1 = chordname_1;
-      self.chordname_2 = chordname_2;
-      self.notes = notes;
+      self.chordname_1 = chordname_1
+      self.chordname_2 = chordname_2
+      self.notes = notes
+    end
+
+    def to_a
+      [self.chordname_1, self.chordname_2, self.notes]
     end
   end
 
@@ -201,6 +236,8 @@ end
 module MusicSetTheory
 
   # Used for converting "C" -> 1, "Db"-> 2b, etc.
+  #
+  #
   def makebaserep( notex, base = 0 )
     notexparsed = WestTemp.note_parse(notex)
     #pos_rep = str(WestTemp.nat_key_lookup_order[notexparsed[0]] + base)
@@ -211,7 +248,7 @@ module MusicSetTheory
     elsif notexparsed[1] < 0
       ret = pos_rep + (M_FLAT * (-1 * notexparsed[1]))
     else
-      ret = pos_rep;
+      ret = pos_rep
     end
 
     ret
@@ -219,25 +256,33 @@ module MusicSetTheory
 
 
   # Returns an instance of scale_chords using the following inputs:
-  # 
-  # scale_name: a name of a scale like "Dorian".
-  # key: generally a standard music key like "C".
-  # possiblechords: a sequence of chord types like "Seventh" and "Ninth".
+  # ==== Args
+  # scale_name:: a name of a scale like "Dorian".
+  # key:: generally a standard music key like "C".
+  # possiblechords:: a sequence of chord types like "Seventh" and "Ninth".
+  # west_temp:: Temperament object.
   #
-  def populate_scale_chords( scale_name, key, possiblechords )
-    our_scale = WestTemp.get_nseqby_name(scale_name, NSEQ_SCALE);
-    num_elem = len(our_scale.nseq_posn);
+  # ==== Returns
+  # ScaleChords object.
+  #
+  #def populate_scale_chords( scale_name, key, possiblechords )
+  def populate_scale_chords( scale_name, key, possiblechords,
+                             west_temp = WestTemp )
+    our_scale = west_temp.get_nseqby_name(scale_name, NSEQ_SCALE)
+    # num_elem = len(our_scale.nseq_posn)
+    num_elem = our_scale.nseq_posn.size
+
     begin
       int_of_key    = key.to_i
-      is_key_an_int = true;
+      is_key_an_int = true
     rescue ValueError
-      is_key_an_int = false;
-      int_of_key    = nil;
+      is_key_an_int = false
+      int_of_key    = nil
     end
 
     if is_key_an_int
       #our_scale_notes = [makebaserep(x, int_of_key) for x in 
-      #our_scale.get_notes_for_key("C")];
+      #our_scale.get_notes_for_key("C")]
       our_scale_notes = our_scale.get_notes_for_key("C").map{|x|
                           makebaserep(x, int_of_key) }
     else
@@ -251,19 +296,22 @@ module MusicSetTheory
       ourchordrow = ScaleChordRow.new(i)
       our_chord_data.rows.append(ourchordrow)
 
-      for j in range(num_elem):
-        our_slice = CHORDTYPE_DICT[i];
+      # for j in range(num_elem):
+      for j in 0...num_elem
+        our_slice = CHORDTYPE_DICT[i]
+
         if is_key_an_int
           #our_chord_notes = [makebaserep(x, int_of_key) for x in
-          #  our_scale.get_notes_for_key("C", j, our_slice)];
+          #  our_scale.get_notes_for_key("C", j, our_slice)]
           our_chord_notes = our_scale.get_notes_for_key("C", j, our_slice).
                               map{|x| makebaserep(x, int_of_key) }
         else
           our_chord_notes = our_scale.get_notes_for_key(key, j, our_slice)
         end
 
-        our_posn  = our_scale.get_posn_for_offset(j, our_slice, true)
-        our_chord = WestTemp.get_nseqby_seqpos(our_posn, NSEQ_CHORD)
+        #our_posn  = our_scale.get_posn_for_offset(j, our_slice, true)
+        our_posn  = our_scale.get_posn_for_offset(j, our_slice, raz: true)
+        our_chord = west_temp.get_nseqby_seqpos(our_posn, NSEQ_CHORD)
         if our_chord
           ourchordrow.notes.append(ScaleChordCell.new(our_chord.nseq_name,
             our_chord.nseq_abbrev, our_chord_notes))
@@ -295,16 +343,17 @@ module MusicSetTheory
       thestring += "<caption>%s</caption>\n" %
         (scale.key + " " + scale.full_name +
           ": " + seqtostr(scale.full_notes))
-      thestring += "<thead>\n" + startrow + "<th>Chord Types</th>\n";
-      for q in range(7):
-#             thestring += "<th>%s</th>\n" % str(int_to_roman(q+1));
+      thestring += "<thead>\n" + startrow + "<th>Chord Types</th>\n"
+      # for q in range(7)
+      for q in 0...7
+        thestring += "<th>%s</th>\n" % str(int_to_roman(q+1))
       end
-      thestring += endrow + "</thead>\n<tbody>\n";
+      thestring += endrow + "</thead>\n<tbody>\n"
 
-      for i in scale.rows:
-        thestring += startrow;    
-        thestring += "<td>%s</td>\n" % i.chord_type;
-        for j in i.notes:
+      for i in scale.rows
+        thestring += startrow
+        thestring += "<td>%s</td>\n" % i.chord_type
+        for j in i.notes
           if not j.chordname_1
             thestring += ("<td><p>%s<br />" % (str(j.chordname_1)))
             thestring += ("<i>%s</i><br />" % (str(j.chordname_2)))

data/lib/music_set_theory/scales.rb

@@ -250,6 +250,9 @@ module MusicSetTheory
     # it (using slice, if not none). If and only if raz is True, the
     # result is rotated-and-zeroed.
     #
+    # ==== See Also
+    # - chord_generator.rb:`populate_scale_chords()`
+    #
     def get_posn_for_offset( rotate_by=0, slice=nil, raz: false )
       if slice
         modulus = self.nseq_temp.no_nat_keys

data/lib/music_set_theory/temperament.rb

@@ -396,13 +396,23 @@ module MusicSetTheory
       # Initialiser.
       # ==== Args
       # no_keys:: the number of keys in the temperament.
+      #   !number of semitones in one octave. ex. 12.
       # nat_keys:: an array consisting of the names of the natural
       #   (unsharped or unflattened) keys in the temperament.
+      #   ex.
+      #     ["C", "D", "E", "F", "G", "A", "B"]
+      #
       # nat_key_posn:: the position of the natural keys in the temperament.
       #   These should correspond to the elements in nat_keys.
       #   Positions are calculated base zero.
+      #   ex.
+      #     [  0,   2,   4,   5,   7,   9,  11]
       #
-      def initialize( no_keys, nat_keys, nat_key_posn )
+      # def initialize( no_keys, nat_keys, nat_key_posn )
+      def initialize( no_keys       = CHROM_SIZE,
+                      nat_keys      = CHROM_NAT_NOTES,
+                      nat_key_posn  = CHROM_NAT_NOTE_POS )
+        #
         self.no_keys      = no_keys
         self.nat_keys     = nat_keys
         self.nat_key_posn = nat_key_posn
@@ -436,13 +446,29 @@ module MusicSetTheory
 
         #  Useful for dictionary lookup later.
         #self.seq_maps = seq_dict([NSEQ_SCALE, NSEQ_CHORD], self);
-        #self.seq_maps = SeqDict.new(NSEQ_SCALE, NSEQ_CHORD);
         self.seq_maps = SeqDict.new([NSEQ_SCALE, NSEQ_CHORD], self)
 
       end
 
+      # Alias methods of getters+setters.
+      # {
+      #   original_base_name: [ name of aliases ],
+      #   original_base_name: [ name of aliases ],
+      #   :
+      #   :
+      # }
+      #
       {
-        seq_maps:            [:seq_dict],
+        no_keys:      [ :num_semitones, :num_keys, ],
+        nat_keys:     [ :natural_key_names, ],
+        nat_key_posn: [ :natural_key_positions, ],
+        no_nat_keys:  [ :num_natural_keys, ],
+        nat_key_pos_lookup: [
+          :natural_key_position_lookup, :natural_key_position_dict, ],
+        pos_lookup_nat_key: [
+          :position_natural_key_lookup, :position_natural_key_dict, ],
+
+        seq_maps: [:seq_dict],
       }.each do |k, vary|
 
         vary.each do |new_name|
@@ -525,6 +551,9 @@ module MusicSetTheory
       # position of the key in the unit of halftone. ex. key: "C"  =>0,
       # key: "D#" =>3, key: "Cb" =>-1
       #
+      # ==== See Also
+      # - `#get_key_of_pos()`
+      #
       def get_pos_of_key( key, debug_f: false )
         key_parsed = self.note_parse(key)
         $stderr.puts "key_parsed: #{key_parsed}"  if debug_f
@@ -534,6 +563,9 @@ module MusicSetTheory
         ret = self.nat_key_pos_lookup[key_parsed[0]] + key_parsed[1]
         ret
       end
+      alias pos_of_key  get_pos_of_key
+      alias position_of get_pos_of_key
+      alias pos_of      get_pos_of_key
 
       # Given a position in the temperament, this function attempts to
       # return the "best" key name corresponding to it. This is not a 
@@ -546,9 +578,9 @@ module MusicSetTheory
       # pos:: the position inside the temperament.
       # desired_nat_note:: the preferred natural key to start the key name.
       #   For example "C" makes the function return "C#" instead of "Db".
-      #   If None, then the preference depends on...
-      # sharp_not_flat:: if True, returns the sharpened accidental form 
-      # (e.g., "C#"); if False, returns the flattened accidental form
+      #   If nil, then the preference depends on...
+      # sharp_not_flat:: if true, returns the sharpened accidental form 
+      # (e.g., "C#"); if false, returns the flattened accidental form
       # (i.e., "Db").
       # ==== Returns
       #
@@ -602,6 +634,8 @@ module MusicSetTheory
 
         return nil
       end
+      alias key_of_pos get_key_of_pos
+      alias key_of     get_key_of_pos
 
 
       # This function takes a key and a sequence of positions relative to
@@ -669,6 +703,8 @@ module MusicSetTheory
       # ["D", "C#", "E"]  =>["D", [0, 11, 2]]
       #
       # this is returned by the function.
+      # ==== See Also
+      # - `#get_note_sequence()`
       #
       def get_keyseq_notes( note_seq )
         base_key = note_seq[0]
@@ -679,52 +715,70 @@ module MusicSetTheory
         [base_key, pos_seq]
       end
 
+    end
+
+  end
+end
+
+
+#
+#
+#
+module MusicSetTheory
+  module Temperament
+
+    class Temperament
+
 
       ### The next few functions are rip-offs of SeqDict functions.
+      #
+      #! actually these are the utility methods for SeqDict instance.
+      #
+
 
-      # This adds an element to the dictionary inside the temperament. The
-      # arguments:
-      # elem: the element to add  to the dictionary .
-      # nseq_type: the type of the elemenet (such as scale or chord).
-      # name_s: a string, or a sequence of strings. This provides names
+      # This adds an element to the dictionary inside the temperament.
+      # ==== Args
+      # elem:: the element to add  to the dictionary .
+      # nseq_type:: the type of the elemenet (such as scale or chord).
+      # name_s:: a string, or a sequence of strings. This provides names
       #   as keys that map onto elem.
-      # abbrv_s: a string, or a sequence of strings. This provides 
+      # abbrv_s:: a string, or a sequence of strings. This provides 
       #   abbreviations as keys that map onto elem.
-      # seqpos: a sequence. A tuple form will be used as a key that
+      # seqpos:: a sequence. A tuple form will be used as a key that
       #   maps onto elem.
       #
       # If nseq_type is not associated with any of the sub-dictionaries in
       # the dictionary in the temperament, then this function exits.
       #
       def add_elem( elem, nseq_type, name_s, abbrv_s, seqpos )
-        self.seq_maps.add_elem(elem, nseq_type, name_s, abbrv_s, seqpos)
+        self.seq_dict.add_elem(elem, nseq_type, name_s, abbrv_s, seqpos)
       end
 
 
       # Checks if there is a subdictionary associated with nseq_type.
       def check_nseqby_subdict( nseq_type )
-        self.seq_maps.check_nseqby_subdict(nseq_type)
+        self.seq_dict.check_nseqby_subdict(nseq_type)
       end
 
       # Checks if there is a noteseq with a given name.
       def check_nseqby_name( nseq_type, name )
-        self.seq_maps.check_nseqby_name(nseq_type, name)
+        self.seq_dict.check_nseqby_name(nseq_type, name)
       end
 
       # Checks if there is a noteseq with a given abbreviation.
       def check_nseqby_abbrv( nseq_type, abbrv )
-        self.seq_maps.check_nseqby_abbrv(nseq_type, abbrv)
+        self.seq_dict.check_nseqby_abbrv(nseq_type, abbrv)
       end
 
       # Checks if there is a noteseq with a given sequence position.
       def check_nseqby_seqpos( nseq_type, seqpos )
-        self.seq_maps.check_nseqby_seqpos(nseq_type, seqpos)
+        self.seq_dict.check_nseqby_seqpos(nseq_type, seqpos)
       end
-  
+
       # Looks up a noteseq (or anything else) by name.
       def get_nseqby_name( name, nseq_type )
-         if self.seq_maps.check_nseqby_name(nseq_type, name)
-           self.seq_maps.get_nseqby_name(name, nseq_type)
+         if self.seq_dict.check_nseqby_name(nseq_type, name)
+           self.seq_dict.get_nseqby_name(name, nseq_type)
          else
            nil
          end
@@ -748,8 +802,8 @@ module MusicSetTheory
         end
       end
 
-
     end
+
   end
 end
 
@@ -766,9 +820,9 @@ module MusicSetTheory
     #   ex. D = 2 (i.e., C + #*2), E = 4 (C + #*4), etc.
     # CHROM_NAT_NOTES:: natural notes.
     #
+    CHROM_SIZE          = 12
     CHROM_NAT_NOTES     = ["C", "D", "E", "F", "G", "A", "B"]
     CHROM_NAT_NOTE_POS  = [  0,   2,   4,   5,   7,   9,  11]
-    CHROM_SIZE          = 12
     def self.WestTempNew
       Temperament.new(CHROM_SIZE, CHROM_NAT_NOTES, CHROM_NAT_NOTE_POS)
     end

data/lib/music_set_theory/version.rb

@@ -4,7 +4,7 @@
 #
 
 module MusicSetTheory
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end
 
 

data/lib/music_set_theory.rb

@@ -20,5 +20,8 @@ require_relative "music_set_theory/temperament"
 require_relative "music_set_theory/scales"
 require_relative "music_set_theory/chords"
 
+#
+require_relative "music_set_theory/chord_generator"
+
 
 #### endof filename: music_set_theory.rb.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: music_set_theory
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - YAMAMOTO, Masayuki
@@ -59,12 +59,12 @@ files:
 - lib/music_set_theory/temperament.rb
 - lib/music_set_theory/version.rb
 - sig/music_theory.rbs
-homepage: https://voidptrjp.blogspot.com/2025/07/musictheorygem.html
+homepage: https://voidptrjp.blogspot.com/2025/07/musicsettheorygem.html
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://voidptrjp.blogspot.com/2025/07/musictheorygem.html
+  homepage_uri: https://voidptrjp.blogspot.com/2025/07/musicsettheorygem.html
   source_code_uri: https://github.com/mephistobooks/music_set_theory
   changelog_uri: https://github.com/mephistobooks/music_set_theory/CHANGELOG.md
 rdoc_options: []