class WordMage::Generator

• WordMage::Generator
• Reference
• Object

Overview

Main word generation engine that combines all components.

Generator is the central class that orchestrates word creation using PhonemeSet, WordSpec, SyllableTemplates, and RomanizationMap. It supports multiple generation modes and handles constraint validation.

Example

generator = Generator.new(
  phoneme_set: phonemes,
  word_spec: word_spec,
  romanizer: romanizer,
  mode: GenerationMode::Random
)
word = generator.generate
batch = generator.generate_batch(10)

Defined in:

generator.cr

Constructors

• .new(phoneme_set : PhonemeSet, word_spec : WordSpec, romanizer : RomanizationMap, mode : GenerationMode, max_words : Int32 = 1000, complexity_budget : Int32 | Nil = nil, hiatus_escalation_factor : Float32 = 1.5_f32, vowel_harmony : VowelHarmony | Nil = nil)

  Creates a new Generator.

Instance Method Summary

• #complexity_budget : Int32 | Nil
• #complexity_budget=(complexity_budget : Int32 | Nil)
• #generate(min_syllables : Int32, max_syllables : Int32) : String

  Generates a word with syllable count from a range.

• #generate(syllable_count : Int32, starting_type : Symbol) : String

  Generates a word with both syllable count and starting type.

• #generate(syllable_count : Int32) : String

  Generates a word with a specific syllable count.

• #generate(starting_type : Symbol) : String

  Generates a word with a specific starting type.

• #generate : String

  Generates a single word according to the current mode.

• #generate_batch(count : Int32) : Array(String)

  Generates multiple words.

• #hiatus_escalation_factor : Float32
• #hiatus_escalation_factor=(hiatus_escalation_factor : Float32)
• #max_words : Int32
• #max_words=(max_words : Int32)
• #mode : GenerationMode
• #mode=(mode : GenerationMode)
• #next_sequential : String | Nil

  Gets the next word in sequential mode.

• #phoneme_set : PhonemeSet
• #phoneme_set=(phoneme_set : PhonemeSet)
• #reset_sequential

  Resets sequential generation to start from the beginning.

• #romanizer : RomanizationMap
• #romanizer=(romanizer : RomanizationMap)
• #vowel_harmony : VowelHarmony | Nil
• #vowel_harmony=(vowel_harmony : VowelHarmony | Nil)
• #word_spec : WordSpec
• #word_spec=(word_spec : WordSpec)

Constructor Detail

Instance Method Detail