pdist 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55a92e4315831c4dbcf6d6f82234c3866c0e2e3d
-  data.tar.gz: 4d302000e4f0b641f00ac5ca203a234aa9e4b636
+  metadata.gz: 6a6f5b3ffbd9c7a94d90ef885b6e3d672cfd9d76
+  data.tar.gz: 06829fa9169d0bfe40034928915e9a4e51b0e3ba
 SHA512:
-  metadata.gz: aa1bd2577a5da537d5204c3d07c4c79a79403eaae915c468f0b8dc40c24026097e76829d31d8c9b1bb31cc10843dc86cc74932484cfeebf7b488e93117d85508
-  data.tar.gz: c029ec2faedefb7f1f501a9fb2c61ca51753d91da446fc87bada34d04b26c26107e6b71c7b740fd5ca5b3cbdfea3591cc9eecd6ad79ce77721bd68b2b95da707
+  metadata.gz: bd6c346ba5a2c20e3c197ace9c893bdd44b00ae7658d538e52bffff47e5e8fabd92bce3eebcff3193bdd5fd9bc54b0f7db519ec031d2ba2242c21f49953dc97b
+  data.tar.gz: 534384b0ba7b37c391e8a73f16e72140765bfb44573bcc9682e7ab9abd4c15e2b50fad2e6fc3452d0f5540bcbf2c24a30ae1a82087caa94e564a11319bd9226c

data/lib/pdist.rb

@@ -12,9 +12,14 @@ class PDist
 		return difference.map! {|i| i.abs } # the deviation's, as absolute values (direction does not matter)
 	end
 
+	# Returns float of the deviation distance between original and permutation
+	def self.deviation_raw(original, permutation)
+		return distances(original, permutation).inject(:+) # sum of each object's deviation, is the deviation distance between original and permutation
+	end
+
 	# Returns float of the deviation distance between original and permutation, normalized between 0.0 and 1.0
 	def self.deviation(original, permutation)
-		s = distances(original, permutation).inject(:+) # sum of each object's deviation, is the deviation distance between original and permutation
+		s = deviation_raw(original, permutation)
 		n = permutation.length
 		if n % 2 == 0 
 			distance = (2.0 / (n ** 2).to_f) * s
@@ -24,17 +29,22 @@ class PDist
 		return distance # if/else block normalizes the deviation distance
 	end
 
-	# Returns float of the squared deviation distance between original and permutation, normalized between 0.0 and 1.0
-	def self.square(original, permutation)
+	# Returns float of the squared deviation distance between original and permutation
+	def self.square_raw(original, permutation)
 		sq_dists = []
 		distances(original, permutation).each{|d| sq_dists << d**2} # each object's deviation is squared
-		s = sq_dists.inject(:+) # sum of each object's squared deviation, is the squared deviation distance between original and permutation
+		return sq_dists.inject(:+) # sum of each object's squared deviation, is the squared deviation distance between original and permutation
+	end
+
+	# Returns float of the squared deviation distance between original and permutation, normalized between 0.0 and 1.0
+	def self.square(original, permutation)
+		s = square_raw(original, permutation)
 		n = permutation.length
 		return (3.0 / (n**3 - n).to_f) * s # normalizes the squared deviation distance
 	end
 
-	# Returns float of the generalized hamming distance between original and permutation, normalized between 0.0 and 1.0 
-	def self.hamming(original, permutation)
+	# Returns float of the generalized hamming distance between original and permutation
+	def self.hamming_raw(original, permutation)
 		x = 0
 		hds = [] # hamming distances
 		permutation.each do |object| # hamming distances are 0 when object's have same index in original and permutation, and 1 when not
@@ -43,34 +53,48 @@ class PDist
 			end
 			x+=1
 		end
-		total_hd = hds.inject(:+).to_f # total hamming distance is the sum of the hamming distances
+		return hds.inject(:+).to_f # total hamming distance is the sum of the hamming distances
+	end
+
+	# Returns float of the generalized hamming distance between original and permutation, normalized between 0.0 and 1.0 
+	def self.hamming(original, permutation)
+		total_hd = hamming_raw(original, permutation)
 		return total_hd / permutation.length.to_f # normalizes by dividing the total hamming distance by the maximum possible total, which == number of objects
 	end
 
-	# Returns float of the compliment R distance between original and permutation, normalized between 0.0 and 1.0
-	def self.rdist(original, permutation)
+	# Returns float of the compliment R distance between original and permutation
+	def self.rdist_raw(original, permutation)
 		x = 0
 		r = [] # compliment of R distance == number of times two objects consecutive in original, are consectutive in permutation
-		n = permutation.length
-		(n - 1).times do 
+		(permutation.length - 1).times do 
 			y = permutation.index(original[x])
 			if original[x+1] != permutation[y+1]
 				r << 1
 			end
 			x+=1
 		end
-		return r.inject(:+).to_f / (n - 1).to_f # normalized: dividing by maximum number of consecutive occurences
+		return r.inject(:+).to_f
+	end
+
+	# Returns float of the compliment R distance between original and permutation, normalized between 0.0 and 1.0
+	def self.rdist(original, permutation)
+		dist = rdist_raw(original, permutation)
+		return dist / (permutation.length - 1).to_f # normalized: dividing by maximum number of consecutive occurences
+	end
+
+	# Returns float of the longest common sub-sequence between original and permutation
+	def self.lcs_raw(original, permutation)
+		return Diff::LCS.LCS(original, permutation) # diff-lcs gem used to calculate longest common sub-sequence
 	end
 
 	# Returns float of the longest common sub-sequence between original and permutation, normalized between 0.0 and 1.0
 	def self.lcs(original, permutation)
-		lcs = Diff::LCS.LCS(original, permutation) # diff-lcs gem used to calculate longest common sub-sequence
+		lcs = lcs_raw(original, permutation)	
 		return (permutation.length - lcs.length).to_f / (permutation.length - 1).to_f # normalized: dividing by longest possible common sub-sequence
 	end
 
-	# Returns float of the kendall's tau distance between original and permutation, normalized between 0.0 and 1.0
-	def self.kendalls_tau(original, permutation) # TODO edit the if statement to work with any type of object
-		n = permutation.length
+	# Returns float of the kendall's tau distance between original and permutation
+	def self.kendalls_tau_raw(original, permutation)
 		kt = []
 		original.each do |x| # for each of the objects in original...
 			permutation.each do |y| # ... iterate over the objects in permutation
@@ -80,7 +104,13 @@ class PDist
 				end
 			end
 		end
-		s = kt.inject(:+) # the number of pairwise adjacent permutations required to transform original into permutation
+		return kt.inject(:+) # the number of pairwise adjacent permutations required to transform original into permutation
+	end
+
+	# Returns float of the kendall's tau distance between original and permutation, normalized between 0.0 and 1.0
+	def self.kendalls_tau(original, permutation) # TODO edit the if statement to work with any type of object
+		n = permutation.length
+		s = kendalls_tau_raw(original, permutation)
 		return 2 * (s.to_f / (n**2 - n).to_f) # normalized kendall's tau distance
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pdist
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Edward Chalstrey