tatara 0.1.0 → 0.2.0

data/docs/tatara/integer_array.md

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

data/docs/tatara/integer_float_map.md

@@ -0,0 +1,52 @@
+# Tatara::IntFloatMap
+## About
+
+`Tatara::IntFloatMap` is `Map` class like `static type programming lang`.
+
+`Tatara::IntFloatMap` used by `Integer` key, and `Float` value.
+But, you can use `Float` for key & value.
+
+```ruby
+@i = Tatara::IntFloatMap.new
+@i[0] = 42
+# => Key: 0, Value: 42.0
+@i[10.0] = 8.4
+# => Key: 10, Value: 8.4
+```
+
+But, can not set `String`.
+
+```ruby
+@i = Tatara::IntFloatMap.new
+@i[0] = "42"
+# => Error!
+```
+
+## Methods
+### Tatara::IntFloatMap#new
+
+Create new `Tatara::IntFloatMap` instance.
+```ruby
+@i = Tatara::IntFloatMap.new
+```
+
+### Tatara::IntFloatMap#\[\]
+
+Access by key.
+
+```ruby
+@i = Tatara::IntFloatMap.new
+@i[0] = 4.2
+puts @i[0]
+# => 4.2
+```
+
+### Tatara::IntFloatMap#\[\]=
+
+Set value by key.
+
+```ruby
+@i = Tatara::IntFloatMap.new
+@i[0] = 4.2
+# => Set value is 4.2
+```

data/docs/tatara/integer_integer_map.md

@@ -0,0 +1,52 @@
+# Tatara::IntIntMap
+## About
+
+`Tatara::IntIntMap` is `Map` class like `static type programming lang`.
+
+`Tatara::IntIntMap` used by `Integer` key, and `Integer` value.
+But, you can use `Float` for key & value.
+
+```ruby
+@i = Tatara::IntIntMap.new
+@i[0] = 42
+# => Key: 0, Value: 42.
+@i[10.0] = 8.4
+# => Key: 10, Value: 8.
+```
+
+But, can not set `String`.
+
+```ruby
+@i = Tatara::IntIntMap.new
+@i[0] = "42"
+# => Error!
+```
+
+## Methods
+### Tatara::IntIntMap#new
+
+Create new `Tatara::IntIntMap` instance.
+```ruby
+@i = Tatara::IntIntMap.new
+```
+
+### Tatara::IntIntMap#\[\]
+
+Access by key.
+
+```ruby
+@i = Tatara::IntIntMap.new
+@i[0] = 42
+puts @i[0]
+# => 42
+```
+
+### Tatara::IntIntMap#\[\]=
+
+Set value by key.
+
+```ruby
+@i = Tatara::IntIntMap.new
+@i[0] = 42
+# => Set value is 42.
+```

data/docs/tatara/integer_string_map.md

@@ -0,0 +1,52 @@
+# Tatara::IntStringMap
+## About
+
+`Tatara::IntStringMap` is `Map` class like `static type programming lang`.
+
+`Tatara::IntStringMap` used by `Integer` key, and `String` value.
+But, you can use `Float` for key & value.
+
+```ruby
+@i = Tatara::IntStringMap.new
+@i[0] = "42"
+# => Key: 0, Value: "42".
+@i[10.0] = "8.4"
+# => Key: 10, Value: "8.4".
+```
+
+But, can not set `Integer` & `Float` for value.
+
+```ruby
+@i = Tatara::IntStringMap.new
+@i[0] = 42
+# => Error!
+```
+
+## Methods
+### Tatara::IntStringMap#new
+
+Create new `Tatara::IntStringMap` instance.
+```ruby
+@i = Tatara::IntStringMap.new
+```
+
+### Tatara::IntStringMap#\[\]
+
+Access by key.
+
+```ruby
+@i = Tatara::IntStringMap.new
+@i[0] = "42"
+puts @i[0]
+# => "42"
+```
+
+### Tatara::IntStringMap#\[\]=
+
+Set value by key.
+
+```ruby
+@i = Tatara::IntStringMap.new
+@i[0] = "42"
+# => Set value is "42".
+```

data/docs/tatara/integer_vector.md

