tatara 0.1.0 → 0.2.0

data/docs/tatara/string.md

@@ -0,0 +1,223 @@
+# Tatara::String
+## About
+
+`Tatara::String` is `String` class like `static type programming lang`.
+
+`Tatara::String` can set `val` for `String`.
+
+```ruby
+@s = Tatara::String.new
+@s.val = "hoge"
+# => Set "hoge"
+@s.val = "fuga"
+# => Set "fuga"
+```
+
+But, can not set `Integer` & `Float` value.
+
+```ruby
+@s = Tatara::String.new
+@s.val = 42
+# => Error!
+@s.val = 4.2
+# => Error!
+```
+
+## Methods
+### Tatara::String#new
+
+Create new `Tatara::String` instance.  And init `value` is `""`
+
+```ruby
+@s = Tatara::String.new
+```
+
+### Tatara::String#value
+
+return `Tatara::String` instance value.
+
+```ruby
+@s = Tatara::String.new
+puts @s.value
+# => Show ""
+```
+
+### Tatara::String#val
+
+return `Tatara::String` instance value.
+
+```ruby
+@s = Tatara::String.new
+puts @s.val
+# => Show ""
+```
+
+### Tatara::String#value=
+
+Set instance value for `Tatara::String`.
+
+```ruby
+@s = Tatara::String.new
+@s.value = "42"
+# => Set "42"
+```
+
+### Tatara::String#val=
+
+Set instance value for `Tatara::String`.
+
+```ruby
+@s = Tatara::String.new
+@s.val = "42"
+# => Set "42"
+```
+
+### Tatara::String#value+= 
+
+Add and Set instance value for `Tatara::String`.
+
+```ruby
+@s = Tatara::String.new
+@s.value = "21"
+@s.value += "21"
+# => Value is "2121"
+@s.value += "21"
+# => Value is "212121"
+```
+
+### Tatara::String#val+= 
+
+Add and Set instance value for `Tatara::String`.
+
+```ruby
+@s = Tatara::String.new
+@s.val = "21"
+@s.val += "21"
+# => Value is "2121"
+@s.val += "21"
+# => Value is "212121"
+```
+
+### Tatara::String#value==
+
+Check instance value, and return `Boolean`.
+
+```ruby 
+@s = Tatara::String.new
+@s.value = "42"
+puts @s.value == "42"
+# => true
+puts @s.value == "62"
+# => false
+```
+
+### Tatara::String#val==
+
+Check instance value, and return `Boolean`.
+
+```ruby 
+@s = Tatara::String.new
+@s.val = "42"
+puts @s.val == "42"
+# => true
+puts @s.val == "62"
+# => false
+```
+
+### Tatara::String#equal?
+
+Check instance value, and return `Boolean`.
+
+```ruby 
+@s = Tatara::String.new
+@s.val = "42"
+puts @s.equal? "42"
+# => true
+puts @s.equal? "62"
+# => false
+```
+
+### Tatara::String#to_i
+
+Convert to `Integer` for instance value.
+
+```ruby
+@s = Tatara::String.new
+@s.val = "42"
+@s.to_i
+# => Conver to Integer.
+```
+
+### Tatara::String#to_f
+
+Convert to `Float` for instance value.
+
+```ruby
+@s = Tatara::String.new
+@s.val = "4.2"
+@s.to_f
+# => Convert to Float.
+```
+
+### Tatara::String#clear
+
+Clear instance value.
+
+```ruby
+@s = Tatara::String.new
+@s.val = "42"
+# => Set "42"
+@s.clear
+# => Clear instance value. Value is ""
+```
+
+### Tatara::String#operator<<
+
+Set instance value for `Tatara::String`.
+
+```ruby
+@s = Tatara::String.new << "42"
+puts @s.val
+# => "42"
+@s = @s << "50"
+puts @s.val
+# => "50"
+```
+
+### Tatara::String#\[\]
+
+Access by Index.
+
+```ruby
+@s = Tatara::String.new
+@s <<= "hello"
+puts @s[0]
+# => "h"
+puts @s[1]
+# => "e"
+```
+
+### Tatara::String#slice
+
+Slice `Tatara::String` value.
+
+```ruby
+@s = Tatara::String.new
+@s <<= "hello"
+puts @s.slice(0, 3)
+# => "hel"
+puts @s.slice(0, 4)
+# => "hell"
+```
+
+### Tatara::String#slice!
+
+Slice `Tatara::String` value, and Reset sliced value.
+
+```ruby
+@s = Tatara::String.new
+@s <<= "hello"
+@s.slice!(0, 3)
+puts @s.val
+# => "hel"
+```

data/docs/tatara/string_array.md

