num4mechaequ 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e3e5fffadd5eea83945129ed1694e89bce4f636a077552c020806fbf60fa5f8
-  data.tar.gz: 4f8c45b1ccd5a0c2b88b4caf7c26d0febe7d82cad638aaeaddaae7b9f6b77829
+  metadata.gz: 33f7db372d5c6d97cce0dfd47d9040d10178f575bc6394b84322079d96f605e6
+  data.tar.gz: a4ef6a9911a6ae1654c095def96600d283bf69e73657c0f39c8fbeb879e42090
 SHA512:
-  metadata.gz: 5810693ced93a1143f50a9d1b418adc2b64435efd0d4cec33900938b5adb5105f34516f5de78ed115f340312ea40c0f814e9786968f747837abce17c1829c613
-  data.tar.gz: 592d88dc5d73c8dc48d1819097b3ce32e6fe33deede84f8308ab255254422e7c9d41f500a4e6c617b2ca29a62ea415c406942f20a5746e68c599b67a55cb2dd4
+  metadata.gz: 014cabe8283d052239d19853b1591e2e981b2e1cc7c97a98d58d4d47439fc26393ec7f991d8c99628a8a5d448e6f86aa735b515ea5a40c816d339804497cb49b
+  data.tar.gz: de07a537f9ec64ee9046a6c84e758b3949916bc679fb851711ec00d01850b442bb53a6a46a85448cf62d3cb85c54002d4ce4fb6667b002828429f6a61d37c2cf

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+## [0.1.4] - 2023-10-18
+
+### add
+- add sample of yardoc
+
 ## [0.1.3] - 2022-07-20
 
 ### Added

data/lib/num4mechaequ.rb

@@ -52,8 +52,8 @@ module Num4MechaEquLib
     end 
     class << self
 
-        #
         # 単振動(simple harmonic motion)
+        #
         # @overload SHM(m, k, t, h0, v0)
         #   @param [double] m 重りの重さ
         #   @param [double] k バネ定数
@@ -61,6 +61,12 @@ module Num4MechaEquLib
         #   @param [double] h0 初期位置値
         #   @param [double] v0 初期速度
         #   @return [hash[]] 0秒からt秒までの位置(h)と速度(v)の値
+        # @example
+        #   m = 1.0
+        #   k = 1.0
+        #   h0 = 1.0
+        #   v0 = 0.0
+        #   yi_1 = Num4MechaEquLib.SHM(m, k, 2, h0, v0)
         #
         def SHM(m, k, t, h0, v0)
             @w = Math.sqrt((k / m))
@@ -75,8 +81,8 @@ module Num4MechaEquLib
             }
             return hvt
         end
-        #
         # 自由落下による運動方程式(空気抵抗有り)
+        #
         # @overload freeFallMotion(m, c, t, h0, v0)
         #   @param [double] m 重りの重さ
         #   @param [double] c 空気抵抗
@@ -84,6 +90,12 @@ module Num4MechaEquLib
         #   @param [double] h0 初期位置値
         #   @param [double] v0 初期速度
         #   @return [hash[]] 0秒からt秒までの位置(h)と速度(v)の値
+        # @example
+        #   m = 1.0
+        #   c = 0.0
+        #   h0 = 1.0
+        #   v0 = 0.0
+        #   yi_1 = Num4MechaEquLib.freeFallMotion(m, c, 2, h0, v0)
         #
         def freeFallMotion(m, c, t, h0, v0)
             @w = c / m
@@ -99,8 +111,8 @@ module Num4MechaEquLib
             return hvt
 
         end
-        #
         # 放物運動
+        #
         # @overload projectileMotion(m, theta, t, h0, v0)
         #   @param [double] m     重りの重さ
         #   @param [double] theta 角度(ラジアン指定)
@@ -108,6 +120,10 @@ module Num4MechaEquLib
         #   @param [double] h0 初期位置値
         #   @param [double] v0 初期速度
         #   @return [hash[]] 0秒からt秒までの位置(h)と速度(v)の値
+        # @example
+        #   m = 1.0
+        #   theta = 5 * Math::PI / 180.0
+        #   yi_1 = Num4MechaEquLib.projectileMotion(m, theta, 2, 0.0, 3.0)
         #
         def projectileMotion(m, theta, t, h0, v0)
             hvt = []