@@ -0,0 +1,268 @@
+# Tatara::IntVector
+## About
+
+`Tatara::IntVector` is `Vector` class like `static type programming lang`.
+
+`Tatara::IntVector` use `Integer` value.
+But, you can use `Float` for value.
+
+```ruby
+@i = Tatara::IntVector.new
+@i[0] = 42
+# => Set value 42 for index of 0.
+@i[1] = 8.4
+# => Set value 8 for index of 1.
+```
+
+But, can not use `String` for value.
+
+```ruby
+@i = Tatara::IntVector.new
+@i[0] = "42"
+# => Error!
+```
+
+## Methods
+### Tatara::IntVector#new
+
+Create new `Tatara::IntVector` instance.
+
+```ruby
+@i = Tatara::IntVector.new
+```
+
+### Tatara::IntVector#\[\]
+
+Access by index.
+
+```ruby
+@i = Tatara::IntVector.new
+@i[0] = 42
+puts @i[0]
+# => 42
+```
+
+### Tatara::IntVector#\[\]=
+
+Set value by index.
+
+```ruby
+@i = Tatara::IntVector.new
+@i[0] = 42
+# => Set value 42 for index of 0.
+```
+
+### Tatara::IntVector#emplace_back
+
+Create new value on end of `Tatara::intVector`.
+
+```ruby
+@i = Tatara::IntVector.new
+@i.emplace_back(42)
+# => Set value 42 on end of `Tatara::intVector`
+```
+
+### Tatara::IntVector#size
+
+Size of `Tatara::intVector`.
+
+```ruby
+@i = Tatara::IntVector.new
+puts @i.size
+# => 0
+@i.emplace_back(42)
+puts @i.size
+# => 1
+```
+
+### Tatara::IntVector#clear
+
+Clear `Tatara::intVector`.
+
+```ruby
+@i = Tatara::IntVector.new
+@i.emplace_back(42)
+puts @i.size
+# => 1
+@i.clear
+puts @i.size
+# => 0
+```
+
+### Tatara::IntVector#sum
+
+Sum value's for `Tatara::IntVector`.
+
+```ruby
+@i = Tatara::IntVector.new
+(1..3).each{|i|
+    @i.emplace_back(i)
+}
+puts @i.sum
+# => 6
+```
+
+### Tatara::IntVector#operator<<
+
+Create new value on end of `Tatara::intVector`.
+
+```ruby
+@i = Tatara::IntVector.new
+@i << 42
+# => Set value 42 on end of `Tatara::intVector`
+```
+
+### Tatara::IntVector#map
+
+`map` method for `Tatara::IntVector`.  
+It's likes `Array#map`
+
+```ruby
+@i = Tatara::IntVector.new
+(1..3).each{|i| @i << i }
+# => Set new value's
+@i.map{|i|
+    puts i
+}
+# => 1 2 3
+```
+
+### Tatara::IntVector#map!
+
+`map!` method for `Tatara::IntVector`.  
+It's likes `Array#map!`
+
+```ruby
+@i = Tatara::IntVector.new
+(1..3).each{|i| @i << i }
+# => Set new value's
+@i.map!{|i| i * 2 }
+@i.map{|i|
+    puts i
+}
+# => 2 4 6
+```
+
+### Tatara::IntVector#each
+
+`each` method for `Tatara::IntVector`.  
+It's likes `Array#each`
+
+```ruby
+@i = Tatara::IntVector.new
+(1..3).each{|i| @i << i }
+# => Set new value's
+@i.each{|i|
+    puts i
+}
+# => 1 2 3
+```
+
+### Tatara::IntVector#each_with_index
+
+`each_with_index` method for `Tatara::IntVector`.  
+It's likes `Array#each_with_index`
+
+```ruby
+@i = Tatara::IntVector.new
+(1..3).each{|i| @i << i }
+# => Set new value's
+@i.each_with_index{|v, i|
+    puts "#{i}:#{v}"
+}
+# => 1:1 2:2 3:3
+```
+
+### Tatara::Intvector#intersection
+
+Intersection value's
+
+```ruby
+@i1 = Tatara::IntVector.new
+(1..10).each{|i| @i1 << i}
+@i2 = Tatara::IntVector.new
+(10..20).each{|i| @i2 << i}
+@i = @i1.intersection @i2
+# => [10]
+```
+
+### Tatara::Intvector#operator&
+
+Intersection value's
+
+```ruby
+@i1 = Tatara::IntVector.new
+(1..10).each{|i| @i1 << i}
+@i2 = Tatara::IntVector.new
+(10..20).each{|i| @i2 << i}
+@i = @i1 & @i2
+# => [10]
+```
+
+### Tatara::IntVector#sort
+
+Sort value's.
+
+```ruby
+@i = Tatara::IntVector.new
+[9, 1, 4].each{|i| @i << i }
+@i = @i.sort
+# => [1, 4, 9]
+```
+
+### Tatara::IntVector#sort!
+
+Sort value's.
+
+```ruby
+@i = Tatara::IntVector.new
+[9, 1, 4].each{|i| @i << i }
+@i.sort!
+# => [1, 4, 9]
+```
+
+### Tatara::IntVector#reverse
+
+Reverse value's.
+
+```ruby
+@i = Tatara::IntVector.new
+[9, 1, 4].each{|i| @i << i }
+@i = @i.reverse
+# => [4, 1, 9]
+```
+
+### Tatara::IntVector#reverse!
+
+Reverse value's.
+
+```ruby
+@i = Tatara::IntVector.new
+[9, 1, 4].each{|i| @i << i }
+@i.reverse!
+# => [4, 1, 9]
+```
+
+### Tatara::IntVector#first
+
+Get first value of `Tatara::IntVector`.
+
+```ruby
+@i = Tatara::IntVector.new
+(1..3).each{|i| @i << i }
+# => Set new value's
+puts @i.first
+# => 1
+```
+
+### Tatara::IntVector#last
+
+Get last value of `Tatara::IntVector`.
+
+```ruby
+@i = Tatara::IntVector.new
+(1..3).each{|i| @i << i }
+# => Set new value's
+puts @i.last
+# => 3
+```