markov-reloaded 0.0.1 → 0.0.2

data/lib/markov-reloaded.rb

@@ -49,17 +49,22 @@ class Array
 		Markov.new(data, order)
 	end
 end
+#Main class for generating Markov Chains
 class Markov
+	#Initialize the markov object from a hash
+	#data is the hash to generate by, order is the order of the hash
 	def initialize (data, order)
 		@data = data
 		@order = order
 	end
 	attr_accessor :data
+	#Analyze an array and add it to the current object's hash
 	def add(array)
-		self.+(array.toMarkov, @order)
+		self.+(array.toMarkov @order)
 	end
+	#Analyze array and create Markov object from it
 	def self.analyze(array, order)
-		data = Hash.new(:Error)
+		data = Hash.new(nil)
 		for i in 0..array.length-1-order
 			el = array[i..i+order-1]
 			if data.include? el
@@ -70,6 +75,7 @@ class Markov
 		end
 		Markov.new(data, order)
 	end
+	#Add the data of another markov object to the current one
 	def +(mark)
 		hash = mark.data
 		hash.each do |key, value|
@@ -80,13 +86,16 @@ class Markov
 			end
 		end
 	end
-	 	def pickElement(element, random)
+	#Given a list of elements with length order(a key for the hash), pick the next element based on the random number generator
+	def pickElement(element, random=(Random.new(Time.now.nsec)))
 		arr = @data[element]
 		i = random.rand(arr.length)
 		arr[i]
 	end
 	attr_accessor :data
-	def generate(maxlength, first= [], seed, terminator)
+	#Given a maximum length, a list of elements with length order at which to begin the generation(nil wil be output at every point if the list of elements does not exist in the analyzed array)
+	#a seed for the random number generator and an element at which to terminate(defaults to "."). Generates and outputs an array corresponding to a markov chain.
+	def generate(maxlength, first= [], seed=(Time.now.nsec), terminator = ".")
 		r = Random.new seed
 		first = @data.keys.pickRand(r) if first == []
 		out = first.dup

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: markov-reloaded
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-22 00:00:00.000000000 Z
+date: 2012-08-23 00:00:00.000000000 Z
 dependencies: []
 description: ! "markov-reloaded provides a simple interface to create markov chains.\n\tthe
   system is based on hashes, but provides flexible methods to generate the chains