@@ -0,0 +1,254 @@
+# Tatara::StringArray
+## About
+
+`Tatara::StringArray` is `Array` class like `static type programming lang`.
+
+`Tatara::StringArray` use `String` value.
+But, you can not use `Integer` & `Float` for value.
+
+```ruby
+@s = Tatara::StringArray.new
+@s[0] = "42"
+# => Set value "42" for index of 0.
+@s[1] = "8.4"
+# => Set value "8.4" for index of 1.
+```
+
+But, can not use `Integer` & `Float` for value.
+
+```ruby
+@s = Tatara::StringArray.new
+@s[0] = 42
+# => Error!
+```
+
+## Methods
+### Tatara::StringArray#new
+
+Create new `Tatara::StringArray` instance.
+
+```ruby
+@s = Tatara::StringArray.new
+```
+
+### Tatara::StringArray#\[\]
+
+Access by index.
+
+```ruby
+@s = Tatara::StringArray.new
+@s[0] = "42"
+puts @s[0]
+# => "42"
+```
+
+### Tatara::StringArray#\[\]=
+
+Set value by index.
+
+```ruby
+@s = Tatara::StringArray.new
+@s[0] = "42"
+# => Set value "42" for index of 0.
+```
+
+### Tatara::StringArray#push
+
+Create new value on end of `Tatara::StringArray`.
+
+```ruby
+@s = Tatara::StringArray.new
+@s.push("42")
+# => Set value "42" on end of `Tatara::StringArray`
+```
+
+### Tatara::StringArray#size
+
+Size of `Tatara::StringArray`.
+
+```ruby
+@s = Tatara::StringArray.new
+puts @s.size
+# => 0
+@s.push("42")
+puts @s.size
+# => 1
+```
+
+### Tatara::StringArray#clear
+
+Clear `Tatara::StringArray`.
+
+```ruby
+@s = Tatara::StringArray.new
+@s.push("42")
+puts @s.size
+# => 1
+@s.clear
+puts @s.size
+# => 0
+```
+### Tatara::StringArray#operator<<
+
+Create new value on end of `Tatara::StringArray`.
+
+```ruby
+@s = Tatara::StringArray.new
+@s << "42"
+# => Set value "42" on end of `Tatara::StringArray`
+```
+
+### Tatara::StringArray#map
+
+`map` method for `Tatara::StringArray`.  
+It's likes `Array#map`
+
+```ruby
+@s = Tatara::StringArray.new
+("A".."C").each{|s| @s << s }
+# => Set new value's
+@s.map{|s|
+    puts s
+}
+# => A B C
+```
+
+### Tatara::StringArray#map!
+
+`map!` method for `Tatara::StringArray`.  
+It's likes `Array#map!`
+
+```ruby
+@s = Tatara::StringArray.new
+("A".."C").each{|s| @s << s }
+# => Set new value's
+@s.map!{|s| s.succ }
+@s.map{|s|
+    puts s
+}
+# => B C D
+```
+
+### Tatara::StringArray#each
+
+`each` method for `Tatara::StringArray`.  
+It's likes `Array#each`
+
+```ruby
+@s = Tatara::StringArray.new
+("A".."C").each{|s| @s << s }
+# => Set new value's
+@s.each{|s|
+    puts s
+}
+# => A B C
+```
+
+### Tatara::StringArray#each_with_index
+
+`each_with_index` method for `Tatara::StringArray`.  
+It's likes `Array#each_with_index`
+
+```ruby
+@s = Tatara::StringArray.new
+("A".."C").each{|s| @s << s }
+# => Set new value's
+@s.each_with_index{|v, i|
+    puts "#{i}:#{v}"
+}
+# => 1:A 2:B 3:C
+```
+
+### Tatara::StringArrayr#intersection
+
+Intersection value's
+
+```ruby
+@s1 = Tatara::StringArray.new
+("A".."C").each{|s| @s1 << s}
+@s2 = Tatara::StringArray.new
+("C".."F").each{|s| @s2 << s}
+@s = @s1.intersection @s2
+# => ["C"]
+```
+
+### Tatara::StringArray#operator&
+
+Intersection value's
+
+```ruby
+@s1 = Tatara::StringArray.new
+("A".."C").each{|s| @s1 << s}
+@s2 = Tatara::StringArray.new
+("C".."F").each{|s| @s2 << s}
+@s = @s1 & @s2
+# => ["C"]
+```
+
+### Tatara::StringArray#sort
+
+Sort value's.
+
+```ruby
+@s = Tatara::StringArray.new
+["9", "1", "4"].each{|s| @s << s }
+@s = @s.sort
+# => ["1", "4", "9"]
+```
+
+### Tatara::StringArray#sort!
+
+Sort value's.
+
+```ruby
+@s = Tatara::StringArray.new
+["9", "1", "4"].each{|s| @s << s }
+@s.sort!
+# => ["1", "4", "9"]
+```
+
+### Tatara::StringArray#reverse
+
+Reverse value's.
+
+```ruby
+@s = Tatara::StringArray.new
+["9", "1", "4"].each{|s| @s << s }
+@s = @s.reverse
+# => ["4", "1", "9"]
+```
+
+### Tatara::StringArray#reverse!
+
+Reverse value's.
+
+```ruby
+@s = Tatara::StringArray.new
+["9", "1", "4"].each{|s| @s << s }
+@s.reverse!
+# => ["4", "1", "9"]
+```
+
+### Tatara::StringArray#first
+
+Get first value of `Tatara::StringArray`.
+
+```ruby
+@s = Tatara::StringArray.new
+("A".."C").each{|s| @s << s }
+# => Set new value's
+puts @s.first
+# => "A"
+```
+
+### Tatara::StringArray#last
+
+Get last value of `Tatara::StringArray`.
+
+```ruby
+@s = Tatara::StringArray.new
+("A".."C").each{|s| @s << s }
+# => Set new value's
+puts @s.last
+# => "C"
+```