tatara 0.1.0 → 0.2.0

data/docs/tatara/float_array.md

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

data/docs/tatara/float_float_map.md

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

data/docs/tatara/float_integer_map.md

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

data/docs/tatara/float_string_map.md

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

data/docs/tatara/float_vector.md

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