summaryrefslogtreecommitdiff
path: root/doc/string/sum.rdoc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/string/sum.rdoc')
-rw-r--r--doc/string/sum.rdoc11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/string/sum.rdoc b/doc/string/sum.rdoc
new file mode 100644
index 0000000000..5de24e6402
--- /dev/null
+++ b/doc/string/sum.rdoc
@@ -0,0 +1,11 @@
+Returns a basic +n+-bit checksum of the characters in +self+;
+the checksum is the sum of the binary value of each byte in +self+,
+modulo <tt>2**n - 1</tt>:
+
+ 'hello'.sum # => 532
+ 'hello'.sum(4) # => 4
+ 'hello'.sum(64) # => 532
+ 'тест'.sum # => 1405
+ 'こんにちは'.sum # => 2582
+
+This is not a particularly strong checksum.