@@ -128,14 +144,20 @@ module Num4MechaEquLib
             }
             return hvt
         end
-        #
         # 等速円運動(Uniform Circular motion)
+        #
         # @overload UCM(m, r, w, t)
         #   @param [double] m 重りの重さ
         #   @param [double] r 半径
         #   @param [double] w 角速度
         #   @param [double] t 時間
         #   @return [hash[]] 0秒からt秒までの位置(h)と速度(v)の値
+        # @example
+        #   m = 1.0
+        #   r  = 3
+        #   w  = 2
+        #   yi_1 = Num4MechaEquLib.UCM(m, r, w, 2)
+        #
         def UCM(m, r, w, t)
             hvt = []
             h = []
@@ -154,8 +176,8 @@ module Num4MechaEquLib
             }
             return hvt
         end
-        #
         # 振り子運動
+        #
         # @overload pendulumMotion(m, l, t, h0, v0)
         #   @param [double] m 重りの重さ
         #   @param [double] l 糸の長さ
@@ -163,11 +185,18 @@ module Num4MechaEquLib
         #   @param [double] h0 初期位置値
         #   @param [double] v0 初期速度
         #   @return [hash[]] 0秒からt秒までの位置(h)と速度(v)の値
+        # @example
+        #   m = 1.0
+        #   l  = 10
+        #   h0 = 1.0
+        #   v0 = 0.0
+        #   yi_1 = Num4MechaEquLib.pendulumMotion(m, l, 2, h0, v0)
+        #
         def pendulumMotion(m, l, t, h0, v0)
             return SHM(m, l, t, h0, v0)
         end
-        #
         # 減衰振動（damped harmonic motion)
+        #
         # @overload DHM(m, k, b, t, h0, v0)
         #   @param [double] m 重りの重さ
         #   @param [double] k 比例定数
@@ -176,6 +205,13 @@ module Num4MechaEquLib
         #   @param [double] h0 初期位置値
         #   @param [double] v0 初期速度
         #   @return [hash[]] 0秒からt秒までの位置(h)と速度(v)の値
+        # @example
+        #   m = 1.0
+        #   k = 1.0
+        #   h0 = 1.0
+        #   v0 = 0.0
+        #   yi_1 = Num4MechaEquLib.DHM(m, k, 0.6, 2, h0, v0)
+        #
         def DHM(m, k, b, t, h0, v0)
             @l = 2 * m * b
             @w = Math.sqrt((k / m))
@@ -190,8 +226,8 @@ module Num4MechaEquLib
             }
             return hvt
         end
-        #
         # 強制振動
+        #
         # @overload forcedOscillation(m, k, w0, w, t, h0, v0)
         #   @param [double] m 重りの重さ
         #   @param [double] k 比例定数
@@ -201,6 +237,14 @@ module Num4MechaEquLib
         #   @param [double] h0 初期位置値
         #   @param [double] v0 初期速度
         #   @return [hash[]] 0秒からt秒までの位置(h)と速度(v)の値
+        # @example
+        #   m = 1.0
+        #   k = 1.0
+        #   f0 = 2.5
+        #   h0 = 1.0
+        #   v0 = 0.0
+        #   yi_1 = Num4MechaEquLib.forcedOscillation(m, k, 0.6, f0, 2, h0, v0)
+        #
         def forcedOscillation(m, k, w0, w, t, h0, v0)
             @w = Math.sqrt((k / m))
             hvt = []

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: num4mechaequ
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - siranovel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-20 00:00:00.000000000 Z
+date: 2023-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: num4simdiff
@@ -45,7 +45,7 @@ licenses:
 - MIT
 metadata:
   changelog_uri: http://github.com/siranovel/num4mechaequation/blob/main/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/num4mechaequ/0.1.3
+  documentation_uri: https://rubydoc.info/gems/num4mechaequ/0.1.4
   homepage_uri: http://github.com/siranovel/num4mechaequation
   wiki_uri: https://github.com/siranovel/mydocs/tree/main/num4phyequation/num4mechaequation
 post_install_message: