normal_distribution 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c39b9084ca8f50ff432a0adb5b80104b9cc163a1
-  data.tar.gz: 632ad1a554d9d79839c38518b670446ed31ad654
+  metadata.gz: bcab113574f1fccfbfdb5652468461ffc009a5f6
+  data.tar.gz: 877e57cd9026fcad6049d06b3a5824ccadd6314b
 SHA512:
-  metadata.gz: 41135056180e292a81e2f2fc0393560905f3e74b8773c054fc301bab0a42a18275593f00e9aba74a918596005d8e13b4a80c73e84dd818c853247075017b6e4b
-  data.tar.gz: b4f9495995cf3636bcffe3803cce38307efd951329c288ab83de7166874158af8b3de184abdc92f2319df9cd1639ac92f802e36b025e14a73597547494b00f6f
+  metadata.gz: a702d3cf3623a7b75e64804ce481abacec2d7d202a5b9fcd8a445cddb4a23227d18dc98ba338683954d80158fe69a2f1b13447b891e88dc410ca73483aa85a61
+  data.tar.gz: e8f18576f23f92172678618ed42a1b782816dd13587fedea8a2f32cc428c8350b427e95421ae24062fb65c3baa9d771ea73dd6700dd83ba28adaef28de5d2864

data/lib/normal_distribution.rb

@@ -3,5 +3,8 @@
 require "normal_distribution/version"
 require "normal_distribution/normal_distribution"
 
+# Namespace for classes and modules serving for normal distribution based calculations
+#
+# @since 0.1.0
 module NormalDistribution
 end

data/lib/normal_distribution/model.rb

@@ -1,21 +1,31 @@
 # frozen_string_literal: true
 
 module NormalDistribution
+  # Model class of normal distribution
+  #
+  # @since 0.1.0
   class Model
-    # :nodoc:
-    # attr_reader :mean
-
-    # :nodoc:
-    # attr_reader :standard_deviation
-
-    # Initializes normal distribution from given data
-    # Params:
-    # +values+:: Non-empty array of numbers representing data for normal distribution construction
-    # def initialize(values); end
-
-    # Creates confidence interval for given percentage
-    # Params:
-    # +percentage+:: Number in interval <0, 100>
-    # def confidence_interval(percentage); end
+    # @!parse [ruby]
+    #
+    #   # @return [Float] mean of data contained in model
+    #   attr_reader :mean
+    #
+    #   # @return [Float] standard deviation of data contained in model
+    #   attr_reader :standard_deviation
+    #
+    #   # Initializes normal distribution model from given data
+    #   #
+    #   # @param values [Array<Numeric>] non-empty array of numbers representing data for normal distribution construction
+    #   def initialize(values)
+    #      # This is stub used for indexing
+    #   end
+    #
+    #   # Calculates confidence interval for given percentage
+    #   #
+    #   # @param percentage [Numeric] a number in interval <0, 100> representing probability
+    #   # @return [Array<Float>] an array containing 2 values, lower bound and upper_bound of confidence interval
+    #   def confidence_interval(percentage)
+    #      # This is stub used for indexing
+    #   end
   end
 end

data/lib/normal_distribution/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module NormalDistribution
-  VERSION = "0.1.1"
+  # Current version of NormalDistribution gem
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: normal_distribution
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Dominik Čermák
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Normal distribution model allows to create normal distribution from given
   data.Initial reason to build this was to use it in anomaly detection in discrete
   numerical data.